REST API Коды ошибок: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
 
(не показано 8 промежуточных версий этого же участника)
Строка 11: Строка 11:
{
{
Result string
Result string
'''Code''' integer($int32)
Code integer($int32)
Error string
Error string
}
}
</source>
</source>
Где '''code''' – целое число ошибки.
Где code целое число ошибки.
 
Без классификации
== Ошибки без классификации ==
·        0 Неизвестная ошибка
*0 Неизвестная ошибка
·        1 Неверный токен
*1 Неверный токен
·        2 Токен не активен
*2 Токен не активен
·        5 Доступ к данному методу для scoup запрещен
*5 Доступ к данному методу для scoup запрещен
  6 Доступ к данному методу/объекту для пользователя запрещен
*6 Доступ к данному методу/объекту для пользователя запрещен
·        10 Аккаунт заблокирован за спам
*10 Аккаунт заблокирован за спам
·        11 - Аккаунт заморожен
*11 Аккаунт заморожен
·        16 - Пользователь неактивен
*16 Пользователь неактивен
·        20 - Подписка не оплачена
*20 Подписка не оплачена
·        21 - Использование API недоступно для бесплатного аккаунта
*21 Использование API недоступно для бесплатного аккаунта
·        30 Неверный формат JSON
*22 — Исчерпан суточный лимит количества запросов к REAT API
·        41 - Недопустимое значение параметра
*23 — Достигнут лимит аккаунта по количеству контактов
Контакты
*30 Неверный формат JSON
·        2000 - Контакт не существует
*40 — Отсутствует один из обязательных параметров метода
·        2001 - Ошибка добавления контакта
*41 Недопустимое значение параметра
·        2002 - Ошибка обновления данных
 
·        2003 При попытке разрешения доступа в Планфикс, у контакта не установлен E-mail
== Задачи ==
·        2004 Неверный формат E-mail
*1000 — Задача не существует
·        2005 - E-mail, указанный для логина, не уникален
*1001  — Ошибка добавления задачи
*1002 — Ошибка обновления задачи
 
== Контакты ==
*2000 Контакт не существует
*2001 Ошибка добавления контакта
*2002 Ошибка обновления данных
*2003 При попытке разрешения доступа в ПланФикс, у контакта не установлен e-mail
*2004 Неверный формат e-mail
*2005 — e-mail, указанный для логина, не уникален
*2006 — ФИО контакта не заполнено
 
== Проекты ==
*3000 — Проект не существует
*3001 — Ошибка добавления проекта
*3002 — Ошибка обновления проекта
 
== Сотрудники ==
*4000 — Сотрудник не существует
*4001 — Ошибка добавления сотрудника
*4002 — Ошибка обновления данных сотрудника
*4003 — Указанный e-mail не уникален
*4004 — Неверный формат username
*4005 — Указанный username не уникален
*4006 — ФИО сотрудника не заполнено
 
== Комментарии ==
*5000 — Комментарий не существует
*5001 — Ошибка добавления комментария
*5002 — Ошибка обновления данных комментария
 
== Аналитики и записи аналитик ==
*6000 — Аналитика не существует
*6010 — Запись аналитики не существует
*6011 — Ошибка добавления записи аналитики
*6012 — Ошибка обновления записи аналитики
*6013 — Ошибка удаления записи аналитики
 
== Файлы ==
*7000 — Файл не существует
*7001 — Ошибка добавления файла
*7002 — Превышен размер загружаемого файла в рамках подписки
*7003 — Ошибка удаления файла
 
== Справочники и записи справочников ==
*8000 — Справочник не существует
*8010 — Запись справочника не существует
*8011 — Ошибка добавления записи справочника
*8012 — Ошибка обновления записи справочника
*8013 — Ошибка удаления записи справочника
 
== Отчеты ==
*9000 — Отчет не существует
 
 
== Перейти ==
*[[REST API]]

Текущая версия от 15:23, 26 сентября 2023

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

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

Где code — целое число ошибки.

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

  • 0 — Неизвестная ошибка
  • 1 — Неверный токен
  • 2 — Токен не активен
  • 5 — Доступ к данному методу для scoup запрещен
  • 6 — Доступ к данному методу/объекту для пользователя запрещен
  • 10 — Аккаунт заблокирован за спам
  • 11 — Аккаунт заморожен
  • 16 — Пользователь неактивен
  • 20 — Подписка не оплачена
  • 21 — Использование API недоступно для бесплатного аккаунта
  • 22 — Исчерпан суточный лимит количества запросов к REAT API
  • 23 — Достигнут лимит аккаунта по количеству контактов
  • 30 — Неверный формат JSON
  • 40 — Отсутствует один из обязательных параметров метода
  • 41 — Недопустимое значение параметра

Задачи

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

Контакты

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

Проекты

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

Сотрудники

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

Комментарии

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

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

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

Файлы

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

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

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

Отчеты

  • 9000 — Отчет не существует


Перейти