| 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 | |
| SOLineID | query | string | No | |
| SOLineIDStartsWith | query | string | No | |
| SOLineIDEndsWith | query | string | No | |
| SOLineIDContains | query | string | No | |
| SOLineIDLike | query | string | No | |
| SOLineIDBetween | query | string[] | No | |
| SOLineIDIn | query | string[] | No | |
| InvoiceID | query | string | No | |
| InvoiceIDStartsWith | query | string | No | |
| InvoiceIDEndsWith | query | string | No | |
| InvoiceIDContains | query | string | No | |
| InvoiceIDLike | query | string | No | |
| InvoiceIDBetween | query | string[] | No | |
| InvoiceIDIn | query | string[] | No | |
| HistoryID | query | string | No | |
| HistoryIDStartsWith | query | string | No | |
| HistoryIDEndsWith | query | string | No | |
| HistoryIDContains | query | string | No | |
| HistoryIDLike | query | string | No | |
| HistoryIDBetween | query | string[] | No | |
| HistoryIDIn | query | string[] | No | |
| LineNum | query | short? | No | |
| LineNumGreaterThanOrEqualTo | query | short? | No | |
| LineNumGreaterThan | query | short? | No | |
| LineNumLessThan | query | short? | No | |
| LineNumLessThanOrEqualTo | query | short? | No | |
| LineNumNotEqualTo | query | short? | No | |
| LineNumBetween | query | short[] | No | |
| LineNumIn | query | short[] | No | |
| SerialNo | query | string | No | |
| SerialNoStartsWith | query | string | No | |
| SerialNoEndsWith | query | string | No | |
| SerialNoContains | query | string | No | |
| SerialNoLike | query | string | No | |
| SerialNoBetween | query | string[] | No | |
| SerialNoIn | query | string[] | No | |
| Quantity | query | decimal? | No | |
| QuantityGreaterThanOrEqualTo | query | decimal? | No | |
| QuantityGreaterThan | query | decimal? | No | |
| QuantityLessThan | query | decimal? | No | |
| QuantityLessThanOrEqualTo | query | decimal? | No | |
| QuantityNotEqualTo | query | decimal? | No | |
| QuantityBetween | query | Nullable<Decimal>[] | No | |
| QuantityIn | query | Nullable<Decimal>[] | 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 | |
| SOLineID | form | string | No | |
| InvoiceID | form | string | No | |
| HistoryID | form | string | No | |
| LineNum | form | short | No | |
| SerialNo | form | string | No | |
| Quantity | form | decimal? | 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_LineSerialsQuery 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"],"SOLineID":"String","SOLineIDStartsWith":"String","SOLineIDEndsWith":"String","SOLineIDContains":"String","SOLineIDLike":"String","SOLineIDBetween":["String"],"SOLineIDIn":["String"],"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"HistoryID":"String","HistoryIDStartsWith":"String","HistoryIDEndsWith":"String","HistoryIDContains":"String","HistoryIDLike":"String","HistoryIDBetween":["String"],"HistoryIDIn":["String"],"LineNum":0,"LineNumGreaterThanOrEqualTo":0,"LineNumGreaterThan":0,"LineNumLessThan":0,"LineNumLessThanOrEqualTo":0,"LineNumNotEqualTo":0,"LineNumBetween":[0],"LineNumIn":[0],"SerialNo":"String","SerialNoStartsWith":"String","SerialNoEndsWith":"String","SerialNoContains":"String","SerialNoLike":"String","SerialNoBetween":["String"],"SerialNoIn":["String"],"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"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","SOLineID":"String","InvoiceID":"String","HistoryID":"String","SerialNo":"String","Quantity":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}