1.4 Завантажити довідник вулиць компанії «Нова Пошта (метод «getStreet»)
Метод «getStreet» працює в моделі "Address", цей метод завантажує довідник вулиць в рамках населених пунктів України куди здійснює доставку ТОВ Нова Пошта. Використовується при створенні відправлень з типом доставки від/до адреси клієнта.
Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендується проводити оновлення довідників раз на добу.
Доступність: Не потребує використання API-ключа.
XML
<?xml version="1.0" encoding="UTF-8"?>
<file>
<modelName>Address</modelName>
<calledMethod>getCities</calledMethod>
<methodProperties>
. . .
</methodProperties>
</file>
JSON
{
"apiKey": "",
"modelName": "Address",
"calledMethod": "getCities",
"methodProperties": {
"CityRef": "8d5a980d-391c-11dd-90d9-001a92567626",
"Page": "1"
}
}
Параметр | Тип | Опис |
---|---|---|
CityRef | string[36] | Ідентифікатор міста(Завантажено за допомогою методу Address/getCities) |
Page | int | Сторінка з інформацією для відображення (Не більше 500 записів на одній сторінці) |
Опис відповіді на запит
Параметри | Тип | Опис |
---|---|---|
Description | string[100] | Назва вулиці |
Ref | string[36] | Ідентифікатор населеного пункта |
StreetsTypeRef | string[36] | Ідентифікатор типу вулиці |
StreetsType | string[] | Тип вулиці |
Якщо в цей запит додати параметр «FindByString» (пошук по рядкам) і в його властивостях прописати назву населеного пункта (Броварський)) який потрібно знайти, Приклад запиту
{ "apiKey": " ваш ключ АРІ 2.0", "modelName": "Address", "calledMethod": "getCities", "methodProperties": { "FindByString": "Броварський)" }
То отримаємо запит за допомогою якого в довіднику знаходиться проспект чи вулиця.