(Quick Reference)
Service: Show a group of employee
Description: This web service return an existing group of employee in JSON format
URL:
https://BASE_URL/api/VERSION/employeeGroups/{id}
URL with external_id:
https://BASE_URL/api/VERSION/employeeGroups/reference/{id}
Method: GET
Parameters:
Name | Description | Type | Required | Example values |
---|
id | id of the wanted group | Long/String | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 2,
"name": "Groupe 2",
"reference": "REF-02",
"organization": "Lyon",
"description": null,
"dateCreated": "2015-11-16T13:28:47Z",
"lastUpdated": "2015-11-16T13:28:47Z"
}
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 employee group with the id 999 doesn't exist."
}