(Quick Reference)
Service: Show an item category translation
Description: Returns the requested item category translation in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/itemCategoryTranslations/{id}
Method: GET
Parameters:
Name | Description | Type | Required | Example values |
---|
id | The numerical ID of the desired translation | Long | yes | 123 |
Success Output
Success case: response.status=200
{
"id": 519,
"itemCategoryReference": "R100",
"itemCategory": {
"id": 1,
"reference": "R100",
"href": "/valomniav2/api/v2.1/itemCategories/1"
},
"name": "new Cate",
"description": "",
"language": {
"id": 3,
"code": "en"
},
"organization": "entity1",
"dateCreated": "2015-12-16T16:38:44Z",
"lastUpdated": "2015-12-16T16:38:44Z"
}
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 item category translation with the id 7065 doesn't exist."
}