| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DutyID | query | string | No | |
| DutyIDStartsWith | query | string | No | |
| DutyIDEndsWith | query | string | No | |
| DutyIDContains | query | string | No | |
| DutyIDLike | query | string | No | |
| DutyIDBetween | query | string[] | No | |
| DutyIDIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| Value | query | decimal? | No | |
| ValueGreaterThanOrEqualTo | query | decimal? | No | |
| ValueGreaterThan | query | decimal? | No | |
| ValueLessThan | query | decimal? | No | |
| ValueLessThanOrEqualTo | query | decimal? | No | |
| ValueNotEqualTo | query | decimal? | No | |
| ValueBetween | query | Nullable<Decimal>[] | No | |
| ValueIn | query | Nullable<Decimal>[] | No | |
| IsDefault | 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 |
|---|---|---|---|---|
| DutyID | form | string | No | |
| Description | form | string | No | |
| Value | form | decimal? | No | |
| IsDefault | 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/IN_DutyQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"DutyID":"String","DutyIDStartsWith":"String","DutyIDEndsWith":"String","DutyIDContains":"String","DutyIDLike":"String","DutyIDBetween":["String"],"DutyIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"Value":0,"ValueGreaterThanOrEqualTo":0,"ValueGreaterThan":0,"ValueLessThan":0,"ValueLessThanOrEqualTo":0,"ValueNotEqualTo":0,"ValueBetween":[0],"ValueIn":[0],"IsDefault":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":[{"DutyID":"String","Description":"String","Value":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}