ЕСОЗ - публічна документація

Search for an Employee

Owned by Georgiy Lysenko (Unlicensed)
Last updated: Jul 17, 2023
2 min read

Purpose

Methods returns list of employees.

Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-partner-relationship-management/employees/search-for-an-employee

Посилання на Apiary або Swagger

Resource

/employees

Посилання на ресурс, наприклад: /api/persons/create

Scope

 

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

Потрібно зазначити тип методу за ступенем доступності

Input parameters

See on Apiary

Filters

See on Apiary

Dictionaries

  • SPECIALITY_TYPE

  • POSITION

  • EMPLOYEE_TYPE

  • SPEC_QUALIFICATION_TYPE

  • SPECIALITY_LEVEL

  • SPEC_QUALIFICATION_TYPE

Request structure

See on Apiary

Authorize

Request to process the request using a token in the headers

Headers

  • Content-Type:application/json

Request data validation

Response structure

See on Apiary

Example:

{ "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" } ], "paging": { "page_number": 2, "page_size": 50, "total_entries": 1000, "total_pages": 23 } }

 

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

 200

 

 

 

 

 

 

ЕСОЗ - публічна документація