JiwaAPI

<back to all web services

CR_AUDITQuery

Requires Authentication
CR_AUDITQuery Parameters:
NameParameterData TypeRequiredDescription
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
CreditorTotalquerydecimal?No
CreditorTotalGreaterThanOrEqualToquerydecimal?No
CreditorTotalGreaterThanquerydecimal?No
CreditorTotalLessThanquerydecimal?No
CreditorTotalLessThanOrEqualToquerydecimal?No
CreditorTotalNotEqualToquerydecimal?No
CreditorTotalBetweenqueryNullable<Decimal>[]No
CreditorTotalInqueryNullable<Decimal>[]No
ReportGroupquerystringNo
ReportGroupStartsWithquerystringNo
ReportGroupEndsWithquerystringNo
ReportGroupContainsquerystringNo
ReportGroupLikequerystringNo
ReportGroupBetweenquerystring[]No
ReportGroupInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CR_AUDIT Parameters:
NameParameterData TypeRequiredDescription
CreditorIDformstringNo
CreditorTotalformdecimal?No
ReportGroupformstringNo
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/CR_AUDITQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CR_AUDITQuery 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>
  <CreditorID>String</CreditorID>
  <CreditorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditorIDBetween>
  <CreditorIDContains>String</CreditorIDContains>
  <CreditorIDEndsWith>String</CreditorIDEndsWith>
  <CreditorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditorIDIn>
  <CreditorIDLike>String</CreditorIDLike>
  <CreditorIDStartsWith>String</CreditorIDStartsWith>
  <CreditorTotal>0</CreditorTotal>
  <CreditorTotalBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </CreditorTotalBetween>
  <CreditorTotalGreaterThan>0</CreditorTotalGreaterThan>
  <CreditorTotalGreaterThanOrEqualTo>0</CreditorTotalGreaterThanOrEqualTo>
  <CreditorTotalIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </CreditorTotalIn>
  <CreditorTotalLessThan>0</CreditorTotalLessThan>
  <CreditorTotalLessThanOrEqualTo>0</CreditorTotalLessThanOrEqualTo>
  <CreditorTotalNotEqualTo>0</CreditorTotalNotEqualTo>
  <ReportGroup>String</ReportGroup>
  <ReportGroupBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ReportGroupBetween>
  <ReportGroupContains>String</ReportGroupContains>
  <ReportGroupEndsWith>String</ReportGroupEndsWith>
  <ReportGroupIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ReportGroupIn>
  <ReportGroupLike>String</ReportGroupLike>
  <ReportGroupStartsWith>String</ReportGroupStartsWith>
</CR_AUDITQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCR_AUDIT7kRqkrSv 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:CR_AUDIT>
      <d2p1:_x003C_CreditorID_x003E_k__BackingField>String</d2p1:_x003C_CreditorID_x003E_k__BackingField>
      <d2p1:_x003C_CreditorTotal_x003E_k__BackingField>0</d2p1:_x003C_CreditorTotal_x003E_k__BackingField>
      <d2p1:_x003C_ReportGroup_x003E_k__BackingField>String</d2p1:_x003C_ReportGroup_x003E_k__BackingField>
    </d2p1:CR_AUDIT>
  </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>
</QueryResponseOfCR_AUDIT7kRqkrSv>