Versions Compared

Key

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

...

Page Properties
idAPI_Specification

Link

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

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

Resource

/api/divisions/{{id}}/actions/deactivate

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

Scope

division:deactivate

Scope для доступу

Components

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

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

Logic

  1. Only authenticated and authorized user can use this service

  2. Only ACTIVE division can be deactivated

  3. Legal entity can deactivate only its own divisions

...

Input parameter

Values

Type

Description

Example

id

String

Required

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

Dictionaries

Dictionary ADDRESS_TYPE
Dictionary PHONE_TYPE
Dictionary SETTLEMENT_TYPE
Dictionary STREET_TYPE
Dictionary DIVISION_TYPE
Dictionary COUNTRY

Authorize

  1. Verify the validity of access token
    Return 401 in case validation fails

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

    1. Return 403 in case invalid scope(s)

...

Parameter

Source

Description

status

INACTIVE

updated_at

Timestamp: now()

Get current date-time

updated_by

Token: user_id

Deactivate Medical Program Provision

For PHARMACY legal entity type only. For related divisions deactivate linked active medical program provision entities (according to link).

Deactivate related active medical program provision entities:

  • set is_active = false

  • set deactivate_reason = AUTO_DIVISION_DEACTIVATION 

  • set updated_at, updated by

Response structure

Example:

...