Коды ошибок XML API v1: различия между версиями
Материал из Planfix
Seva (обсуждение | вклад) Нет описания правки |
Seva (обсуждение | вклад) Нет описания правки |
||
(не показано 12 промежуточных версий 4 участников) | |||
Строка 5: | Строка 5: | ||
|description=Коды ошибок api | |description=Коды ошибок api | ||
}} | }} | ||
Если при выполнении запроса произошла ошибка, сервер отвечает в следующем формате: | Если при выполнении запроса произошла ошибка, сервер отвечает в следующем формате: | ||
Строка 30: | Строка 29: | ||
* 0005 - Ключ сессии недействителен (время жизни сессии истекло) | * 0005 - Ключ сессии недействителен (время жизни сессии истекло) | ||
* 0006 - Неверная подпись | * 0006 - Неверная подпись | ||
* 0007 - Превышен лимит использования ресурсов ( | * 0007 - Превышен лимит использования ресурсов (превышено максимальное количество запросов в сутки) | ||
* 0008 - Неизвестное имя функции | * 0008 - Неизвестное имя функции | ||
* 0009 - Отсутствует один из обязательных параметров функции | * 0009 - Отсутствует один из обязательных параметров функции | ||
* 0010 - Аккаунт заморожен | * 0010 - Аккаунт заморожен | ||
* 0011 - На площадке аккаунта производится обновление программного обеспечения | * 0011 - На площадке аккаунта производится обновление программного обеспечения | ||
* 0012 - | * 0012 - Ошибка авторизации: при авторизаци по логину и паролю - отсутствует сессия, не передан параметр сессии в запрос; при авторизации по токену - переданный токен не существует | ||
* 0013 - Неопределенный пользователь | * 0013 - Неопределенный пользователь | ||
* 0014 - Пользователь неактивен | * 0014 - Пользователь неактивен | ||
Строка 48: | Строка 47: | ||
* 0023 - Запрошенное действие невозможно в рамках текущего тарифного плана аккаунта | * 0023 - Запрошенное действие невозможно в рамках текущего тарифного плана аккаунта | ||
* 0024 - Аккаунт расположен в другом датацентре, проверьте [https://planfix.ru/docs/Введение#.D0.94.D0.BE.D1.81.D1.82.D1.83.D0.BF_.D0.BA_.D0.B8.D0.BD.D1.82.D0.B5.D1.80.D1.84.D0.B5.D0.B9.D1.81.D0.B0.D0.BC| url запроса] | * 0024 - Аккаунт расположен в другом датацентре, проверьте [https://planfix.ru/docs/Введение#.D0.94.D0.BE.D1.81.D1.82.D1.83.D0.BF_.D0.BA_.D0.B8.D0.BD.D1.82.D0.B5.D1.80.D1.84.D0.B5.D0.B9.D1.81.D0.B0.D0.BC| url запроса] | ||
* 0025 - API Key не совпадает с API Key этого аккаунта | |||
* 0101 - Запрошенный объект не существует | |||
* 0102 - Ошибка добавления | |||
* 0103 - Ошибка обновления | |||
* 0104 - Доступ к данным запрещен | |||
* 0105 - Нет права на редактирование объекта | |||
=== Аутентификация === | === Аутентификация === | ||
* 1001 - Неверный логин или пароль | * 1001 - Неверный логин или пароль | ||
* 1002 - На выполнение данного запроса отсутствуют права (привилегии) | * 1002 - На выполнение данного запроса отсутствуют права (привилегии) | ||
* 1005 - Включена [[двухфакторная аутентификация]] - авторизация возможна только [[ПланФикс API: Авторизация по токену | по токену]] | |||
== Проект == | == Проект == | ||
Строка 59: | Строка 66: | ||
== Задача == | == Задача == | ||
* 3001 - Указанная задача не существует | * 3001 - Указанная задача (или другой запрашиваемый объект) не существует | ||
* 3002 - Нет доступа к над задаче | * 3002 - Нет доступа к над задаче | ||
* 3003 - Проект, в рамках которого создается задача, не существует | * 3003 - Проект, в рамках которого создается задача, не существует | ||
Строка 121: | Строка 128: | ||
* 8008 - Попытка установки пароля для контакта, не активировавшего доступ в ПланФикс | * 8008 - Попытка установки пароля для контакта, не активировавшего доступ в ПланФикс | ||
* 8009 - Ошибка обновления данных для входа в систему | * 8009 - Ошибка обновления данных для входа в систему | ||
* 8010 - Указан некорректный e-mail адрес | |||
== Файл == | == Файл == | ||
Строка 139: | Строка 147: | ||
* 10004 - Переданный параметр справочника аналитики не существует | * 10004 - Переданный параметр справочника аналитики не существует | ||
== Перейти == | == Перейти == |
Текущая версия от 05:54, 23 октября 2023
Если при выполнении запроса произошла ошибка, сервер отвечает в следующем формате:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
code | string(4) | 4-х значное число, может начинаться с нуля, код ошибки. |
Без классификации
- 0001 - Неверный API Key
- 0002 - Приложение заблокировано
- 0003 - Ошибка XML разбора. Некорректный XML
- 0004 - Неизвестный аккаунт
- 0005 - Ключ сессии недействителен (время жизни сессии истекло)
- 0006 - Неверная подпись
- 0007 - Превышен лимит использования ресурсов (превышено максимальное количество запросов в сутки)
- 0008 - Неизвестное имя функции
- 0009 - Отсутствует один из обязательных параметров функции
- 0010 - Аккаунт заморожен
- 0011 - На площадке аккаунта производится обновление программного обеспечения
- 0012 - Ошибка авторизации: при авторизаци по логину и паролю - отсутствует сессия, не передан параметр сессии в запрос; при авторизации по токену - переданный токен не существует
- 0013 - Неопределенный пользователь
- 0014 - Пользователь неактивен
- 0015 - Недопустимое значение параметра
- 0016 - В данном контексте параметр не может принимать переданное значение
- 0017 - Отсутствует значение для зависящего параметра
- 0018 - Функции/функционал не реализована
- 0019 - Заданы конфликтующие между собой параметры
- 0020 - Вызов функции запрещен
- 0021 - Запрошенное количество объектов больше максимально разрешенного для данной функции
- 0022 - Использование API недоступно для бесплатного аккаунта
- 0023 - Запрошенное действие невозможно в рамках текущего тарифного плана аккаунта
- 0024 - Аккаунт расположен в другом датацентре, проверьте url запроса
- 0025 - API Key не совпадает с API Key этого аккаунта
- 0101 - Запрошенный объект не существует
- 0102 - Ошибка добавления
- 0103 - Ошибка обновления
- 0104 - Доступ к данным запрещен
- 0105 - Нет права на редактирование объекта
Аутентификация
- 1001 - Неверный логин или пароль
- 1002 - На выполнение данного запроса отсутствуют права (привилегии)
- 1005 - Включена двухфакторная аутентификация - авторизация возможна только по токену
Проект
- 2001 - Запрошенный проект не существует
- 2002 - На выполнение данного запроса отсутствуют права (привилегии)
- 2003 - Ошибка добавления проекта
Задача
- 3001 - Указанная задача (или другой запрашиваемый объект) не существует
- 3002 - Нет доступа к над задаче
- 3003 - Проект, в рамках которого создается задача, не существует
- 3004 - Проект, в рамках которого создается задача, не доступен
- 3005 - Ошибка добавления задачи
- 3006 - Время "Приступить к работе" не может быть больше времени "Закончить работу до"
- 3007 - Неопределенная периодичность, скорее всего задано несколько узлов, которые конфликтуют друг с другом или не указан ни один
- 3008 - Нет доступа к задаче
- 3009 - Нет доступа на изменение данных задачи
- 3010 - Данную задачу отклонить нельзя (скорее всего, она уже принята этим пользователем)
- 3011 - Данную задачу принять нельзя (скорее всего, она уже принята этим пользователем)
- 3012 - Пользователь, выполняющий запрос, не является исполнителем задачи
- 3013 - Задача не принята (для выполнения данной функции задача должна быть принята)
- 3014 - Задача в процессе изменения (сценарием или другим API запросом). Повторите запрос через некоторое время.
Действие
- 4001 - На выполнение данного запроса отсутствуют права (привилегии)
- 4002 - Действие не существует
- 4003 - Ошибка добавления действия
- 4004 - Ошибка обновления данных
- 4005 - Ошибка обновления данных
- 4006 - Попытка изменить статус на недозволенный
- 4007 - В данном действии запрещено менять статус
- 4008 - Доступ к комментария/действию отсутствует
- 4009 - Доступ к задаче отсутствует
- 4010 - Указанная аналитика не существует
- 4011 - Для аналитики были переданы не все поля
- 4012 - Указан несуществующий параметр для аналитики
- 4013 - Переданные данные не соответствуют типу поля
- 4014 - Указанный ключ справочника нельзя использовать
- 4015 - Указанный ключ справочника не существует
- 4016 - Указанный ключ данных поля не принадлежит указанной аналитике
Группа пользователей
- 5001 - Указанная группа пользователей не существует
- 5002 - На выполнение данного запроса отсутствуют права (привилегии)
- 5003 - Ошибка добавления
Сотрудники
- 6001 - На выполнение данного запроса отсутствуют права (привилегии)
- 6002 - Данный e-mail уже используется
- 6003 - Ошибка добавления сотрудника
- 6004 - Пользователь не существует
- 6005 - Ошибка обновления данных
- 6006 - Указан идентификатор несуществующей группы пользователей
Контрагенты
- 7001 - На выполнение данного запроса отсутствуют права (привилегии)
- 7002 - Клиент не существует
- 7003 - Ошибка добавления клиента
- 7004 - Ошибка обновления данных
Контакты
- 8001 - На выполнение данного запроса отсутствуют права (привилегии)
- 8002 - Контакт не существует
- 8003 - Ошибка добавления контакта
- 8004 - Ошибка обновления данных
- 8005 - Контакт не активировал доступ в ПланФикс
- 8006 - Контакту не предоставлен доступ в ПланФикс
- 8007 - E-mail, указанный для логина, не уникален
- 8008 - Попытка установки пароля для контакта, не активировавшего доступ в ПланФикс
- 8009 - Ошибка обновления данных для входа в систему
- 8010 - Указан некорректный e-mail адрес
Файл
- 9001 - На выполнение данного запроса отсутствуют права (привилегии)
- 9002 - Запрашиваемый файл не существует
- 9003 - Ошибка загрузки файла
- 9004 - Попытка загрузить пустой список файлов
- 9005 - Недопустимый символ в имени файла
- 9006 - Имя файла не уникально
- 9007 - Ошибка файловой системы
- 9008 - Ошибка возникает при попытке добавить файл из проекта для проекта
- 9009 - Файл, который пытаются добавить к задаче, является файлом другого проекта
Аналитика
- 10001 - На выполнение данного запроса отсутствуют права (привилегии)
- 10002 - Аналитика не существует
- 10003 - Переданный параметр группы аналитики не существует
- 10004 - Переданный параметр справочника аналитики не существует