| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FilterID | query | string | No | |
| FilterIDStartsWith | query | string | No | |
| FilterIDEndsWith | query | string | No | |
| FilterIDContains | query | string | No | |
| FilterIDLike | query | string | No | |
| FilterIDBetween | query | string[] | No | |
| FilterIDIn | query | string[] | No | |
| Section | query | short? | No | |
| SectionGreaterThanOrEqualTo | query | short? | No | |
| SectionGreaterThan | query | short? | No | |
| SectionLessThan | query | short? | No | |
| SectionLessThanOrEqualTo | query | short? | No | |
| SectionNotEqualTo | query | short? | No | |
| SectionBetween | query | Nullable<Int16>[] | No | |
| SectionIn | query | Nullable<Int16>[] | No | |
| Filter | query | string | No | |
| FilterStartsWith | query | string | No | |
| FilterEndsWith | query | string | No | |
| FilterContains | query | string | No | |
| FilterLike | query | string | No | |
| FilterBetween | query | string[] | No | |
| FilterIn | 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 |
| 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 |
|---|---|---|---|---|
| FilterID | form | string | No | |
| Section | form | short? | No | |
| Filter | form | string | No | |
| Description | 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/SY_FiltersTempQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"FilterID":"String","FilterIDStartsWith":"String","FilterIDEndsWith":"String","FilterIDContains":"String","FilterIDLike":"String","FilterIDBetween":["String"],"FilterIDIn":["String"],"Section":0,"SectionGreaterThanOrEqualTo":0,"SectionGreaterThan":0,"SectionLessThan":0,"SectionLessThanOrEqualTo":0,"SectionNotEqualTo":0,"SectionBetween":[0],"SectionIn":[0],"Filter":"String","FilterStartsWith":"String","FilterEndsWith":"String","FilterContains":"String","FilterLike":"String","FilterBetween":["String"],"FilterIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["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":[{"FilterID":"String","Section":0,"Filter":"String","Description":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}