JiwaAPI

<back to all web services

v_InventoryQuery

Requires Authentication
v_InventoryQuery Parameters:
NameParameterData TypeRequiredDescription
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
PartNoAndDescriptionquerystringNo
PartNoAndDescriptionStartsWithquerystringNo
PartNoAndDescriptionEndsWithquerystringNo
PartNoAndDescriptionContainsquerystringNo
PartNoAndDescriptionLikequerystringNo
PartNoAndDescriptionBetweenquerystring[]No
PartNoAndDescriptionInquerystring[]No
Category1IDquerystringNo
Category1IDStartsWithquerystringNo
Category1IDEndsWithquerystringNo
Category1IDContainsquerystringNo
Category1IDLikequerystringNo
Category1IDBetweenquerystring[]No
Category1IDInquerystring[]No
Category2IDquerystringNo
Category2IDStartsWithquerystringNo
Category2IDEndsWithquerystringNo
Category2IDContainsquerystringNo
Category2IDLikequerystringNo
Category2IDBetweenquerystring[]No
Category2IDInquerystring[]No
Category3IDquerystringNo
Category3IDStartsWithquerystringNo
Category3IDEndsWithquerystringNo
Category3IDContainsquerystringNo
Category3IDLikequerystringNo
Category3IDBetweenquerystring[]No
Category3IDInquerystring[]No
Category4IDquerystringNo
Category4IDStartsWithquerystringNo
Category4IDEndsWithquerystringNo
Category4IDContainsquerystringNo
Category4IDLikequerystringNo
Category4IDBetweenquerystring[]No
Category4IDInquerystring[]No
Category5IDquerystringNo
Category5IDStartsWithquerystringNo
Category5IDEndsWithquerystringNo
Category5IDContainsquerystringNo
Category5IDLikequerystringNo
Category5IDBetweenquerystring[]No
Category5IDInquerystring[]No
ClassificationIDquerystringNo
ClassificationIDStartsWithquerystringNo
ClassificationIDEndsWithquerystringNo
ClassificationIDContainsquerystringNo
ClassificationIDLikequerystringNo
ClassificationIDBetweenquerystring[]No
ClassificationIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_Inventory Parameters:
NameParameterData TypeRequiredDescription
InventoryIDformstringNo
PartNoformstringNo
DescriptionformstringNo
PartNoAndDescriptionformstringNo
Category1IDformstringNo
Category2IDformstringNo
Category3IDformstringNo
Category4IDformstringNo
Category5IDformstringNo
ClassificationIDformstringNo
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.

POST /json/reply/v_InventoryQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"PartNoAndDescription":"String","PartNoAndDescriptionStartsWith":"String","PartNoAndDescriptionEndsWith":"String","PartNoAndDescriptionContains":"String","PartNoAndDescriptionLike":"String","PartNoAndDescriptionBetween":["String"],"PartNoAndDescriptionIn":["String"],"Category1ID":"String","Category1IDStartsWith":"String","Category1IDEndsWith":"String","Category1IDContains":"String","Category1IDLike":"String","Category1IDBetween":["String"],"Category1IDIn":["String"],"Category2ID":"String","Category2IDStartsWith":"String","Category2IDEndsWith":"String","Category2IDContains":"String","Category2IDLike":"String","Category2IDBetween":["String"],"Category2IDIn":["String"],"Category3ID":"String","Category3IDStartsWith":"String","Category3IDEndsWith":"String","Category3IDContains":"String","Category3IDLike":"String","Category3IDBetween":["String"],"Category3IDIn":["String"],"Category4ID":"String","Category4IDStartsWith":"String","Category4IDEndsWith":"String","Category4IDContains":"String","Category4IDLike":"String","Category4IDBetween":["String"],"Category4IDIn":["String"],"Category5ID":"String","Category5IDStartsWith":"String","Category5IDEndsWith":"String","Category5IDContains":"String","Category5IDLike":"String","Category5IDBetween":["String"],"Category5IDIn":["String"],"ClassificationID":"String","ClassificationIDStartsWith":"String","ClassificationIDEndsWith":"String","ClassificationIDContains":"String","ClassificationIDLike":"String","ClassificationIDBetween":["String"],"ClassificationIDIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"InventoryID":"String","PartNo":"String","Description":"String","PartNoAndDescription":"String","Category1ID":"String","Category2ID":"String","Category3ID":"String","Category4ID":"String","Category5ID":"String","ClassificationID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}