Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Cost | query | decimal? | No | |
CostGreaterThanOrEqualTo | query | decimal? | No | |
CostGreaterThan | query | decimal? | No | |
CostLessThan | query | decimal? | No | |
CostLessThanOrEqualTo | query | decimal? | No | |
CostNotEqualTo | query | decimal? | No | |
CostBetween | query | Nullable<Decimal>[] | No | |
CostIn | query | Nullable<Decimal>[] | No | |
Charge | query | decimal? | No | |
ChargeGreaterThanOrEqualTo | query | decimal? | No | |
ChargeGreaterThan | query | decimal? | No | |
ChargeLessThan | query | decimal? | No | |
ChargeLessThanOrEqualTo | query | decimal? | No | |
ChargeNotEqualTo | query | decimal? | No | |
ChargeBetween | query | Nullable<Decimal>[] | No | |
ChargeIn | 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 |
---|---|---|---|---|
Cost | form | decimal? | No | |
Charge | 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_WIPValueQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Cost":0,"CostGreaterThanOrEqualTo":0,"CostGreaterThan":0,"CostLessThan":0,"CostLessThanOrEqualTo":0,"CostNotEqualTo":0,"CostBetween":[0],"CostIn":[0],"Charge":0,"ChargeGreaterThanOrEqualTo":0,"ChargeGreaterThan":0,"ChargeLessThan":0,"ChargeLessThanOrEqualTo":0,"ChargeNotEqualTo":0,"ChargeBetween":[0],"ChargeIn":[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":[{"Cost":0,"Charge":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"}}}