Довідник міст компанії

Отримання довідника міст компанії «Нова Пошта» українською та російською мовами. Метод «getCities» працює в моделі «Address», цей метод завантажує довідник населених пунктів України.

Варто враховувати, що довідник вивантажується тільки з населеними пунктами, де є відділення "Нова Пошта" і можна оформити доставку на відділення, а також доставку за адресою.

Якщо до цього запиту додати параметр «FindByString» (пошук за рядками) та у його властивостях прописати назву населеного пункту (Бровари), який потрібно знайти, то отримаємо запит за допомогою якого в довіднику знаходиться населений пункт.

"methodProperties": { "FindByString": "Бровари" }

Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендується проводити оновлення довідників раз на день.

Текст запиту
Параметр Тип Опис
Ref string[36] Ідентифікатор міста
Page string[36] Номер сторінки для відображення
FindByString string[36] Пошук по назві міста
Limit string[36] Кількість записів на сторінці. Працює разом з параметром Page
* Позначення обов’язкового параметру
                        
 
{
   "apiKey": "[ВАШ КЛЮЧ]",
   "modelName": "Address",
   "calledMethod": "getCities",
   "methodProperties": {"Ref" : "00000000-0000-0000-0000-000000000000","Page" : "1","FindByString" : "Київ","Limit" : "20"   }
}

                                
                                  




                                

Відповідь 200
Завжди повертає код 200 навіть при логічних помилках.

Тіло відповіді на запит
Параметр Тип Опис
Description string[50] Місто українською мовою
DescriptionRu string[50] Місто російською мовою
Ref string[36] Ідентифікатор міста
Delivery1 string[36] Наявність доставки відправлення в днях тижня
Delivery2 string[36] Наявність доставки відправлення в днях тижня
Delivery3 string[36] Наявність доставки відправлення в днях тижня
Delivery4 string[36] Наявність доставки відправлення в днях тижня
Delivery5 string[36] Наявність доставки відправлення в днях тижня
Delivery6 string[36] Наявність доставки відправлення в днях тижня
Delivery7 string[36] Наявність доставки відправлення в днях тижня
Area string[36] Область
SettlementType string[36] Ідентифікатор (реф) типу населеного пункту
IsBranch string[36] Наявність відділень (1/0)
PreventEntryNewStreetsUser string[36] Ознака налаштування "Заборонити ведення нових вулиць користувачем" (1/0)
Conglomerates string[36] Конгломерат
CityID string[36] Код міста
SettlementTypeDescriptionRu string[36] Опис типу населеного пункту російською мовою
SettlementTypeDescription string[36] Опис типу населеного пункту українською мовою
                                  
{
  "success": true,
  "data": [{"Description" : "Київ","DescriptionRu" : "Киев","Ref" : "00000000-0000-0000-0000-000000000000","Delivery1" : "1","Delivery2" : "1","Delivery3" : "1","Delivery4" : "1","Delivery5" : "1","Delivery6" : "0","Delivery7" : "0","Area" : "00000000-0000-0000-0000-000000000000","SettlementType" : "00000000-0000-0000-0000-000000000000","IsBranch" : "0","PreventEntryNewStreetsUser" : "null","Conglomerates" : "null","CityID" : "890","SettlementTypeDescriptionRu" : "село","SettlementTypeDescription" : "село"  }],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}