Versions Compared

Key

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

...

Page Properties

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/employees/deactivate-employee

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

Resource

/api/employees/{{id}}/actions/deactivate

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

Scope

employee:deactivate

Scope для доступу

Components

Employees, Legal Entity, Divisions

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

il/api

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

PATCH

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Public

...

Input parameter

Values

Type

Description

Example

id

String

Required

d290f1ee-6c54-4b01-90e6-d701748f0851

Dictionaries

https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1190887576/DIVISION+TYPE https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1191084177/DIVISION+STATUS https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1307344919/LEGAL+ENTITY+TYPE+V2 https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1313178092/LICENSE+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 COUNTRY EDUCATION_DEGREE https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1194852413/QUALIFICATION+TYPE

...

  • +DIVISION_TYPE

  • +DIVISION_STATUS

  • LEGAL_ENTITY_TYPE_V2

  • LICENSE_TYPE

  • +DOCUMENT_TYPE

  • PHONE_TYPE

  • COUNTRY

  • EDUCATION_DEGREE

  • QUALIFICATION_TYPE

  • SPECIALITY_TYPE

  • SPECIALITY_LEVEL

  • SPEC_QUALIFICATION_TYPE

Authorize

  1. Verify the validity of access token.

  2. Check user scope employee:deactivate in order to perform this action

    1. In case error - return 401 error.

...