JiwaAPI

<back to all web services

IN_LogicalQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/IN_LogicalRetrieves a list of logical warehouses.
IN_LogicalQuery Parameters:
NameParameterData TypeRequiredDescription
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
IN_PhysicalIDquerystringNo
IN_PhysicalIDStartsWithquerystringNo
IN_PhysicalIDEndsWithquerystringNo
IN_PhysicalIDContainsquerystringNo
IN_PhysicalIDLikequerystringNo
IN_PhysicalIDBetweenquerystring[]No
IN_PhysicalIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
LedgerMaskquerystringNo
LedgerMaskStartsWithquerystringNo
LedgerMaskEndsWithquerystringNo
LedgerMaskContainsquerystringNo
LedgerMaskLikequerystringNo
LedgerMaskBetweenquerystring[]No
LedgerMaskInquerystring[]No
WarehouseCodequerystringNo
WarehouseCodeStartsWithquerystringNo
WarehouseCodeEndsWithquerystringNo
WarehouseCodeContainsquerystringNo
WarehouseCodeLikequerystringNo
WarehouseCodeBetweenquerystring[]No
WarehouseCodeInquerystring[]No
InTransitquerybool?No
DefaultInTransitquerybool?No
IN_Region_RecIDquerystringNo
IN_Region_RecIDStartsWithquerystringNo
IN_Region_RecIDEndsWithquerystringNo
IN_Region_RecIDContainsquerystringNo
IN_Region_RecIDLikequerystringNo
IN_Region_RecIDBetweenquerystring[]No
IN_Region_RecIDInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
Colourqueryint?No
ColourGreaterThanOrEqualToqueryint?No
ColourGreaterThanqueryint?No
ColourLessThanqueryint?No
ColourLessThanOrEqualToqueryint?No
ColourNotEqualToqueryint?No
ColourBetweenqueryNullable<Int32>[]No
ColourInqueryNullable<Int32>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Logical Parameters:
NameParameterData TypeRequiredDescription
IN_LogicalIDformstringNo
IN_PhysicalIDformstringNo
LastSavedDateTimeformDateTimeNo
DescriptionformstringNo
LedgerMaskformstringNo
WarehouseCodeformstringNo
InTransitformbool?No
DefaultInTransitformbool?No
IN_Region_RecIDformstringNo
ItemNoformintNo
RowHashformbyte[]No
Colourformint?No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}