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 | |
ItemNo | query | short? | No | |
ItemNoGreaterThanOrEqualTo | query | short? | No | |
ItemNoGreaterThan | query | short? | No | |
ItemNoLessThan | query | short? | No | |
ItemNoLessThanOrEqualTo | query | short? | No | |
ItemNoNotEqualTo | query | short? | No | |
ItemNoBetween | query | short[] | No | |
ItemNoIn | query | short[] | No | |
RA_ShipMain_RecID | query | string | No | |
RA_ShipMain_RecIDStartsWith | query | string | No | |
RA_ShipMain_RecIDEndsWith | query | string | No | |
RA_ShipMain_RecIDContains | query | string | No | |
RA_ShipMain_RecIDLike | query | string | No | |
RA_ShipMain_RecIDBetween | query | string[] | No | |
RA_ShipMain_RecIDIn | 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 | |
InventoryID | query | string | No | |
InventoryIDStartsWith | query | string | No | |
InventoryIDEndsWith | query | string | No | |
InventoryIDContains | query | string | No | |
InventoryIDLike | query | string | No | |
InventoryIDBetween | query | string[] | No | |
InventoryIDIn | query | string[] | No | |
RA_ReturnCodes_RecID | query | string | No | |
RA_ReturnCodes_RecIDStartsWith | query | string | No | |
RA_ReturnCodes_RecIDEndsWith | query | string | No | |
RA_ReturnCodes_RecIDContains | query | string | No | |
RA_ReturnCodes_RecIDLike | query | string | No | |
RA_ReturnCodes_RecIDBetween | query | string[] | No | |
RA_ReturnCodes_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 | |
Remark | query | string | No | |
RemarkStartsWith | query | string | No | |
RemarkEndsWith | query | string | No | |
RemarkContains | query | string | No | |
RemarkLike | query | string | No | |
RemarkBetween | query | string[] | No | |
RemarkIn | query | string[] | No | |
UnitReturnValue | query | decimal? | No | |
UnitReturnValueGreaterThanOrEqualTo | query | decimal? | No | |
UnitReturnValueGreaterThan | query | decimal? | No | |
UnitReturnValueLessThan | query | decimal? | No | |
UnitReturnValueLessThanOrEqualTo | query | decimal? | No | |
UnitReturnValueNotEqualTo | query | decimal? | No | |
UnitReturnValueBetween | query | decimal[] | No | |
UnitReturnValueIn | query | decimal[] | No | |
TotalReturnValue | query | decimal? | No | |
TotalReturnValueGreaterThanOrEqualTo | query | decimal? | No | |
TotalReturnValueGreaterThan | query | decimal? | No | |
TotalReturnValueLessThan | query | decimal? | No | |
TotalReturnValueLessThanOrEqualTo | query | decimal? | No | |
TotalReturnValueNotEqualTo | query | decimal? | No | |
TotalReturnValueBetween | query | decimal[] | No | |
TotalReturnValueIn | query | decimal[] | No | |
RA_RequestLines_RecID | query | string | No | |
RA_RequestLines_RecIDStartsWith | query | string | No | |
RA_RequestLines_RecIDEndsWith | query | string | No | |
RA_RequestLines_RecIDContains | query | string | No | |
RA_RequestLines_RecIDLike | query | string | No | |
RA_RequestLines_RecIDBetween | query | string[] | No | |
RA_RequestLines_RecIDIn | query | string[] | No | |
TaxID | query | string | No | |
TaxIDStartsWith | query | string | No | |
TaxIDEndsWith | query | string | No | |
TaxIDContains | query | string | No | |
TaxIDLike | query | string | No | |
TaxIDBetween | query | string[] | No | |
TaxIDIn | query | string[] | No | |
TaxAmount | query | decimal? | No | |
TaxAmountGreaterThanOrEqualTo | query | decimal? | No | |
TaxAmountGreaterThan | query | decimal? | No | |
TaxAmountLessThan | query | decimal? | No | |
TaxAmountLessThanOrEqualTo | query | decimal? | No | |
TaxAmountNotEqualTo | query | decimal? | No | |
TaxAmountBetween | query | decimal[] | No | |
TaxAmountIn | query | decimal[] | No | |
RowHash | query | byte[] | No | |
FXUnitReturnValue | query | decimal? | No | |
FXUnitReturnValueGreaterThanOrEqualTo | query | decimal? | No | |
FXUnitReturnValueGreaterThan | query | decimal? | No | |
FXUnitReturnValueLessThan | query | decimal? | No | |
FXUnitReturnValueLessThanOrEqualTo | query | decimal? | No | |
FXUnitReturnValueNotEqualTo | query | decimal? | No | |
FXUnitReturnValueBetween | query | decimal[] | No | |
FXUnitReturnValueIn | query | decimal[] | No | |
FXTotalReturnValue | query | decimal? | No | |
FXTotalReturnValueGreaterThanOrEqualTo | query | decimal? | No | |
FXTotalReturnValueGreaterThan | query | decimal? | No | |
FXTotalReturnValueLessThan | query | decimal? | No | |
FXTotalReturnValueLessThanOrEqualTo | query | decimal? | No | |
FXTotalReturnValueNotEqualTo | query | decimal? | No | |
FXTotalReturnValueBetween | query | decimal[] | No | |
FXTotalReturnValueIn | query | decimal[] | No | |
FXRate | query | decimal? | No | |
FXRateGreaterThanOrEqualTo | query | decimal? | No | |
FXRateGreaterThan | query | decimal? | No | |
FXRateLessThan | query | decimal? | No | |
FXRateLessThanOrEqualTo | query | decimal? | No | |
FXRateNotEqualTo | query | decimal? | No | |
FXRateBetween | query | decimal[] | No | |
FXRateIn | query | decimal[] | No | |
PO_Lines_OrderLineID | query | string | No | |
PO_Lines_OrderLineIDStartsWith | query | string | No | |
PO_Lines_OrderLineIDEndsWith | query | string | No | |
PO_Lines_OrderLineIDContains | query | string | No | |
PO_Lines_OrderLineIDLike | query | string | No | |
PO_Lines_OrderLineIDBetween | query | string[] | No | |
PO_Lines_OrderLineIDIn | 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 | |
ItemNo | form | short | No | |
RA_ShipMain_RecID | form | string | No | |
Quantity | form | decimal | No | |
InventoryID | form | string | No | |
RA_ReturnCodes_RecID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
Remark | form | string | No | |
UnitReturnValue | form | decimal | No | |
TotalReturnValue | form | decimal | No | |
RA_RequestLines_RecID | form | string | No | |
TaxID | form | string | No | |
TaxAmount | form | decimal | No | |
RowHash | form | byte[] | No | |
FXUnitReturnValue | form | decimal | No | |
FXTotalReturnValue | form | decimal | No | |
FXRate | form | decimal | No | |
PO_Lines_OrderLineID | 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/RA_ShipLinesQuery 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"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RA_ShipMain_RecID":"String","RA_ShipMain_RecIDStartsWith":"String","RA_ShipMain_RecIDEndsWith":"String","RA_ShipMain_RecIDContains":"String","RA_ShipMain_RecIDLike":"String","RA_ShipMain_RecIDBetween":["String"],"RA_ShipMain_RecIDIn":["String"],"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"RA_ReturnCodes_RecID":"String","RA_ReturnCodes_RecIDStartsWith":"String","RA_ReturnCodes_RecIDEndsWith":"String","RA_ReturnCodes_RecIDContains":"String","RA_ReturnCodes_RecIDLike":"String","RA_ReturnCodes_RecIDBetween":["String"],"RA_ReturnCodes_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"],"Remark":"String","RemarkStartsWith":"String","RemarkEndsWith":"String","RemarkContains":"String","RemarkLike":"String","RemarkBetween":["String"],"RemarkIn":["String"],"UnitReturnValue":0,"UnitReturnValueGreaterThanOrEqualTo":0,"UnitReturnValueGreaterThan":0,"UnitReturnValueLessThan":0,"UnitReturnValueLessThanOrEqualTo":0,"UnitReturnValueNotEqualTo":0,"UnitReturnValueBetween":[0],"UnitReturnValueIn":[0],"TotalReturnValue":0,"TotalReturnValueGreaterThanOrEqualTo":0,"TotalReturnValueGreaterThan":0,"TotalReturnValueLessThan":0,"TotalReturnValueLessThanOrEqualTo":0,"TotalReturnValueNotEqualTo":0,"TotalReturnValueBetween":[0],"TotalReturnValueIn":[0],"RA_RequestLines_RecID":"String","RA_RequestLines_RecIDStartsWith":"String","RA_RequestLines_RecIDEndsWith":"String","RA_RequestLines_RecIDContains":"String","RA_RequestLines_RecIDLike":"String","RA_RequestLines_RecIDBetween":["String"],"RA_RequestLines_RecIDIn":["String"],"TaxID":"String","TaxIDStartsWith":"String","TaxIDEndsWith":"String","TaxIDContains":"String","TaxIDLike":"String","TaxIDBetween":["String"],"TaxIDIn":["String"],"TaxAmount":0,"TaxAmountGreaterThanOrEqualTo":0,"TaxAmountGreaterThan":0,"TaxAmountLessThan":0,"TaxAmountLessThanOrEqualTo":0,"TaxAmountNotEqualTo":0,"TaxAmountBetween":[0],"TaxAmountIn":[0],"RowHash":"AA==","FXUnitReturnValue":0,"FXUnitReturnValueGreaterThanOrEqualTo":0,"FXUnitReturnValueGreaterThan":0,"FXUnitReturnValueLessThan":0,"FXUnitReturnValueLessThanOrEqualTo":0,"FXUnitReturnValueNotEqualTo":0,"FXUnitReturnValueBetween":[0],"FXUnitReturnValueIn":[0],"FXTotalReturnValue":0,"FXTotalReturnValueGreaterThanOrEqualTo":0,"FXTotalReturnValueGreaterThan":0,"FXTotalReturnValueLessThan":0,"FXTotalReturnValueLessThanOrEqualTo":0,"FXTotalReturnValueNotEqualTo":0,"FXTotalReturnValueBetween":[0],"FXTotalReturnValueIn":[0],"FXRate":0,"FXRateGreaterThanOrEqualTo":0,"FXRateGreaterThan":0,"FXRateLessThan":0,"FXRateLessThanOrEqualTo":0,"FXRateNotEqualTo":0,"FXRateBetween":[0],"FXRateIn":[0],"PO_Lines_OrderLineID":"String","PO_Lines_OrderLineIDStartsWith":"String","PO_Lines_OrderLineIDEndsWith":"String","PO_Lines_OrderLineIDContains":"String","PO_Lines_OrderLineIDLike":"String","PO_Lines_OrderLineIDBetween":["String"],"PO_Lines_OrderLineIDIn":["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","RA_ShipMain_RecID":"String","InventoryID":"String","RA_ReturnCodes_RecID":"String","Remark":"String","RA_RequestLines_RecID":"String","TaxID":"String","RowHash":"AA==","PO_Lines_OrderLineID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}