Error codes XML API v1

From Planfix
Revision as of 15:03, 15 November 2023 by Aliona (talk | contribs) (Created page with "{{#seo: |title=Error codes XML API v1 |titlemode=append |keywords=planfix, api, еrror, codes, XML |description=Error codes XML API }} If an error occurs while executing the request, the server responds in the following format: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <response status="error"> <code></code> </response> </source> {| class="wikitable" style="margin-top: 1em; width:100% " !width="150"|Name !!width="200"| Type !!width="50%"| Meaning !! N...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

If an error occurs while executing the request, the server responds in the following format:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>
Name Type Meaning Note
code string(4) Four-digit number, can start with zero, error code.

Unclassified

  • 0001 - Incorrect API Key
  • 0002 -The application is blocked
  • 0003 - XML parsing error. Invalid XML
  • 0004 - Unknown account
  • 0005 - Session key is invalid (session has expired)
  • 0006 - Incorrect signature
  • 0007 - Resource usage limit exceeded (maximum daily request limit exceeded)
  • 0008 - Function name is not recognized
  • 0009 - One of the required function parameters is missing
  • 0010 - The account is frozen
  • 0011 - Software update is in progress on the account platform
  • 0012 - Authentication error: when logging in with username and password - session is missing, session parameter is not provided in the request; when logging in with a token - the provided token does not exist
  • 0013 - Undefined user
  • 0014 - User is inactive
  • 0015 - Invalid parameter value
  • 0016 - In this context, the parameters cannot accept provided value
  • 0017 - Value is missing for a dependent parameter
  • 0018 - Function/functionality is not implemented
  • 0019 - Conflict between specified parameters
  • 0020 - Unauthorized to perform the requested function
  • 0021 - The requested number of objects exceeds the maximum allowed for this function
  • 0022 - API usage is not available for free accounts
  • 0023 - The requested action is not possible within the current account's plan
  • 0024 - The account is located in a different data center, please check the request URL
  • 0101 - The requested object does not exist
  • 0102 - Error adding the object
  • 0103 - Error updating the object
  • 0104 - Access to data is denied
  • 0105 - No permission to edit the object

Authentication

  • 1001 - incorrect login or password
  • 1002 - The request cannot be executed due to insufficient permissions (privileges)

Project

  • 2001 - The requested project does not exist
  • 2002 - The request cannot be executed due to insufficient permissions (privileges)
  • 2003 - Error adding the project

Task

  • 3001 - The specified task (or another requested object) does not exist
  • 3002 - No access to the task
  • 3003 - The project within which the task is created does not exist
  • 3004 - The project within which the task is created is not available
  • 3005 - Error adding the task
  • 3006 - The "Start working" time cannot be later than the "Finish by" time
  • 3007 - Invalid recurrence, likely multiple conflicting parameters are specified or none at all
  • 3008 - No access to the task
  • 3009 - No access to modify task data
  • 3010 - This task cannot be declined (likely it's already accepted by this user)
  • 3011 - This task cannot be accepted (likely it's already accepted by this user)
  • 3012 - The user making the request is not the task assignee
  • 3013 - The task is not accepted (to perform this function, the task must be accepted)
  • 3014 - The task is being modified (by script or another API request). Please retry the request after some time.

Actions

  • 4001 - The request cannot be executed due to insufficient permissions (privileges)
  • 4002 - The action does not exist
  • 4003 - Error adding the action
  • 4004 - Error updating the data
  • 4006 - Attempt to change the status to an unauthorized one
  • 4007 - Changing status is prohibited in this action
  • 4008 - No access to the comment/action
  • 4009 - No access to the task
  • 4010 - The specified data tag does not exist
  • 4011 - Not all fields were provided for the data tag
  • 4012 - An invalid parameter was specified for the data tag
  • 4013 -The provided data does not match the field type
  • 4014 - The specified directory key cannot be used
  • 4015 -The specified reference key is invalid
  • 4016 - The specified data field key does not belong to the specified data tag

User group

  • 5001 - The specified user group does not exist
  • 5002 - The request cannot be executed due to insufficient permissions (privileges)
  • 5003 - Error adding the group

Employees

  • 6001 - The request cannot be executed due to insufficient permissions (privileges)
  • 6002 - This email is already in use
  • 6003 - Error adding the employee
  • 6004 - The user does not exist
  • 6005 - Error updating the data
  • 6006 - The identifier for a non-existing user group is specified

Counterparty

  • 7001 - The request cannot be executed due to insufficient permissions (privileges)
  • 7002 - The customer does not exist
  • 7003 - Error adding the customer
  • 7004 - Error updating the data

Contacts

  • 8001 -The request cannot be executed due to insufficient permissions (privileges)
  • 8002 - The contact does not exist
  • 8003 - Error adding the contact
  • 8004 - Error updating the data
  • 8005 - The contact has not activated access to Planfix
  • 8006 - Access to Planfix has not been granted to the contact
  • 8007 - The email specified for login is already taken
  • 8008 - Attempt to set a password for a contact who has not activated access to Planfix
  • 8009 - Error updating login data
  • 8010 - An incorrect email address is specified

File

  • 9001 - The request cannot be executed due to insufficient permissions (privileges)
  • 9002 - The requested file does not exist
  • 9003 - Error uploading the file
  • 9004 - Attempt to upload an empty list of files
  • 9005 - Invalid character in the file name
  • 9006 - The file name is already taken
  • 9007 - File system error
  • 9008 - An error occurs when trying to add a file from one project to another
  • 9009 - The file being added to the task is a file from another project

Data tag

  • 10001 - The request cannot be executed due to insufficient permissions (privileges)
  • 10002 - The data tag does not exist
  • 10003 - The passed parameter for the data tag group does not exist
  • 10004 - The passed parameter for data tag directory does not exist


Go To