| 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 | |
| BatchDate | query | DateTime? | No | |
| BatchDateGreaterThanOrEqualTo | query | DateTime? | No | |
| BatchDateGreaterThan | query | DateTime? | No | |
| BatchDateLessThan | query | DateTime? | No | |
| BatchDateLessThanOrEqualTo | query | DateTime? | No | |
| BatchDateNotEqualTo | query | DateTime? | No | |
| BatchDateBetween | query | DateTime[] | No | |
| BatchDateIn | query | DateTime[] | 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 | byte[] | No | |
| StatusIn | query | byte[] | No | |
| LastSavedBy_HR_Staff_RecID | query | string | No | |
| LastSavedBy_HR_Staff_RecIDStartsWith | query | string | No | |
| LastSavedBy_HR_Staff_RecIDEndsWith | query | string | No | |
| LastSavedBy_HR_Staff_RecIDContains | query | string | No | |
| LastSavedBy_HR_Staff_RecIDLike | query | string | No | |
| LastSavedBy_HR_Staff_RecIDBetween | query | string[] | No | |
| LastSavedBy_HR_Staff_RecIDIn | 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 | |
| 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 | |
| RowHash | query | byte[] | 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 | |
| BatchDate | form | DateTime | No | |
| Status | form | byte | No | |
| LastSavedBy_HR_Staff_RecID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| Description | form | string | No | |
| RowHash | form | byte[] | 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/DB_AdjustmentsQuery 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"],"BatchDate":"0001-01-01T00:00:00.0000000","BatchDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","BatchDateGreaterThan":"0001-01-01T00:00:00.0000000","BatchDateLessThan":"0001-01-01T00:00:00.0000000","BatchDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","BatchDateNotEqualTo":"0001-01-01T00:00:00.0000000","BatchDateBetween":["0001-01-01T00:00:00.0000000"],"BatchDateIn":["0001-01-01T00:00:00.0000000"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":"AA==","StatusIn":"AA==","LastSavedBy_HR_Staff_RecID":"String","LastSavedBy_HR_Staff_RecIDStartsWith":"String","LastSavedBy_HR_Staff_RecIDEndsWith":"String","LastSavedBy_HR_Staff_RecIDContains":"String","LastSavedBy_HR_Staff_RecIDLike":"String","LastSavedBy_HR_Staff_RecIDBetween":["String"],"LastSavedBy_HR_Staff_RecIDIn":["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"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"RowHash":"AA==","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","LastSavedBy_HR_Staff_RecID":"String","Description":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}