Поиск по сайту

API
Главная / API - Errors of API methods

Errors of API methods

Обновлено 14.01.2019
98 кб

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.

The given format of errors is currently used only for the "/v2/customers/request" method.

Format of errors

Format of response of API methods in case of errors

Response example

{  
   "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
ParameterTypeDescription
metadataobjectOrder information
metadata.statusinteger

Emulated http-code of status

metadata.detailstring

Description of the server response

metadata.generated_atstring

Date and time of the server respone generation

errorsarray of Response.ErrorsList of errors

Response.Errors
ParameterTypeDescription
codeintegerError number
titlestring

Error title

detailstringError description
linkstringLink to the document
fieldsarray of string

List of parameters in method request that caused the error

validValuesarray of stringList of available parameter values
badValuesarray of string

List of wrong parameter values that were passed

List of general errors of API methods

Error numberhttp-codeError titleError description
TitleTranslationDescriptionTranslation
100001415Некорректный content-typeIncorrect content-typeДопустимые значения content-type: application/json (стандарт RFC4627) и text/xml (стандарт RFC3023)Valid content-type values: application/json (standard RFC4627) and text/xml (standard RFC3023)
100002404Метод не найденMethod not foundПроверьте правильность адреса методаCheck if the method address is correct
100003410Метод отключенMethod disabledЗапрошенный метод более не доступенThe requested method is no longer available
100004403Отсутствует доступ к методуNo access to methodДоступ к методу предоставляется по требованию. Для получения доступа обратитесь к персональному менеджеру или в техническую поддержкуAccess to the method is available on request. For access please contact your personal manager or technical support
100005429Количество запросов к методу превышеноNumber of requests to the method exceededПревышена допустимая частота запросов. Для увеличения лимита обратитесь к персональному менеджеру или в техническую поддержкуThe allowed request rate has been exceeded. To increase the limit, contact your personal manager or technical support
100006500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
101001401Ошибка авторизации

Authorization error

Не передан API-ключAPI key is not passed
101002401Ошибка авторизацииAuthorization errorПередан недействительный API-ключThe passed API key is invalid
101003401Ошибка авторизацииAuthorization errorТребуется передать параметр sessionIDThe "sessionID" parameter is required
101004401Ошибка авторизацииAuthorization errorВремя жизни сессии истеклоSession expired
101005401Ошибка авторизацииAuthorization errorСессия не найдена или создана с другим API-ключомSession not found or created with another API key
101006401Ошибка авторизацииAuthorization errorНеверный логин или парольIncorrect login or password
101007401Ошибка авторизацииAuthorization errorAPI-ключ заблокирован. Обратитесь в техническую поддержкуAPI key is blocked. Contact technical support
101008401Невалидный запросInvalid requestЗапрос не соответствует формату jsonRequest does not match the json format
101009401Невалидный запросInvalid requestЗапрос не соответствует формату xmlRequest does not match the xml format
110001400Неверный формат параметраIncorrect parameter formatЗначение, переданное в параметре, не соответствует требуемому форматуParameter value does not match the required format
110002400Ошибка типизацииIncorrect typeЗначение, переданное в параметре, имеет некорректный типParameter value has incorrect type
110003400Отсутствует обязательный параметрRequired parameter is missingОтсутствует обязательный параметрRequired parameter is missing
110004400Не передан ни один из обязательных параметровAll required parameter are missingВ запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одногоRequest must contain at least one of the required parameters, but contains none of them
110005400Допустима передача только одного из параметровOnly one of the parameters is allowedУказаны взаимоисключающие параметры, только один из которых может присутствовать в запросеMutually exclusive parameters are passed. Request must contain just one of them
110006400Превышено ограничение на длину спискаExceeded list length limitКоличество элементов в списке превышает максимально допустимоеNumber of items in the list exceeds the maximum allowed
120001500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
120002500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
120101500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
120102500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
120201400Ошибка в параметрах запросаError in request parametersПереданы неправильные параметры в запросRequest contains incorrect parameters
130001500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
130002500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
150001500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
150002500Внутренняя ошибка сервераInternal server errorПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержкиTry using the method after a while. If the error persists, contact technical support
180001400id отсутствует в адресной книгеID is not in the address bookУказанный в запросе id не найден в адресной книге. Проверьте правильность переданного значенияID passed in the request is not found in the address book. Check if the passed value is correct