Справочники
Общие сведения
Сервис позволяет получить данные справочников.
Запросы методов
Запросы всех методов имеют одинаковую структуру.
Структура запроса
{ "appkey": "00000000-0000-0000-0000-000000000000" }
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> </request>
Описание параметров
Параметр | Обязательный | Тип | Описание |
---|---|---|---|
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
Ответы методов
Ответы следующих методов имеют одинаковую структуру (в ответах методов содержится ссылка для скачивания CSV-файла):
- Справочник дополнительных услуг.
- Характер груза.
- Документы для получения груза.
- Справочник параметров для статистического отчета.
Описания ответов прочих методов приведено в соответствующих разделах.
Структура ответа
{ "hash": "1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4", "url": "https://api.dellin.ru/catalog/[filename].csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434" }
<response> <hash>1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4</hash> <url>https://api.dellin.ru/catalog/[filename].csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434</url> </response>
Описание параметров
Параметр | Тип | Описание |
---|---|---|
hash | string | Хеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет |
url | string | Ссылка на файл с данными справочника в формате csv в кодировке utf-8 (срок действия ссылки – 10 минут). Рекомендуемая частота обновления скачанного файла - раз в месяц. Вместо "[filename]" ссылка содержит наименование, совпадающее с ключевым словом в наименовании соответствующего метода. Разделителем строк в файле является символ "\n", разделителем столбцов – символ ",", а разделителем текста – символ " " ". Описания содержимого файлов приведены в разделах соответствующих методов |
Обработка ошибок
В методах используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".
Справочник дополнительных услуг
Адрес метода:
- JSON: https://api.dellin.ru/v1/public/request_services.json
- XML: https://api.dellin.ru/v1/public/request_services.xml
Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:
- id - уникальный идентификатор услуги;
- uid - уникальный идентификатор для связи с другими справочниками;
- name - наименование услуги.
Характер груза
Адрес метода:
- JSON: https://api.dellin.ru/v1/public/freight_types.json
- XML: https://api.dellin.ru/v1/public/freight_types.xml
Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:
- UID - уникальный идентификатор характера груза;
- description - наименование характера груза.
Документы для получения груза
Адрес метода:
- JSON: https://api.dellin.ru/v1/public/documents_for_receive.json
- XML: https://api.dellin.ru/v1/public/documents_for_receive.xml
Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:
- UID - уникальный идентификатор документа для получения груза;
- name - наименование документа для получения груза;
- day_to_day - признак, определяющий возможность получения груза день в день по данному документу.
Справочник параметров для статистического отчета
Адрес метода:
- JSON: https://api.dellin.ru/v1/public/report_params.json
- XML: https://api.dellin.ru/v1/public/report_params.xml
Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:
- name - наименование параметра (ключ; на латинице);
- caption - название параметра (на кириллице).
Справочник видов загрузки
Адрес метода:
- JSON: https://api.dellin.ru/v1/references/load_types.json
- XML: https://api.dellin.ru/v1/references/load_types.xml
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2015-06-18 12:37:28" }, "data":[ { "uid":"0xb83b7589658a3851440a853325d1bf69", "name":"боковая погрузка", "title":"Боковая загрузка", "incompatible":[ "0xabb9c63c596b08f94c3664c930e77778" ] } ] }
<response> <metadata> <status>200</status> <generated_at>2015-06-18 12:37:28</generated_at> </metadata> <data> <uid>0xb83b7589658a3851440a853325d1bf69</uid> <name>боковая погрузка</name> <title>Боковая загрузка</title> <incompatible>0xabb9c63c596b08f94c3664c930e77778</incompatible> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | array of Data | Сведения о видах загрузки |
data.uid | string | UID вида загрузки |
data.name | string | Полное наименование вида загрузки. Возможные значения:
|
data.title | string | Краткое наименование вида загрузки. Возможные значения:
|
data.incompatible | array of strings | UID видов загрузки, несовместимых с видом, UID которого передан в параметре "data.uid" |
Справочник специальных требований к транспорту
Адрес метода:
- JSON: https://api.dellin.ru/v1/references/services.json
- XML: https://api.dellin.ru/v1/references/services.xml
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2015-06-18 12:37:28" }, "data":[ { "uid":"0x92fce2284f000b0241dad7c2e88b1655", "name":"для погрузки необходим гидроборт", "title":"Гидроборт", "incompatible":[ "0x88f93a2c37f106d94ff9f7ada8efe886" ] } ] }
<response> <metadata> <status>200</status> <generated_at>2015-06-18 12:37:28</generated_at> </metadata> <data> <uid>0x92fce2284f000b0241dad7c2e88b1655</uid> <name>для погрузки необходим гидроборт</name> <title>Гидроборт</title> <incompatible>0x88f93a2c37f106d94ff9f7ada8efe886</incompatible> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | array of Data | Информация о специальном требовании к транспорту |
data.uid | string | UID услуги |
data.name | string | Полное наименование услуги. Возможные значения параметра см. в таблице ниже |
data.title | string | Краткое наименование услуги. Возможные значения параметра см. в таблице ниже |
data.incompatible | array of strings | UID услуг, несовместимых с видом, UID которого передан в параметре "data.uid" |
Значения параметров "response.data.name" и "response.data.title"
data.name | data.title |
---|---|
для погрузки необходим гидроборт | Гидроборт |
для погрузки необходим манипулятор | Манипулятор |
для погрузки необходима открытая машина | Открытая машина |
растентовка | Растентовка |
Справочник видов упаковки (только для методов v1/public/packages_available/ и v1/public/request_conditions)
Адрес метода:
- JSON: https://api.dellin.ru/v1/references/packages.json
- XML: https://api.dellin.ru/v1/references/packages.xml
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2015-06-18 12:37:28" }, "data":[ { "uid":"0x838FC70BAEB49B564426B45B1D216C15", "title":"Деревянная обрешётка", "name":"crate", "countable":"false", "incompatible":[ "0x8783b183e825d40d4eb5c21ef63fbbfb", "0xb9f594d27a2d31b440a647d19547543c" ] } ] }
<response> <metadata> <status>200</status> <generated_at>2015-06-18 12:37:28</generated_at> </metadata> <data> <uid>0x838FC70BAEB49B564426B45B1D216C15</uid> <title>Деревянная обрешётка</title> <name>crate</name> <countable>false</countable> <incompatible>0x8783b183e825d40d4eb5c21ef63fbbfb</incompatible> <incompatible>0xb9f594d27a2d31b440a647d19547543c</incompatible> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | array of Data | Информация о виде упаковки |
data.uid | string | UID |
data.title | string | Наименование типа упаковки на русском языке. Возможные значения параметра см. в таблице ниже |
data.name | string | Условное наименование типа упаковки на английском языке. Возможные значения параметра см. в таблице ниже |
data.countable | boolean | Флаг, обозначающий, что можно заказать несколько единиц упаковки |
data.incompatible | array of strings | UID видов упаковки, несовместимых с видом, UID которого передан в параметре "data.uid" |
Значения параметров "response.data.title" и "response.data.name"
data.title | data.name |
---|---|
Деревянная обрешётка | crate |
Жёсткая короб | crate_plus |
Картонные коробки | box |
Дополнительная упаковка | type |
Деревянная обрешётка + амортизация | crate_with_bubble |
Спец. упаковка для автостекол | protect_auto_glass |
Спец. упаковка для автозапчастей | protect_auto_part |
Палетный борт + амортизация | pallet_with_bubble |
Воздушно-пузырьковая плёнка | buble |
Мешок | bag |
Палетный борт | pallet |
Справочник статусов заказа груза
Адрес метода:
- JSON: https://api.dellin.ru/v1/references/statuses.json
- XML: https://api.dellin.ru/v1/references/statuses.xml
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2015-06-18 12:37:28" }, "data":[ { "status":"processing", "title":"В обработке" } ] }
<response> <metadata> <status>200</status> <generated_at>2015-06-18 12:37:28</generated_at> </metadata> <data> <status>processing</status> <title>В обработке</title> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | array of Data | Информация о статусе заказа |
data.status | string | Статус заказа. Возможные значения параметра см. в таблице ниже |
data.title | string | Наименование статуса заказа на русском языке Возможные значения параметра см. в таблице ниже |
Значения параметров "response.data.status" и "response.data.title"
data.status | data.title | Примечание |
---|---|---|
draft | Черновик | - |
processing | В обработке | - |
pickup | Забор груза от адреса | Передача груза на адресе отправителя |
waiting | Ожидает сдачи на терминал | - |
declined | Отклонен | - |
received | Груз принят к перевозке | - |
received_warehousing | Груз принят к перевозке. Платное хранение | - |
inway | Груз в пути | - |
arrived | Груз прибыл на терминал | - |
warehousing | Груз прибыл на терминал. Платное хранение | - |
arrived_to_airport | Груз прибыл в аэропорт | - |
airport_warehousing | Груз прибыл в аэропорт. Платное хранение | - |
delivery | Доставка груза до адреса | Доставка груза до адреса получателя |
accompanying_documents_return | Груз выдан. Возврат СД | - |
finished | Заказ завершен | - |