Довідник вулиць компанії
Метод «getStreet» працює в моделі «Address», цей метод завантажує довідник вулиць в рамках населених пунктів України куди здійснєю доставку компанія «Нова Пошта».
Довідник використовується під час створення відправлень з типом доставки від/до адреси клієнта. Якщо в цей запит додати параметр FindByString (пошук по рядках) і в його властивостях прописати назву вулиці (Броварський), який потрібно знайти, то отримаємо запит за допомогою якого в довіднику знаходиться проспект або вулиця.
Текст запиту
| Параметр | Тип | Опис |
|---|---|---|
| CityRef* | string[36] | Ідентифікатор (REF) міста, брати REF з відповіді Довідника міст компанії |
| FindByString* | string[36] | Пошук по рядках |
| Page | string[36] | Сторінка до 500 записів на сторінці |
| Limit | string[36] | Кількість записів на сторінці. Працює разом з параметром Page |
* Позначення обов’язкового параметру
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Address",
"calledMethod": "getStreet",
"methodProperties": {"CityRef" : "00000000-0000-0000-0000-000000000000","FindByString" : "Київ","Page" : "1","Limit" : "" }
}
Відповідь 200
Завжди повертає код 200 навіть при логічних помилках.
Тіло відповіді на запит
| Параметр | Тип | Опис |
| Ref | string[36] | Ідентифікатор (REF) вулиці |
| Description | string[100] | Назва вулиці українською мовою |
| StreetsTypeRef | string[36] | Ідентифікатор (REF) типу вулиці |
| StreetsType | string[36] | Тип вулиці |
{
"success": true,
"data": [{"Ref" : "00000000-0000-0000-0000-000000000000","Description" : "Хрещатик","StreetsTypeRef" : "00000000-0000-0000-0000-000000000000","StreetsType" : "00000000-0000-0000-0000-000000000000" }],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}