| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RA_CreditMain_RecID | query | string | No | |
| RA_CreditMain_RecIDStartsWith | query | string | No | |
| RA_CreditMain_RecIDEndsWith | query | string | No | |
| RA_CreditMain_RecIDContains | query | string | No | |
| RA_CreditMain_RecIDLike | query | string | No | |
| RA_CreditMain_RecIDBetween | query | string[] | No | |
| RA_CreditMain_RecIDIn | query | string[] | No | |
| RA_ShipMain_RecID | query | string | No | |
| RA_ShipMain_RecIDStartsWith | query | string | No | |
| RA_ShipMain_RecIDEndsWith | query | string | No | |
| RA_ShipMain_RecIDContains | query | string | No | |
| RA_ShipMain_RecIDLike | query | string | No | |
| RA_ShipMain_RecIDBetween | query | string[] | No | |
| RA_ShipMain_RecIDIn | 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 |
|---|---|---|---|---|
| RA_CreditMain_RecID | form | string | No | |
| RA_ShipMain_RecID | 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/RA_ShipInQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RA_CreditMain_RecID":"String","RA_CreditMain_RecIDStartsWith":"String","RA_CreditMain_RecIDEndsWith":"String","RA_CreditMain_RecIDContains":"String","RA_CreditMain_RecIDLike":"String","RA_CreditMain_RecIDBetween":["String"],"RA_CreditMain_RecIDIn":["String"],"RA_ShipMain_RecID":"String","RA_ShipMain_RecIDStartsWith":"String","RA_ShipMain_RecIDEndsWith":"String","RA_ShipMain_RecIDContains":"String","RA_ShipMain_RecIDLike":"String","RA_ShipMain_RecIDBetween":["String"],"RA_ShipMain_RecIDIn":["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":[{"RA_CreditMain_RecID":"String","RA_ShipMain_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}