Properties of a REST API method document

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

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

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 examples

See on API-specification

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

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used