Словник заборонених випусків для врегулювання
Загальна інформація
Назва методу
Словник заборонених випусків для врегулювання
HTTP Метод
Повертає маніфест із посиланнями на офлайн-файли, що містять населені пункти, куди заборонено доставляти вантаж в Україні.
Роут
GET /api.novapost.pl/v.1.0/dictionary/settlements/prohibited-issuance
Авторизація
Authorization: Bearer jwt-token…
Опис
Цей API надає щоденно оновлюваний маніфест українських розрахунків, де заборонено доставку відправлень. Маніфест містить посилання на локалізовані, стиснені за допомогою gzip-файли JSON з детальною інформацією про розрахунки та прапорцями заборони. Файли доступні як українською, так і англійською мовами для підтримки локалізації.
Файли оновлюються щодня о 5:00 UTC.
Основні можливості
Назва
Тип
Обов'язковість
Опис
Authorization
string
Yes
Bearer <token>. Auth token of the client.
Схема:
Назва
Тип
Null-доступ
Опис
id
int
Yes
Унікальний ідентифікатор запису про розрахунки.
name
string
No
Локалізована назва населеного пункту. (наприклад, «місто Авдіївка»). Мінімум 2 символи
country
object
No
Країна, до якої належить поселення. Має бути Україна.
country.code
string
No
2-букви країни ("UA").
country.name
string
No
Назва країни відповідно до локалізації(наприклад Ukraine).
region
object
Yes
Деталі адміністративного поділу регіону.
region.id
number
Yes
Ідентифікатор регіону.
region.name
string
Yes
Назва адміністративного регіону, якому підпорядковується населений пункт.
region.parent
object
Yes
Материнська адміністративна одиниця (область), до якої належить регіон.
region.parent.id
number
Yes
Ідентифікатор батьківського регіону.
region.parent.name
string
Yes
Назва батьківського регіону (наприклад Donetska oblast).
latitude
number
Yes
Географічна широта населеного пункту в десяткових градусах (мін. -90┃макс. 90)
longitude
number
Yes
Географічна довгота населеного пункту в десяткових градусах (мін. -180┃макс. 180)
postCode1
string
Yes
Нижня межа діапазону поштових індексів населеного пункту або єдиний поштовий індекс, якщо існує лише один.
postCode2
string
Yes
Верхня межа поштового індексу; дорівнює postCode1, якщо один індекс.
alternativeNames
array of string
Yes
Масив альтернативних назв (латиницею та кирилицею, з/без «село/село»). Може бути порожнім ([]).
externalId
string
No
Зовнішній ключ.
prohibitedIssuance
boolean
No
Поле prohibitedIssuance вказує, чи заборонено відправлення (доставку) відправлень до цього населеного пункту. Якщо prohibitedIssuance має значення true, доставка відправлень до цього населеного пункту заборонена.
Приклад відповіді:
https://api.novapost.pl/v.1.0/dictionary/settlements/prohibited-issuance
Використовуйте URL-адреси, надані в маніфесті, щоб завантажити найновіші списки поселень для кожної підтримуваної локалізації.
Приклад структури pfgbne JSON '
HTTP-code
Status
Description
200
OK
Запит успішно виконано. Сервер відповів належним чином.
400
Not Found
Повідомлення про помилку: "Дія_не_доступна"
cURL