JiwaAPI

SO_ReportDefinitionQuery

**SO_ReportDefinitionQuery** Parameters:
Name	Parameter	Data Type	Required
RecID	query	string	No
RecIDStartsWith	query	string	No
RecIDEndsWith	query	string	No
RecIDContains	query	string	No
RecIDLike	query	string	No
RecIDBetween	query	string[]	No
RecIDIn	query	string[]	No
Name	query	string	No
NameStartsWith	query	string	No
NameEndsWith	query	string	No
NameContains	query	string	No
NameLike	query	string	No
NameBetween	query	string[]	No
NameIn	query	string[]	No
BillingType	query	byte?	No
BillingTypeGreaterThanOrEqualTo	query	byte?	No
BillingTypeGreaterThan	query	byte?	No
BillingTypeLessThan	query	byte?	No
BillingTypeLessThanOrEqualTo	query	byte?	No
BillingTypeNotEqualTo	query	byte?	No
BillingTypeBetween	query	byte[]	No
BillingTypeIn	query	byte[]	No
TradingCategory	query	int?	No
TradingCategoryGreaterThanOrEqualTo	query	int?	No
TradingCategoryGreaterThan	query	int?	No
TradingCategoryLessThan	query	int?	No
TradingCategoryLessThanOrEqualTo	query	int?	No
TradingCategoryNotEqualTo	query	int?	No
TradingCategoryBetween	query	int[]	No
TradingCategoryIn	query	int[]	No
DocumentType	query	byte?	No
DocumentTypeGreaterThanOrEqualTo	query	byte?	No
DocumentTypeGreaterThan	query	byte?	No
DocumentTypeLessThan	query	byte?	No
DocumentTypeLessThanOrEqualTo	query	byte?	No
DocumentTypeNotEqualTo	query	byte?	No
DocumentTypeBetween	query	byte[]	No
DocumentTypeIn	query	byte[]	No
NumberOfCopies	query	short?	No
NumberOfCopiesGreaterThanOrEqualTo	query	short?	No
NumberOfCopiesGreaterThan	query	short?	No
NumberOfCopiesLessThan	query	short?	No
NumberOfCopiesLessThanOrEqualTo	query	short?	No
NumberOfCopiesNotEqualTo	query	short?	No
NumberOfCopiesBetween	query	short[]	No
NumberOfCopiesIn	query	short[]	No
UseRange	query	bool?	No
RangeType	query	byte?	No
RangeTypeGreaterThanOrEqualTo	query	byte?	No
RangeTypeGreaterThan	query	byte?	No
RangeTypeLessThan	query	byte?	No
RangeTypeLessThanOrEqualTo	query	byte?	No
RangeTypeNotEqualTo	query	byte?	No
RangeTypeBetween	query	byte[]	No
RangeTypeIn	query	byte[]	No
MinRange	query	decimal?	No
MinRangeGreaterThanOrEqualTo	query	decimal?	No
MinRangeGreaterThan	query	decimal?	No
MinRangeLessThan	query	decimal?	No
MinRangeLessThanOrEqualTo	query	decimal?	No
MinRangeNotEqualTo	query	decimal?	No
MinRangeBetween	query	decimal[]	No
MinRangeIn	query	decimal[]	No
MaxRange	query	decimal?	No
MaxRangeGreaterThanOrEqualTo	query	decimal?	No
MaxRangeGreaterThan	query	decimal?	No
MaxRangeLessThan	query	decimal?	No
MaxRangeLessThanOrEqualTo	query	decimal?	No
MaxRangeNotEqualTo	query	decimal?	No
MaxRangeBetween	query	decimal[]	No
MaxRangeIn	query	decimal[]	No
BackOrderStatus	query	byte?	No
BackOrderStatusGreaterThanOrEqualTo	query	byte?	No
BackOrderStatusGreaterThan	query	byte?	No
BackOrderStatusLessThan	query	byte?	No
BackOrderStatusLessThanOrEqualTo	query	byte?	No
BackOrderStatusNotEqualTo	query	byte?	No
BackOrderStatusBetween	query	byte[]	No
BackOrderStatusIn	query	byte[]	No
SY_Report_RecID	query	string	No
SY_Report_RecIDStartsWith	query	string	No
SY_Report_RecIDEndsWith	query	string	No
SY_Report_RecIDContains	query	string	No
SY_Report_RecIDLike	query	string	No
SY_Report_RecIDBetween	query	string[]	No
SY_Report_RecIDIn	query	string[]	No
SY_PrintGroupLogicalPrinter_RecID	query	string	No
SY_PrintGroupLogicalPrinter_RecIDStartsWith	query	string	No
SY_PrintGroupLogicalPrinter_RecIDEndsWith	query	string	No
SY_PrintGroupLogicalPrinter_RecIDContains	query	string	No
SY_PrintGroupLogicalPrinter_RecIDLike	query	string	No
SY_PrintGroupLogicalPrinter_RecIDBetween	query	string[]	No
SY_PrintGroupLogicalPrinter_RecIDIn	query	string[]	No
ItemNo	query	int?	No
ItemNoGreaterThanOrEqualTo	query	int?	No
ItemNoGreaterThan	query	int?	No
ItemNoLessThan	query	int?	No
ItemNoLessThanOrEqualTo	query	int?	No
ItemNoNotEqualTo	query	int?	No
ItemNoBetween	query	int[]	No
ItemNoIn	query	int[]	No
RowHash	query	byte[]	No
SY_PrintGroup_RecID	query	string	No
SY_PrintGroup_RecIDStartsWith	query	string	No
SY_PrintGroup_RecIDEndsWith	query	string	No
SY_PrintGroup_RecIDContains	query	string	No
SY_PrintGroup_RecIDLike	query	string	No
SY_PrintGroup_RecIDBetween	query	string[]	No
SY_PrintGroup_RecIDIn	query	string[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**SO_ReportDefinition** Parameters:
Name	Parameter	Data Type	Required
RecID	form	string	No
Name	form	string	No
BillingType	form	byte	No
TradingCategory	form	int	No
DocumentType	form	byte	No
NumberOfCopies	form	short	No
UseRange	form	bool	No
RangeType	form	byte	No
MinRange	form	decimal	No
MaxRange	form	decimal	No
BackOrderStatus	form	byte	No
SY_Report_RecID	form	string	No
SY_PrintGroupLogicalPrinter_RecID	form	string	No
ItemNo	form	int	No
RowHash	form	byte[]	No
SY_PrintGroup_RecID	form	string	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

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>