JiwaAPI

<back to all web services

DB_AuditQuery

Requires Authentication
DB_AuditQuery Parameters:
NameParameterData TypeRequiredDescription
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
DebtorTotalquerydecimal?No
DebtorTotalGreaterThanOrEqualToquerydecimal?No
DebtorTotalGreaterThanquerydecimal?No
DebtorTotalLessThanquerydecimal?No
DebtorTotalLessThanOrEqualToquerydecimal?No
DebtorTotalNotEqualToquerydecimal?No
DebtorTotalBetweenqueryNullable<Decimal>[]No
DebtorTotalInqueryNullable<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
DB_Audit Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
DebtorTotalformdecimal?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/DB_AuditQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"DebtorTotal":0,"DebtorTotalGreaterThanOrEqualTo":0,"DebtorTotalGreaterThan":0,"DebtorTotalLessThan":0,"DebtorTotalLessThanOrEqualTo":0,"DebtorTotalNotEqualTo":0,"DebtorTotalBetween":[0],"DebtorTotalIn":[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":[{"DebtorID":"String","DebtorTotal":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"}}}