Errors of API methods
General information
The document describes the error format of the API methods. It also contains the list of general errors that may occur when accessing API methods.
Format of errors
Format of response of API methods in case of errors
Response structure
{ "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>
Description of parameters
Response | ||
---|---|---|
Parameter | Type | Description |
metadata | object | Order information |
metadata.status | integer | Emulated http-code of status |
metadata.detail | string | Description of the server response |
metadata.generated_at | string | Date and time of the server respone generation |
errors | array of Response.Errors | List of errors |
Response.Errors | ||
---|---|---|
Parameter | Type | Description |
code | integer | Error number |
title | string | Error title |
detail | string | Error description |
link | string | Link to the document |
fields | array of string | List of parameters in method request that caused the error |
validValues | array of string | List of available parameter values |
badValues | array of string | List of wrong parameter values that were passed |
List of general errors of API methods
Error number | http-code | Error title | Error description | ||
---|---|---|---|---|---|
Title | Translation | Description | Translation | ||
100001 | 415 | Некорректный content-type | Incorrect content-type | Допустимые значения content-type: application/json (стандарт RFC4627) и text/xml (стандарт RFC3023) | Valid content-type values: application/json (standard RFC4627) and text/xml (standard RFC3023) |
100002 | 404 | Метод не найден | Method not found | Проверьте правильность адреса метода | Check if the method address is correct |
100003 | 410 | Метод отключен | Method disabled | Запрошенный метод более не доступен | The requested method is no longer available |
100004 | 403 | Отсутствует доступ к методу | No access to method | Доступ к методу предоставляется по требованию. Для получения доступа обратитесь к персональному менеджеру или в техническую поддержку | Access to the method is available on request. For access please contact your personal manager or technical support |
100005 | 429 | Количество запросов превышено | Number of requests exceeded the limits | Превышена допустимая частота запросов. Для увеличения лимита обратитесь к персональному менеджеру или в техническую поддержку | The allowed request rate has been exceeded. To increase the limit, contact your personal manager or technical support |
100006 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки | Try using the method after a while. If the error persists, contact technical support |
101001 | 401 | Требуется авторизация | Authorization required | Не передан API-ключ | API key is not passed |
101002 | 401 | Требуется авторизация | Authorization required | Передан недействительный API-ключ | The passed API key is invalid |
101003 | 401 | Требуется авторизация | Authorization required | Требуется передать параметр sessionID | The "sessionID" parameter is required |
101004 | 401 | Требуется авторизация | Authorization required | Время жизни сессии истекло | Session expired |
101005 | 401 | Требуется авторизация | Authorization required | Сессия не найдена или создана с другим API-ключом | Session not found or created with another API key |
101006 | 401 | Требуется авторизация | Authorization required | Неверный логин или пароль | Incorrect login or password |
101007 | 401 | Требуется авторизация | Authorization required | API-ключ заблокирован. Обратитесь в техническую поддержку | API key is blocked. Contact technical support |
101008 | 401 | Ошибка парсинга | Parsing error | Запрос не соответствует формату json | Request does not match the json format |
101009 | 401 | Ошибка парсинга | Parsing error | Запрос не соответствует формату xml | Request does not match the xml format |
110001 | 400 | Неверный формат параметра | Invalid parameter format | Значение, переданное в параметре, не соответствует требуемому формату | Parameter value does not match the required format |
110002 | 400 | Ошибка типизации | Invalid type | Значение, переданное в параметре, имеет некорректный тип | Parameter value has incorrect type |
110003 | 400 | Отсутствует обязательный параметр | Required parameter is missing | Отсутствует обязательный параметр | Required parameter is missing |
110004 | 400 | Не передан ни один из обязательных параметров | All required parameter are missing | В запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одного | Request must contain at least one of the required parameters, but contains none of them |
110005 | 400 | Допустима передача только одного из параметров | Only one of the parameters is allowed | Указаны взаимоисключающие параметры, только один из которых может присутствовать в запросе | Mutually exclusive parameters are passed. Request must contain just one of them |
110006 | 400 | Превышено ограничение на длину списка | Exceeded list length limit | Количество элементов в списке превышает максимально допустимое | Number of items in the list exceeds the maximum allowed |
110007 | 400 | Объект не существует | Object does not exist | Не найден объект с указанным ID. Проверьте правильность переданного значения | The object with the indicated ID is not found. Check if the passed value is correct |
110008 | 400 | Недопустимый набор параметров | Invalid parameters set | Указанные параметры не должны участвовать в запросе | The specified parameters should not be present in the request |
120001 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomers не отвечает) | Try using the method after a while. If the error persists, contact technical support (Reason: The calculateCustomers service is not responding) |
120002 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomers вернул неизвестную ошибку) | Try using the method after a while. If the error persists, contact technical support (Reason: The calculateCustomers service returned an unknown error) |
120101 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomersV2 не отвечает) | Try using the method after a while. If the error persists, contact technical support (Reason: The calculateCustomersV2 service is not responding) |
120102 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomersV2 вернул неизвестную ошибку) | Try using the method after a while. If the error persists, contact technical support (Reason: The calculateCustomersV2 service returned an unknown error) |
120201 | 400 | Ошибка в параметрах запроса | Invalid request parameters | Переданы неправильные параметры в запрос (Причина: Переданы некорректные данные в getOrdersTracker) | Request contains invalid parameters (Reason: Invalid data passed to getOrdersTracker) |
120301 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис getPaymentsByOrders не отвечает) | Try using the method after a while. If the error persists, contact technical support (Reason: The getPaymentsByOrders service is not responding) |
121001 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки | Try using the method after a while. If the error persists, contact technical support |
121002 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки | Try using the method after a while. If the error persists, contact technical support |
130001 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки | Try using the method after a while. If the error persists, contact technical support |
130002 | 400 | Ошибка выполнения запроса | Request completed with an error | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
130003 | 400 | Указан некорректный документ, удостоверяющий личность | Invalid ID value | Проверьте правильность переданных значений | Verify that the passed values are correct |
130004 | 400 | Не передан ни один из обязательных параметров | All required parameter are missing | В запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одного | Request must contain at least one of the required parameters, but contains none of them |
130005 | 400 | Отсутствует обязательный параметр | Required parameter is missing | Отсутствует обязательный параметр | Required parameter is missing |
130006 | 400 | Значение превышает допустимое | Value exceeds the allowed maximum | Габариты превышают допустимые размеры | The dimensions exceed the maximum allowed sizes |
130007 | 400 | Неверный формат параметра | Invalid parameter format | Значение, переданное в параметре, не соответствует требуемому формату | Parameter value does not match the required format |
130008 | 400 | Недопустимое значение параметра | Invalid parameter value | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
130009 | 400 | Превышено ограничение на длину значения | The value exceeds the maximum allowed length | Превышена максимально допустимая длина значения поля | The value exceeds the maximum allowed field length |
130010 | 400 | Отсутствует согласие с тарифами и правилами перевозки | The pricing policy and the shipping rules were not accepted | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
130014 | 400 | Ошибка наложенного платежа | Cash on delivery error | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
130015 | 400 | Ошибка оформления услуги | Service ordering error | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
130017 | 400 | Невозможно оформить заявку на указанное время | The order can not be placed for the specified time | - | - |
130021 | 400 | Услуга недоступна | The service is not available | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
130022 | 400 | Указан некорректный адрес | Invalid address | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
130023 | 400 | Выбран недопустимый терминал | Inappropriate terminal selected | Выбран недопустимый терминал | Inappropriate terminal selected |
130024 | 400 | Превышено ограничение на длину списка | The list length limit exceeded | Превышено максимальное количество контрагентов в адресной книге (10000). Необходимо удалить часть записей или обратиться в службу поддержки | The maximum allowed number of counterparties in the address book (10000) is exceeded. Please delete unnecessary entries or contact the technical support |
150001 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки | Try using the method after a while. If the error persists, contact technical support |
150002 | 500 | Внутренняя ошибка сервера | Internal server error | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки | Try using the method after a while. If the error persists, contact technical support |
180001 | 400 | Указан некорректный документ, удостоверяющий личность | Invalid ID value | Проверьте правильность переданных значений | Verify that the passed values are correct |
180002 | 400 | Указан некорректный адрес | Invalid address | Указан некорректный адрес | Invalid address |
180003 | 400 | Выбран недопустимый терминал | Wrong terminal selected | Выбранный терминал не может принять груз с указанными ВГХ | The selected terminal cannot accept the cargo with the indicated weight and dimensions |
180004 | 400 | Услуга недоступна | The service is not available | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180005 | 400 | Значение превышает допустимое | Value exceeds the allowed maximum | Весогабаритные характеристики груза превышают допустимые для приёма на терминалах города | Weight and dimensions of the cargo exceed the maximum values allowable for the terminals of the city |
180006 | 400 | Ошибка в параметрах запроса | Invalid request parameters | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180007 | 400 | Недопустимое значение параметра | Invalid parameter value | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180008 | 400 | Ошибка упрощенной отправки | Simplified dispatch error | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180009 | 400 | Ошибка оформления услуги Доставка в день заказа | Same day delivery error | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180010 | 400 | Ошибка оформления услуги Доставка в точное время | Exact time delivery error | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180011 | 400 | Указан некорректный период работы | Invalid work hours indicated | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180012 | 400 | Выбранная дата недоступна | The selected date is not available | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180013 | 400 | Ошибка параметров оплаты | Payment parameters error | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180014 | 400 | Ошибка наложенного платежа | Cash on delivery payment error | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180015 | 400 | Ошибка оформления услуги | Service ordering error | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180016 | 400 | Ошибка при сохранении заявки | Order saving error | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |
180017 | 400 | Невозможно оформить заявку на указанное время | Order can not be placed on time specified | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра | The error description contains the additional information. The text varies depending on the parameter verified |