This WS is designed to search employees by legal_entity_id.
- Search employees by filters in ws url:
- required filters
- legal_entity_id (MSP id),
- optional filters:
- status (employees status ACTIVE, INACTIVE). By default used ACTIVE
- type (employees type DOCTOR, HR, ACCOUNTANT). By default returned all types of employees.
- limit (limit response size - quantity of employee objects). By default returned 50 objects.
- starting_after (cursor to fetch next page)
- ending_before (cursor to fetch previous page)
- required filters
- If according to filters employees are not found, WS returns empty data array.
WS returns shortened details, which consist of employee and party objects, pagination data - for tecnical info.
Response mapping
| response parameters | source |
|---|---|
| $.data[:].id | DB table: employee column: id |
| $.data[:].position | DB table: employee column: position |
| $.data[:].employee_type | DB table: employee column: employee_type |
| $.data[:].active | DB table: employee column: active |
| $.data[:].start_date | DB table: employee column: start_date |
| $.data[:].end_date | DB table: employee column: end_date |
| $.data[:].party.id | DB table: party column: id |
| $.data[:].party.first_name | DB table: party column: first_name |
| $.data[:].party.last_name | DB table: party column: last_name |
| $.data[:].party.second_name | DB table: party column: second_name |
...