REST API: Коды ошибок

Материал из Planfix

Если при выполнении запроса произошла ошибка, сервер отвечает в следующем формате:

{
	Result	string.
	Code	integer($int32).
	Error	string.
}

Где code — целое число ошибки, а не HTTP-статус ответа.

Ошибки без классификации

  • 0 — Неизвестная ошибка
  • 1 — Неверный токен
  • 2 — Токен не активен
  • 3 — Объект находится в процессе изменения
  • 4 — Срок действия OAuth-токена доступа истек. Получите новый токен с помощью refresh_token.
  • 5 — Доступ к данному методу для scope запрещен.
  • 6 — Доступ к данному методу/объекту для пользователя запрещен
  • 10 — Аккаунт заблокирован за спам
  • 11 — Аккаунт заморожен
  • 16 — Сотрудник, от имени которого выполняется запрос, неактивен.
  • 20 — Подписка не оплачена
  • 21 — Использование API недоступно для бесплатного аккаунта
  • 22 — Превышен допустимый лимит запросов или операций. Подробности указаны в поле error.
  • 23 — Достигнут лимит аккаунта по количеству контактов
  • 24 — Достигнут лимит аккаунта по количеству сотрудников
  • 25 — Достигнут общий лимит аккаунта
  • 30 — Неверный формат JSON
  • 40 — Отсутствует один из обязательных параметров метода
  • 41 — Недопустимое значение параметра
  • 43 — Значение заголовка Idempotency-Key уже использовано для запроса с этим токеном в данном аккаунте.

Задачи

  • 1000 — Задача не существует
  • 1001 — Ошибка добавления задачи
  • 1002 — Ошибка обновления задачи
  • 1003 — Ошибка удаления задачи

Контакты

  • 2000 — Контакт не существует
  • 2001 — Ошибка добавления контакта
  • 2002 — Ошибка обновления данных контакта.
  • 2003 — При попытке разрешения доступа в ПланФикс, у контакта не установлен e-mail
  • 2004 — Неверный формат e-mail
  • 2005 — e-mail, указанный для логина, не уникален
  • 2006 — ФИО контакта не заполнено
  • 2007 — e-mail контакта уже присутствует в массиве дополнительных e-mail
  • 2008 — Ошибка удаления контакта.

Проекты

  • 3000 — Проект не существует
  • 3001 — Ошибка добавления проекта
  • 3002 — Ошибка обновления проекта
  • 3003 — Ошибка удаления проекта

Сотрудники

  • 4000 — Сотрудник не существует
  • 4001 — Ошибка добавления сотрудника
  • 4002 — Ошибка обновления данных сотрудника
  • 4003 — Указанный e-mail не уникален
  • 4004 — Неверный формат username
  • 4005 — Указанный username не уникален
  • 4006 — ФИО сотрудника не заполнено
  • 4007 — Ошибка удаления сотрудника
  • 401 — Ошибка обновления группы сотрудников
  • 402 — Ошибка обновления должности сотрудника
  • 403 — Ошибка обновления телефона сотрудника
  • 404 — Должность не существует

Комментарии

  • 5000 — Комментарий не существует
  • 5001 — Ошибка добавления комментария
  • 5002 — Ошибка обновления данных комментария

Пользовательские поля и наборы полей

  • 501 — Ошибка добавления пользовательского поля
  • 502 — Ошибка добавления набора пользовательских полей
  • 503 — Ошибка обновления пользовательского поля
  • 504 — Ошибка удаления пользовательского поля

Чек-листы

  • 600 — Пункт чек-листа не существует
  • 601 — Ошибка добавления пункта чек-листа
  • 602 — Ошибка обновления пункта чек-листа
  • 603 — Ошибка удаления пункта чек-листа

Аналитики и записи аналитик

  • 6000 — Аналитика не существует
  • 6010 — Запись аналитики не существует
  • 6011 — Ошибка добавления записи аналитики
  • 6012 — Ошибка обновления записи аналитики
  • 6013 — Ошибка удаления записи аналитики

Файлы

  • 7000 — Файл не существует
  • 7001 — Ошибка добавления файла
  • 7002 — Превышен размер загружаемого файла в рамках подписки
  • 7003 — Ошибка удаления файла

Справочники и записи справочников

  • 8000 — Справочник не существует
  • 8001 — Ошибка добавления справочника
  • 8010 — Запись справочника не существует
  • 8011 — Ошибка добавления записи справочника
  • 8012 — Ошибка обновления записи справочника
  • 8013 — Ошибка удаления записи справочника
  • 8014 — Ошибка добавления группы записей справочника

Отчеты

  • 9000 — Отчет не существует
  • 9001 — Формирование отчета через REST API недоступно на тарифе аккаунта
  • 9002 — Отчет уже находится в процессе формирования
  • 9003 — Идентификатор запроса не существует
  • 9004 — Превышен лимит частоты запросов на формирование отчета
  • 9005 — Сохраненная версия отчета не существует

Перейти