JiwaAPI

SY_FormReportDefinitionQuery

**SY_FormReportDefinitionQuery** 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
Description	query	string	No
DescriptionStartsWith	query	string	No
DescriptionEndsWith	query	string	No
DescriptionContains	query	string	No
DescriptionLike	query	string	No
DescriptionBetween	query	string[]	No
DescriptionIn	query	string[]	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
SY_Forms_ClassName	query	string	No
SY_Forms_ClassNameStartsWith	query	string	No
SY_Forms_ClassNameEndsWith	query	string	No
SY_Forms_ClassNameContains	query	string	No
SY_Forms_ClassNameLike	query	string	No
SY_Forms_ClassNameBetween	query	string[]	No
SY_Forms_ClassNameIn	query	string[]	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
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
LastSavedDateTime	query	DateTime?	No
LastSavedDateTimeGreaterThanOrEqualTo	query	DateTime?	No
LastSavedDateTimeGreaterThan	query	DateTime?	No
LastSavedDateTimeLessThan	query	DateTime?	No
LastSavedDateTimeLessThanOrEqualTo	query	DateTime?	No
LastSavedDateTimeNotEqualTo	query	DateTime?	No
LastSavedDateTimeBetween	query	DateTime[]	No
LastSavedDateTimeIn	query	DateTime[]	No
IsDefault	query	bool?	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

**SY_FormReportDefinition** Parameters:
Name	Parameter	Data Type	Required
RecID	form	string	No
Description	form	string	No
SY_Report_RecID	form	string	No
SY_PrintGroupLogicalPrinter_RecID	form	string	No
SY_Forms_ClassName	form	string	No
SY_PrintGroup_RecID	form	string	No
ItemNo	form	int	No
RowHash	form	byte[]	No
LastSavedDateTime	form	DateTime	No
IsDefault	form	bool	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/SY_FormReportDefinitionQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_FormReportDefinitionQuery 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>
  <Description>String</Description>
  <DescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionBetween>
  <DescriptionContains>String</DescriptionContains>
  <DescriptionEndsWith>String</DescriptionEndsWith>
  <DescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionIn>
  <DescriptionLike>String</DescriptionLike>
  <DescriptionStartsWith>String</DescriptionStartsWith>
  <IsDefault>false</IsDefault>
  <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>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeBetween>
  <LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
  <LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
  <LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeIn>
  <LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
  <LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
  <LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
  <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_Forms_ClassName>String</SY_Forms_ClassName>
  <SY_Forms_ClassNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Forms_ClassNameBetween>
  <SY_Forms_ClassNameContains>String</SY_Forms_ClassNameContains>
  <SY_Forms_ClassNameEndsWith>String</SY_Forms_ClassNameEndsWith>
  <SY_Forms_ClassNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SY_Forms_ClassNameIn>
  <SY_Forms_ClassNameLike>String</SY_Forms_ClassNameLike>
  <SY_Forms_ClassNameStartsWith>String</SY_Forms_ClassNameStartsWith>
  <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>
</SY_FormReportDefinitionQuery>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_FormReportDefinition7kRqkrSv 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:SY_FormReportDefinition>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_IsDefault_x003E_k__BackingField>false</d2p1:_x003C_IsDefault_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_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_Forms_ClassName_x003E_k__BackingField>String</d2p1:_x003C_SY_Forms_ClassName_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:SY_FormReportDefinition>
  </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>
</QueryResponseOfSY_FormReportDefinition7kRqkrSv>