Versions Compared

Version Old Version 2 New Version 3
Changes made by

Oksana Demchenko

Anzhela Kovalenko (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] Settlements by district [API-012-001-001-0411]

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-001-0411

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-districts/settlements-by-district

Resource

{{host}}/api/uaddresses/districts/{{id}}

Scope

address:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

N/A

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

 

 

 

 

 

2

 

 

 

 

 

Request structure

See on API-specification

Expand
titleExample
Code Block
languagejson
Headers
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
 Expand
titleExample
 Code Block
languagejson
{
  "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",
      "settlement_name": "Новосілки"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
 
 200
 Response
 
 
3
Специфічні
4
 
 
 
 
 
Post-processing processes
N/A
Technical modules where the method is used
Название
Содержимое не найдено