JiwaAPI

<back to all web services

PO_ClassificationQuery

Requires Authentication
PO_ClassificationQuery Parameters:
NameParameterData TypeRequiredDescription
POClassificationIDquerystringNo
POClassificationIDStartsWithquerystringNo
POClassificationIDEndsWithquerystringNo
POClassificationIDContainsquerystringNo
POClassificationIDLikequerystringNo
POClassificationIDBetweenquerystring[]No
POClassificationIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
PurchClassLedgerIDquerystringNo
PurchClassLedgerIDStartsWithquerystringNo
PurchClassLedgerIDEndsWithquerystringNo
PurchClassLedgerIDContainsquerystringNo
PurchClassLedgerIDLikequerystringNo
PurchClassLedgerIDBetweenquerystring[]No
PurchClassLedgerIDInquerystring[]No
DefaultClassqueryshort?No
DefaultClassGreaterThanOrEqualToqueryshort?No
DefaultClassGreaterThanqueryshort?No
DefaultClassLessThanqueryshort?No
DefaultClassLessThanOrEqualToqueryshort?No
DefaultClassNotEqualToqueryshort?No
DefaultClassBetweenqueryNullable<Int16>[]No
DefaultClassInqueryNullable<Int16>[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PO_Classification Parameters:
NameParameterData TypeRequiredDescription
POClassificationIDformstringNo
DescriptionformstringNo
PurchClassLedgerIDformstringNo
DefaultClassformshort?No
LastSavedDateTimeformDateTime?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_ClassificationQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PO_ClassificationQuery 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>
  <DefaultClass>0</DefaultClass>
  <DefaultClassBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </DefaultClassBetween>
  <DefaultClassGreaterThan>0</DefaultClassGreaterThan>
  <DefaultClassGreaterThanOrEqualTo>0</DefaultClassGreaterThanOrEqualTo>
  <DefaultClassIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </DefaultClassIn>
  <DefaultClassLessThan>0</DefaultClassLessThan>
  <DefaultClassLessThanOrEqualTo>0</DefaultClassLessThanOrEqualTo>
  <DefaultClassNotEqualTo>0</DefaultClassNotEqualTo>
  <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>
  <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>
  <POClassificationID>String</POClassificationID>
  <POClassificationIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </POClassificationIDBetween>
  <POClassificationIDContains>String</POClassificationIDContains>
  <POClassificationIDEndsWith>String</POClassificationIDEndsWith>
  <POClassificationIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </POClassificationIDIn>
  <POClassificationIDLike>String</POClassificationIDLike>
  <POClassificationIDStartsWith>String</POClassificationIDStartsWith>
  <PurchClassLedgerID>String</PurchClassLedgerID>
  <PurchClassLedgerIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PurchClassLedgerIDBetween>
  <PurchClassLedgerIDContains>String</PurchClassLedgerIDContains>
  <PurchClassLedgerIDEndsWith>String</PurchClassLedgerIDEndsWith>
  <PurchClassLedgerIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PurchClassLedgerIDIn>
  <PurchClassLedgerIDLike>String</PurchClassLedgerIDLike>
  <PurchClassLedgerIDStartsWith>String</PurchClassLedgerIDStartsWith>
</PO_ClassificationQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfPO_Classification7kRqkrSv 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_Classification>
      <d2p1:_x003C_DefaultClass_x003E_k__BackingField>0</d2p1:_x003C_DefaultClass_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_POClassificationID_x003E_k__BackingField>String</d2p1:_x003C_POClassificationID_x003E_k__BackingField>
      <d2p1:_x003C_PurchClassLedgerID_x003E_k__BackingField>String</d2p1:_x003C_PurchClassLedgerID_x003E_k__BackingField>
    </d2p1:PO_Classification>
  </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_Classification7kRqkrSv>