This document describes the error codes thrown by TGC's REST API. They map directly onto the W3C's standard HTTP status codes (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). When functioning properly the web service will always return a 200 HTTP status code.
NOTE: While the error codes documented here are returned as HTTP status codes, they are also returned in the JSON response of the body.
These are errors caused by the client providing invalid or outdated information.
The URI path you tried to call does not exist.
See also 440.
These errors have to do with invalid parameters, missing parameters, or parameters specified out of range. The data section of the error will contain a string listing the parameter name having the problem.
The object you requested doesn't exist.
This refers to an object specified in the query string,
not in the path.
See also 404.
You're missing a required parameter.
The value specified for a field was out of range. If it's a numeric field make sure you're above the minumum and below the maximum. If it's an enumerated field make sure you've specfified an valid option.
The name or resource requested is already in use by someone else.
You tried to upload a file that the system doesn't allow.
You tried to assign a file to a field that doesn't match the field's criteria. For example you tried to assign a PDF to a field looking for images.
For one reason or another the payment requested was declined. Usually due to typos, but could also do with credit card holds, insufficient funds, etc.
These errors have to do with authentication and authorization.
You do not have the privileges necessary to complete that operation. Note: you will see this error if you have not included the session_id parameter in a request.
The session you are using has expired. Request a new one before continuing.
You have exceeded the maximum number of requests allowed per minute. This exception is telling you to slow down so you don't denial of service the server with your requests.
A prerequisite of performing the requested action has not been met.
The password you specified does not match our records.
This request was going to take too long so it was handed off to be processed in the background.
These errors are systemic in nature. In general, these should never happen.
An unhandled exception has occurred in the server. Under normal operating procedures this should never happen, as all exceptions should be trapped within the code and returned as a defined exception. Therefore this is an untrapped exception, and is in all cases a bug.
Could not connect to an external resource, such as a database or web service.