Note |
---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
Info |
---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
Table of Contents |
---|
Properties of a REST API method document
Page Properties | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the systemThis method is designed to retrieve a catalog of dictionaries that can be used in eHealth. This WS can represent hierarchical dictionaries with subordinate (child) values. Each value can be managed by ‘is_active’ flag.
Logic
Filter dictionaries by search params.
Render found dictionaries with all fields from PRM DB.
Configuration parameters
N/A
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
...
name - dictionary name
is_active - dictionary status
value_code - code of the dictionary value
value_description - description of the dictionary value
value_is_active - status of the dictionary value
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 |
composition_id
M
String ($uuid) (path)
89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
2 |
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
Expand | ||
---|---|---|
| ||
|
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
...
|
Headers
Request data validation
N/A
Processing
N/A
Response structure examples
Each dictionary is an object that contains code, description and status of the value. It can be represented by a hierarchical structure with subordinate (child) values. Each dictionary has a definite dictionary’s labels and flag ‘is_active’ that define a dictionary status
See on API-specification
Expand | |||||
---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 |
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
401
Unauthorized
200 | Response | ||||
3 | |||||
4 | Специфічні | ||||
5 |
422
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
Page Properties Report | ||||
---|---|---|---|---|
|
...