| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FilterDefID | query | string | No | |
| FilterDefIDStartsWith | query | string | No | |
| FilterDefIDEndsWith | query | string | No | |
| FilterDefIDContains | query | string | No | |
| FilterDefIDLike | query | string | No | |
| FilterDefIDBetween | query | string[] | No | |
| FilterDefIDIn | query | string[] | No | |
| StaffID | query | string | No | |
| StaffIDStartsWith | query | string | No | |
| StaffIDEndsWith | query | string | No | |
| StaffIDContains | query | string | No | |
| StaffIDLike | query | string | No | |
| StaffIDBetween | query | string[] | No | |
| StaffIDIn | query | string[] | No | |
| FilterNo | query | int? | No | |
| FilterNoGreaterThanOrEqualTo | query | int? | No | |
| FilterNoGreaterThan | query | int? | No | |
| FilterNoLessThan | query | int? | No | |
| FilterNoLessThanOrEqualTo | query | int? | No | |
| FilterNoNotEqualTo | query | int? | No | |
| FilterNoBetween | query | int[] | No | |
| FilterNoIn | query | int[] | No | |
| SortOrderIndex | query | short? | No | |
| SortOrderIndexGreaterThanOrEqualTo | query | short? | No | |
| SortOrderIndexGreaterThan | query | short? | No | |
| SortOrderIndexLessThan | query | short? | No | |
| SortOrderIndexLessThanOrEqualTo | query | short? | No | |
| SortOrderIndexNotEqualTo | query | short? | No | |
| SortOrderIndexBetween | query | Nullable<Int16>[] | No | |
| SortOrderIndexIn | query | Nullable<Int16>[] | No | |
| GetDataOnLoad | query | bool? | No | |
| SortOrderType | query | short? | No | |
| SortOrderTypeGreaterThanOrEqualTo | query | short? | No | |
| SortOrderTypeGreaterThan | query | short? | No | |
| SortOrderTypeLessThan | query | short? | No | |
| SortOrderTypeLessThanOrEqualTo | query | short? | No | |
| SortOrderTypeNotEqualTo | query | short? | No | |
| SortOrderTypeBetween | query | Nullable<Int16>[] | No | |
| SortOrderTypeIn | query | Nullable<Int16>[] | No | |
| StartType | query | short? | No | |
| StartTypeGreaterThanOrEqualTo | query | short? | No | |
| StartTypeGreaterThan | query | short? | No | |
| StartTypeLessThan | query | short? | No | |
| StartTypeLessThanOrEqualTo | query | short? | No | |
| StartTypeNotEqualTo | query | short? | No | |
| StartTypeBetween | query | Nullable<Int16>[] | No | |
| StartTypeIn | query | Nullable<Int16>[] | No | |
| SY_Filters_RecID | query | string | No | |
| SY_Filters_RecIDStartsWith | query | string | No | |
| SY_Filters_RecIDEndsWith | query | string | No | |
| SY_Filters_RecIDContains | query | string | No | |
| SY_Filters_RecIDLike | query | string | No | |
| SY_Filters_RecIDBetween | query | string[] | No | |
| SY_Filters_RecIDIn | 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 |
|---|---|---|---|---|
| FilterDefID | form | string | No | |
| StaffID | form | string | No | |
| FilterNo | form | int | No | |
| SortOrderIndex | form | short? | No | |
| GetDataOnLoad | form | bool | No | |
| SortOrderType | form | short? | No | |
| StartType | form | short? | No | |
| SY_Filters_RecID | 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_FilterDefaultsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"FilterDefID":"String","FilterDefIDStartsWith":"String","FilterDefIDEndsWith":"String","FilterDefIDContains":"String","FilterDefIDLike":"String","FilterDefIDBetween":["String"],"FilterDefIDIn":["String"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"FilterNo":0,"FilterNoGreaterThanOrEqualTo":0,"FilterNoGreaterThan":0,"FilterNoLessThan":0,"FilterNoLessThanOrEqualTo":0,"FilterNoNotEqualTo":0,"FilterNoBetween":[0],"FilterNoIn":[0],"SortOrderIndex":0,"SortOrderIndexGreaterThanOrEqualTo":0,"SortOrderIndexGreaterThan":0,"SortOrderIndexLessThan":0,"SortOrderIndexLessThanOrEqualTo":0,"SortOrderIndexNotEqualTo":0,"SortOrderIndexBetween":[0],"SortOrderIndexIn":[0],"GetDataOnLoad":false,"SortOrderType":0,"SortOrderTypeGreaterThanOrEqualTo":0,"SortOrderTypeGreaterThan":0,"SortOrderTypeLessThan":0,"SortOrderTypeLessThanOrEqualTo":0,"SortOrderTypeNotEqualTo":0,"SortOrderTypeBetween":[0],"SortOrderTypeIn":[0],"StartType":0,"StartTypeGreaterThanOrEqualTo":0,"StartTypeGreaterThan":0,"StartTypeLessThan":0,"StartTypeLessThanOrEqualTo":0,"StartTypeNotEqualTo":0,"StartTypeBetween":[0],"StartTypeIn":[0],"SY_Filters_RecID":"String","SY_Filters_RecIDStartsWith":"String","SY_Filters_RecIDEndsWith":"String","SY_Filters_RecIDContains":"String","SY_Filters_RecIDLike":"String","SY_Filters_RecIDBetween":["String"],"SY_Filters_RecIDIn":["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":[{"FilterDefID":"String","StaffID":"String","SortOrderIndex":0,"SortOrderType":0,"StartType":0,"SY_Filters_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}