Recuro Health uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, invalid date provided, etc.). Codes in the 5xx range indicate an error with Recuro Health's servers (these are rare).

Some 4xx errors that could be handled programmatically (e.g., this member already exists) include a ErrorCode that briefly explains the error reported.

The Error Object

Whenever an error occurs as a result of an API request, we will always return the same Error object.

Attributes

messagestring :required A human-readable message providing more details about the error.

errorCodeinteger :required The unique identifier representing this type of error.

languagestring :required The ISO code representing the language being used in the message. Default value is "en-us".

moreInformationUristring :optional When available, a URL that provides more details about this error. Note that this URL is meant to assist the developer with diagnosis and remedy options and is not for end-user consumption.

Example

{
  	"message": "Invalid EventTypeId",
	"errorCode": "50054",
	"language": "en-us",
    "moreInformationUri": null
}