Versions Compared

Old Version 12

changes.mady.by.user Oksana Demchenko

Saved on

compared with

New Version Current

changes.mady.by.user Oksana Demchenko

Saved on

Key

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

Purpose

API paragraph not foundThis method allows to deactivate a previously added employee role

Specification

Page Properties
idAPI_Specification

Link

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

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

Resource

/api/employee_roles/{{id}}/actions/deactivate

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

Scope

employee_role:write

Scope для доступу

Components

Scopes modelEmployees

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

Microservices

API paragraph not foundil/api

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

Protocol type

REST

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

Request type

PATCH

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

Sync/Async

Sync

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

Public/Private/Internal

Public

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

Preconditions

The user must have an active role

Logic

  1. Only authenticated and authorized user can use this service

  2. Only ACTIVE employee role can be deactivated

  3. Legal entity can deactivate only its own employee roles

...

Input parameter

Values

Type

Description

Example

id

 

String

Employee role identifier.

Optional

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

Request structure

...

Authorize

  1. Verify the validity of access token

    1. Return 401 in case validation fails

  2. Check scopes in order to perform this action (scope = 'employee_role:write')

    1. Return 403 in case invalid scope(s)

Headers

API paragraph not foundContent-Type:application/json

Request data validation

Validate legal entity

...