(Quick Reference)
55 Assign employees to warehouses - Reference Documentation
Version: 2.1
55 Assign employees to warehouses
55.1 List
Service: List
Description: This web service return the list of employeeWarehouses data in JSON Format
URL:
https://BASE_URL/api/VERSION/employeeWarehouses
: 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 | |
| warehouseReference | Wildcard search by the resource's reference | String | no | warehouseReference=Ref-6* , warehouseReference=*ef-6 , warehouseReference=*ef-6* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 3,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"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"
},
{
"id": 10,
"organization": "Lyon",
"warehouseReference": "ref test WareHouse",
"employeeReference": "ref test Employee",
"employee": {
"id": 19,
"reference": "ref test Employee",
"href": "/api/v1/users/19"
},
"warehouse": {
"id": 18,
"reference": "ref test WareHouse",
"name": "test name",
"href": "/api/v1/warehouses/18"
},
"dateCreated": "2016-07-19T13:41:54Z",
"lastUpdated": "2016-07-19T13:41:54Z"
},
{
"id": 11,
"organization": "Lyon",
"warehouseReference": "ref test WareHouse",
"employeeReference": "ref test Employee",
"employee": {
"id": 20,
"reference": "ref test Employee",
"href": "/api/v1/users/20"
},
"warehouse": {
"id": 18,
"reference": "ref test WareHouse",
"name": "test name",
"href": "/api/v1/warehouses/18"
},
"dateCreated": "2016-07-19T13:41:54Z",
"lastUpdated": "2016-07-19T13:41:54Z"
}
]
} 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..."
}55.2 Show
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}: 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."
}
