JiwaAPI

PO_DocumentsQuery

**PO_DocumentsQuery** 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
PurchaseOrderID	query	string	No
PurchaseOrderIDStartsWith	query	string	No
PurchaseOrderIDEndsWith	query	string	No
PurchaseOrderIDContains	query	string	No
PurchaseOrderIDLike	query	string	No
PurchaseOrderIDBetween	query	string[]	No
PurchaseOrderIDIn	query	string[]	No
FileID	query	string	No
FileIDStartsWith	query	string	No
FileIDEndsWith	query	string	No
FileIDContains	query	string	No
FileIDLike	query	string	No
FileIDBetween	query	string[]	No
FileIDIn	query	string[]	No
DocumentTypeID	query	string	No
DocumentTypeIDStartsWith	query	string	No
DocumentTypeIDEndsWith	query	string	No
DocumentTypeIDContains	query	string	No
DocumentTypeIDLike	query	string	No
DocumentTypeIDBetween	query	string[]	No
DocumentTypeIDIn	query	string[]	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	Nullable<DateTime>[]	No
LastSavedDateTimeIn	query	Nullable<DateTime>[]	No
LastSavedByStaffID	query	string	No
LastSavedByStaffIDStartsWith	query	string	No
LastSavedByStaffIDEndsWith	query	string	No
LastSavedByStaffIDContains	query	string	No
LastSavedByStaffIDLike	query	string	No
LastSavedByStaffIDBetween	query	string[]	No
LastSavedByStaffIDIn	query	string[]	No
FileBinary	query	byte[]	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
PhysicalFileName	query	string	No
PhysicalFileNameStartsWith	query	string	No
PhysicalFileNameEndsWith	query	string	No
PhysicalFileNameContains	query	string	No
PhysicalFileNameLike	query	string	No
PhysicalFileNameBetween	query	string[]	No
PhysicalFileNameIn	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

**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

**PO_Documents** Parameters:
Name	Parameter	Data Type	Required
RecID	form	string	No
PurchaseOrderID	form	string	No
FileID	form	string	No
DocumentTypeID	form	string	No
LastSavedDateTime	form	DateTime?	No
LastSavedByStaffID	form	string	No
FileBinary	form	byte[]	No
Description	form	string	No
PhysicalFileName	form	string	No
ItemNo	form	int	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/PO_DocumentsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PO_DocumentsQuery 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>
  <DocumentTypeID>String</DocumentTypeID>
  <DocumentTypeIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DocumentTypeIDBetween>
  <DocumentTypeIDContains>String</DocumentTypeIDContains>
  <DocumentTypeIDEndsWith>String</DocumentTypeIDEndsWith>
  <DocumentTypeIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DocumentTypeIDIn>
  <DocumentTypeIDLike>String</DocumentTypeIDLike>
  <DocumentTypeIDStartsWith>String</DocumentTypeIDStartsWith>
  <FileBinary>AA==</FileBinary>
  <FileID>String</FileID>
  <FileIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FileIDBetween>
  <FileIDContains>String</FileIDContains>
  <FileIDEndsWith>String</FileIDEndsWith>
  <FileIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FileIDIn>
  <FileIDLike>String</FileIDLike>
  <FileIDStartsWith>String</FileIDStartsWith>
  <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>
  <LastSavedByStaffID>String</LastSavedByStaffID>
  <LastSavedByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LastSavedByStaffIDBetween>
  <LastSavedByStaffIDContains>String</LastSavedByStaffIDContains>
  <LastSavedByStaffIDEndsWith>String</LastSavedByStaffIDEndsWith>
  <LastSavedByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LastSavedByStaffIDIn>
  <LastSavedByStaffIDLike>String</LastSavedByStaffIDLike>
  <LastSavedByStaffIDStartsWith>String</LastSavedByStaffIDStartsWith>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <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.datacontract.org/2004/07/System">
    <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>
  <PhysicalFileName>String</PhysicalFileName>
  <PhysicalFileNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PhysicalFileNameBetween>
  <PhysicalFileNameContains>String</PhysicalFileNameContains>
  <PhysicalFileNameEndsWith>String</PhysicalFileNameEndsWith>
  <PhysicalFileNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PhysicalFileNameIn>
  <PhysicalFileNameLike>String</PhysicalFileNameLike>
  <PhysicalFileNameStartsWith>String</PhysicalFileNameStartsWith>
  <PurchaseOrderID>String</PurchaseOrderID>
  <PurchaseOrderIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PurchaseOrderIDBetween>
  <PurchaseOrderIDContains>String</PurchaseOrderIDContains>
  <PurchaseOrderIDEndsWith>String</PurchaseOrderIDEndsWith>
  <PurchaseOrderIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PurchaseOrderIDIn>
  <PurchaseOrderIDLike>String</PurchaseOrderIDLike>
  <PurchaseOrderIDStartsWith>String</PurchaseOrderIDStartsWith>
  <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>
</PO_DocumentsQuery>

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

<QueryResponseOfPO_Documents7kRqkrSv 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:PO_Documents>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_DocumentTypeID_x003E_k__BackingField>String</d2p1:_x003C_DocumentTypeID_x003E_k__BackingField>
      <d2p1:_x003C_FileBinary_x003E_k__BackingField>AA==</d2p1:_x003C_FileBinary_x003E_k__BackingField>
      <d2p1:_x003C_FileID_x003E_k__BackingField>String</d2p1:_x003C_FileID_x003E_k__BackingField>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_LastSavedByStaffID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_PhysicalFileName_x003E_k__BackingField>String</d2p1:_x003C_PhysicalFileName_x003E_k__BackingField>
      <d2p1:_x003C_PurchaseOrderID_x003E_k__BackingField>String</d2p1:_x003C_PurchaseOrderID_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
    </d2p1:PO_Documents>
  </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>
</QueryResponseOfPO_Documents7kRqkrSv>