| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalCost | query | decimal? | No | |
| TotalCostGreaterThanOrEqualTo | query | decimal? | No | |
| TotalCostGreaterThan | query | decimal? | No | |
| TotalCostLessThan | query | decimal? | No | |
| TotalCostLessThanOrEqualTo | query | decimal? | No | |
| TotalCostNotEqualTo | query | decimal? | No | |
| TotalCostBetween | query | Nullable<Decimal>[] | No | |
| TotalCostIn | query | Nullable<Decimal>[] | No | |
| JobID | query | string | No | |
| JobIDStartsWith | query | string | No | |
| JobIDEndsWith | query | string | No | |
| JobIDContains | query | string | No | |
| JobIDLike | query | string | No | |
| JobIDBetween | query | string[] | No | |
| JobIDIn | 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 |
|---|---|---|---|---|
| TotalCost | form | decimal? | No | |
| JobID | 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/v_JB_CostsToDateQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"TotalCost":0,"TotalCostGreaterThanOrEqualTo":0,"TotalCostGreaterThan":0,"TotalCostLessThan":0,"TotalCostLessThanOrEqualTo":0,"TotalCostNotEqualTo":0,"TotalCostBetween":[0],"TotalCostIn":[0],"JobID":"String","JobIDStartsWith":"String","JobIDEndsWith":"String","JobIDContains":"String","JobIDLike":"String","JobIDBetween":["String"],"JobIDIn":["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":[{"TotalCost":0,"JobID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}