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 | |
RE_Lines_RecID | query | string | No | |
RE_Lines_RecIDStartsWith | query | string | No | |
RE_Lines_RecIDEndsWith | query | string | No | |
RE_Lines_RecIDContains | query | string | No | |
RE_Lines_RecIDLike | query | string | No | |
RE_Lines_RecIDBetween | query | string[] | No | |
RE_Lines_RecIDIn | query | string[] | No | |
LinkID | query | string | No | |
LinkIDStartsWith | query | string | No | |
LinkIDEndsWith | query | string | No | |
LinkIDContains | query | string | No | |
LinkIDLike | query | string | No | |
LinkIDBetween | query | string[] | No | |
LinkIDIn | 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 | decimal[] | No | |
QuantityIn | query | decimal[] | 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 | |
BinLocationDescription | query | string | No | |
BinLocationDescriptionStartsWith | query | string | No | |
BinLocationDescriptionEndsWith | query | string | No | |
BinLocationDescriptionContains | query | string | No | |
BinLocationDescriptionLike | query | string | No | |
BinLocationDescriptionBetween | query | string[] | No | |
BinLocationDescriptionIn | 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 | |
RowHash | query | byte[] | No | |
ExpiryDate | query | DateTime? | No | |
ExpiryDateGreaterThanOrEqualTo | query | DateTime? | No | |
ExpiryDateGreaterThan | query | DateTime? | No | |
ExpiryDateLessThan | query | DateTime? | No | |
ExpiryDateLessThanOrEqualTo | query | DateTime? | No | |
ExpiryDateNotEqualTo | query | DateTime? | No | |
ExpiryDateBetween | query | Nullable<DateTime>[] | No | |
ExpiryDateIn | query | Nullable<DateTime>[] | No | |
ItemNo | query | int? | No | |
ItemNoGreaterThanOrEqualTo | query | int? | No | |
ItemNoGreaterThan | query | int? | No | |
ItemNoLessThan | query | int? | No | |
ItemNoLessThanOrEqualTo | query | int? | No | |
ItemNoNotEqualTo | query | int? | No | |
ItemNoBetween | query | int[] | No | |
ItemNoIn | query | int[] | 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 | |
RE_Lines_RecID | form | string | No | |
LinkID | form | string | No | |
Quantity | form | decimal | No | |
SerialNo | form | string | No | |
BinLocationDescription | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
RowHash | form | byte[] | No | |
ExpiryDate | form | DateTime? | No | |
ItemNo | form | int | 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/RE_LineDetailsQuery 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"],"RE_Lines_RecID":"String","RE_Lines_RecIDStartsWith":"String","RE_Lines_RecIDEndsWith":"String","RE_Lines_RecIDContains":"String","RE_Lines_RecIDLike":"String","RE_Lines_RecIDBetween":["String"],"RE_Lines_RecIDIn":["String"],"LinkID":"String","LinkIDStartsWith":"String","LinkIDEndsWith":"String","LinkIDContains":"String","LinkIDLike":"String","LinkIDBetween":["String"],"LinkIDIn":["String"],"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"SerialNo":"String","SerialNoStartsWith":"String","SerialNoEndsWith":"String","SerialNoContains":"String","SerialNoLike":"String","SerialNoBetween":["String"],"SerialNoIn":["String"],"BinLocationDescription":"String","BinLocationDescriptionStartsWith":"String","BinLocationDescriptionEndsWith":"String","BinLocationDescriptionContains":"String","BinLocationDescriptionLike":"String","BinLocationDescriptionBetween":["String"],"BinLocationDescriptionIn":["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"],"RowHash":"AA==","ExpiryDate":"0001-01-01T00:00:00.0000000","ExpiryDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateGreaterThan":"0001-01-01T00:00:00.0000000","ExpiryDateLessThan":"0001-01-01T00:00:00.0000000","ExpiryDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateNotEqualTo":"0001-01-01T00:00:00.0000000","ExpiryDateBetween":["0001-01-01T00:00:00.0000000"],"ExpiryDateIn":["0001-01-01T00:00:00.0000000"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[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","RE_Lines_RecID":"String","LinkID":"String","SerialNo":"String","BinLocationDescription":"String","RowHash":"AA==","ExpiryDate":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}