Коды ответов и ошибок

Коды ответов

Все ответы API содержат параметр response.code:

Код ответа Описание
200 Успешный запрос.
400 Ошибка в запросе.
403 Доступ запрещен.
404 По запросу ничего не найдено.
500 Внутренняя ошибка сервера.
503 Сервис временно не доступен.

Коды ошибок

В случае, если код ответа соответствует некоторой ошибке, ответ от API содержит параметр response.error.code:

Код ошибки Описание
unknownParam Неизвестный параметр. Проверьте, что нет опечаток в названии параметра.
unknownMethod Неизвестный метод API.
incorrectParams Некорректные параметры. Проверьте, что все обязательные параметры переданы и нет опечаток в их названиях.
paramIsRequired Пропущен обязательный параметр. Проверьте, что параметр передан и нет опечаток в названии.
paramIsIncorrect Некорректное значение параметра.
paramIsOutsideSet Значение параметра вне допустимого набора значений
paramLengthIsOutsideRange Значение параметра превышает допустимое количество символов
paramShouldEquals Параметр должен быть равен определенному значению
conflictingParams В запросе присутствуют взаимоисключаемые параметры.
conflictingSomeParams В запросе присутствуют несколько взаимоисключаюх параметра. В сообщении об ошибке будут предложены ссылки на документацию к этим методам.
incorrectEncoding Недопустимая кодировка.
forbidden Доступ к API запрещен для ключа, указанного в запросе.
withoutResult Результаты по запросу не найдены.
uncaught Неизвестная ошибка.
serviceUnavailable Сервис временно недоступен.
internalError Внутренняя ошибка сервера.
paramHasDuplicateValues Значения параметра содержат дубликаты.
langIsNotSuitableForProject Указанный в запросе язык не соответсвует языку искомого региона.
boundIsIncorrect Прямоугольная область поиска задана не верхним левым и правым нижним углом.
startPointIsEqualEndPoint Пункт отправки равен пункту назначения.

Примеры

Найти резиденцию Деда Мороза в Новосибирске.

Запрос:

http://catalog.api.2gis.ru/2.0/catalog/branch/search?q=Мавзолей&region_id=1&key=1234567890

Ответ: