GET | /Queries/IN_Categories | Retrieves a list of inventory categories. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CategoryNo | query | int? | No | |
CategoryNoGreaterThanOrEqualTo | query | int? | No | |
CategoryNoGreaterThan | query | int? | No | |
CategoryNoLessThan | query | int? | No | |
CategoryNoLessThanOrEqualTo | query | int? | No | |
CategoryNoNotEqualTo | query | int? | No | |
CategoryNoBetween | query | int[] | No | |
CategoryNoIn | query | int[] | No | |
CategoryID | query | string | No | |
CategoryIDStartsWith | query | string | No | |
CategoryIDEndsWith | query | string | No | |
CategoryIDContains | query | string | No | |
CategoryIDLike | query | string | No | |
CategoryIDBetween | query | string[] | No | |
CategoryIDIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
DefaultCategory | query | bool? | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
Picture | query | byte[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CategoryNo | form | int | No | |
CategoryID | form | string | No | |
Description | form | string | No | |
DefaultCategory | form | bool | No | |
LastSavedDateTime | form | DateTime? | No | |
Picture | form | byte[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}