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