Get person limitations
This endpoint returns the limitations set for an employee to perform specific tasks.
GET /api/v1/business/{businessId}/employees/{employeeId}/locationLimitations/from/{yyyy-MM-dd}/to/{yyyy-MM-dd}The following parameters must be specified in the request URL:
-
External identifier of the business (businessId).
-
External identifier of the employee (employeeId).
-
Interval for which the query is made (from/to) in
yyyy-MM-ddformat.
If the data included in the URL is correct, the response will contain the limitations set for the employee within the requested interval.
Below is an example:
GET /api/v1/business/BUSINESSID/employees/EMPLOYEEID/locationLimitations/from/2025-09-29/to/2025-10-30{
"lag": 0,
"locationLimitations": [
{
"id": "1810",
"product": "0001-GENERAL",
"from": "2025-09-30",
"zone": "General",
"location": "01"
},
{
"id": "1019",
"product": "0001-GENERAL",
"from": "2025-10-15",
"to": "2025-10-25",
"zone": "General",
"location": "02"
}
]
}As shown in the example, the request returns the previously defined limitations set for the employee.
Considerations
If the employee specified in the URL does not exist in the business, the request will return a 404 Not Found error, with the message Employee not found.
If no limitations are defined for the employee in the given time interval, the request will return an empty array: "locationLimitations": [].
|
To visualize the limitations in the interface, the employee must already have the aptitude defined for that task. |