...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Table of Contents |
|---|
Purpose
This service is designed to obtain list of related legal entities by MSP or NHS.
Specification
Overview
Use this method to get the list of child legal entities which are related to current legal entity.
only employees with scope "related_legal_entities:read" can get a list of related legal entities
it's possible to see only
...
children legal entities (GET /legal_entities/{{id}}/related{?page,page_size})
...
Specification
| Page Properties | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
|
Logic
API paragraph not found
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
id | String | Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
Filters
See on Apiary
Request structure
API paragraph not found
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')
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
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
Example:
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes
API paragraph not found
HTTP status codes
| Page Properties | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|