API V1.0 – 1.2. Населені пункти
Отримання інформації з довідника населених пунктів:
URL-Адреса запиту:
https://api.sat.ua/study/hs/api/v1.0/main/{format}/getTowns[?searchString][&rsp]Параметри запиту:
format
string
Формат даних для отримання відповіді (xml, json)
language (додатковий)
string
Код мови для отримання відповіді (ru, en, uk)
searchString (додатковий)
string
Пошук міст за частиною найменування. Якщо параметр не вказано, будуть повернуті всі міста обраного РСП. При цьому параметр rsp має бути вказано.
rsp (додатковий)
string
Ідентифікатор відділення. Використовується для фільтрації вибірки за містами, які обслуговуються даним відділенням
ref (додатковий)
string
Ідентифікатор міста.
Відповідь 200
-
ref:
ідентифікатор міста
-
description:
найменування міста
-
rspRef:
ідентифікатор відділення
-
district:
район населеного пункту
-
region:
область населеного пункту
-
rspList:
масив ідентифікаторів РСП (відділень), розташованих у цьому населеному пункті
приклад відповіді
text/xml
| application/json
<response>
<success>true</success>
<data>
<item>
<description>Днепропетровск</description>
<ref>49eb5fe9-9314-11da-9860-00024407fbce</ref>
<rspRef>bbf8e491-33a7-11dd-a17a-001a4d3b885e</rspRef>
<district/>
<region/>
<rspList>09181b9a-dc25-11e4-89fa-0017a4770440</rspList>
<rspList>bbf8e491-33a7-11dd-a17a-001a4d3b885e</rspList>
<rspList>d22fd6b9-2ae0-11e1-b0b4-0017a4770020</rspList>
</item>
<item>
<description>Днепродзержинск</description>
<ref>381d1fb7-9314-11da-9860-00024407fbce</ref>
<rspRef>a5e411a8-d6a8-4b62-8bc2-a64832bdcc11</rspRef>
<district/>
<region/>
<rspList>a5e411a8-d6a8-4b62-8bc2-a64832bdcc11</rspList>
</item>
<item>
<description>Днепровское</description>
<ref>0dc05dc0-9314-11da-9860-00024407fbce</ref>
<rspRef>a5e411a8-d6a8-4b62-8bc2-a64832bdcc11</rspRef>
<district/>
<region/>
</item>
<item>
<description>Приднепровское</description>
<ref>5d440009-9315-11da-9860-00024407fbce</ref>
<rspRef>c65740da-8f2b-405b-a0fa-a2a1f92e374a</rspRef>
<district/>
<region/>
</item>
</data>
</response>
інтерфейси API