| 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 | |
| SplitFromSOHID | query | string | No | |
| SplitFromSOHIDStartsWith | query | string | No | |
| SplitFromSOHIDEndsWith | query | string | No | |
| SplitFromSOHIDContains | query | string | No | |
| SplitFromSOHIDLike | query | string | No | |
| SplitFromSOHIDBetween | query | string[] | No | |
| SplitFromSOHIDIn | query | string[] | No | |
| SplitToSOHID | query | string | No | |
| SplitToSOHIDStartsWith | query | string | No | |
| SplitToSOHIDEndsWith | query | string | No | |
| SplitToSOHIDContains | query | string | No | |
| SplitToSOHIDLike | query | string | No | |
| SplitToSOHIDBetween | query | string[] | No | |
| SplitToSOHIDIn | query | string[] | No | |
| QuantitySplit | query | decimal? | No | |
| QuantitySplitGreaterThanOrEqualTo | query | decimal? | No | |
| QuantitySplitGreaterThan | query | decimal? | No | |
| QuantitySplitLessThan | query | decimal? | No | |
| QuantitySplitLessThanOrEqualTo | query | decimal? | No | |
| QuantitySplitNotEqualTo | query | decimal? | No | |
| QuantitySplitBetween | query | decimal[] | No | |
| QuantitySplitIn | query | decimal[] | No | |
| StaffID | query | string | No | |
| StaffIDStartsWith | query | string | No | |
| StaffIDEndsWith | query | string | No | |
| StaffIDContains | query | string | No | |
| StaffIDLike | query | string | No | |
| StaffIDBetween | query | string[] | No | |
| StaffIDIn | query | string[] | No | |
| SplitDateTime | query | DateTime? | No | |
| SplitDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| SplitDateTimeGreaterThan | query | DateTime? | No | |
| SplitDateTimeLessThan | query | DateTime? | No | |
| SplitDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| SplitDateTimeNotEqualTo | query | DateTime? | No | |
| SplitDateTimeBetween | query | DateTime[] | No | |
| SplitDateTimeIn | query | DateTime[] | 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 | |
| SplitFromSOHID | form | string | No | |
| SplitToSOHID | form | string | No | |
| QuantitySplit | form | decimal | No | |
| StaffID | form | string | No | |
| SplitDateTime | form | DateTime | 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/IN_SOHManualSplitAuditQuery 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"],"SplitFromSOHID":"String","SplitFromSOHIDStartsWith":"String","SplitFromSOHIDEndsWith":"String","SplitFromSOHIDContains":"String","SplitFromSOHIDLike":"String","SplitFromSOHIDBetween":["String"],"SplitFromSOHIDIn":["String"],"SplitToSOHID":"String","SplitToSOHIDStartsWith":"String","SplitToSOHIDEndsWith":"String","SplitToSOHIDContains":"String","SplitToSOHIDLike":"String","SplitToSOHIDBetween":["String"],"SplitToSOHIDIn":["String"],"QuantitySplit":0,"QuantitySplitGreaterThanOrEqualTo":0,"QuantitySplitGreaterThan":0,"QuantitySplitLessThan":0,"QuantitySplitLessThanOrEqualTo":0,"QuantitySplitNotEqualTo":0,"QuantitySplitBetween":[0],"QuantitySplitIn":[0],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"SplitDateTime":"0001-01-01T00:00:00.0000000","SplitDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","SplitDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","SplitDateTimeLessThan":"0001-01-01T00:00:00.0000000","SplitDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","SplitDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","SplitDateTimeBetween":["0001-01-01T00:00:00.0000000"],"SplitDateTimeIn":["0001-01-01T00:00:00.0000000"],"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","SplitFromSOHID":"String","SplitToSOHID":"String","StaffID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}