Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Table of Contents

...

Purpose

This service returns a list of all active legal entities of all types (except MIS) filtering result by query parameters

Specification

Page Properties
idAPI_Specification

...

Resource

/api/v2/legal_entities

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

Scope

legal_entity:read

Scope для доступу

Components

Legal Entities

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Public

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

Logic

...

Filters

See on Apiary

Request structure

API paragraph not found

Authorize

  1. Verify the validity of access token

  2. Check user scope legal_entity:read in order to perform this action

Headers

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

Check user context

Return response to user limited by context from user's token

Token type

Limitation

TOKENS_TYPES_PERSONAL

Limited by Legal Entity (ID)

TOKENS_TYPES_MIS

No limitations

TOKENS_TYPES_ADMIN

No limitations

Processing

Get legal entities

Invoke PRM.Legal Entities List

  1. By default service returns legal entities with type - MSP

  2. Service return only active legal_entities, where is_active = true

  3. If settlement_id passes as input parameter - legal entities should be filtered by setllement_id in residence address only

  4. Method returns list of objects with short details from PRM DM legal_entity tableand pagination information.

    1. For each legal entity return in response:

      1. legal entity details from legal_entities

...

      1. table and from edr_data table

      2. licenses from licenses table

      3. services

...

      1. from capitation_contract

...

      1.  table

      2. addresses from legal_entity table

      3. phones from legal_entity table

      4. emails from legal_entity table

      5. founders from legal_entity table

  1. If according to

...

  1. filters Legal Entities are not found, WS returns empty data array.

Response structure

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "edr": {
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "name": "Клініка Ноунейм",
        "short_name": "Ноунейм",
        "public_name": "Ноунейм",
        "legal_form": "140",
        "edrpou": "54323454",
        "kveds": [
          {
            "name": "Діяльність лікарняних закладів",
            "code": "86.10",
            "is_primary": true
          }
        ],
        "registration_address": {
          "zip": "02090",
          "country": "УКРАЇНА",
          "address": "Волинська обл., місто Луцьк ВУЛИЦЯ КОНЯКІНА буд. 14 кв. 144",
          "parts": {
            "atu": "Волинська обл., місто Луцьк",
            "atu_code": "0710100000",
            "street": "ВУЛИЦЯ КОНЯКІНА",
            "house_type": "буд.",
            "house": "14",
            "building_type": "null",
            "building": "``",
            "num_type": "кв.",
            "num": "144"
          }
        },
        "state": 1
      },
      "edrpou": "32323454",
      "type": "PRIMARY_CARE",
      "residence_address": {
        "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",
      "website": "www.msp.com.ua",
      "receiver_funds_code": "12345",
      "beneficiary": "Борисов Борис Борисович",
      "accreditation": {
        "category": "SECOND",
        "issued_date": "2017-02-28",
        "expiry_date": "2017-02-28",
        "order_no": "fd123443",
        "order_date": "2017-02-28"
      },
      "license": {
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "type": "MSP",
        "license_number": "fd123443",
        "issued_by": "Кваліфікацйна комісія",
        "issued_date": "2017-02-28",
        "expiry_date": "2017-02-28",
        "active_from_date": "2017-02-28",
        "what_licensed": "реалізація наркотичних засобів",
        "order_no": "ВА43234"
      },
      "archive": [
        {
          "date": "2017-02-28",
          "place": "вул. Грушевського 15"
        }
      ],
      "public_offer": {
        "consent_text": "Consent text",
        "consent": true
      },
      "status": "ACTIVE"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

 200

 Response