Руководство разработчика
Ресурсы API

Сообщения об ошибках

В случае возникновения ошибки обработка запроса прекращается, сервер возвращает HTTP-статус ответа, отражающий суть произошедшей ошибки. Кроме статуса в ответе передается краткое описание ошибки.

Сообщение об ошибке возвращается в том формате, который указан в URL запроса после имени метода (по умолчанию в формате XML).

Описание ошибок передается в параметре errors.

Описание ошибок

HTTP-статус Текст ошибкиПояснение
200Ok

Запрос выполнен успешно.

400Bad request

Запрос невалидный.

Пример сообщения для формата XML:

<errors>
 <error>Bad request</error>
</errors>

Пример сообщения для формата JSON:

errors:["Bad request"]

401Authorization failed

Ошибка авторизации.

Возможные ошибки:

  • в запросе не указан авторизационный ключ или он невалидный;

  • IP-адрес, с которого был отправлен запрос, отсутствует в списке IP-адресов, указанных при получении авторизационного ключа.

Пример сообщения для формата XML:

<errors>
 <error>Authorization failed</error>
</errors>

Пример сообщения для формата JSON:

errors:["Authorization failed"]

403Rate limit exceeded

Превышено ограничение на доступ к ресурсам.

Пример сообщения для формата XML:

<errors>
  <error>Rate limit exceeded</error>
</errors>

Пример сообщения для формата JSON:

errors:["Rate limit exceeded"]

Forbidden resource

У вас нет доступа к этому ресурсу.

Пример сообщения для формата XML:

<errors>
  <error>Forbidden resource</error>
</errors>

Пример сообщения для формата JSON:

errors:["Forbidden resource"]

404{название_объекта} not found

Указанный в запросе объект не найден.

Пример сообщения для формата XML:

<errors>
 <error>Model not found</error>
</errors>

Пример сообщения для формата JSON:

errors:["Model not found"]

405Request method '{название_метода}' not supported

Используемый метод не поддерживается.

Пример сообщения для формата XML:

<errors>
 <error>Request method 'PUT' not supported</error>
</errors>

Пример сообщения для формата JSON:

errors:["Request method 'PUT' not supported"]

422Required parameter '{название_параметра}' is missing

В запросе отсутствует обязательный параметр.

Пример сообщения для формата XML:

<errors>
 <error>Required parameter 'text' is missing</error>
 <error>Required parameter 'region_id' is missing</error>
</errors>

Пример сообщения для формата JSON:

errors:["Required parameter 'text' is missing","Required parameter 'region_id' is missing"]

422Parameter '{название_параметра}' format is incorrect, expected {название_формата}

Значение параметра, указанного в запросе, не соответствует формату. В тексте ошибки указывается требуемый формат параметра.

Пример сообщения для формата XML:

<errors>
 <error>Parameter 'region_id' format is incorrect, expected number</error>
</errors>

Пример сообщения для формата JSON:

errors:["Parameter 'region_id' format is incorrect, expected number"]

422Value '{переданное_значение}' of parameter '{название_параметра}' is not supported

Значение параметра, указанное в запросе, не поддерживается.

Пример сообщения для формата XML:

<errors>
 <error>Value 'pric' of parameter 'sort_by' is not supported</error>
 <error>Value '15' of parameter 'desc' is not supported</error>
</errors>

Пример сообщения для формата JSON:

errors:["Value 'pric' of parameter 'sort_by' is not supported","Value '15' of parameter 'desc' is not supported"]

Сообщения об ошибках Коды ошибок Ошибки