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

Get legators Legal Entities

Owned by Bogdana Konovalenko (Unlicensed)
Last updated: Mar 11, 2023 by Serhii Boldin (SoE eHealth)
2 min read

Purpose

Use this method to get the list of child legal entities which are related to current legal entity.

  1. only employees with scope "related_legal_entities:read" can get a list of related legal entities

  2. it's possible to see only children legal entities (GET /legal_entities/{{id}}/related{?page,page_size})

 

Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/legal-entities/get-legators-legal-entities

Resource

/api/legal_entities/{{id}}/related

Scope

related_legal_entities:read

Components

Legal Entities

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private/Internal

Public

 

Logic

API paragraph not found

 

Input parameters

Input parameter

Values

Type

Description

Example

Input parameter

Values

Type

Description

Example

id

 

String

Required

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

 

Filters

See on Apiary

 

Request structure

See on Apiary

 

Authorize

Request to process the request using a token in the headers

 

Headers

Наприклад:

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

 

Request data validation

Validate token

  • Verify the validity of access token

    • Return 401 in case validation fails

  • token is not expired

    • in case error return 401 

Validate scopes

  • Check user scopes in order to perform this action (scope = 'related_legal_entities:read')

    1. Return 403 in case invalid scope(s) -"Your scope does not allow to access this resource. Missing allowances: related_legal_entities:read"

Validate client

  • Check $id =tokens.details.client_id

    1. Return 403 in case of error -"User is not allowed to view"

Validate context

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

  • if TOKENS_TYPES_PERSONAL

    • return response limited by legal_entity/{{id}}=user.client_id

 

Processing

Find related legal entities as select merged_from_id from related_legal_entities where merged_to_id=$id. Enrich id with data from legal entities table and form response according to json scheme.

If no related_legal_entities found return 200 and empty array.

 

Response structure

See on Apiary

Example:

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "data": [ { "merged_from_legal_entity": { "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "name": "Клініка Ноунейм", "edrpou": "5432345432" }, "reason": "на підставі наказу №1111", "reason_date": "2022-02-10", "type": "ACCESSION", "is_active": true, "inserted_at": "2005-10-30 10:45", "inserted_by": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b" } ], "paging": { "page_number": 2, "page_size": 50, "total_entries": 1000, "total_pages": 23 } }

 

Post-processing processes

API paragraph not found

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

200

 Response

 

401

 

 Token validation failed

403

  • Your scope does not allow to access this resource. Missing allowances: related_legal_entities:read

  • User is not allowed to view

 

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