| 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 | |
| Status | query | byte? | No | |
| StatusGreaterThanOrEqualTo | query | byte? | No | |
| StatusGreaterThan | query | byte? | No | |
| StatusLessThan | query | byte? | No | |
| StatusLessThanOrEqualTo | query | byte? | No | |
| StatusNotEqualTo | query | byte? | No | |
| StatusBetween | query | Nullable<Byte>[] | No | |
| StatusIn | query | Nullable<Byte>[] | No | |
| StartDateTime | query | DateTime? | No | |
| StartDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| StartDateTimeGreaterThan | query | DateTime? | No | |
| StartDateTimeLessThan | query | DateTime? | No | |
| StartDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| StartDateTimeNotEqualTo | query | DateTime? | No | |
| StartDateTimeBetween | query | DateTime[] | No | |
| StartDateTimeIn | query | DateTime[] | No | |
| EndDateTime | query | DateTime? | No | |
| EndDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| EndDateTimeGreaterThan | query | DateTime? | No | |
| EndDateTimeLessThan | query | DateTime? | No | |
| EndDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| EndDateTimeNotEqualTo | query | DateTime? | No | |
| EndDateTimeBetween | query | DateTime[] | No | |
| EndDateTimeIn | query | DateTime[] | No | |
| Message | query | string | No | |
| MessageStartsWith | query | string | No | |
| MessageEndsWith | query | string | No | |
| MessageContains | query | string | No | |
| MessageLike | query | string | No | |
| MessageBetween | query | string[] | No | |
| MessageIn | query | string[] | No | |
| Report | query | string | No | |
| ReportStartsWith | query | string | No | |
| ReportEndsWith | query | string | No | |
| ReportContains | query | string | No | |
| ReportLike | query | string | No | |
| ReportBetween | query | string[] | No | |
| ReportIn | 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 | |
| ExecutionID | query | string | No | |
| ExecutionIDStartsWith | query | string | No | |
| ExecutionIDEndsWith | query | string | No | |
| ExecutionIDContains | query | string | No | |
| ExecutionIDLike | query | string | No | |
| ExecutionIDBetween | query | string[] | No | |
| ExecutionIDIn | 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 | |
| Status | form | byte? | No | |
| StartDateTime | form | DateTime | No | |
| EndDateTime | form | DateTime | No | |
| Message | form | string | No | |
| Report | form | string | No | |
| CreatedDateTime | form | DateTime | No | |
| CreatedByStaffID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| LastSavedByStaffID | form | string | No | |
| ExecutionID | 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_HistoryQuery 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"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"StartDateTime":"0001-01-01T00:00:00.0000000","StartDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","StartDateTimeLessThan":"0001-01-01T00:00:00.0000000","StartDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","StartDateTimeBetween":["0001-01-01T00:00:00.0000000"],"StartDateTimeIn":["0001-01-01T00:00:00.0000000"],"EndDateTime":"0001-01-01T00:00:00.0000000","EndDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","EndDateTimeLessThan":"0001-01-01T00:00:00.0000000","EndDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","EndDateTimeBetween":["0001-01-01T00:00:00.0000000"],"EndDateTimeIn":["0001-01-01T00:00:00.0000000"],"Message":"String","MessageStartsWith":"String","MessageEndsWith":"String","MessageContains":"String","MessageLike":"String","MessageBetween":["String"],"MessageIn":["String"],"Report":"String","ReportStartsWith":"String","ReportEndsWith":"String","ReportContains":"String","ReportLike":"String","ReportBetween":["String"],"ReportIn":["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"],"ExecutionID":"String","ExecutionIDStartsWith":"String","ExecutionIDEndsWith":"String","ExecutionIDContains":"String","ExecutionIDLike":"String","ExecutionIDBetween":["String"],"ExecutionIDIn":["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","Status":0,"Message":"String","Report":"String","CreatedByStaffID":"String","LastSavedByStaffID":"String","ExecutionID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}