GET | /Queries/IN_Logical | Retrieves a list of logical warehouses. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IN_LogicalID | query | string | No | |
IN_LogicalIDStartsWith | query | string | No | |
IN_LogicalIDEndsWith | query | string | No | |
IN_LogicalIDContains | query | string | No | |
IN_LogicalIDLike | query | string | No | |
IN_LogicalIDBetween | query | string[] | No | |
IN_LogicalIDIn | query | string[] | No | |
IN_PhysicalID | query | string | No | |
IN_PhysicalIDStartsWith | query | string | No | |
IN_PhysicalIDEndsWith | query | string | No | |
IN_PhysicalIDContains | query | string | No | |
IN_PhysicalIDLike | query | string | No | |
IN_PhysicalIDBetween | query | string[] | No | |
IN_PhysicalIDIn | 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 | |
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 | |
LedgerMask | query | string | No | |
LedgerMaskStartsWith | query | string | No | |
LedgerMaskEndsWith | query | string | No | |
LedgerMaskContains | query | string | No | |
LedgerMaskLike | query | string | No | |
LedgerMaskBetween | query | string[] | No | |
LedgerMaskIn | query | string[] | No | |
WarehouseCode | query | string | No | |
WarehouseCodeStartsWith | query | string | No | |
WarehouseCodeEndsWith | query | string | No | |
WarehouseCodeContains | query | string | No | |
WarehouseCodeLike | query | string | No | |
WarehouseCodeBetween | query | string[] | No | |
WarehouseCodeIn | query | string[] | No | |
InTransit | query | bool? | No | |
DefaultInTransit | query | bool? | No | |
IN_Region_RecID | query | string | No | |
IN_Region_RecIDStartsWith | query | string | No | |
IN_Region_RecIDEndsWith | query | string | No | |
IN_Region_RecIDContains | query | string | No | |
IN_Region_RecIDLike | query | string | No | |
IN_Region_RecIDBetween | query | string[] | No | |
IN_Region_RecIDIn | query | string[] | 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 | |
Colour | query | int? | No | |
ColourGreaterThanOrEqualTo | query | int? | No | |
ColourGreaterThan | query | int? | No | |
ColourLessThan | query | int? | No | |
ColourLessThanOrEqualTo | query | int? | No | |
ColourNotEqualTo | query | int? | No | |
ColourBetween | query | Nullable<Int32>[] | No | |
ColourIn | query | Nullable<Int32>[] | 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 |
---|---|---|---|---|
IN_LogicalID | form | string | No | |
IN_PhysicalID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
Description | form | string | No | |
LedgerMask | form | string | No | |
WarehouseCode | form | string | No | |
InTransit | form | bool? | No | |
DefaultInTransit | form | bool? | No | |
IN_Region_RecID | form | string | No | |
ItemNo | form | int | No | |
RowHash | form | byte[] | No | |
Colour | 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.
GET /Queries/IN_Logical HTTP/1.1 Host: api.jiwa.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Results":[{"IN_LogicalID":"String","IN_PhysicalID":"String","Description":"String","LedgerMask":"String","WarehouseCode":"String","InTransit":false,"DefaultInTransit":false,"IN_Region_RecID":"String","RowHash":"AA==","Colour":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}