ЕСОЗ - публічна документація
Get Employee details (Private)
- Georgiy Lysenko (Unlicensed)
Purpose
Methods returns employee details by ID.
Specification
Link | Посилання на Apiary або Swagger | |
Resource | /api/employees/{{employee_id}} | Посилання на ресурс, наприклад: /api/persons/create |
Scope | employee:details | Scope для доступу |
Components | Employees | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription |
Microservices | il/api | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC |
Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… |
Sync/Async | Sync | Метод є синхронним чи асинхронним? |
Public/Private/Internal | Private | Потрібно зазначити тип методу за ступенем доступності |
Logic
Search in the legal_entity by :legal_entity_id (legal_entity_id from Context)
return error if not found
Search in the employee by :employee_id and is_active = true
return error if not found
Check employee.employee_type
employee_type in (DOCTOR, PHARMACIST)
employee_type in (HR, ACCOUNTANT, OWNER, PHARMACY_OWNER)
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
employee_id |
| String | Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
Filters
See on Apiary
Dictionaries
+DIVISION_TYPE
LEGAL_FORM
OWNER_PROPERTY_TYPE
EMPLOYEE_TYPE
+DOCUMENT_TYPE
PHONE_TYPE
EDUCATION_DEGREECOUNTRYQUALIFICATION_TYPE
SPECIALITY_TYPE
SPECIALITY_LEVEL
SPEC_QUALIFICATION_TYPE
SCIENCE_DEGREE
LEGAL_ENTITY_TYPE_V2
Request structure
See on Apiary
Authorize
Request to process the request using a token in the headers
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Request data validation
API paragraph not found
Response structure
See on Apiary
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"data": {
"id": "d290f1ee",
"party_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"no_tax_id": true,
"legal_entity_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"division_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"employee_type": "DOCTOR",
"position": "P1",
"start_date": "2017",
"end_date": "2017",
"status": "NEW",
"speciality": {
"speciality": "THERAPIST",
"speciality_officio": true,
"level": "FIRST",
"qualification_type": "AWARDING",
"attestation_name": "Академія Богомольця",
"attestation_date": "2017-02-28",
"valid_to_date": "2020-02-28",
"certificate_number": "AB/21331"
},
"status_reason": "new_employee",
"inserted_at": "1991-08-19T00:00:00.000Z",
"inserted_by": "userid",
"updated_at": "1991-08-19T00:00:00.000Z",
"updated_by": "userid"
}
}HTTP status codes
HTTP status code | Message | What caused the error |
|---|---|---|
200 | Response |
|
ЕСОЗ - публічна документація