REST API: Error Codes

From Planfix
Revision as of 15:30, 17 November 2023 by Aliona (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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
  • 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
  • 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

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

Comments

  • 5000 — Comment does not exist
  • 5001 — Error adding comment
  • 5002 — Error updating comment data

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


Go To