Get aptitudes by service
This endpoint returns the aptitudes of all employees in the specified service.
GET /api/v1/businesses/{businessId}/services/{serviceId}/aptitudesIf the provided data —both businessId and serviceId— is correct, the response will contain aptitudes for each employee across all products within the service where they have any defined aptitude. The following information will be detailed:
-
employeeId: external identifier of the employee.
-
aptitudes: list of aptitudes for the employee within the service.
-
productId: external identifier of the product or section where the employee has defined aptitudes.
-
aptitudes: list of aptitudes for the employee within the product or section.
-
locationId: external identifier of the task to which the aptitude refers.
-
level: level of competency in the task, ranging from 0 (not competent) to 3 (expert).
-
-
Here is a sample response:
[
{
"employeeId": "000",
"aptitudes": [
{
"productId": "0001-G",
"aptitudes": [
{
"locationId": "02",
"level": 2
},
{
"locationId": "01",
"level": 2
},
{
"locationId": "03",
"level": 3
},
{
"locationId": "05",
"level": 3
},
{
"locationId": "06",
"level": 2
}
]
}
]
},
{
"employeeId": "001",
"aptitudes": [
{
"productId": "0001-G",
"aptitudes": [
{
"locationId": "02",
"level": 3
},
{
"locationId": "01",
"level": 2
}
]
},
{
"productId": "008",
"aptitudes": [
{
"locationId": "06",
"level": 3
}
]
}
]
}
]As shown in the example, if an employee has aptitudes across multiple products within the service, all of them will appear in the list.
Considerations
The data of employees who DO NOT have an external identifier set in the system will not be included in the response.
If no aptitudes are defined for the employees in the specified service, the request will return an empty array [].
If the service specified in the URL does not exist in the business, the request will return a 404 Not Found error, specifying not exists in the message.