ЕСОЗ - публічна документація
[DRAFT] Get healthcare services [API-005-009-001-0172]
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.
https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
- 1 Properties of a REST API method document
- 2 Purpose
- 2.1 Key points
- 3 Logic
- 4 Configuration parameters
- 5 Dictionaries
- 6 Input parameters
- 7 Request structure
- 8 Headers
- 9 Request data validation
- 9.1 Authorize
- 10 Processing
- 11 Response structure examples
- 12 HTTP status codes
- 13 Post-processing processes
- 14 Technical modules where the method is used
Properties of a REST API method document
Document type | Метод REST API |
---|---|
Document title | [DRAFT] Get healthcare services [API-005-009-001-0172] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-005-009-001-0172 |
Microservices (namespace) | IL |
Component | Legal Entities |
Component ID | COM-005-009 |
Link на API-специфікацію | |
Resource | {{host}}/api/healthcare_services/ |
Scope | healthcare_service:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This WS allows getting a list of healthcare services by a legal entity
Key points
Only authenticated and authorized user with an appropriate scope can get the healthcare services list.
WS returns only healthcare services related to the same legal entity as the user.
Logic
Filter active healthcare_services:
with legal_entity_id = client_id from access token;
by search params.
Render found healthcare_services with all fields from PRM DB.
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
PROVIDING_CONDITION
SPECIALITY_TYPE
HEALTHCARE_SERVICE_CATEGORIES
HEALTHCARE_SERVICE_PHARMACY_DRUGS_TYPES
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 |
|
|
|
|
|
2 |
|
|
|
|
|
Request structure
See on API-specification
Headers
Request data validation
Authorize
Verify the validity of access token
in case of error - return 401 (“Invalid access token”) in case of validation fails.
Verify that token is not expired
in case of error - return 401 (“Invalid access token”).
Check user scopes in order to perform this action (scope = 'healthcare_service:read')
return 403 (“Your scope does not allow to access this resource. Missing allowances: healthcare_service:read”) in case of invalid scope(s).
Processing
N/A
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 |
| 200 | Response |
|
|
3 |
| 401 | Invalid access token |
|
|
4 |
| 403 | Your scope does not allow to access this resource. Missing allowances: healthcare_service:read |
|
|
5 | Специфічні | ||||
6 |
|
|
|
|
|
Post-processing processes
N/A
Technical modules where the method is used
ЕСОЗ - публічна документація