...
| Page Properties |
|---|
|
Link | https://uaehealthapi.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/dictionaries/get-dictionaries | Посилання на Apiary або Swagger | Resource | /api/dictionaries | Посилання на ресурс, наприклад: /api/persons/create | Scope | dictionary:read | Scope для доступу | Components | Dictionaries | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: 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
Filter dictionaries by search params.
Render found dictionaries with all fields from PRM DB.
Input parameters
name - dictionary name
is_active - dictionary status
Filters
No
Authorize
API paragraph not found
...
API paragraph not found
Response structure
Each dictionary is an object that contains {key}:{value} pairs where:
{key} is a dictionary record
{value} is a dictionary record description
has a definite dictionary’s labels and flag ‘is_active’ that define a dictionary status
See on Apiary
Example:
| Expand |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"data": [
{
"name": "DOCUMENT_TYPE",
"values": {
"key": "value"
},
"labels": [
"SYSTEM",
"EXTERNAL"
],
"is_active": true
}
]
} |
|
...