JiwaAPI

PO_BatchHeaderQuery

**PO_BatchHeaderQuery** 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
BatchNo	query	string	No
BatchNoStartsWith	query	string	No
BatchNoEndsWith	query	string	No
BatchNoContains	query	string	No
BatchNoLike	query	string	No
BatchNoBetween	query	string[]	No
BatchNoIn	query	string[]	No
IN_LogicalID	query	string	No
IN_LogicalIDStartsWith	query	string	No
IN_LogicalIDEndsWith	query	string	No
IN_LogicalIDContains	query	string	No
IN_LogicalIDLike	query	string	No
IN_LogicalIDBetween	query	string[]	No
IN_LogicalIDIn	query	string[]	No
CreatedByStaffID	query	string	No
CreatedByStaffIDStartsWith	query	string	No
CreatedByStaffIDEndsWith	query	string	No
CreatedByStaffIDContains	query	string	No
CreatedByStaffIDLike	query	string	No
CreatedByStaffIDBetween	query	string[]	No
CreatedByStaffIDIn	query	string[]	No
CreatedDateTime	query	DateTime?	No
CreatedDateTimeGreaterThanOrEqualTo	query	DateTime?	No
CreatedDateTimeGreaterThan	query	DateTime?	No
CreatedDateTimeLessThan	query	DateTime?	No
CreatedDateTimeLessThanOrEqualTo	query	DateTime?	No
CreatedDateTimeNotEqualTo	query	DateTime?	No
CreatedDateTimeBetween	query	DateTime[]	No
CreatedDateTimeIn	query	DateTime[]	No
LastModifiedByStaffID	query	string	No
LastModifiedByStaffIDStartsWith	query	string	No
LastModifiedByStaffIDEndsWith	query	string	No
LastModifiedByStaffIDContains	query	string	No
LastModifiedByStaffIDLike	query	string	No
LastModifiedByStaffIDBetween	query	string[]	No
LastModifiedByStaffIDIn	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	DateTime[]	No
LastSavedDateTimeIn	query	DateTime[]	No
BatchStatus	query	byte?	No
BatchStatusGreaterThanOrEqualTo	query	byte?	No
BatchStatusGreaterThan	query	byte?	No
BatchStatusLessThan	query	byte?	No
BatchStatusLessThanOrEqualTo	query	byte?	No
BatchStatusNotEqualTo	query	byte?	No
BatchStatusBetween	query	byte[]	No
BatchStatusIn	query	byte[]	No
ReOrderMonth	query	byte?	No
ReOrderMonthGreaterThanOrEqualTo	query	byte?	No
ReOrderMonthGreaterThan	query	byte?	No
ReOrderMonthLessThan	query	byte?	No
ReOrderMonthLessThanOrEqualTo	query	byte?	No
ReOrderMonthNotEqualTo	query	byte?	No
ReOrderMonthBetween	query	byte[]	No
ReOrderMonthIn	query	byte[]	No
IncludeDefaultSuppliersOnly	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

**PO_BatchHeader** Parameters:
Name	Parameter	Data Type	Required
RecID	form	string	No
BatchNo	form	string	No
IN_LogicalID	form	string	No
CreatedByStaffID	form	string	No
CreatedDateTime	form	DateTime	No
LastModifiedByStaffID	form	string	No
LastSavedDateTime	form	DateTime	No
BatchStatus	form	byte	No
ReOrderMonth	form	byte	No
IncludeDefaultSuppliersOnly	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/PO_BatchHeaderQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PO_BatchHeaderQuery 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>
  <BatchNo>String</BatchNo>
  <BatchNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BatchNoBetween>
  <BatchNoContains>String</BatchNoContains>
  <BatchNoEndsWith>String</BatchNoEndsWith>
  <BatchNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BatchNoIn>
  <BatchNoLike>String</BatchNoLike>
  <BatchNoStartsWith>String</BatchNoStartsWith>
  <BatchStatus>0</BatchStatus>
  <BatchStatusBetween>AA==</BatchStatusBetween>
  <BatchStatusGreaterThan>0</BatchStatusGreaterThan>
  <BatchStatusGreaterThanOrEqualTo>0</BatchStatusGreaterThanOrEqualTo>
  <BatchStatusIn>AA==</BatchStatusIn>
  <BatchStatusLessThan>0</BatchStatusLessThan>
  <BatchStatusLessThanOrEqualTo>0</BatchStatusLessThanOrEqualTo>
  <BatchStatusNotEqualTo>0</BatchStatusNotEqualTo>
  <CreatedByStaffID>String</CreatedByStaffID>
  <CreatedByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreatedByStaffIDBetween>
  <CreatedByStaffIDContains>String</CreatedByStaffIDContains>
  <CreatedByStaffIDEndsWith>String</CreatedByStaffIDEndsWith>
  <CreatedByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreatedByStaffIDIn>
  <CreatedByStaffIDLike>String</CreatedByStaffIDLike>
  <CreatedByStaffIDStartsWith>String</CreatedByStaffIDStartsWith>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <CreatedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CreatedDateTimeBetween>
  <CreatedDateTimeGreaterThan>0001-01-01T00:00:00</CreatedDateTimeGreaterThan>
  <CreatedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</CreatedDateTimeGreaterThanOrEqualTo>
  <CreatedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CreatedDateTimeIn>
  <CreatedDateTimeLessThan>0001-01-01T00:00:00</CreatedDateTimeLessThan>
  <CreatedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</CreatedDateTimeLessThanOrEqualTo>
  <CreatedDateTimeNotEqualTo>0001-01-01T00:00:00</CreatedDateTimeNotEqualTo>
  <IN_LogicalID>String</IN_LogicalID>
  <IN_LogicalIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IN_LogicalIDBetween>
  <IN_LogicalIDContains>String</IN_LogicalIDContains>
  <IN_LogicalIDEndsWith>String</IN_LogicalIDEndsWith>
  <IN_LogicalIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IN_LogicalIDIn>
  <IN_LogicalIDLike>String</IN_LogicalIDLike>
  <IN_LogicalIDStartsWith>String</IN_LogicalIDStartsWith>
  <IncludeDefaultSuppliersOnly>false</IncludeDefaultSuppliersOnly>
  <LastModifiedByStaffID>String</LastModifiedByStaffID>
  <LastModifiedByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LastModifiedByStaffIDBetween>
  <LastModifiedByStaffIDContains>String</LastModifiedByStaffIDContains>
  <LastModifiedByStaffIDEndsWith>String</LastModifiedByStaffIDEndsWith>
  <LastModifiedByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LastModifiedByStaffIDIn>
  <LastModifiedByStaffIDLike>String</LastModifiedByStaffIDLike>
  <LastModifiedByStaffIDStartsWith>String</LastModifiedByStaffIDStartsWith>
  <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>
  <ReOrderMonth>0</ReOrderMonth>
  <ReOrderMonthBetween>AA==</ReOrderMonthBetween>
  <ReOrderMonthGreaterThan>0</ReOrderMonthGreaterThan>
  <ReOrderMonthGreaterThanOrEqualTo>0</ReOrderMonthGreaterThanOrEqualTo>
  <ReOrderMonthIn>AA==</ReOrderMonthIn>
  <ReOrderMonthLessThan>0</ReOrderMonthLessThan>
  <ReOrderMonthLessThanOrEqualTo>0</ReOrderMonthLessThanOrEqualTo>
  <ReOrderMonthNotEqualTo>0</ReOrderMonthNotEqualTo>
  <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_BatchHeaderQuery>

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

<QueryResponseOfPO_BatchHeader7kRqkrSv 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_BatchHeader>
      <d2p1:_x003C_BatchNo_x003E_k__BackingField>String</d2p1:_x003C_BatchNo_x003E_k__BackingField>
      <d2p1:_x003C_BatchStatus_x003E_k__BackingField>0</d2p1:_x003C_BatchStatus_x003E_k__BackingField>
      <d2p1:_x003C_CreatedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_CreatedByStaffID_x003E_k__BackingField>
      <d2p1:_x003C_CreatedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_CreatedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>
      <d2p1:_x003C_IncludeDefaultSuppliersOnly_x003E_k__BackingField>false</d2p1:_x003C_IncludeDefaultSuppliersOnly_x003E_k__BackingField>
      <d2p1:_x003C_LastModifiedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_LastModifiedByStaffID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_ReOrderMonth_x003E_k__BackingField>0</d2p1:_x003C_ReOrderMonth_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
    </d2p1:PO_BatchHeader>
  </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_BatchHeader7kRqkrSv>