Онлайн пошук в довіднику населених пунктів
Метод «searchSettlements», працює в моделі «Address», цей метод необхідний для ОНЛАЙН ПОШУКУ населених пунктів.
Завдяки даному методу немає необхідності на своїй стороні зберігати довідники та здійснювати їх оновлення.
Текст запиту
| Параметр | Тип | Опис |
|---|---|---|
| CityName* | string[36] | Назва населеного пункту або Індекс населеного пункту |
| Limit* | string[36] | Кільксть записів на сторінці. Працює разом із параметром Page |
| Page* | string[36] | Сторінка, працює разом з параметром Limit |
* Позначення обов’язкового параметру
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Address",
"calledMethod": "searchSettlements",
"methodProperties": {"CityName" : "київ","Limit" : "50","Page" : "2" }
}
Відповідь 200
Завжди повертає код 200 навіть при логічних помилках.
Тіло відповіді на запит
| Параметр | Тип | Опис |
| TotalCount | string[36] | Кількість знайдених об'єктів |
| Addresses | array | Адреса |
| Warehouses | string[36] | Кількість відділень |
| MainDescription | string[50] | Назва населених пунктів |
| Area | string[50] | Ознака області |
| Region | string[50] | Ознака району |
| SettlementTypeCode | string[50] | Абревіатура типу населеного пункту |
| Ref | string[50] | REF міста із довідника getSettlements |
| DeliveryCity | string[50] | REF міста із довідника getCities, з якого виконується доставка |
{
"success": true,
"data": [{"TotalCount" : "235","Addresses" : [{"Warehouses":0","MainDescription":"Київ","Area":"Миколаївська","Region":"Доманівський","SettlementTypeCode":"с.","Ref":"0db2df4b-4b3a-11e4-ab6d-005056801329","DeliveryCity":"06f8795a-4079-11de-b509-001d92f78698"}],"Warehouses" : "568","MainDescription" : "Київ","Area" : "обл","Region" : "Київська","SettlementTypeCode" : "м.","Ref" : "00000000-0000-0000-0000-000000000000","DeliveryCity" : "00000000-0000-0000-0000-000000000000" }],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}