Evernote API: Module: Errors
Enumerations
Enumeration: EDAMErrorCode
Numeric codes indicating the type of error that occurred on the
service.
- UNKNOWN
- No information available about the error
- BAD_DATA_FORMAT
- The format of the request data was incorrect
- PERMISSION_DENIED
- Not permitted to perform action
- INTERNAL_ERROR
- Unexpected problem with the service
- DATA_REQUIRED
- A required parameter/field was absent
- LIMIT_REACHED
- Operation denied due to data model limit
- QUOTA_REACHED
- Operation denied due to user storage limit
- INVALID_AUTH
- Username and/or password incorrect
- AUTH_EXPIRED
- Authentication token expired
- DATA_CONFLICT
- Change denied due to data model conflict
- ENML_VALIDATION
- Content of submitted note was malformed
- SHARD_UNAVAILABLE
- Service shard with account data is temporarily down
- LEN_TOO_SHORT
- Operation denied due to data model limit, where something such
as a string length was too short
- LEN_TOO_LONG
- Operation denied due to data model limit, where something such
as a string length was too long
- TOO_FEW
- Operation denied due to data model limit, where there were
too few of something.
- TOO_MANY
- Operation denied due to data model limit, where there were
too many of something.
- UNSUPPORTED_OPERATION
- Operation denied because it is currently unsupported.
- TAKEN_DOWN
- Operation denied because access to the corresponding object is
prohibited in response to a take-down notice.
- RATE_LIMIT_REACHED
- Operation denied because the calling application has reached
its hourly API call limit for this user.
UNKNOWN | 1 |
BAD_DATA_FORMAT | 2 |
PERMISSION_DENIED | 3 |
INTERNAL_ERROR | 4 |
DATA_REQUIRED | 5 |
LIMIT_REACHED | 6 |
QUOTA_REACHED | 7 |
INVALID_AUTH | 8 |
AUTH_EXPIRED | 9 |
DATA_CONFLICT | 10 |
ENML_VALIDATION | 11 |
SHARD_UNAVAILABLE | 12 |
LEN_TOO_SHORT | 13 |
LEN_TOO_LONG | 14 |
TOO_FEW | 15 |
TOO_MANY | 16 |
UNSUPPORTED_OPERATION | 17 |
TAKEN_DOWN | 18 |
RATE_LIMIT_REACHED | 19 |
Data structures
Exception: EDAMUserException
This exception is thrown by EDAM procedures when a call fails as a result of
a problem that a caller may be able to resolve. For example, if the user
attempts to add a note to their account which would exceed their storage
quota, this type of exception may be thrown to indicate the source of the
error so that they can choose an alternate action.
This exception would not be used for internal system errors that do not
reflect user actions, but rather reflect a problem within the service that
the user cannot resolve.
errorCode: The numeric code indicating the type of error that occurred.
must be one of the values of EDAMErrorCode.
parameter: If the error applied to a particular input parameter, this will
indicate which parameter.
Exception: EDAMSystemException
| Field | Type |
|---|
| errorCode | EDAMErrorCode |
| message | string |
| rateLimitDuration | i32 |
This exception is thrown by EDAM procedures when a call fails as a result of
a problem in the service that could not be changed through caller action.
errorCode: The numeric code indicating the type of error that occurred.
must be one of the values of EDAMErrorCode.
message: This may contain additional information about the error
rateLimitDuration: Indicates the minimum number of seconds that an application should
expect subsequent API calls for this user to fail. The application should not retry
API requests for the user until at least this many seconds have passed. Present only
when errorCode is RATE_LIMIT_REACHED,
Exception: EDAMNotFoundException
| Field | Type |
|---|
| identifier | string |
| key | string |
This exception is thrown by EDAM procedures when a caller asks to perform
an operation on an object that does not exist. This may be thrown based on an invalid
primary identifier (e.g. a bad GUID), or when the caller refers to an object
by another unique identifier (e.g. a User's email address).
identifier: A description of the object that was not found on the server.
For example, "Note.notebookGuid" when a caller attempts to create a note in a
notebook that does not exist in the user's account.
key: The value passed from the client in the identifier, which was not
found. For example, the GUID that was not found.