(Quick Reference)
Service: Show
Description: This web service return a customer category details of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/customerCategories/{id}:
https://BASE_URL/api/VERSION/customerCategories/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the wanted customer category | Long/String | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 2,
"name": "Home",
"isRoot": true,
"parentId": null,
"parentCategory": null,
"reference": "Ref-01",
"description": "Home",
"image": "BASE_URL/Nice-1444810602520/photoCustomerCategory/1455207900621_users_crowd.png",
"organization": "Lyon",
"dateCreated": "2015-10-13T10:12:40Z",
"lastUpdated": "2016-02-11T16:25:00Z"
}To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:
<BASE_URL>/Nice-1444810602520/photoCustomerCategory/small_1455207868614_users_crowd.png
Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The customer category with the id 999 doesn't exist."
}
