| 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 | |
| ProviderName | query | string | No | |
| ProviderNameStartsWith | query | string | No | |
| ProviderNameEndsWith | query | string | No | |
| ProviderNameContains | query | string | No | |
| ProviderNameLike | query | string | No | |
| ProviderNameBetween | query | string[] | No | |
| ProviderNameIn | query | string[] | No | |
| StoredProcedureName | query | string | No | |
| StoredProcedureNameStartsWith | query | string | No | |
| StoredProcedureNameEndsWith | query | string | No | |
| StoredProcedureNameContains | query | string | No | |
| StoredProcedureNameLike | query | string | No | |
| StoredProcedureNameBetween | query | string[] | No | |
| StoredProcedureNameIn | query | string[] | No | |
| ProviderDescription | query | string | No | |
| ProviderDescriptionStartsWith | query | string | No | |
| ProviderDescriptionEndsWith | query | string | No | |
| ProviderDescriptionContains | query | string | No | |
| ProviderDescriptionLike | query | string | No | |
| ProviderDescriptionBetween | query | string[] | No | |
| ProviderDescriptionIn | 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 |
|---|---|---|---|---|
| ProviderID | form | string | No | |
| ProviderName | form | string | No | |
| StoredProcedureName | form | string | No | |
| ProviderDescription | 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 .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/AR_ProviderQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ProviderID":"String","ProviderIDStartsWith":"String","ProviderIDEndsWith":"String","ProviderIDContains":"String","ProviderIDLike":"String","ProviderIDBetween":["String"],"ProviderIDIn":["String"],"ProviderName":"String","ProviderNameStartsWith":"String","ProviderNameEndsWith":"String","ProviderNameContains":"String","ProviderNameLike":"String","ProviderNameBetween":["String"],"ProviderNameIn":["String"],"StoredProcedureName":"String","StoredProcedureNameStartsWith":"String","StoredProcedureNameEndsWith":"String","StoredProcedureNameContains":"String","StoredProcedureNameLike":"String","StoredProcedureNameBetween":["String"],"StoredProcedureNameIn":["String"],"ProviderDescription":"String","ProviderDescriptionStartsWith":"String","ProviderDescriptionEndsWith":"String","ProviderDescriptionContains":"String","ProviderDescriptionLike":"String","ProviderDescriptionBetween":["String"],"ProviderDescriptionIn":["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: text/csv
Content-Length: length
{"Results":[{"ProviderID":"String","ProviderName":"String","StoredProcedureName":"String","ProviderDescription":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}