Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] REST API Search Divisions [API-005-006-001-0094]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-005-006-001-0094
Microservices (namespace)	IL
Component	Divisions
Component ID	COM-005-006
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-portal-and-reports/divisions/search-divisions
Resource	{{host}}
Scope
Protocol type	REST
Request type
Sync/Async
Public/Private

Purpose

This method is designed to search divisions on public portal by employees or any citizen of Ukraine or via cabinet by any registered patient

Divisions should be filtered on portal by settlement, edrpou and name. At the moment only MSP is shown on the map and filters, PHARMATHY will be done in future.

Each division should be linked to its LE.

Divisions have link to the map.

All datas are shown without scopes from reports DB.

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	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