Note |
---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
...
Properties of a REST API method document
Document type | Метод REST API |
---|---|
Document title | [DRAFT] Get healthcare service details by ID [API-005-009-001-0173] |
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-специфікацію | |
Resource | {{host}}/api/healthcare_services/{{id}} |
Scope | healthcare_service:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This WS is designed to return healthcare service details
...
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 systemN/A
Dictionaries
PROVIDING_CONDITION
SPECIALITY_TYPE
HEALTHCARE_SERVICE_CATEGORIES
HEALTHCARE_SERVICE_PHARMACY_DRUGS_TYPES
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | id |
| String | Healthcare service identifier. Optional. | d290f1ee-6c54-4b01-90e6-d701748f0851 |
2 |
|
|
|
|
|
Request structure
See on API-specification
...
Expand | |||||
---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 | 200 | Response |
| ||
3 | 401 | Invalid access token |
| ||
4 | 403 | forbidden | Healthcare service belongs to legal entity id from access token check failed. | ||
5 | 403 | Your scope does not allow to access this resource. Missing allowances: healthcare_service:read. | |||
6 | 404 | Not found | Healthcare service exists in PRM DB check failed | ||
7 | Специфічні | ||||
8 |
|
Post-processing processes
...
Technical modules where the method is used
Название | ID ТМ | Статус |
---|---|---|
TM0112 | ||