vikunja-api/docs/content/doc/usage/errors.md

138 lines
5.3 KiB
Markdown
Raw Normal View History

2019-02-17 20:53:04 +01:00
---
date: "2019-02-12:00:00+02:00"
title: "Errors"
draft: false
type: "doc"
menu:
sidebar:
parent: "usage"
---
2018-10-06 18:32:33 +02:00
# Errors
This document describes the different errors Vikunja can return.
2020-09-03 17:34:44 +02:00
{{< table_of_contents >}}
## Generic
2020-04-19 14:33:51 +02:00
2018-10-06 18:32:33 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
| 0001 | 403 | Generic forbidden error. |
2020-04-19 14:33:51 +02:00
2020-09-03 17:34:44 +02:00
## User
2020-04-19 14:33:51 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
2018-10-06 18:32:33 +02:00
| 1001 | 400 | A user with this username already exists. |
| 1002 | 400 | A user with this email address already exists. |
| 1004 | 400 | No username and password specified. |
| 1005 | 404 | The user does not exist. |
| 1006 | 400 | Could not get the user id. |
2018-10-27 11:33:28 +02:00
| 1008 | 412 | No password reset token provided. |
| 1009 | 412 | Invalid password reset token. |
| 1010 | 412 | Invalid email confirm token. |
| 1011 | 412 | Wrong username or password. |
| 1012 | 412 | Email address of the user not confirmed. |
2019-04-21 20:18:17 +02:00
| 1013 | 412 | New password is empty. |
| 1014 | 412 | Old password is empty. |
| 1015 | 412 | Totp is already enabled for this user. |
| 1016 | 412 | Totp is not enabled for this user. |
| 1017 | 412 | The provided Totp passcode is invalid. |
| 1018 | 412 | The provided user avatar provider type setting is invalid. |
2020-04-19 14:33:51 +02:00
2020-09-03 17:34:44 +02:00
## Validation
2020-04-19 14:33:51 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
2018-10-06 18:32:33 +02:00
| 2001 | 400 | ID cannot be empty or 0. |
2018-11-17 00:17:37 +01:00
| 2002 | 400 | Some of the request data was invalid. The response contains an aditional array with all invalid fields. |
2020-04-19 14:33:51 +02:00
2020-09-03 17:34:44 +02:00
## List
2020-04-19 14:33:51 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
2018-10-06 18:32:33 +02:00
| 3001 | 404 | The list does not exist. |
| 3004 | 403 | The user needs to have read permissions on that list to perform that action. |
| 3005 | 400 | The list title cannot be empty. |
| 3006 | 404 | The list share does not exist. |
2019-12-07 23:28:45 +01:00
| 3007 | 400 | A list with this identifier already exists. |
| 3008 | 412 | The list is archived and can therefore only be accessed read only. This is also true for all tasks associated with this list. |
2020-04-19 14:33:51 +02:00
2020-09-03 17:34:44 +02:00
## Task
2020-04-19 14:33:51 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
2018-10-06 18:32:33 +02:00
| 4001 | 400 | The list task text cannot be empty. |
| 4002 | 404 | The list task does not exist. |
2018-12-28 22:49:46 +01:00
| 4003 | 403 | All bulk editing tasks must belong to the same list. |
| 4004 | 403 | Need at least one task when bulk editing tasks. |
2018-12-31 02:18:41 +01:00
| 4005 | 403 | The user does not have the right to see the task. |
2019-09-25 20:44:41 +02:00
| 4006 | 403 | The user tried to set a parent task as the task itself. |
| 4007 | 400 | The user tried to create a task relation with an invalid kind of relation. |
| 4008 | 409 | The user tried to create a task relation which already exists. |
| 4009 | 404 | The task relation does not exist. |
| 4010 | 400 | Cannot relate a task with itself. |
2019-10-16 22:52:29 +02:00
| 4011 | 404 | The task attachment does not exist. |
| 4012 | 400 | The task attachment is too large. |
2019-12-07 15:30:51 +01:00
| 4013 | 400 | The task sort param is invalid. |
| 4014 | 400 | The task sort order is invalid. |
| 4015 | 404 | The task comment does not exist. |
| 4016 | 403 | Invalid task field. |
| 4017 | 403 | Invalid task filter comparator. |
| 4018 | 403 | Invalid task filter concatinator. |
| 4019 | 403 | Invalid task filter value. |
2020-04-19 14:33:51 +02:00
2020-09-03 17:34:44 +02:00
## Namespace
2020-04-19 14:33:51 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
2018-10-06 18:32:33 +02:00
| 5001 | 404 | The namspace does not exist. |
| 5003 | 403 | The user does not have access to the specified namespace. |
| 5006 | 400 | The namespace name cannot be empty. |
| 5009 | 403 | The user needs to have namespace read access to perform that action. |
| 5010 | 403 | This team does not have access to that namespace. |
| 5011 | 409 | This user has already access to that namespace. |
| 5012 | 412 | The namespace is archived and can therefore only be accessed read only. |
2020-04-19 14:33:51 +02:00
2020-09-03 17:34:44 +02:00
## Team
2020-04-19 14:33:51 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
2018-10-06 18:32:33 +02:00
| 6001 | 400 | The team name cannot be emtpy. |
| 6002 | 404 | The team does not exist. |
| 6004 | 409 | The team already has access to that namespace or list. |
| 6005 | 409 | The user is already a member of that team. |
| 6006 | 400 | Cannot delete the last team member. |
| 6007 | 403 | The team does not have access to the list to perform that action. |
2020-04-19 14:33:51 +02:00
2020-09-03 17:34:44 +02:00
## User List Access
2020-04-19 14:33:51 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
2018-10-06 18:32:33 +02:00
| 7002 | 409 | The user already has access to that list. |
| 7003 | 403 | The user does not have access to that list. |
2020-04-19 14:33:51 +02:00
2020-09-03 17:34:44 +02:00
## Label
2020-04-19 14:33:51 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
2018-12-31 02:18:41 +01:00
| 8001 | 403 | This label already exists on that task. |
2019-01-10 00:08:12 +01:00
| 8002 | 404 | The label does not exist. |
| 8003 | 403 | The user does not have access to this label. |
2020-04-19 14:33:51 +02:00
2020-09-03 17:34:44 +02:00
## Right
2020-04-19 14:33:51 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
| 9001 | 403 | The right is invalid. |
2020-04-19 14:33:51 +02:00
2020-09-03 17:34:44 +02:00
## Kanban
2020-04-19 14:33:51 +02:00
| ErrorCode | HTTP Status Code | Description |
|-----------|------------------|-------------|
| 10001 | 404 | The bucket does not exist. |
| 10002 | 400 | The bucket does not belong to that list. |
| 10003 | 412 | You cannot remove the last bucket on a list. |
| 10004 | 412 | You cannot add the task to this bucket as it already exceeded the limit of tasks it can hold. |