ЕСОЗ - публічна документація
Get equipment details by ID
Purpose
This WS is designed to receive detailed information about equipment by ID
Specification
Link | Посилання на Apiary або Swagger | |
Resource | /api/equipment/{{id}} | Посилання на ресурс, наприклад: /api/persons/create |
Scope | equipment:read | Scope для доступу |
Components | Devices and equipment | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: 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
Only authenticated and authorized HR, ADMIN, OWNER employees from MSP, OUTPATIENT, PRIMARY_CARE, EMERGENCY legal entities can get the equipment by id.
Service returns only equipment related to the same legal entity as the user. User with role NHS ADMIN can get any equipment from any legal entity.
Get equipment details from prm.equipments table by equipment id from request
Preload equipment names from
prm.equipment_names
Render response according to specification.
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id |
| String | Equipment identifier. Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
Request structure
API paragraph not found
Authorize
Verify the validity of access token
Return 401 in case validation fails
Verify that token is not expired
in case of error - return (401, 'Invalid access token')
Check scopes in order to perform this action (scope = 'equipment:read')
Return 403 in case invalid scope(s)
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en
Request data validation
Validate equipment
Check that equipment with such ID exists in the system (is_active = true)
In case of error - return 404
Check that equipment with such ID belongs to to the same legal entity as the user OR user has NHS ADMIN role.
In case of error - return 403
Validate legal entity
Check that requested equipment belongs to the same legal entity as user
Extract
client_id
from tokenCheck that
equipments.legal_entity_id
==client_id
in case of error - return 403
Processing
Response structure
Example:
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 | Response |
|
401 |
| Access token validation failed |
403 |
|
|
404 |
| Validation failed |
ЕСОЗ - публічна документація