| 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 | |
| BatchNo | query | string | No | |
| BatchNoStartsWith | query | string | No | |
| BatchNoEndsWith | query | string | No | |
| BatchNoContains | query | string | No | |
| BatchNoLike | query | string | No | |
| BatchNoBetween | query | string[] | No | |
| BatchNoIn | 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 | |
| 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 | |
| ActivatedDateTime | query | DateTime? | No | |
| ActivatedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| ActivatedDateTimeGreaterThan | query | DateTime? | No | |
| ActivatedDateTimeLessThan | query | DateTime? | No | |
| ActivatedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| ActivatedDateTimeNotEqualTo | query | DateTime? | No | |
| ActivatedDateTimeBetween | query | Nullable<DateTime>[] | No | |
| ActivatedDateTimeIn | query | Nullable<DateTime>[] | No | |
| ActivatedByStaffID | query | string | No | |
| ActivatedByStaffIDStartsWith | query | string | No | |
| ActivatedByStaffIDEndsWith | query | string | No | |
| ActivatedByStaffIDContains | query | string | No | |
| ActivatedByStaffIDLike | query | string | No | |
| ActivatedByStaffIDBetween | query | string[] | No | |
| ActivatedByStaffIDIn | query | string[] | No | |
| IN_LogicalID | query | string | No | |
| IN_LogicalIDStartsWith | query | string | No | |
| IN_LogicalIDEndsWith | query | string | No | |
| IN_LogicalIDContains | query | string | No | |
| IN_LogicalIDLike | query | string | No | |
| IN_LogicalIDBetween | query | string[] | No | |
| IN_LogicalIDIn | query | string[] | No | |
| Status | query | short? | No | |
| StatusGreaterThanOrEqualTo | query | short? | No | |
| StatusGreaterThan | query | short? | No | |
| StatusLessThan | query | short? | No | |
| StatusLessThanOrEqualTo | query | short? | No | |
| StatusNotEqualTo | query | short? | No | |
| StatusBetween | query | short[] | No | |
| StatusIn | query | short[] | No | |
| Notes | query | string | No | |
| NotesStartsWith | query | string | No | |
| NotesEndsWith | query | string | No | |
| NotesContains | query | string | No | |
| NotesLike | query | string | No | |
| NotesBetween | query | string[] | No | |
| NotesIn | query | string[] | No | |
| BORunNo | query | string | No | |
| BORunNoStartsWith | query | string | No | |
| BORunNoEndsWith | query | string | No | |
| BORunNoContains | query | string | No | |
| BORunNoLike | query | string | No | |
| BORunNoBetween | query | string[] | No | |
| BORunNoIn | 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 | |
| BatchNo | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| LastSavedByStaffID | form | string | No | |
| CreatedDateTime | form | DateTime | No | |
| CreatedByStaffID | form | string | No | |
| ActivatedDateTime | form | DateTime? | No | |
| ActivatedByStaffID | form | string | No | |
| IN_LogicalID | form | string | No | |
| Status | form | short | No | |
| Notes | form | string | No | |
| BORunNo | 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/BO_ManualReleaseBatchQuery 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"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["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"],"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"],"ActivatedDateTime":"0001-01-01T00:00:00.0000000","ActivatedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ActivatedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","ActivatedDateTimeLessThan":"0001-01-01T00:00:00.0000000","ActivatedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ActivatedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","ActivatedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"ActivatedDateTimeIn":["0001-01-01T00:00:00.0000000"],"ActivatedByStaffID":"String","ActivatedByStaffIDStartsWith":"String","ActivatedByStaffIDEndsWith":"String","ActivatedByStaffIDContains":"String","ActivatedByStaffIDLike":"String","ActivatedByStaffIDBetween":["String"],"ActivatedByStaffIDIn":["String"],"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"Notes":"String","NotesStartsWith":"String","NotesEndsWith":"String","NotesContains":"String","NotesLike":"String","NotesBetween":["String"],"NotesIn":["String"],"BORunNo":"String","BORunNoStartsWith":"String","BORunNoEndsWith":"String","BORunNoContains":"String","BORunNoLike":"String","BORunNoBetween":["String"],"BORunNoIn":["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","BatchNo":"String","LastSavedByStaffID":"String","CreatedByStaffID":"String","ActivatedDateTime":"0001-01-01T00:00:00.0000000","ActivatedByStaffID":"String","IN_LogicalID":"String","Notes":"String","BORunNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}