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

API
Главная / API - Ошибки методов API

Ошибки методов API

Обновлено 24.09.2020
110 кб

Общие сведения

В документе описан формат ошибок методов 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
ПараметрТипОписание
metadataobjectИнформация об оформленной заявке
metadata.statusinteger

Эмуляция http-кода состояния

metadata.detailstringТекстовое описание ответа сервера
metadata.generated_atstringДата и время генерации ответа сервера
errorsarray of Response.ErrorsПеречень ошибок

Response.Errors
ПараметрТипОписание
codeintegerНомер ошибки
titlestring

Краткое описание ошибки

detailstringДетальное описание ошибки
linkstringСсылка на документацию
fieldsarray of stringСписок параметров в запросе к методу, вызвавших ошибку
validValuesarray of stringСписок доступных значений параметра
badValuesarray 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Внутренняя ошибка сервераПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки

120002

500Внутренняя ошибка сервераПопробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки

120201

400Ошибка в параметрах запросаПереданы неправильные параметры в запрос

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Ошибка наложенного платежаДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра

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Ошибка параметров оплатыДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра

180015

400Ошибка оформления услугиДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра

180016

400Ошибка при сохранении заявкиДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра

180017

400Невозможно оформить заявку на указанное времяДетальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра