Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Page Properties

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-partner-relationship-management/employees/get-employee-details

Посилання на 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

  1. Search in the legal_entity by :legal_entity_id (legal_entity_id from Context)

  2. return error if not found

  3. Search in the employee by :employee_id and is_active = true

    1. return error if not found

  4. Check employee.employee_type

    1. employee_type in (DOCTOR, PHARMACIST)

      1. Return doctor, pharmacist response structure

    2. employee_type in (HR, ACCOUNTANT, OWNER, PHARMACY_OWNER)

      1. Return other employee type response structure.

...

Filters

See on Apiary

Dictionaries

https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1190887576/DIVISION+TYPE https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1306296336/LEGAL+FORM https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1321467905/OWNER+PROPERTY+TYPE https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1300529210/EMPLOYEE+TYPE

https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1287192636/DOCUMENT+TYPE https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1321533446/PHONE+TYPE EDUCATION_DEGREE COUNTRY https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1194852413/QUALIFICATION+TYPE

https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1195114505/SPECIALITY+TYPE https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1194852386/SPECIALITY+LEVEL https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1195278373/SPEC+QUALIFICATION+TYPE https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1198161934/SCIENCE+DEGREE

...

  • +DIVISION_TYPE

  • LEGAL_FORM

  • OWNER_PROPERTY_TYPE

  • EMPLOYEE_TYPE

  • +DOCUMENT_TYPE

  • PHONE_TYPE

  • EDUCATION_DEGREE

  • COUNTRY

  • QUALIFICATION_TYPE

  • SPECIALITY_TYPE

  • SPECIALITY_LEVEL

  • SPEC_QUALIFICATION_TYPE

  • SCIENCE_DEGREE

  • LEGAL_ENTITY_TYPE_V2

Request structure

See on Apiary

...