REST API: Error Codes: Difference between revisions
From Planfix
No edit summary |
|||
| Line 35: | Line 35: | ||
*40 — One of the mandatory method parameters is missing | *40 — One of the mandatory method parameters is missing | ||
*41 — Invalid parameter value | *41 — Invalid parameter value | ||
== Tasks == | == Tasks == | ||
*1000 — Task does not exist | *1000 — Task does not exist | ||
*1001 — Error adding task | *1001 — Error adding task | ||
*1002 — Error updating task | *1002 — Error updating task | ||
== Contacts == | == Contacts == | ||
*2000 — Contact does not exist | *2000 — Contact does not exist | ||
| Line 50: | Line 48: | ||
*2006 — Contact's full name is not filled in | *2006 — Contact's full name is not filled in | ||
*2007 — Contact's email is already present in the additional email array | *2007 — Contact's email is already present in the additional email array | ||
== Projects == | == Projects == | ||
*3000 — Project does not exist | *3000 — Project does not exist | ||
*3001 — Error adding project | *3001 — Error adding project | ||
*3002 — Error updating project | *3002 — Error updating project | ||
== Employees == | == Employees == | ||
*4000 — Employee does not exist | *4000 — Employee does not exist | ||
| Line 67: | Line 63: | ||
*402 — Error updating employee position | *402 — Error updating employee position | ||
*403 — Error updating employee phone number | *403 — Error updating employee phone number | ||
== Comments == | == Comments == | ||
*5000 — Comment does not exist | *5000 — Comment does not exist | ||
*5001 — Error adding comment | *5001 — Error adding comment | ||
*5002 — Error updating comment data | *5002 — Error updating comment data | ||
== Custom fields and field sets == | |||
== Data tags and data tag records == | == Data tags and data tag records == | ||
*6000 — Data tag does not exist | *6000 — Data tag does not exist | ||
| Line 79: | Line 74: | ||
*6012 — Error updating data tag entry | *6012 — Error updating data tag entry | ||
*6013 — Error deleting data tag entry | *6013 — Error deleting data tag entry | ||
== Files == | == Files == | ||
*7000 — File does not exist | *7000 — File does not exist | ||
| Line 85: | Line 79: | ||
*7002 — Uploaded file size exceeded within the subscription | *7002 — Uploaded file size exceeded within the subscription | ||
*7003 — Error deleting file | *7003 — Error deleting file | ||
== Directories and directory entries == | == Directories and directory entries == | ||
*8000 — Directory does not exist | *8000 — Directory does not exist | ||
| Line 92: | Line 85: | ||
*8012 — Error updating directory entry | *8012 — Error updating directory entry | ||
*8013 — Error deleting directory entry | *8013 — Error deleting directory entry | ||
== Reports == | == Reports == | ||
*9000 — Report does not exist | *9000 — Report does not exist | ||
== Go To == | == Go To == | ||
*[[REST API]] | *[[REST API]] | ||
Revision as of 08:40, 5 December 2025
If an error occurs while executing a request, the server responds in the following format:
{
Result string
Code integer($int32)
Error string
}Where code is the error's integer.
Unclassified errors
- 0 — Unknown error
- 1 — Invalid token
- 2 — The token is not active
- 3 — The object is being modified
- 5 — Access to this method for scoup is forbidden
- 6 — Access to this method/object for the user is forbidden
- 10 — The account is blocked for spam
- 11 — Account is frozen
- 16 — User is inactive
- 20 — Subscription is not paid
- 21 — API usage is not available for a free account
- 22 — The daily limit of requests to the REAT API is spent
- 23 — The account limit for the number of contacts has been reached
- 24 — The account has reached the employee limit
- 25 — The account has reached the overall limit
- 30 — Invalid JSON format
- 40 — One of the mandatory method parameters is missing
- 41 — Invalid parameter value
Tasks
- 1000 — Task does not exist
- 1001 — Error adding task
- 1002 — Error updating task
Contacts
- 2000 — Contact does not exist
- 2001 — Error adding contact
- 2002 — Error updating data
- 2003 — When attempting to grant access to Planfix, the contact does not have an email set
- 2004 — Invalid email format
- 2005 — The email specified is already taken
- 2006 — Contact's full name is not filled in
- 2007 — Contact's email is already present in the additional email array
Projects
- 3000 — Project does not exist
- 3001 — Error adding project
- 3002 — Error updating project
Employees
- 4000 — Employee does not exist
- 4001 — Error adding employee
- 4002 — Error updating employee data
- 4003 — The specified email is not unique
- 4004 — Invalid username format
- 4005 — The specified username is not unique
- 4006 — Employee's full name is not filled in
- 401 — Error updating employee group
- 402 — Error updating employee position
- 403 — Error updating employee phone number
Comments
- 5000 — Comment does not exist
- 5001 — Error adding comment
- 5002 — Error updating comment data
Custom fields and field sets
Data tags and data tag records
- 6000 — Data tag does not exist
- 6010 — Data tag record does not exist
- 6011 — Error adding data tag entry
- 6012 — Error updating data tag entry
- 6013 — Error deleting data tag entry
Files
- 7000 — File does not exist
- 7001 — Error adding file
- 7002 — Uploaded file size exceeded within the subscription
- 7003 — Error deleting file
Directories and directory entries
- 8000 — Directory does not exist
- 8010 — Directory entry does not exist
- 8011 — Error adding directory entry
- 8012 — Error updating directory entry
- 8013 — Error deleting directory entry
Reports
- 9000 — Report does not exist