Error Handling


Response Errors

All response objects contain base error handler properties. These properties can be verified when the reponse is received.

Name Description Type Additional information
Success represents the success of the call. boolean


ErrorMessage if the success property is false, the ErrorMessage property will contain error text, otherwise it will be null. string


ErrorType if the success property is false the ErrorType property will contain the text of the type of error that has occured, otherwise it will be null. string [Optional]


Error Types

These are the list of error types that can be used when the Success property of the base reponse is false.

Name Value
InvalidRequest 1
InvalidApplication 2
InvalidGrant 3
UnauthorizedClient 4
UnsupportedGrantType 5
CallVolumeExceeeded 6
PersonUidNotFound 7


Possible Errors

  1. Not using Post
    HTTP/1.1 405 Method Not Allowed
    Cache-Control: no-cache
    Pragma: no-cache
    Allow: POST
    Content-Length: 72
    Content-Type: application/json; charset=utf-8
    Expires: -1
    {"Error":"The requested resource does not support http method 'GET'."}

    Solution: Switch to POST

  2. Expired Authentication Token
    HTTP/1.1 419
    Cache-Control: no-cache
    Pragma: no-cache
    Content-Length: 95
    Content-Type: application/json
    Expires: -1
    {"Error":"InvalidRequest","ErrorDescription":"application token has expired"}

    Solution: Reauthenticate to the authorization server to receive a new token. Tokens expire every 60 minutes.