Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DebtorID | query | string | No | |
DebtorIDStartsWith | query | string | No | |
DebtorIDEndsWith | query | string | No | |
DebtorIDContains | query | string | No | |
DebtorIDLike | query | string | No | |
DebtorIDBetween | query | string[] | No | |
DebtorIDIn | query | string[] | No | |
DebtorTotal | query | decimal? | No | |
DebtorTotalGreaterThanOrEqualTo | query | decimal? | No | |
DebtorTotalGreaterThan | query | decimal? | No | |
DebtorTotalLessThan | query | decimal? | No | |
DebtorTotalLessThanOrEqualTo | query | decimal? | No | |
DebtorTotalNotEqualTo | query | decimal? | No | |
DebtorTotalBetween | query | Nullable<Decimal>[] | No | |
DebtorTotalIn | query | Nullable<Decimal>[] | No | |
ReportGroup | query | string | No | |
ReportGroupStartsWith | query | string | No | |
ReportGroupEndsWith | query | string | No | |
ReportGroupContains | query | string | No | |
ReportGroupLike | query | string | No | |
ReportGroupBetween | query | string[] | No | |
ReportGroupIn | query | string[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DebtorID | form | string | No | |
DebtorTotal | form | decimal? | No | |
ReportGroup | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}