(Quick Reference)
Service: List of item categories
Description: This web service return the list of item categories with consideration to the specified organization in JSON format
URL:
https://BASE_URL/api/VERSION/itemCategories
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| offset | Tells where to start returning records from the entire set of results | Integer | No | |
| max | limits the number of resources requested to return | Integer | No | |
| sort | Orders the results by the specified field | String | No | |
| order | Orders ascending (ASC) or descending DESC | Integer | No | asc, desc |
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| reference | Wildcard search by the resource's reference | String | no | reference=Ref-6* , reference=*ef-6 , reference=*ef-6* |
| name | Wildcard search by the resource's name | String | no | |
| isRoot | Filters by root categories, and vice versa | boolean | no | true,false |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 2,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 255,
"name": "Item Category255",
"isRoot": true,
"isGoodiesCategory": false,
"isAsset": false,
"parentId": null,
"parentCategory": null,
"reference": "R100",
"description": null,
"image": null,
"organization": "Lyon",
"displayOrder": null,
"isActive" : true,
"dateCreated": "2016-08-18T08:21:05Z",
"lastUpdated": "2016-08-18T08:21:05Z"
},
{
"id": 256,
"name": "Item Category256",
"isRoot": true,
"isGoodiesCategory": false,
"isAsset": false,
"parentId": null,
"parentCategory": null,
"reference": "R200",
"description": null,
"image": null,
"organization": "Lyon",
"displayOrder": 6,
"isActive" : false,
"dateCreated": "2016-08-18T08:21:21Z",
"lastUpdated": "2016-08-18T08:21:21Z"
}
]
}To get resized images, add prefix
small_ or
medium_ to the link url before the image's name, for example:
<BASE_URL>/Lyon-1447055487659/photoItemCategory/medium_1471513158851_forfix.png
Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
