| 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 | |
| RunID | query | string | No | |
| RunIDStartsWith | query | string | No | |
| RunIDEndsWith | query | string | No | |
| RunIDContains | query | string | No | |
| RunIDLike | query | string | No | |
| RunIDBetween | query | string[] | No | |
| RunIDIn | query | string[] | No | |
| SourceType | query | short? | No | |
| SourceTypeGreaterThanOrEqualTo | query | short? | No | |
| SourceTypeGreaterThan | query | short? | No | |
| SourceTypeLessThan | query | short? | No | |
| SourceTypeLessThanOrEqualTo | query | short? | No | |
| SourceTypeNotEqualTo | query | short? | No | |
| SourceTypeBetween | query | Nullable<Int16>[] | No | |
| SourceTypeIn | query | Nullable<Int16>[] | No | |
| SourceLineID | query | string | No | |
| SourceLineIDStartsWith | query | string | No | |
| SourceLineIDEndsWith | query | string | No | |
| SourceLineIDContains | query | string | No | |
| SourceLineIDLike | query | string | No | |
| SourceLineIDBetween | query | string[] | No | |
| SourceLineIDIn | 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 | |
| RunID | form | string | No | |
| SourceType | form | short? | No | |
| SourceLineID | 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/SO_BORunLinesQuery 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"],"RunID":"String","RunIDStartsWith":"String","RunIDEndsWith":"String","RunIDContains":"String","RunIDLike":"String","RunIDBetween":["String"],"RunIDIn":["String"],"SourceType":0,"SourceTypeGreaterThanOrEqualTo":0,"SourceTypeGreaterThan":0,"SourceTypeLessThan":0,"SourceTypeLessThanOrEqualTo":0,"SourceTypeNotEqualTo":0,"SourceTypeBetween":[0],"SourceTypeIn":[0],"SourceLineID":"String","SourceLineIDStartsWith":"String","SourceLineIDEndsWith":"String","SourceLineIDContains":"String","SourceLineIDLike":"String","SourceLineIDBetween":["String"],"SourceLineIDIn":["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","RunID":"String","SourceType":0,"SourceLineID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}