Properties of a REST API method document

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input This method should be used for the deactivation of the division

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

Configuration parameters

N/A

Dictionaries

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

Input parameters

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Headers

...

Headers

...

Request data validation

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

...

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)

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 healthcare service

Check that there are no active healthcare services related to this division

1. Search for healthcare services with this division in status ACTIVE

   1. If search result contains any records - return 409 error (Division cannot be deactivated - active healthcare services exists)

Validate equipment

Check that there are no active records in equipment table related to this division

1. Search for equipments with this division in ACTIVE status

   1. If search result contains any records - return 409 error (Division cannot be deactivated - active equipments exists)

Validate transition

Only ACTIVE division can be deactivated

Available transitions

1. ACTIVE → INACTIVE

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

Processing

Save object to DB

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

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

...