(Quick Reference)
54 Assign employees to item categories - Reference Documentation
Version: 2.1
54 Assign employees to item categories
54.1 List
Service: List
Description: This web service return the list of assigned employee item category in JSON format
URL:
http://BASE_URL/api/VERSION/employeeItemCategory
: 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 | |
| itemCategoryReference | Wildcard search by the resource's reference | String | no | itemCategoryReference=Ref-6* , itemCategoryReference=*ef-6 , itemCategoryReference=*ef-6* |
| employeeReference | Wildcard search by the employee's reference | String | no | employeeReference=Emp-6* , employeeReference=*mp-6 , employeeReference=*mp-6* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 2,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 159,
"employeeReference": "Emp-3",
"itemCategoryReference": "R-A-001",
"itemCategory": {
"id": 1751,
"reference": "R-A-001",
"name": "category1",
"href": "/api/v1.0/itemCategories/1751"
},
"employee": {
"id": 23,
"reference": "Emp-3",
"name": "new Employee",
"href": "/api/v1.0/employees/23"
},
"organization": "Lyon",
"dateCreated": "2016-08-23T11:23:27Z",
"lastUpdated": "2016-08-23T11:23:27Z"
},
{
"id": 156,
"employeeReference": "Emp-4",
"itemCategoryReference": "R-A-002",
"itemCategory": {
"id": 1752,
"reference": "R-A-002",
"name": "category2",
"href": "/api/v1.0/itemCategories/1752"
},
"employee": {
"id": 25,
"reference": "Emp-4",
"name": "Employee 4",
"href": "/api/v1.0/employees/25"
},
"organization": "Lyon",
"dateCreated": "2016-08-23T11:23:27Z",
"lastUpdated": "2016-08-23T11:23:27Z"
}
]
} 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..."
}54.2 Show
Service: Show an assigned customer to an employee
Description: This web service returns an assigned customer to an employee data in JSON format
Method: GET
URL:
https://BASE_URL/api/VERSION/employeeItemCategories/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the wanted record | Integer | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/employeeItemCategories/reference/{itemCategoryId}/{userId}:
| Name | Description | Type | Required | Examples values |
|---|
| itemCategoryId | reference of the item category | String | Yes | CC-002 |
| userId | reference of the user | String | Yes | U-001 |
Success Output
Success case: response.status=200
{
"id": 570,
"employeeReference": "Emp-3",
"itemCategoryReference": "R-A-001",
"itemCategory": {
"id": 1751,
"reference": "R-A-001",
"name": "category1",
"href": "/api/v1.0/itemCategories/1751"
},
"employee": {
"id": 23,
"reference": "Emp-3",
"name": "new Employee",
"href": "/api/v1.0/employees/23"
},
"organization": "Lyon",
"dateCreated": "2016-08-22T09:42:19Z",
"lastUpdated": "2016-08-22T09:42:19Z"
} 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 employee with the id 999 doesn't exist."
}54.3 Create
Service: Assign item group to employee
Description: This web service is used to assign an item group to an employee, the data created will be returned in JSON format
URL:
https://BASE_URL/api/VERSION/employeeItemCategories
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| userId | the id of the employee | Long/String | Yes | 777 |
| itemCategoryId | the id of the item category to assign | Long/String | Yes | |
| useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
The customer can only be assigned just one time
Success Output
Success case: response.status=201
{
"id": 570,
"employeeReference": "Emp-3",
"itemCategoryReference": "R-A-001",
"itemCategory": {
"id": 1751,
"reference": "R-A-001",
"name": "category1",
"href": "/api/v1.0/itemCategories/1751"
},
"employee": {
"id": 23,
"reference": "Emp-3",
"name": "new Employee",
"href": "/api/v1.0/employees/23"
},
"organization": "Lyon",
"dateCreated": "2016-08-22T09:42:19Z",
"lastUpdated": "2016-08-22T09:42:19Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "userId parameter is missing"
}"error": "already_assigned",
"error_description": "item group is already assigned to employee."{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error":"not_found",
"error_description": "The user with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}54.4 Update
Service: Assign an assigned item category to a new employee
Description: This web service is used to update an assigned item category to an employee to the database
Method: PUT
Request content type: application/json
URL:
https://BASE_URL/api/VERSION/employeeItemCategories/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record | Long | Yes | 111 |
| userId | the id of the employee | Long | Yes | 777 |
| customerId | the id of the customer to assign | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/employeeItemCategories/reference/{itemCategoryId}/{userId}:
| Name | Description | Type | Required | Examples values |
|---|
| itemCategoryId | reference of the item category | String | Yes | CC-002 |
| userId | reference of the user | String | Yes | U-001 |
Success Output
Success case: response.status=201
{
"id": 570,
"employeeReference": "Emp-3",
"itemCategoryReference": "R-A-001",
"itemCategory": {
"id": 1751,
"reference": "R-A-001",
"name": "category1",
"href": "/api/v1.0/itemCategories/1751"
},
"employee": {
"id": 23,
"reference": "Emp-3",
"name": "new Employee",
"href": "/api/v1.0/employees/23"
},
"organization": "Lyon",
"dateCreated": "2016-08-22T09:42:19Z",
"lastUpdated": "2016-08-22T09:42:19Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "userId parameter is missing"
}"error": "already_assigned",
"error_description": "item category is already assigned to employee."{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error":"not_found",
"error_description": "The user with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}54.5 Delete
Service: Dissociate an item category from an employee
Description: This web service is used in order to dissociate an item category from an employee, when success it will returns
Method: DELETE
URL:
https://BASE_URL/api/VERSION/employeeItemCategories/{id}:
| Name | Description | Type | Required | Examples values |
|---|
| id | Id of the desired record to delete | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/employeeItemCategories/reference/{itemCategoryId}/{userId}:
| Name | Description | Type | Required | Examples values |
|---|
| itemCategoryId | reference of the item category | String | Yes | CC-002 |
| userId | reference of the user | String | Yes | U-001 |
Success Output
Success case: response.status=200
{
"success": "true",
"success_description": "Instance deleted successfully"
} 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."
}{
"error": "delete_failed",
"error_description": "Failed to delete instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The item category employee with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
