JiwaAPI

<back to all web services

IN_DescriptionQuery

Requires Authentication
IN_DescriptionQuery Parameters:
NameParameterData TypeRequiredDescription
DescriptionIDquerystringNo
DescriptionIDStartsWithquerystringNo
DescriptionIDEndsWithquerystringNo
DescriptionIDContainsquerystringNo
DescriptionIDLikequerystringNo
DescriptionIDBetweenquerystring[]No
DescriptionIDInquerystring[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
SY_Language_RecIDquerystringNo
SY_Language_RecIDStartsWithquerystringNo
SY_Language_RecIDEndsWithquerystringNo
SY_Language_RecIDContainsquerystringNo
SY_Language_RecIDLikequerystringNo
SY_Language_RecIDBetweenquerystring[]No
SY_Language_RecIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Description Parameters:
NameParameterData TypeRequiredDescription
DescriptionIDformstringNo
InventoryIDformstringNo
DescriptionformstringNo
SY_Language_RecIDformstringNo
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/IN_DescriptionQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DescriptionID":"String","DescriptionIDStartsWith":"String","DescriptionIDEndsWith":"String","DescriptionIDContains":"String","DescriptionIDLike":"String","DescriptionIDBetween":["String"],"DescriptionIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"SY_Language_RecID":"String","SY_Language_RecIDStartsWith":"String","SY_Language_RecIDEndsWith":"String","SY_Language_RecIDContains":"String","SY_Language_RecIDLike":"String","SY_Language_RecIDBetween":["String"],"SY_Language_RecIDIn":["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":[{"DescriptionID":"String","InventoryID":"String","Description":"String","SY_Language_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}