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 | |
BM_WarehouseProductionArea_RecID | query | string | No | |
BM_WarehouseProductionArea_RecIDStartsWith | query | string | No | |
BM_WarehouseProductionArea_RecIDEndsWith | query | string | No | |
BM_WarehouseProductionArea_RecIDContains | query | string | No | |
BM_WarehouseProductionArea_RecIDLike | query | string | No | |
BM_WarehouseProductionArea_RecIDBetween | query | string[] | No | |
BM_WarehouseProductionArea_RecIDIn | query | string[] | No | |
BM_ProductionLine_RecID | query | string | No | |
BM_ProductionLine_RecIDStartsWith | query | string | No | |
BM_ProductionLine_RecIDEndsWith | query | string | No | |
BM_ProductionLine_RecIDContains | query | string | No | |
BM_ProductionLine_RecIDLike | query | string | No | |
BM_ProductionLine_RecIDBetween | query | string[] | No | |
BM_ProductionLine_RecIDIn | query | string[] | No | |
Name | query | string | No | |
NameStartsWith | query | string | No | |
NameEndsWith | query | string | No | |
NameContains | query | string | No | |
NameLike | query | string | No | |
NameBetween | query | string[] | No | |
NameIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
IsEnabled | query | bool? | 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 | |
RowHash | query | byte[] | 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 | |
BM_WarehouseProductionArea_RecID | form | string | No | |
BM_ProductionLine_RecID | form | string | No | |
Name | form | string | No | |
Description | form | string | No | |
IsEnabled | form | bool | No | |
ItemNo | form | int | No | |
RowHash | form | byte[] | 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/BM_WarehouseProductionLineQuery 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"],"BM_WarehouseProductionArea_RecID":"String","BM_WarehouseProductionArea_RecIDStartsWith":"String","BM_WarehouseProductionArea_RecIDEndsWith":"String","BM_WarehouseProductionArea_RecIDContains":"String","BM_WarehouseProductionArea_RecIDLike":"String","BM_WarehouseProductionArea_RecIDBetween":["String"],"BM_WarehouseProductionArea_RecIDIn":["String"],"BM_ProductionLine_RecID":"String","BM_ProductionLine_RecIDStartsWith":"String","BM_ProductionLine_RecIDEndsWith":"String","BM_ProductionLine_RecIDContains":"String","BM_ProductionLine_RecIDLike":"String","BM_ProductionLine_RecIDBetween":["String"],"BM_ProductionLine_RecIDIn":["String"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"IsEnabled":false,"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","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","BM_WarehouseProductionArea_RecID":"String","BM_ProductionLine_RecID":"String","Name":"String","Description":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}