Ошибки методов API
Общие сведения
В документе описан формат ошибок методов API, а также приведен перечень общих ошибок, которые могут возникать при обращении к методам API.
Формат ошибок
Формат ответа методов API в случае ошибок
Структура ответа
{ "metadata":{ "status":400, "detail":"abc", "generated_at":"2015-06-18 12:37:28" }, "errors":[ { "code":281016, "title":"ошибка упрощённой отправки", "detail":"контрагент с минимальным набором данных не может быть отправителем по заказу", "link":"https://dev.dellin.ru/api/ordering/request/#error_281016", "fields":["receiver"] }, { "code":281017, "title":"Недопустимое значение параметра", "detail":"Данный параметр может содержать только значения из списка доступных значений", "link":"https://dev.dellin.ru/api/ordering/request/#error_281017", "fields":["requester"], "validValues":[1, 2, 3] }, { "code":117004, "title":"значение не найдено в справочнике", "detail":"необходимо выбрать значение из соответствующего справочника", "link":"https://dev.dellin.ru/calculation/pickup/#error_117004", "fields":["requester"], "badValues":["0xa77fcf6a449164ed490133777a68bd00"] } ] }
<response> <metadata> <status>400</status> <detail>abc</detail> <generated_at>2015-06-18 12:37:28</generated_at> </metadata> <errors> <code>281016</code> <title>ошибка упрощённой отправки</title> <detail>контрагент с минимальным набором данных не может быть отправителем по заказу</detail> <link>https://dev.dellin.ru/api/ordering/request/#error_281016</link> <fields>receiver</fields> </errors> <errors> <code>281017</code> <title>Недопустимое значение параметра</title> <detail>Данный параметр может содержать только значения из списка доступных значений</detail> <link>https://dev.dellin.ru/api/ordering/request/#error_281017</link> <fields>requester</fields> <validValues>1</validValues> <validValues>2</validValues> <validValues>3</validValues> </errors> <errors> <code>117004</code> <title>значение не найдено в справочнике</title> <detail>необходимо выбрать значение из соответствующего справочника</detail> <link>https://dev.dellin.ru/calculation/pickup/#error_117004</link> <fields>requester</fields> <badValues>0xa77fcf6a449164ed490133777a68bd00</badValues> </errors> </response>
Описание параметров
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Информация об оформленной заявке |
metadata.status | integer | Эмуляция http-кода состояния |
metadata.detail | string | Текстовое описание ответа сервера |
metadata.generated_at | string | Дата и время генерации ответа сервера |
errors | array of Response.Errors | Перечень ошибок |
Response.Errors | ||
---|---|---|
Параметр | Тип | Описание |
code | integer | Номер ошибки |
title | string | Краткое описание ошибки |
detail | string | Детальное описание ошибки |
link | string | Ссылка на документацию |
fields | array of string | Список параметров в запросе к методу, вызвавших ошибку |
validValues | array of string | Список доступных значений параметра |
badValues | array of string | Список ошибочных значений, переданных в параметре |
Описание общих ошибок API
Номер ошибки | http-код | Краткое описание ошибки | Детальное описание ошибки |
---|---|---|---|
100001 | 415 | Некорректный content-type | Допустимые значения content-type: application/json (стандарт RFC4627) и text/xml (стандарт RFC3023) |
100002 | 404 | Метод не найден | Проверьте правильность адреса метода |
100003 | 410 | Метод отключен | Запрошенный метод более не доступен |
100004 | 403 | Отсутствует доступ к методу | Доступ к методу предоставляется по требованию. Для получения доступа обратитесь к персональному менеджеру или в техническую поддержку |
100005 | 429 | Количество запросов к превышено | Превышена допустимая частота запросов. Для увеличения лимита обратитесь к персональному менеджеру или в техническую поддержку |
100006 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
101001 | 401 | Требуется авторизация | Не передан API-ключ |
101002 | 401 | Требуется авторизация | Передан недействительный API-ключ |
101003 | 401 | Требуется авторизация | Требуется передать параметр sessionID |
101004 | 401 | Требуется авторизация | Время жизни сессии истекло |
101005 | 401 | Требуется авторизация | Сессия не найдена или создана с другим API-ключом |
101006 | 401 | Требуется авторизация | Неверный логин или пароль |
101007 | 401 | Требуется авторизация | API-ключ заблокирован. Обратитесь в техническую поддержку |
101008 | 401 | Ошибка парсинга | Запрос не соответствует формату json |
101009 | 401 | Ошибка парсинга | Запрос не соответствует формату xml |
110001 | 400 | Неверный формат параметра | Значение, переданное в параметре, не соответствует требуемому формату |
110002 | 400 | Ошибка типизации | Значение, переданное в параметре, имеет некорректный тип |
110003 | 400 | Отсутствует обязательный параметр | Отсутствует обязательный параметр |
110004 | 400 | Не передан ни один из обязательных параметров | В запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одного |
110005 | 400 | Допустима передача только одного из параметров | Указаны взаимоисключающие параметры, только один из которых может присутствовать в запросе |
110006 | 400 | Превышено ограничение на длину списка | Количество элементов в списке превышает максимально допустимое |
110007 | 400 | Объект не существует | Не найден объект с указанным ID. Проверьте правильность переданного значения |
110008 | 400 | Недопустимый набор параметров | Указанные параметры не должны участвовать в запросе |
120001 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomers не отвечает) |
120002 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomers вернул неизвестную ошибку) |
120101 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomersV2 не отвечает) |
120102 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomersV2 вернул неизвестную ошибку) |
120201 | 400 | Ошибка в параметрах запроса | Переданы неправильные параметры в запрос (Причина: Переданы некорректные данные в getOrdersTracker) |
120301 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис getPaymentsByOrders не отвечает) |
121001 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
121002 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
130001 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
130002 | 400 | Ошибка выполнения запроса | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130003 | 400 | Указан некорректный документ, удостоверяющий личность | Проверьте правильность переданных значений |
130004 | 400 | Не передан ни один из обязательных параметров | В запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одного |
130005 | 400 | Отсутствует обязательный параметр | Отсутствует обязательный параметр |
130006 | 400 | Значение превышает допустимое | Габариты превышают допустимые размеры |
130007 | 400 | Неверный формат параметра | Значение, переданное в параметре, не соответствует требуемому формату |
130008 | 400 | Недопустимое значение параметра | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130009 | 400 | Превышено ограничение на длину значения | Превышена максимально допустимая длина значения поля |
130010 | 400 | Отсутствует согласие с тарифами и правилами перевозки | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130014 | 400 | Ошибка наложенного платежа | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130015 | 400 | Ошибка оформления услуги | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130017 | 400 | Невозможно оформить заявку на указанное время | - |
130021 | 400 | Услуга недоступна | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130022 | 400 | Указан некорректный адрес | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130023 | 400 | Выбран недопустимый терминал | Выбран недопустимый терминал |
130024 | 400 | Превышено ограничение на длину списка | Превышено максимальное количество контрагентов в адресной книге (10000). Необходимо удалить часть записей или обратиться в службу поддержки |
150001 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
150002 | 500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
180001 | 400 | Указан некорректный документ, удостоверяющий личность | Проверьте правильность переданных значений |
180002 | 400 | Указан некорректный адрес | Указан некорректный адрес |
180003 | 400 | Выбран недопустимый терминал | Выбранный терминал не может принять груз с указанными ВГХ |
180004 | 400 | Услуга недоступна | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180005 | 400 | Значение превышает допустимое | Весогабаритные характеристики груза превышают допустимые для приёма на терминалах города |
180006 | 400 | Ошибка в параметрах запроса | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180007 | 400 | Недопустимое значение параметра | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180008 | 400 | Ошибка упрощенной отправки | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180009 | 400 | Ошибка оформления услуги Доставка в день заказа | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180010 | 400 | Ошибка оформления услуги Доставка в точное время | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180011 | 400 | Указан некорректный период работы | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180012 | 400 | Выбранная дата недоступна | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180013 | 400 | Ошибка параметров оплаты | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180014 | 400 | Ошибка наложенного платежа | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180015 | 400 | Ошибка оформления услуги | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180016 | 400 | Ошибка при сохранении заявки | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180017 | 400 | Невозможно оформить заявку на указанное время | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |