| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProviderID | query | string | No | |
| ProviderIDStartsWith | query | string | No | |
| ProviderIDEndsWith | query | string | No | |
| ProviderIDContains | query | string | No | |
| ProviderIDLike | query | string | No | |
| ProviderIDBetween | query | string[] | No | |
| ProviderIDIn | query | string[] | No | |
| 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 | |
| HeaderName | query | string | No | |
| HeaderNameStartsWith | query | string | No | |
| HeaderNameEndsWith | query | string | No | |
| HeaderNameContains | query | string | No | |
| HeaderNameLike | query | string | No | |
| HeaderNameBetween | query | string[] | No | |
| HeaderNameIn | query | string[] | No | |
| DataType | query | int? | No | |
| DataTypeGreaterThanOrEqualTo | query | int? | No | |
| DataTypeGreaterThan | query | int? | No | |
| DataTypeLessThan | query | int? | No | |
| DataTypeLessThanOrEqualTo | query | int? | No | |
| DataTypeNotEqualTo | query | int? | No | |
| DataTypeBetween | query | int[] | No | |
| DataTypeIn | query | int[] | 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 | |
| OrdinalPosition | query | short? | No | |
| OrdinalPositionGreaterThanOrEqualTo | query | short? | No | |
| OrdinalPositionGreaterThan | query | short? | No | |
| OrdinalPositionLessThan | query | short? | No | |
| OrdinalPositionLessThanOrEqualTo | query | short? | No | |
| OrdinalPositionNotEqualTo | query | short? | No | |
| OrdinalPositionBetween | query | short[] | No | |
| OrdinalPositionIn | query | short[] | 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 |
|---|---|---|---|---|
| ProviderID | form | string | No | |
| HeaderID | form | string | No | |
| HeaderName | form | string | No | |
| DataType | form | int | No | |
| LastSavedDateTime | form | DateTime | No | |
| OrdinalPosition | form | short | 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_ProviderHeadersQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ProviderID":"String","ProviderIDStartsWith":"String","ProviderIDEndsWith":"String","ProviderIDContains":"String","ProviderIDLike":"String","ProviderIDBetween":["String"],"ProviderIDIn":["String"],"HeaderID":"String","HeaderIDStartsWith":"String","HeaderIDEndsWith":"String","HeaderIDContains":"String","HeaderIDLike":"String","HeaderIDBetween":["String"],"HeaderIDIn":["String"],"HeaderName":"String","HeaderNameStartsWith":"String","HeaderNameEndsWith":"String","HeaderNameContains":"String","HeaderNameLike":"String","HeaderNameBetween":["String"],"HeaderNameIn":["String"],"DataType":0,"DataTypeGreaterThanOrEqualTo":0,"DataTypeGreaterThan":0,"DataTypeLessThan":0,"DataTypeLessThanOrEqualTo":0,"DataTypeNotEqualTo":0,"DataTypeBetween":[0],"DataTypeIn":[0],"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"],"OrdinalPosition":0,"OrdinalPositionGreaterThanOrEqualTo":0,"OrdinalPositionGreaterThan":0,"OrdinalPositionLessThan":0,"OrdinalPositionLessThanOrEqualTo":0,"OrdinalPositionNotEqualTo":0,"OrdinalPositionBetween":[0],"OrdinalPositionIn":[0],"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":[{"ProviderID":"String","HeaderID":"String","HeaderName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}