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_Tasks_RecID | query | string | No | |
AR_Tasks_RecIDStartsWith | query | string | No | |
AR_Tasks_RecIDEndsWith | query | string | No | |
AR_Tasks_RecIDContains | query | string | No | |
AR_Tasks_RecIDLike | query | string | No | |
AR_Tasks_RecIDBetween | query | string[] | No | |
AR_Tasks_RecIDIn | query | string[] | No | |
AR_ProviderHeaders_HeaderID | query | string | No | |
AR_ProviderHeaders_HeaderIDStartsWith | query | string | No | |
AR_ProviderHeaders_HeaderIDEndsWith | query | string | No | |
AR_ProviderHeaders_HeaderIDContains | query | string | No | |
AR_ProviderHeaders_HeaderIDLike | query | string | No | |
AR_ProviderHeaders_HeaderIDBetween | query | string[] | No | |
AR_ProviderHeaders_HeaderIDIn | query | string[] | No | |
AR_ProviderFilters_FilterID | query | string | No | |
AR_ProviderFilters_FilterIDStartsWith | query | string | No | |
AR_ProviderFilters_FilterIDEndsWith | query | string | No | |
AR_ProviderFilters_FilterIDContains | query | string | No | |
AR_ProviderFilters_FilterIDLike | query | string | No | |
AR_ProviderFilters_FilterIDBetween | query | string[] | No | |
AR_ProviderFilters_FilterIDIn | 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_Tasks_RecID | form | string | No | |
AR_ProviderHeaders_HeaderID | form | string | No | |
AR_ProviderFilters_FilterID | 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_TaskFiltersQuery 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_Tasks_RecID":"String","AR_Tasks_RecIDStartsWith":"String","AR_Tasks_RecIDEndsWith":"String","AR_Tasks_RecIDContains":"String","AR_Tasks_RecIDLike":"String","AR_Tasks_RecIDBetween":["String"],"AR_Tasks_RecIDIn":["String"],"AR_ProviderHeaders_HeaderID":"String","AR_ProviderHeaders_HeaderIDStartsWith":"String","AR_ProviderHeaders_HeaderIDEndsWith":"String","AR_ProviderHeaders_HeaderIDContains":"String","AR_ProviderHeaders_HeaderIDLike":"String","AR_ProviderHeaders_HeaderIDBetween":["String"],"AR_ProviderHeaders_HeaderIDIn":["String"],"AR_ProviderFilters_FilterID":"String","AR_ProviderFilters_FilterIDStartsWith":"String","AR_ProviderFilters_FilterIDEndsWith":"String","AR_ProviderFilters_FilterIDContains":"String","AR_ProviderFilters_FilterIDLike":"String","AR_ProviderFilters_FilterIDBetween":["String"],"AR_ProviderFilters_FilterIDIn":["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_Tasks_RecID":"String","AR_ProviderHeaders_HeaderID":"String","AR_ProviderFilters_FilterID":"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"}}}