Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] Get settlement details by ID [API-012-001-003-0414]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-012-001-003-0414
Microservices (namespace)	UA ADRESSES
Component	Dictionaries and Registers
Component ID	COM-012-001
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/search-settlements/get-settlement-details-by-id
Resource	{{host}}/api/uaddresses/settlements/{{id}}
Scope	address:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

Use this method to obtain city details

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

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

Request structure

See on API-specification

Example

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Processing

N/A

Response structure examples

See on API-specification

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
  }
}

HTTP status codes

	Response code	HTTP Status code	Message
1	Базові
2		200	Response
3	Специфічні
4

Post-processing processes

N/A

Technical modules where the method is used

[DRAFT] Get settlement details by ID [API-012-001-003-0414]

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Authorize

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used