Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Purpose

API paragraph not foundList of streets by setllement

Specification

Page Properties
idAPI_Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/search-streets/list-of-streets-by-search-params

Посилання на Apiary або Swagger

Resource

/api/uaddresses/streets

Посилання на ресурс, наприклад: /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

...

Request to process the request using a token in the headers

Headers

API paragraph not foundContent-Type: application/json

Request data validation

API paragraph not found

...

Expand
titleResponse example
Code Block
{
 
"metadata": [
{
   
"codealiases": 200,
   [],
"urlid": "https://example.com/resource",
    "type0f967aa5-5b78-4ab7-ab77-439b9b15b434",
"name": "objectТуристична",
   
"requestsettlement_id": "6617aeecc0094697-15e2555a-4d6f4ac3-b9bd8914-53559c358f97#17810d3f97e07e53b",
"type": "STREET"
}
],
 
"datameta": [
    {
      ""code": 200,
"request_id": "d290f1ee7f32a138-6c549daa-4b0141d2-90e6afda-d701748f0851ff2be2f50061#410200",
     
"settlement_nametype": "Новосілкиlist",
    
 "street_typeurl": "вул",
      "street_name": "Єрмоленка Володимира"
    }
  ],
 http://api-svc.uaddresses/streets"
},
"paging": {

   "page_number": 21,
   
"page_size": 50,
   
"total_entries": 10001,
    "total_pages": 23
 1
}
}

Post-processing processes

...