Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] Get dictionaries [API-011-001-008-0406]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-011-001-008-0406
Microservices (namespace)	PRM
Component	Dictionaries and Registers
Component ID	COM-011-001
Link на API-специфікацію	GENERAL MIS API · Apiary
Resource	{{host}}/api/dictionaries
Scope	dictionary:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

This method is designed to retrieve eHealth dictionaries

Logic

Filter dictionaries by search params.
Render found dictionaries with all fields from PRM DB.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

name - dictionary name
is_active - dictionary status

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1
2

Request structure

See on API-specification

Headers

Request data validation

N/A

Processing

N/A

Response structure examples

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