Versions Compared

Old Version 1

changes.mady.by.user Kateryna Yakovleva

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

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

Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] Get divisions [API-005-006-001-0087]

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

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/get-divisions

Resource

{{host}}/api/divisions

Scope

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This WS allows to get a list of divisions of legal entity. Also, this list can be filtered using search parameters.

  1. Only authenticated and authorized owners with appropriate scope can get a list of divisions.

  2. Method returns a list of divisions for user’s legal entity only.

  3. List can be filtered by search params.

Logic

  1. Get client_id from token as legal entity identifier

  2. Define all the divisions of the legal entity

  3. Get and render all the records with defined divisions from divisions table filtered by search params.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

Expand
titleExample
Code Block
Headers
Headers 
Request data validation
Authorize
  • Verify the validity of access token
    • in case of error - return 401 “Invalid access token” in case of validation fails
  • Verify that token is not expired
    • in case of error - return 401 “Invalid access token”
  • Check user scopes in order to perform this action (scope = 'division:read')
    • return 403 “Your scope does not allow to access this resource. Missing allowances: division:read” in case of invalid scope(s)
Validate legal entity
  • Extract client_id from token.
  • Check client scopes in order to perform this action (scope = 'division:read')
    • in case of error - return 403 “Your scope does not allow to access this resource. Missing allowances: division:read”
  • Check legal entity status (status = ACTIVE, SUSPENDED)
    • In case of error - return 422 “Legal entity is not active”
Processing
N/A
Response structure examples
See on API-specification 
 Expand
titleExample
 Code Block
languagejson
{
  "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
  },
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
 Response
 
3
401
 Authorization failed
4
401
Invalid access token
5
403
 Invalid scopes
6
403
Your scope does not allow to access this resource. Missing allowances: division:read
7
422
Legal entity is not active
8
422
 Validation failed
9
Специфічні
10
Post-processing processes
N/A
Technical modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"