HTTP Return and Error Codes

Overview

If a service has encountered an error of any kind, an error code is returned. The following is a list of error codes and the reasons why these codes are returned.

Error Code	Status Code	Reason
EXCEEDS_MAX_LENGTH	500	The length of the field exceeds the length specified for the field. Refer to the documentation regarding field lengths.
INSUFFICIENT_RIGHTS	403	Attempting to update an entity or an entity field that the user does not have rights to.
INVALID_FIELD	500	An invalid field name was requested. Refer to the documentation regarding valid field names.
INVALID_DATA_TYPE	500	The value supplied was of the incorrect type. Refer to the documentation regarding field data types.
INVALID_ENTITY	500	An invalid entity was passed to the entity function.
INVALID_PROTOCOL	505	The service is called over http. Only https is supported.
INVALID_REFERENCE_ID	500	An invalid foreign key has been supplied. For example, updating the Organization ID on the location entity to reference an Organization that does not exist.
INVALID_SESSIONID	500	The sessionID that has been passed has expired or is invalid.
INVALID_VALID_VALUE	500	The value supplied is not a valid value. Refer to the documentation for a list of valid values for this field.
NO_VALID_FIELDS	500	No valid fields were passed. Refer to the documentation for valid field names.
NON_UNIQUE_EMAIL	500	The Unique Email Validation setting is on and the email address supplied already exists in the system
NOT_AUTHENTICATED	401	The resource being accessed requires authentication.
NUM_REQUESTS_EXCEEDED	429	The number of requests has exceeded the value as specified by the Max Requests setting.
REQUIRED_DATA_MISSING	500	A non-nullable field has not been given a value.
UNKNOWN_EXCEPTION	500	An unhandled error has occurred. Refer an administrator to the errorID supplied.