Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
HeaderID | query | string | No | |
HeaderIDStartsWith | query | string | No | |
HeaderIDEndsWith | query | string | No | |
HeaderIDContains | query | string | No | |
HeaderIDLike | query | string | No | |
HeaderIDBetween | query | string[] | No | |
HeaderIDIn | query | string[] | No | |
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 | |
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 | |
FilterScript | query | string | No | |
FilterScriptStartsWith | query | string | No | |
FilterScriptEndsWith | query | string | No | |
FilterScriptContains | query | string | No | |
FilterScriptLike | query | string | No | |
FilterScriptBetween | query | string[] | No | |
FilterScriptIn | query | string[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | DateTime[] | No | |
LastSavedDateTimeIn | query | DateTime[] | 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 |
---|---|---|---|---|
HeaderID | form | string | No | |
FilterID | form | string | No | |
Description | form | string | No | |
FilterScript | form | string | No | |
LastSavedDateTime | form | DateTime | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/AR_ProviderFiltersQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"HeaderID":"String","HeaderIDStartsWith":"String","HeaderIDEndsWith":"String","HeaderIDContains":"String","HeaderIDLike":"String","HeaderIDBetween":["String"],"HeaderIDIn":["String"],"FilterID":"String","FilterIDStartsWith":"String","FilterIDEndsWith":"String","FilterIDContains":"String","FilterIDLike":"String","FilterIDBetween":["String"],"FilterIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"FilterScript":"String","FilterScriptStartsWith":"String","FilterScriptEndsWith":"String","FilterScriptContains":"String","FilterScriptLike":"String","FilterScriptBetween":["String"],"FilterScriptIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Results":[{"HeaderID":"String","FilterID":"String","Description":"String","FilterScript":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}