1 Purpose
2 Specification
3 Logic
4 Input parameters
5 Request structure
6 Authorize
7 Headers
8 Request data validation
9 Processing
10 Response structure
11 Post-processing processes
12 HTTP status codes

Purpose

Use this method to obtain city details

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/search-streets/get-settlement-details-by-id	Посилання на Apiary або Swagger
Resource	/api/uaddresses/settlements/{{id}}	Посилання на ресурс, наприклад: /api/persons/create
Scope	address:read	Scope для доступу
Components	Uaddresses	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: 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

API paragraph not found

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter	Values	Type	Description	Example
id		String	Required	d290f1ee-6c54-4b01-90e6-d701748f0851

Request structure

API paragraph not found

Authorize

Request to process the request using a token in the headers

Headers

API paragraph not found

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
    "region_id": "99310bc4-ac7c-4f1f-bc29-b3ae25bd96bc",
    "region": "Київ",
    "district": "Києво-Святошинський",
    "district_id": "99310bc4-ac7c-4f1f-bc29-b3ae25bd96bc",
    "settlement_name": "Новосілки",
    "mountain_group": "0",
    "type": "СITY",
    "koatuu": "3520380802",
    "parent_settlement": "Берегово",
    "parent_settlement_id": "99310bc4-ac7c-4f1f-bc29-b3ae25bd96bc"
  },
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200	Response

E-Health

Get settlement details by ID

Purpose

Specification

Logic

Input parameters

Request structure

Authorize

Headers

Request data validation

Processing

Response structure

Post-processing processes

HTTP status codes