| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PI_ReceiptsID | query | string | No | |
| PI_ReceiptsIDStartsWith | query | string | No | |
| PI_ReceiptsIDEndsWith | query | string | No | |
| PI_ReceiptsIDContains | query | string | No | |
| PI_ReceiptsIDLike | query | string | No | |
| PI_ReceiptsIDBetween | query | string[] | No | |
| PI_ReceiptsIDIn | query | string[] | No | |
| PI_MainID | query | string | No | |
| PI_MainIDStartsWith | query | string | No | |
| PI_MainIDEndsWith | query | string | No | |
| PI_MainIDContains | query | string | No | |
| PI_MainIDLike | query | string | No | |
| PI_MainIDBetween | query | string[] | No | |
| PI_MainIDIn | query | string[] | No | |
| RE_MainID | query | string | No | |
| RE_MainIDStartsWith | query | string | No | |
| RE_MainIDEndsWith | query | string | No | |
| RE_MainIDContains | query | string | No | |
| RE_MainIDLike | query | string | No | |
| RE_MainIDBetween | query | string[] | No | |
| RE_MainIDIn | 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 |
|---|---|---|---|---|
| PI_ReceiptsID | form | string | No | |
| PI_MainID | form | string | No | |
| RE_MainID | 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/PI_ReceiptsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"PI_ReceiptsID":"String","PI_ReceiptsIDStartsWith":"String","PI_ReceiptsIDEndsWith":"String","PI_ReceiptsIDContains":"String","PI_ReceiptsIDLike":"String","PI_ReceiptsIDBetween":["String"],"PI_ReceiptsIDIn":["String"],"PI_MainID":"String","PI_MainIDStartsWith":"String","PI_MainIDEndsWith":"String","PI_MainIDContains":"String","PI_MainIDLike":"String","PI_MainIDBetween":["String"],"PI_MainIDIn":["String"],"RE_MainID":"String","RE_MainIDStartsWith":"String","RE_MainIDEndsWith":"String","RE_MainIDContains":"String","RE_MainIDLike":"String","RE_MainIDBetween":["String"],"RE_MainIDIn":["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":[{"PI_ReceiptsID":"String","PI_MainID":"String","RE_MainID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}