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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/CR_AUDITQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"CreditorTotal":0,"CreditorTotalGreaterThanOrEqualTo":0,"CreditorTotalGreaterThan":0,"CreditorTotalLessThan":0,"CreditorTotalLessThanOrEqualTo":0,"CreditorTotalNotEqualTo":0,"CreditorTotalBetween":[0],"CreditorTotalIn":[0],"ReportGroup":"String","ReportGroupStartsWith":"String","ReportGroupEndsWith":"String","ReportGroupContains":"String","ReportGroupLike":"String","ReportGroupBetween":["String"],"ReportGroupIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"CreditorID":"String","CreditorTotal":0,"ReportGroup":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}