Table of Contents

Purpose

This method should be used to activate division

Specification

Page Properties

id	API_Specification

Link

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

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

...

або Swagger
Resource	/api/divisions/{{id}}/actions/activate	Посилання на ресурс, наприклад: /api/persons/create
Scope	division:activate	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

Only authenticated and authorized user can use this service
Only INACTIVE division can be activated
Legal entity can activate only its own divisions

...

Input parameters

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

Verify the validity of access token
1. Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'division:activate')
1. Return 403 in case invalid scope(s)

Headers

Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}

Request data validation

Validate division

Check that division with such ID exists in the system (is_active = true)
1. In case of error - return 404
Check that division belongs to the same legal entity as the user
1. In case of error - return 403

...

Only INACTIVE divisions can be activated

Available transitions

ACTIVE → INACTIVEINACTIVE → ACTIVE

In other cases - return 409 error ('{current_status} division cannot be ACTIVATED')

Processing

Save object to DB

Parameter	Source	Description
status	ACTIVE
updated_at	Timestamp: now()	Get current date-time
updated_by	Token: user_id

Response structure

Example:

Expand

title	Response example

Code Block

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "Бориспільське відділення Клініки Ноунейм",
    "addresses": [
      {
        "type": "RESIDENCE",
        "country": "UA",
        "area": "Житомирська",
        "region": "Бердичівський",
        "settlement": "Київ",
        "settlement_type": "CITY",
        "settlement_id": "b075f148",
        "street_type": "STREET",
        "street": "вул. Ніжинська",
        "building": "15",
        "apartment": "23",
        "zip": "02090"
      }
    ],
    "phones": [
      {
        "type": "MOBILE",
        "number": "+380503410870"
      }
    ],
    "email": "email@example.com",
    "working_hours": {
      "mon": [
        [
          "08.00",
          "12.00"
        ],
        [
          "14.00",
          "18.00"
        ]
      ],
      "tue": [
        [
          "08.00",
          "12.00"
        ]
      ],
      "wed": [
        [
          "08.00",
          "12.00"
        ]
      ],
      "thu": [
        [
          "08.00",
          "12.00"
        ]
      ],
      "fri": [
        [
          "08.00",
          "12.00"
        ]
      ]
    },
    "type": "CLINIC",
    "legal_entity_id": "c8aadb87-ecb9-41ca-9ad4-ffdfe1dd89c9",
    "external_id": "3213213",
    "location": {
      "latitude": 30.1233,
      "longitude": 50.32423
    },
    "status": "ACTIVE",
    "mountain_group": false,
    "dls_id": "2872985",
    "dls_verified": true
  }
}

HTTP status codes

Page Properties

id	API_HTTP status codes

HTTP status code	Message	What caused the error
200	Response
401		Invalid access token
403		Invalid scope Check that division belongs to the same legal entity as the user failed
404		Validation error
409		Validation error

Versions Compared

Old Version 5

New Version Current

Key

Purpose

Specification

Logic

Input parameters

Dictionaries

Authorize

Headers

Request data validation

Validate division

Processing

Save object to DB

Response structure

HTTP status codes

Page Comparison

Versions Compared

Old Version 5

New Version Current

Key

Purpose

Specification

Logic

Input parameters

Dictionaries

Authorize

Headers

Request data validation

Validate division

Processing

Save object to DB

Response structure

HTTP status codes