Параметры негабаритного груза
Общие сведения
Сервис позволяет получить значения весогабаритных характеристик, при которых груз считается негабаритным в зависимости от вида перевозки, на указанную дату.
Параметры негабаритного груза
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v1/oversized_cargo_thresholds.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "serviceKind":"auto", "periodFrom":"2023-09-18T22:11:21" }
Адрес метода: https://api.dellin.ru/v1/oversized_cargo_thresholds.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <serviceKind>auto</serviceKind> <periodFrom>2023-09-18T22:11:21</periodFrom> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Нет | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
serviceKind | Нет | string | Вид перевозки. Доступные значения:
Если параметр не передан, то в ответе выводятся значения для всех видов перевозки |
periodFrom | Нет | string | Дата, на которую требуется получить параметры негабаритного груза. Формат: "ГГГГ-ММ-ДДTЧЧ:ММ:СС" (символ "T" указывается на латинице). Значение по умолчанию: текущая дата |
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2023-09-18 22:11:21" }, "data":[ { "oversizedHeight":2.34, "oversizedLength":5.11, "serviceKind":"auto", "oversizedVolume":2.01, "oversizedWeight":100, "oversizedWidth":2.34 } ] }
<response> <metadata> <status>200</status> <generated_at>2023-09-18 22:11:21</generated_at> </metadata> <data> <oversizedHeight>2.34</oversizedHeight> <oversizedLength>5.11</oversizedLength> <serviceKind>auto</serviceKind> <oversizedVolume>2.01</oversizedVolume> <oversizedWeight>100</oversizedWeight> <oversizedWidth>2.34</oversizedWidth> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK) |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | array of Data | Негабаритные параметры груза |
Data
Data | ||
---|---|---|
Параметр | Тип | Описание |
oversizedHeight | decimal | Негабаритная высота |
oversizedLength | decimal | Негабаритная длина |
serviceKind | string | Вид перевозки. Возможные значения:
|
oversizedVolume | decimal | Негабаритный объем |
oversizedWeight | decimal | Негабаритный вес |
oversizedWidth | decimal | Негабаритная ширина |
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".