JiwaAPI

<back to all web services

v_JIWA_DefaultOrderLocationsQuery

Requires Authentication
v_JIWA_DefaultOrderLocationsQuery 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
LogicalWarehouseDesciptionquerystringNo
LogicalWarehouseDesciptionStartsWithquerystringNo
LogicalWarehouseDesciptionEndsWithquerystringNo
LogicalWarehouseDesciptionContainsquerystringNo
LogicalWarehouseDesciptionLikequerystringNo
LogicalWarehouseDesciptionBetweenquerystring[]No
LogicalWarehouseDesciptionInquerystring[]No
PhysicalWarehouseDesciptionquerystringNo
PhysicalWarehouseDesciptionStartsWithquerystringNo
PhysicalWarehouseDesciptionEndsWithquerystringNo
PhysicalWarehouseDesciptionContainsquerystringNo
PhysicalWarehouseDesciptionLikequerystringNo
PhysicalWarehouseDesciptionBetweenquerystring[]No
PhysicalWarehouseDesciptionInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_JIWA_DefaultOrderLocations Parameters:
NameParameterData TypeRequiredDescription
IN_LogicalIDformstringNo
IN_PhysicalIDformstringNo
LogicalWarehouseDesciptionformstringNo
PhysicalWarehouseDesciptionformstringNo
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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/v_JIWA_DefaultOrderLocationsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["String"],"IN_PhysicalID":"String","IN_PhysicalIDStartsWith":"String","IN_PhysicalIDEndsWith":"String","IN_PhysicalIDContains":"String","IN_PhysicalIDLike":"String","IN_PhysicalIDBetween":["String"],"IN_PhysicalIDIn":["String"],"LogicalWarehouseDesciption":"String","LogicalWarehouseDesciptionStartsWith":"String","LogicalWarehouseDesciptionEndsWith":"String","LogicalWarehouseDesciptionContains":"String","LogicalWarehouseDesciptionLike":"String","LogicalWarehouseDesciptionBetween":["String"],"LogicalWarehouseDesciptionIn":["String"],"PhysicalWarehouseDesciption":"String","PhysicalWarehouseDesciptionStartsWith":"String","PhysicalWarehouseDesciptionEndsWith":"String","PhysicalWarehouseDesciptionContains":"String","PhysicalWarehouseDesciptionLike":"String","PhysicalWarehouseDesciptionBetween":["String"],"PhysicalWarehouseDesciptionIn":["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":[{"IN_LogicalID":"String","IN_PhysicalID":"String","LogicalWarehouseDesciption":"String","PhysicalWarehouseDesciption":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}