| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | query | string[] | No | |
| AR_Main_RecID | query | string | No | |
| AR_Main_RecIDStartsWith | query | string | No | |
| AR_Main_RecIDEndsWith | query | string | No | |
| AR_Main_RecIDContains | query | string | No | |
| AR_Main_RecIDLike | query | string | No | |
| AR_Main_RecIDBetween | query | string[] | No | |
| AR_Main_RecIDIn | query | string[] | No | |
| TaskNo | query | int? | No | |
| TaskNoGreaterThanOrEqualTo | query | int? | No | |
| TaskNoGreaterThan | query | int? | No | |
| TaskNoLessThan | query | int? | No | |
| TaskNoLessThanOrEqualTo | query | int? | No | |
| TaskNoNotEqualTo | query | int? | No | |
| TaskNoBetween | query | int[] | No | |
| TaskNoIn | query | int[] | No | |
| Name | query | string | No | |
| NameStartsWith | query | string | No | |
| NameEndsWith | query | string | No | |
| NameContains | query | string | No | |
| NameLike | query | string | No | |
| NameBetween | query | string[] | No | |
| NameIn | query | string[] | No | |
| AR_Provider_ProviderID | query | string | No | |
| AR_Provider_ProviderIDStartsWith | query | string | No | |
| AR_Provider_ProviderIDEndsWith | query | string | No | |
| AR_Provider_ProviderIDContains | query | string | No | |
| AR_Provider_ProviderIDLike | query | string | No | |
| AR_Provider_ProviderIDBetween | query | string[] | No | |
| AR_Provider_ProviderIDIn | query | string[] | No | |
| Enabled | query | byte? | No | |
| EnabledGreaterThanOrEqualTo | query | byte? | No | |
| EnabledGreaterThan | query | byte? | No | |
| EnabledLessThan | query | byte? | No | |
| EnabledLessThanOrEqualTo | query | byte? | No | |
| EnabledNotEqualTo | query | byte? | No | |
| EnabledBetween | query | Nullable<Byte>[] | No | |
| EnabledIn | query | Nullable<Byte>[] | 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 | |
| CreatedDateTime | query | DateTime? | No | |
| CreatedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| CreatedDateTimeGreaterThan | query | DateTime? | No | |
| CreatedDateTimeLessThan | query | DateTime? | No | |
| CreatedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| CreatedDateTimeNotEqualTo | query | DateTime? | No | |
| CreatedDateTimeBetween | query | DateTime[] | No | |
| CreatedDateTimeIn | query | DateTime[] | No | |
| CreatedByStaffID | query | string | No | |
| CreatedByStaffIDStartsWith | query | string | No | |
| CreatedByStaffIDEndsWith | query | string | No | |
| CreatedByStaffIDContains | query | string | No | |
| CreatedByStaffIDLike | query | string | No | |
| CreatedByStaffIDBetween | query | string[] | No | |
| CreatedByStaffIDIn | 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 | |
| LastSavedByStaffID | query | string | No | |
| LastSavedByStaffIDStartsWith | query | string | No | |
| LastSavedByStaffIDEndsWith | query | string | No | |
| LastSavedByStaffIDContains | query | string | No | |
| LastSavedByStaffIDLike | query | string | No | |
| LastSavedByStaffIDBetween | query | string[] | No | |
| LastSavedByStaffIDIn | 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 |
|---|---|---|---|---|
| RecID | form | string | No | |
| AR_Main_RecID | form | string | No | |
| TaskNo | form | int | No | |
| Name | form | string | No | |
| AR_Provider_ProviderID | form | string | No | |
| Enabled | form | byte? | No | |
| Description | form | string | No | |
| CreatedDateTime | form | DateTime | No | |
| CreatedByStaffID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| LastSavedByStaffID | 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/AR_TasksQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"AR_Main_RecID":"String","AR_Main_RecIDStartsWith":"String","AR_Main_RecIDEndsWith":"String","AR_Main_RecIDContains":"String","AR_Main_RecIDLike":"String","AR_Main_RecIDBetween":["String"],"AR_Main_RecIDIn":["String"],"TaskNo":0,"TaskNoGreaterThanOrEqualTo":0,"TaskNoGreaterThan":0,"TaskNoLessThan":0,"TaskNoLessThanOrEqualTo":0,"TaskNoNotEqualTo":0,"TaskNoBetween":[0],"TaskNoIn":[0],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"AR_Provider_ProviderID":"String","AR_Provider_ProviderIDStartsWith":"String","AR_Provider_ProviderIDEndsWith":"String","AR_Provider_ProviderIDContains":"String","AR_Provider_ProviderIDLike":"String","AR_Provider_ProviderIDBetween":["String"],"AR_Provider_ProviderIDIn":["String"],"Enabled":0,"EnabledGreaterThanOrEqualTo":0,"EnabledGreaterThan":0,"EnabledLessThan":0,"EnabledLessThanOrEqualTo":0,"EnabledNotEqualTo":0,"EnabledBetween":[0],"EnabledIn":[0],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"CreatedDateTime":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"CreatedDateTimeIn":["0001-01-01T00:00:00.0000000"],"CreatedByStaffID":"String","CreatedByStaffIDStartsWith":"String","CreatedByStaffIDEndsWith":"String","CreatedByStaffIDContains":"String","CreatedByStaffIDLike":"String","CreatedByStaffIDBetween":["String"],"CreatedByStaffIDIn":["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"],"LastSavedByStaffID":"String","LastSavedByStaffIDStartsWith":"String","LastSavedByStaffIDEndsWith":"String","LastSavedByStaffIDContains":"String","LastSavedByStaffIDLike":"String","LastSavedByStaffIDBetween":["String"],"LastSavedByStaffIDIn":["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":[{"RecID":"String","AR_Main_RecID":"String","Name":"String","AR_Provider_ProviderID":"String","Enabled":0,"Description":"String","CreatedByStaffID":"String","LastSavedByStaffID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}