(Quick Reference)
Service: Show an item category
Description: This web service return an existing item category details of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/itemCategories/{id}:
https://BASE_URL/api/VERSION/itemCategories/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the wanted item category | Long/String | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 255,
"name": "Brigui",
"isRoot": true,
"isGoodiesCategory": false,
"isAsset": false,
"parentId": null,
"parentCategory": null,
"reference": "R100",
"description": null,
"image": null,
"organization": "Lyon",
"displayOrder": 6,
"isActive" : true,
"dateCreated": "2016-08-18T08:21:05Z",
"lastUpdated": "2016-08-18T08:21:05Z"
}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 = 404
{
"error": "not_found",
"error_description": "The item category with the id 3 doesn't exist."
} Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}
