| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CreditReasonID | query | string | No | |
| CreditReasonIDStartsWith | query | string | No | |
| CreditReasonIDEndsWith | query | string | No | |
| CreditReasonIDContains | query | string | No | |
| CreditReasonIDLike | query | string | No | |
| CreditReasonIDBetween | query | string[] | No | |
| CreditReasonIDIn | query | string[] | No | |
| CreditReasonDescription | query | string | No | |
| CreditReasonDescriptionStartsWith | query | string | No | |
| CreditReasonDescriptionEndsWith | query | string | No | |
| CreditReasonDescriptionContains | query | string | No | |
| CreditReasonDescriptionLike | query | string | No | |
| CreditReasonDescriptionBetween | query | string[] | No | |
| CreditReasonDescriptionIn | query | string[] | No | |
| DefaultCreditReason | query | bool? | No | |
| CreditIntoStock | query | bool? | 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 |
|---|---|---|---|---|
| CreditReasonID | form | string | No | |
| CreditReasonDescription | form | string | No | |
| DefaultCreditReason | form | bool | No | |
| CreditIntoStock | form | bool | 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/SO_CreditReasonsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CreditReasonID":"String","CreditReasonIDStartsWith":"String","CreditReasonIDEndsWith":"String","CreditReasonIDContains":"String","CreditReasonIDLike":"String","CreditReasonIDBetween":["String"],"CreditReasonIDIn":["String"],"CreditReasonDescription":"String","CreditReasonDescriptionStartsWith":"String","CreditReasonDescriptionEndsWith":"String","CreditReasonDescriptionContains":"String","CreditReasonDescriptionLike":"String","CreditReasonDescriptionBetween":["String"],"CreditReasonDescriptionIn":["String"],"DefaultCreditReason":false,"CreditIntoStock":false,"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":[{"CreditReasonID":"String","CreditReasonDescription":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}