(Quick Reference)
Service: Show
Description: This web service return an existing employeeWarehouses record of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/employeeWarehouses/{id}
Method: GET
Parameters:
Name | Description | Type | Required | Example values |
---|
id | id of the desired object | Long | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 6,
"organization": "Lyon",
"warehouseReference": "Ref-01",
"employeeReference": "emp-006",
"employee": {
"id": 6,
"reference": "emp-006",
"href": "/api/v1/users/6"
},
"warehouse": {
"id": 1,
"reference": "Ref-01",
"name": "Main warehouse ",
"href": "/api/v1/warehouses/1"
},
"dateCreated": "2016-03-17T08:39:15Z",
"lastUpdated": "2016-03-17T08:39:15Z"
}
Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The warehouse employee with the id 999 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."
}