JiwaAPI

<back to all web services

IN_CategoriesQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/IN_CategoriesRetrieves a list of inventory categories.
IN_CategoriesQuery Parameters:
NameParameterData TypeRequiredDescription
CategoryNoqueryint?No
CategoryNoGreaterThanOrEqualToqueryint?No
CategoryNoGreaterThanqueryint?No
CategoryNoLessThanqueryint?No
CategoryNoLessThanOrEqualToqueryint?No
CategoryNoNotEqualToqueryint?No
CategoryNoBetweenqueryint[]No
CategoryNoInqueryint[]No
CategoryIDquerystringNo
CategoryIDStartsWithquerystringNo
CategoryIDEndsWithquerystringNo
CategoryIDContainsquerystringNo
CategoryIDLikequerystringNo
CategoryIDBetweenquerystring[]No
CategoryIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
DefaultCategoryquerybool?No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
Picturequerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Categories Parameters:
NameParameterData TypeRequiredDescription
CategoryNoformintNo
CategoryIDformstringNo
DescriptionformstringNo
DefaultCategoryformboolNo
LastSavedDateTimeformDateTime?No
Pictureformbyte[]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 .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.

GET /Queries/IN_Categories HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"CategoryID":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Picture":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}