Common Error Codes

Any SwiftAssess API method can return the following general errors. The errors are arranged by the value of the type property used to describe them in an error response. For a description of the format of an SwiftAssess API error response, see Getting Started: JSON Response Format and Error Codes.

API Error Codes

The following errors are turned with an error type value of api.

Error Code	Description
SA_API_SERVICE_TEMPORARILY_UNAVAILABLE	The SwiftAssess API service is temporarily offline, and will return momentarily. Issued as part of an HTTP 503 error response. Applications that receive this error should wait 30 seconds or longer before attempting the request again.
SA_API_INVALID_HTTP_METHOD	The API was called with the wrong HTTP method (GET, POST, or HEAD). Please check the method documentation for the correct HTTP method.

Authentication Error Codes

The following errors are turned with an error type value of authentication.

Error Code	Description
SA_API_AUTH_EXPIRED_ACCOUNT	The user account associated with the API key has expired. Please contact Customer Support for assistance.
no_token	The client access token, specified using the access_token query string parameter, is absent from the request.
invalid_token	The client application's Access Token has expired or malformed.

Validation Error Codes

The following general errors are returned because one or more of the parameters submitted in the request was incorrect or malformed. Validation errors are categorized with a type value of validation in an API error response.

Error Code	Description
SA_API_VALIDATION_PARAM_REQUIRED	The named parameter is required.
SA_VALIDATION_INVALID_ID	The numeric ID for the named parameter is not valid.

Miscellaneous API Error Codes

The following errors are turned with an error type value of misc.

Error Code	Description
SA_API_INTERNAL_ERROR	A fatal internal error has occured. Please contact Customer Support for more assistance
SA_API_NOT_AUTHORIZED	The client is not authorized to access this API