Онлайн пошук вулиць в довіднику населених пунктів
Метод «searchSettlementStreets», працює в моделі «Address», цей метод необхідний для ОНЛАЙН ПОШУКУ вулиць в обраному населеному пункті.
Завдяки даному методу немає необхідності на своїй стороні зберігати довідники та здійснювати їх оновлення.
Текст запиту
| Параметр | Тип | Опис |
|---|---|---|
| StreetName* | string[36] | Назва вулиці |
| SettlementRef* | string[36] | Ідентифікатор (REF) населеного пункту із довідника населених пунктів України |
| Limit | string[36] | Кількість відповідей |
* Позначення обов’язкового параметру
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Address",
"calledMethod": "searchSettlementStreets",
"methodProperties": {"StreetName" : "Хрещатик","SettlementRef" : "00000000-0000-0000-0000-000000000000","Limit" : "50" }
}
Відповідь 200
Завжди повертає код 200 навіть при логічних помилках.
Тіло відповіді на запит
| Параметр | Тип | Опис |
| TotalCount | string[36] | Кількість знайдениї об'єктів |
| SettlementRef | string[50] | Ідентифікатор (REF) населеного пункту |
| SettlementStreetRef | string[50] | Ідентифікатор (REF) вулиці |
| SettlementStreetDescription | string[50] | Опис вулиці |
| Present | string[50] | Повний опис вулиці |
| StreetsType | string[50] | Ідентифікатор (REF) типу вулиці |
| StreetsTypeDescription | string[50] | Опис типу вулиці |
| Location | string[50] | Локація |
{
"success": true,
"data": [{"TotalCount" : "123","SettlementRef" : "00000000-0000-0000-0000-000000000000","SettlementStreetRef" : "00000000-0000-0000-0000-000000000000","SettlementStreetDescription" : "Незалежності","Present" : "бул. Незалежності","StreetsType" : "00000000-0000-0000-0000-000000000000","StreetsTypeDescription" : "бул.","Location" : "" }],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}