API Справочники
Работа со справочниками.
- Виды временных интервалов
- Виды груза
- Виды обратной доставки груза
- Виды паллет
- Виды плательщиков
- Виды плательщиков обратной доставки
- Виды упаковки
- Виды шин и дисков
- Описания груза
- Перечень ошибок
- Технологии доставки
- Типы контрагентов
- Формы оплаты
- Формы собственности
Виды временных интервалов
Метод «getTimeIntervals», работает в модели «Common», этот метод необходим для получения списка временных интервалов (для заказа услуги "Временные интервалы"). Для обновления данных, справочник необходимо загружать один раз в месяц.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Использование API-ключа не требуется.
URL-адрес запроса
Параметры запроса
string
Форматы JSON, XML
(дополнительный)
string
Точка входа для сервисов в формате JSON с форматом ответа JSONP ?callback=?
Заголовки запросов
(дополнительный)
string
Тип формата текста, отправляемого в API.
Текст запроса
Параметр | Тип данных | Описание |
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
methodProperties | string | Свойства метода |
RecipientCityRef* | string[36] | Город для которого будут получены часовые интервалы |
DateTime | string[36] | Дата на которую будут получены часовые интервалы, необязательный параметр, по умолчанию равен текущей дате, формат dd.mm.YYYY |
{
"modelName": "Common",
"calledMethod": "getTimeIntervals",
"methodProperties": {
"RecipientCityRef": "8d5a980d-391c-11dd-90d9-001a92567626",
"DateTime": "18.09.2016"
}
}
<?xml version="1.0" encoding="utf-8"?>
<file>
<modelName>Common</modelName>
<calledMethod>getTimeIntervals</calledMethod>
<methodProperties>
<RecipientCityRef>8d5a980d-391c-11dd-90d9-001a92567626</RecipientCityRef>
<DateTime>18.09.2016</DateTime>
</methodProperties>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Number | int[36] | Идентификатор |
Start | string[36] | Время начала интервала |
End | string[36] | Время окончания интервала |
{
"success":true,
"data":[
{
"Number":"CityDeliveryTimeInterval2",
"Start":"12:00",
"End":"15:00"
},
{
"Number":"CityDeliveryTimeInterval3",
"Start":"15:01",
"End":"18:00"
},
{
"Number":"CityDeliveryTimeInterval4",
"Start":"18:01",
"End":"21:00"
}
],
"errors":[
],
"warnings":[
],
"info":[
]
}
<root>
<success>true</success>
<data>
<item>
<Number>CityDeliveryTimeInterval2</Number>
<Start>12:00</Start>
<End>15:00</End>
</item>
<item>
<Number>CityDeliveryTimeInterval3</Number>
<Start>15:01</Start>
<End>18:00</End>
</item>
<item>
<Number>CityDeliveryTimeInterval4</Number>
<Start>18:01</Start>
<End>21:00</End>
</item>
</data>
<errors />
<warnings />
<info />
</root>