Get aptitudes by employee
This endpoint returns all aptitudes for an employee.
GET /api/v1/businesses/{businessId}/people/{employeeId}/aptitudes
If the provided data —both businessId and employeeId— is correct, the response will contain the aptitudes for the employee across all products where they have any defined aptitude. The following information will be detailed:
-
productId: external identifier of the product or section where the employee has defined aptitudes.
-
aptitudes: list of aptitudes.
-
locationId: external identifier of the task to which the aptitude refers.
-
level: level of competency for the task, ranging from 0 (not competent) to 3 (expert).
-
zone: external identifier of the zone.
-
Here is an example of a response:
[
{
"productId": "0001",
"aptitudes": [
{
"locationId": "02",
"level": 1,
"zone": "General"
}
]
},
{
"productId": "0002",
"aptitudes": [
{
"locationId": "01",
"level": 3,
"zone": "General"
},
{
"locationId": "01",
"level": 0,
"zone": "P1"
},
{
"locationId": "01",
"level": 3,
"zone": "P2"
}
]
}
]
As shown in the example, if an employee has aptitudes in several products, all of them will appear in the list.
Considerations
If a product has multiple zones, the response will contain the competency level for each. If the aptitude has been disabled for any of the zones, "level": 0
will appear for that zone.
If the employee ID does not exist in the business, the request will return a 404 Not Found
error, specifying Person not found in the message.
If no aptitudes are defined for the employee, the request will return an empty array []
.