Purpose

This service is designed to obtain list of related legal entities by MSP or NHS.

Specification

Get legators Legal Entities

Overview

1. only employees with scope "related_legal_entities:read" can get list of related legal entities
2. it's possible to see only  children legal entities (GET /legal_entities/{{id}}/related{?page,page_size})

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

Response

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