| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApportionedID | query | string | No | |
| ApportionedIDStartsWith | query | string | No | |
| ApportionedIDEndsWith | query | string | No | |
| ApportionedIDContains | query | string | No | |
| ApportionedIDLike | query | string | No | |
| ApportionedIDBetween | query | string[] | No | |
| ApportionedIDIn | query | string[] | No | |
| CostsID | query | string | No | |
| CostsIDStartsWith | query | string | No | |
| CostsIDEndsWith | query | string | No | |
| CostsIDContains | query | string | No | |
| CostsIDLike | query | string | No | |
| CostsIDBetween | query | string[] | No | |
| CostsIDIn | query | string[] | No | |
| ShipmentID | query | string | No | |
| ShipmentIDStartsWith | query | string | No | |
| ShipmentIDEndsWith | query | string | No | |
| ShipmentIDContains | query | string | No | |
| ShipmentIDLike | query | string | No | |
| ShipmentIDBetween | query | string[] | No | |
| ShipmentIDIn | query | string[] | No | |
| OrdersUsedID | query | string | No | |
| OrdersUsedIDStartsWith | query | string | No | |
| OrdersUsedIDEndsWith | query | string | No | |
| OrdersUsedIDContains | query | string | No | |
| OrdersUsedIDLike | query | string | No | |
| OrdersUsedIDBetween | query | string[] | No | |
| OrdersUsedIDIn | query | string[] | No | |
| RowHash | query | byte[] | 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 |
|---|---|---|---|---|
| ApportionedID | form | string | No | |
| CostsID | form | string | No | |
| ShipmentID | form | string | No | |
| OrdersUsedID | form | string | No | |
| RowHash | form | byte[] | 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/SH_ApportionedCostsOnPOQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ApportionedID":"String","ApportionedIDStartsWith":"String","ApportionedIDEndsWith":"String","ApportionedIDContains":"String","ApportionedIDLike":"String","ApportionedIDBetween":["String"],"ApportionedIDIn":["String"],"CostsID":"String","CostsIDStartsWith":"String","CostsIDEndsWith":"String","CostsIDContains":"String","CostsIDLike":"String","CostsIDBetween":["String"],"CostsIDIn":["String"],"ShipmentID":"String","ShipmentIDStartsWith":"String","ShipmentIDEndsWith":"String","ShipmentIDContains":"String","ShipmentIDLike":"String","ShipmentIDBetween":["String"],"ShipmentIDIn":["String"],"OrdersUsedID":"String","OrdersUsedIDStartsWith":"String","OrdersUsedIDEndsWith":"String","OrdersUsedIDContains":"String","OrdersUsedIDLike":"String","OrdersUsedIDBetween":["String"],"OrdersUsedIDIn":["String"],"RowHash":"AA==","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":[{"ApportionedID":"String","CostsID":"String","ShipmentID":"String","OrdersUsedID":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}