ЕСОЗ - публічна документація

[DRAFT] Activate division [API-005-006-001-0091]

Owned by Kateryna Yakovleva
Last updated: yesterday at 5:30 PM by Anastasiia Prokhorova (SoE eHealth)
4 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] Activate division [API-005-006-001-0091]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-005-006-001-0091

Microservices (namespace)

IL

Component

Divisions

Component ID

COM-005-006

Link на API-специфікацію

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

Resource

{{host}}/api/divisions/{{id}}/actions/activate

Scope

division:activate

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private

Public

Purpose

This method should be used to activate division

Logic

  1. Only authenticated and authorized user can use this service

  2. Only INACTIVE division can be activated

  3. Legal entity can activate only its own divisions

Configuration parameters

N/A

Dictionaries

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

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

Required

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

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Headers

Request data validation

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 = 'division:activate')

    1. Return 403 in case invalid scope(s)

Validate division

  1. Check that division with such ID exists in the system (is_active = true)

    1. In case of error - return 404

  2. Check that division belongs to the same legal entity as the user

    1. In case of error - return 403

Validate transition

Only INACTIVE divisions can be activated

Available transitions

  1. INACTIVE → ACTIVE

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

Processing

Save object to DB

Parameter

Source

Description

Parameter

Source

Description

status

ACTIVE

 

updated_at

Timestamp: now()

Get current date-time

updated_by

Token: user_id

 

Response structure examples

See on API-specification

{ "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

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 Response

 

 

3

 

401

  Invalid access token

 

 

4

 

403

Check that division belongs to the same legal entity as the user failed

 

 

5

 

403

 Invalid scope

 

 

6

 

404

 Validation error

 

 

7

 

409

{current_status} division cannot be ACTIVATED

 

 

8

 

409

 Validation error

 

 

9

Специфічні

10

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

 

ЕСОЗ - публічна документація