JiwaAPI

<back to all web services

PO_BatchPurchaseOrdersQuery

Requires Authentication
PO_BatchPurchaseOrdersQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
PO_BatchHeader_RecIDquerystringNo
PO_BatchHeader_RecIDStartsWithquerystringNo
PO_BatchHeader_RecIDEndsWithquerystringNo
PO_BatchHeader_RecIDContainsquerystringNo
PO_BatchHeader_RecIDLikequerystringNo
PO_BatchHeader_RecIDBetweenquerystring[]No
PO_BatchHeader_RecIDInquerystring[]No
PO_Main_RecIDquerystringNo
PO_Main_RecIDStartsWithquerystringNo
PO_Main_RecIDEndsWithquerystringNo
PO_Main_RecIDContainsquerystringNo
PO_Main_RecIDLikequerystringNo
PO_Main_RecIDBetweenquerystring[]No
PO_Main_RecIDInquerystring[]No
CR_Main_RecIDquerystringNo
CR_Main_RecIDStartsWithquerystringNo
CR_Main_RecIDEndsWithquerystringNo
CR_Main_RecIDContainsquerystringNo
CR_Main_RecIDLikequerystringNo
CR_Main_RecIDBetweenquerystring[]No
CR_Main_RecIDInquerystring[]No
FXCurrencyRatequerydecimal?No
FXCurrencyRateGreaterThanOrEqualToquerydecimal?No
FXCurrencyRateGreaterThanquerydecimal?No
FXCurrencyRateLessThanquerydecimal?No
FXCurrencyRateLessThanOrEqualToquerydecimal?No
FXCurrencyRateNotEqualToquerydecimal?No
FXCurrencyRateBetweenquerydecimal[]No
FXCurrencyRateInquerydecimal[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PO_BatchPurchaseOrders Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
PO_BatchHeader_RecIDformstringNo
PO_Main_RecIDformstringNo
CR_Main_RecIDformstringNo
FXCurrencyRateformdecimalNo
RowHashformbyte[]No
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/PO_BatchPurchaseOrdersQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PO_BatchPurchaseOrdersQuery 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>
  <CR_Main_RecID>String</CR_Main_RecID>
  <CR_Main_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CR_Main_RecIDBetween>
  <CR_Main_RecIDContains>String</CR_Main_RecIDContains>
  <CR_Main_RecIDEndsWith>String</CR_Main_RecIDEndsWith>
  <CR_Main_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CR_Main_RecIDIn>
  <CR_Main_RecIDLike>String</CR_Main_RecIDLike>
  <CR_Main_RecIDStartsWith>String</CR_Main_RecIDStartsWith>
  <FXCurrencyRate>0</FXCurrencyRate>
  <FXCurrencyRateBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </FXCurrencyRateBetween>
  <FXCurrencyRateGreaterThan>0</FXCurrencyRateGreaterThan>
  <FXCurrencyRateGreaterThanOrEqualTo>0</FXCurrencyRateGreaterThanOrEqualTo>
  <FXCurrencyRateIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </FXCurrencyRateIn>
  <FXCurrencyRateLessThan>0</FXCurrencyRateLessThan>
  <FXCurrencyRateLessThanOrEqualTo>0</FXCurrencyRateLessThanOrEqualTo>
  <FXCurrencyRateNotEqualTo>0</FXCurrencyRateNotEqualTo>
  <PO_BatchHeader_RecID>String</PO_BatchHeader_RecID>
  <PO_BatchHeader_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PO_BatchHeader_RecIDBetween>
  <PO_BatchHeader_RecIDContains>String</PO_BatchHeader_RecIDContains>
  <PO_BatchHeader_RecIDEndsWith>String</PO_BatchHeader_RecIDEndsWith>
  <PO_BatchHeader_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PO_BatchHeader_RecIDIn>
  <PO_BatchHeader_RecIDLike>String</PO_BatchHeader_RecIDLike>
  <PO_BatchHeader_RecIDStartsWith>String</PO_BatchHeader_RecIDStartsWith>
  <PO_Main_RecID>String</PO_Main_RecID>
  <PO_Main_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PO_Main_RecIDBetween>
  <PO_Main_RecIDContains>String</PO_Main_RecIDContains>
  <PO_Main_RecIDEndsWith>String</PO_Main_RecIDEndsWith>
  <PO_Main_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PO_Main_RecIDIn>
  <PO_Main_RecIDLike>String</PO_Main_RecIDLike>
  <PO_Main_RecIDStartsWith>String</PO_Main_RecIDStartsWith>
  <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>
</PO_BatchPurchaseOrdersQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfPO_BatchPurchaseOrders7kRqkrSv 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_BatchPurchaseOrders>
      <d2p1:_x003C_CR_Main_RecID_x003E_k__BackingField>String</d2p1:_x003C_CR_Main_RecID_x003E_k__BackingField>
      <d2p1:_x003C_FXCurrencyRate_x003E_k__BackingField>0</d2p1:_x003C_FXCurrencyRate_x003E_k__BackingField>
      <d2p1:_x003C_PO_BatchHeader_RecID_x003E_k__BackingField>String</d2p1:_x003C_PO_BatchHeader_RecID_x003E_k__BackingField>
      <d2p1:_x003C_PO_Main_RecID_x003E_k__BackingField>String</d2p1:_x003C_PO_Main_RecID_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:PO_BatchPurchaseOrders>
  </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_BatchPurchaseOrders7kRqkrSv>