Zoho Planner

Tags:  

Zoho Planner - Data APIs


Zoho Planner provides REST style Data APIs that supports other application mashups and development.

Zoho Planner employs POST method calling convention for all these APIs. All calls are POST requests to a URL of the form :


http://planner.zoho.com/api/private/[format]/methodname?parameters

where,
methodname is one of the API methods documented below.
parameters are query parameters passed as POST input.
format is one of the required output formats (xml/json)

All methods return an XML or JSON document whose top-level object is a <response> containing method-dependent information.

API URL

For accessing the Zoho Planner Data API, users need to pass a couple of additional query parameters. These parameters are:
  • API Key
  • Ticket ID
For more on how to request for an API Key and generate Ticket ID, please click here.

Error Codes and Messages

The list of exceptions that you will get while accessing the API methods are basically segregated into two categories -

General - This entails authentication errors as well as internal server errors while processing the request.

Input - This error may occur as a result of user missing out on providing mandatory arguments for the method, incorrect parameter values etc.

The error report will be in the form of HTTP error code and an XML error response.

Error Codes

The list of HTTP error codes are tabulated below:

Code Category Description
4400
 General Error occurred while parsing the URI
4401
 General
 Authentication failed because of invalid "ticket"
4402 General
 The specified operation (e.g. HTTP GET or POST) is not supported for this request
4405 General
 No such Method. Incorrect method name
4890 General
 The "apikey" specified in the request is invalid.
4891 General Bad request URI.
4832
 Input
 Missing argument error. Mandatory arguments, required for processing this request is missing
4833 Input Value specified for a parameter is of wrong type


REST API Methods List

 RSS of this page