JiwaAPI

<back to all web services

SO_ReportDefinitionQuery

Requires Authentication
SO_ReportDefinitionQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
BillingTypequerybyte?No
BillingTypeGreaterThanOrEqualToquerybyte?No
BillingTypeGreaterThanquerybyte?No
BillingTypeLessThanquerybyte?No
BillingTypeLessThanOrEqualToquerybyte?No
BillingTypeNotEqualToquerybyte?No
BillingTypeBetweenquerybyte[]No
BillingTypeInquerybyte[]No
TradingCategoryqueryint?No
TradingCategoryGreaterThanOrEqualToqueryint?No
TradingCategoryGreaterThanqueryint?No
TradingCategoryLessThanqueryint?No
TradingCategoryLessThanOrEqualToqueryint?No
TradingCategoryNotEqualToqueryint?No
TradingCategoryBetweenqueryint[]No
TradingCategoryInqueryint[]No
DocumentTypequerybyte?No
DocumentTypeGreaterThanOrEqualToquerybyte?No
DocumentTypeGreaterThanquerybyte?No
DocumentTypeLessThanquerybyte?No
DocumentTypeLessThanOrEqualToquerybyte?No
DocumentTypeNotEqualToquerybyte?No
DocumentTypeBetweenquerybyte[]No
DocumentTypeInquerybyte[]No
NumberOfCopiesqueryshort?No
NumberOfCopiesGreaterThanOrEqualToqueryshort?No
NumberOfCopiesGreaterThanqueryshort?No
NumberOfCopiesLessThanqueryshort?No
NumberOfCopiesLessThanOrEqualToqueryshort?No
NumberOfCopiesNotEqualToqueryshort?No
NumberOfCopiesBetweenqueryshort[]No
NumberOfCopiesInqueryshort[]No
UseRangequerybool?No
RangeTypequerybyte?No
RangeTypeGreaterThanOrEqualToquerybyte?No
RangeTypeGreaterThanquerybyte?No
RangeTypeLessThanquerybyte?No
RangeTypeLessThanOrEqualToquerybyte?No
RangeTypeNotEqualToquerybyte?No
RangeTypeBetweenquerybyte[]No
RangeTypeInquerybyte[]No
MinRangequerydecimal?No
MinRangeGreaterThanOrEqualToquerydecimal?No
MinRangeGreaterThanquerydecimal?No
MinRangeLessThanquerydecimal?No
MinRangeLessThanOrEqualToquerydecimal?No
MinRangeNotEqualToquerydecimal?No
MinRangeBetweenquerydecimal[]No
MinRangeInquerydecimal[]No
MaxRangequerydecimal?No
MaxRangeGreaterThanOrEqualToquerydecimal?No
MaxRangeGreaterThanquerydecimal?No
MaxRangeLessThanquerydecimal?No
MaxRangeLessThanOrEqualToquerydecimal?No
MaxRangeNotEqualToquerydecimal?No
MaxRangeBetweenquerydecimal[]No
MaxRangeInquerydecimal[]No
BackOrderStatusquerybyte?No
BackOrderStatusGreaterThanOrEqualToquerybyte?No
BackOrderStatusGreaterThanquerybyte?No
BackOrderStatusLessThanquerybyte?No
BackOrderStatusLessThanOrEqualToquerybyte?No
BackOrderStatusNotEqualToquerybyte?No
BackOrderStatusBetweenquerybyte[]No
BackOrderStatusInquerybyte[]No
SY_Report_RecIDquerystringNo
SY_Report_RecIDStartsWithquerystringNo
SY_Report_RecIDEndsWithquerystringNo
SY_Report_RecIDContainsquerystringNo
SY_Report_RecIDLikequerystringNo
SY_Report_RecIDBetweenquerystring[]No
SY_Report_RecIDInquerystring[]No
SY_PrintGroupLogicalPrinter_RecIDquerystringNo
SY_PrintGroupLogicalPrinter_RecIDStartsWithquerystringNo
SY_PrintGroupLogicalPrinter_RecIDEndsWithquerystringNo
SY_PrintGroupLogicalPrinter_RecIDContainsquerystringNo
SY_PrintGroupLogicalPrinter_RecIDLikequerystringNo
SY_PrintGroupLogicalPrinter_RecIDBetweenquerystring[]No
SY_PrintGroupLogicalPrinter_RecIDInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
SY_PrintGroup_RecIDquerystringNo
SY_PrintGroup_RecIDStartsWithquerystringNo
SY_PrintGroup_RecIDEndsWithquerystringNo
SY_PrintGroup_RecIDContainsquerystringNo
SY_PrintGroup_RecIDLikequerystringNo
SY_PrintGroup_RecIDBetweenquerystring[]No
SY_PrintGroup_RecIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_ReportDefinition Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
NameformstringNo
BillingTypeformbyteNo
TradingCategoryformintNo
DocumentTypeformbyteNo
NumberOfCopiesformshortNo
UseRangeformboolNo
RangeTypeformbyteNo
MinRangeformdecimalNo
MaxRangeformdecimalNo
BackOrderStatusformbyteNo
SY_Report_RecIDformstringNo
SY_PrintGroupLogicalPrinter_RecIDformstringNo
ItemNoformintNo
RowHashformbyte[]No
SY_PrintGroup_RecIDformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/SO_ReportDefinitionQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SO_ReportDefinitionQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <BackOrderStatus>0</BackOrderStatus>
  <BackOrderStatusBetween>AA==</BackOrderStatusBetween>
  <BackOrderStatusGreaterThan>0</BackOrderStatusGreaterThan>
  <BackOrderStatusGreaterThanOrEqualTo>0</BackOrderStatusGreaterThanOrEqualTo>
  <BackOrderStatusIn>AA==</BackOrderStatusIn>
  <BackOrderStatusLessThan>0</BackOrderStatusLessThan>
  <BackOrderStatusLessThanOrEqualTo>0</BackOrderStatusLessThanOrEqualTo>
  <BackOrderStatusNotEqualTo>0</BackOrderStatusNotEqualTo>
  <BillingType>0</BillingType>
  <BillingTypeBetween>AA==</BillingTypeBetween>
  <BillingTypeGreaterThan>0</BillingTypeGreaterThan>
  <BillingTypeGreaterThanOrEqualTo>0</BillingTypeGreaterThanOrEqualTo>
  <BillingTypeIn>AA==</BillingTypeIn>
  <BillingTypeLessThan>0</BillingTypeLessThan>
  <BillingTypeLessThanOrEqualTo>0</BillingTypeLessThanOrEqualTo>
  <BillingTypeNotEqualTo>0</BillingTypeNotEqualTo>
  <DocumentType>0</DocumentType>
  <DocumentTypeBetween>AA==</DocumentTypeBetween>
  <DocumentTypeGreaterThan>0</DocumentTypeGreaterThan>
  <DocumentTypeGreaterThanOrEqualTo>0</DocumentTypeGreaterThanOrEqualTo>
  <DocumentTypeIn>AA==</DocumentTypeIn>
  <DocumentTypeLessThan>0</DocumentTypeLessThan>
  <DocumentTypeLessThanOrEqualTo>0</DocumentTypeLessThanOrEqualTo>
  <DocumentTypeNotEqualTo>0</DocumentTypeNotEqualTo>
  <ItemNo>0</ItemNo>
  <ItemNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoBetween>
  <ItemNoGreaterThan>0</ItemNoGreaterThan>
  <ItemNoGreaterThanOrEqualTo>0</ItemNoGreaterThanOrEqualTo>
  <ItemNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoIn>
  <ItemNoLessThan>0</ItemNoLessThan>
  <ItemNoLessThanOrEqualTo>0</ItemNoLessThanOrEqualTo>
  <ItemNoNotEqualTo>0</ItemNoNotEqualTo>
  <MaxRange>0</MaxRange>
  <MaxRangeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </MaxRangeBetween>
  <MaxRangeGreaterThan>0</MaxRangeGreaterThan>
  <MaxRangeGreaterThanOrEqualTo>0</MaxRangeGreaterThanOrEqualTo>
  <MaxRangeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </MaxRangeIn>
  <MaxRangeLessThan>0</MaxRangeLessThan>
  <MaxRangeLessThanOrEqualTo>0</MaxRangeLessThanOrEqualTo>
  <MaxRangeNotEqualTo>0</MaxRangeNotEqualTo>
  <MinRange>0</MinRange>
  <MinRangeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </MinRangeBetween>
  <MinRangeGreaterThan>0</MinRangeGreaterThan>
  <MinRangeGreaterThanOrEqualTo>0</MinRangeGreaterThanOrEqualTo>
  <MinRangeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </MinRangeIn>
  <MinRangeLessThan>0</MinRangeLessThan>
  <MinRangeLessThanOrEqualTo>0</MinRangeLessThanOrEqualTo>
  <MinRangeNotEqualTo>0</MinRangeNotEqualTo>
  <Name>String</Name>
  <NameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameBetween>
  <NameContains>String</NameContains>
  <NameEndsWith>String</NameEndsWith>
  <NameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NameIn>
  <NameLike>String</NameLike>
  <NameStartsWith>String</NameStartsWith>
  <NumberOfCopies>0</NumberOfCopies>
  <NumberOfCopiesBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </NumberOfCopiesBetween>
  <NumberOfCopiesGreaterThan>0</NumberOfCopiesGreaterThan>
  <NumberOfCopiesGreaterThanOrEqualTo>0</NumberOfCopiesGreaterThanOrEqualTo>
  <NumberOfCopiesIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </NumberOfCopiesIn>
  <NumberOfCopiesLessThan>0</NumberOfCopiesLessThan>
  <NumberOfCopiesLessThanOrEqualTo>0</NumberOfCopiesLessThanOrEqualTo>
  <NumberOfCopiesNotEqualTo>0</NumberOfCopiesNotEqualTo>
  <RangeType>0</RangeType>
  <RangeTypeBetween>AA==</RangeTypeBetween>
  <RangeTypeGreaterThan>0</RangeTypeGreaterThan>
  <RangeTypeGreaterThanOrEqualTo>0</RangeTypeGreaterThanOrEqualTo>
  <RangeTypeIn>AA==</RangeTypeIn>
  <RangeTypeLessThan>0</RangeTypeLessThan>
  <RangeTypeLessThanOrEqualTo>0</RangeTypeLessThanOrEqualTo>
  <RangeTypeNotEqualTo>0</RangeTypeNotEqualTo>
  <RecID>String</RecID>
  <RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDBetween>
  <RecIDContains>String</RecIDContains>
  <RecIDEndsWith>String</RecIDEndsWith>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDIn>
  <RecIDLike>String</RecIDLike>
  <RecIDStartsWith>String</RecIDStartsWith>
  <RowHash>AA==</RowHash>
  <SY_PrintGroupLogicalPrinter_RecID>String</SY_PrintGroupLogicalPrinter_RecID>
  <SY_PrintGroupLogicalPrinter_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_PrintGroupLogicalPrinter_RecIDBetween>
  <SY_PrintGroupLogicalPrinter_RecIDContains>String</SY_PrintGroupLogicalPrinter_RecIDContains>
  <SY_PrintGroupLogicalPrinter_RecIDEndsWith>String</SY_PrintGroupLogicalPrinter_RecIDEndsWith>
  <SY_PrintGroupLogicalPrinter_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_PrintGroupLogicalPrinter_RecIDIn>
  <SY_PrintGroupLogicalPrinter_RecIDLike>String</SY_PrintGroupLogicalPrinter_RecIDLike>
  <SY_PrintGroupLogicalPrinter_RecIDStartsWith>String</SY_PrintGroupLogicalPrinter_RecIDStartsWith>
  <SY_PrintGroup_RecID>String</SY_PrintGroup_RecID>
  <SY_PrintGroup_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_PrintGroup_RecIDBetween>
  <SY_PrintGroup_RecIDContains>String</SY_PrintGroup_RecIDContains>
  <SY_PrintGroup_RecIDEndsWith>String</SY_PrintGroup_RecIDEndsWith>
  <SY_PrintGroup_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_PrintGroup_RecIDIn>
  <SY_PrintGroup_RecIDLike>String</SY_PrintGroup_RecIDLike>
  <SY_PrintGroup_RecIDStartsWith>String</SY_PrintGroup_RecIDStartsWith>
  <SY_Report_RecID>String</SY_Report_RecID>
  <SY_Report_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Report_RecIDBetween>
  <SY_Report_RecIDContains>String</SY_Report_RecIDContains>
  <SY_Report_RecIDEndsWith>String</SY_Report_RecIDEndsWith>
  <SY_Report_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Report_RecIDIn>
  <SY_Report_RecIDLike>String</SY_Report_RecIDLike>
  <SY_Report_RecIDStartsWith>String</SY_Report_RecIDStartsWith>
  <TradingCategory>0</TradingCategory>
  <TradingCategoryBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TradingCategoryBetween>
  <TradingCategoryGreaterThan>0</TradingCategoryGreaterThan>
  <TradingCategoryGreaterThanOrEqualTo>0</TradingCategoryGreaterThanOrEqualTo>
  <TradingCategoryIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TradingCategoryIn>
  <TradingCategoryLessThan>0</TradingCategoryLessThan>
  <TradingCategoryLessThanOrEqualTo>0</TradingCategoryLessThanOrEqualTo>
  <TradingCategoryNotEqualTo>0</TradingCategoryNotEqualTo>
  <UseRange>false</UseRange>
</SO_ReportDefinitionQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSO_ReportDefinition7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:SO_ReportDefinition>
      <d2p1:_x003C_BackOrderStatus_x003E_k__BackingField>0</d2p1:_x003C_BackOrderStatus_x003E_k__BackingField>
      <d2p1:_x003C_BillingType_x003E_k__BackingField>0</d2p1:_x003C_BillingType_x003E_k__BackingField>
      <d2p1:_x003C_DocumentType_x003E_k__BackingField>0</d2p1:_x003C_DocumentType_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_MaxRange_x003E_k__BackingField>0</d2p1:_x003C_MaxRange_x003E_k__BackingField>
      <d2p1:_x003C_MinRange_x003E_k__BackingField>0</d2p1:_x003C_MinRange_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
      <d2p1:_x003C_NumberOfCopies_x003E_k__BackingField>0</d2p1:_x003C_NumberOfCopies_x003E_k__BackingField>
      <d2p1:_x003C_RangeType_x003E_k__BackingField>0</d2p1:_x003C_RangeType_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_SY_PrintGroupLogicalPrinter_RecID_x003E_k__BackingField>String</d2p1:_x003C_SY_PrintGroupLogicalPrinter_RecID_x003E_k__BackingField>
      <d2p1:_x003C_SY_PrintGroup_RecID_x003E_k__BackingField>String</d2p1:_x003C_SY_PrintGroup_RecID_x003E_k__BackingField>
      <d2p1:_x003C_SY_Report_RecID_x003E_k__BackingField>String</d2p1:_x003C_SY_Report_RecID_x003E_k__BackingField>
      <d2p1:_x003C_TradingCategory_x003E_k__BackingField>0</d2p1:_x003C_TradingCategory_x003E_k__BackingField>
      <d2p1:_x003C_UseRange_x003E_k__BackingField>false</d2p1:_x003C_UseRange_x003E_k__BackingField>
    </d2p1:SO_ReportDefinition>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfSO_ReportDefinition7kRqkrSv>