REST API method / Метод REST API (настанова) (remove the link block before publishing the document)
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [Document status] REST API [Назва методу] [ID методу] |
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-0173 |
Microservices (namespace) | IL |
Component | Legal Entities |
Component ID | COM-005-009 |
Link на API-специфікацію | https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/employeehealthcare-rolesservices/get-healthcare-service-details-by-id |
Resource | {{host}}/api/healthcare_services/{{id}} |
Scope | healthcare_service:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
...
Get data from healthcare_services by id (PRM DB).
Render a response according to specification.
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
...
Get healthcare service by $.id. Check that healthcare service exists in PRM DB
in case of error - return 404 (“not_found”).
Get healthcare service by $.id. Check that healthcare service belongs to legal entity id from access token
in case of error - return 403 (“forbidden”).
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
...
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||