Getting Started
 
 
  1. Home
  2. Authentication
  3. Error Handling

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

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

[Optional]
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: 70
Content-Type: application/json; charset=utf-8
Expires: -1

{"Error":"The requested resource does not support http method 'GET'."}

    Solution: Switch to POST

  2. Not providing ApplicationId 
    HTTP/1.1 400 Bad Request
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 96
Content-Type: application/json
Expires: -1

{"Error":"InvalidRequest","ErrorDescription":"application token or application id not provided"}

    Solution: Supply assigned ApplicationId or Authorization Token

  3. Wrong ApplicationId 
    HTTP/1.1 400 Bad Request
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 88
Content-Type: application/json
Expires: -1
{"Error":"InvalidRequest","ErrorDescription":"application id specified not found in system"}

    Solution: Consult representative and confirm you are using right id for right environment

  4. Invalid Format 
    HTTP/1.1 401 Unauthorized
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 95
Content-Type: application/json
Expires: -1
{"Error":"InvalidRequest","ErrorDescription":"application id specified is not in valid format"}

    Solution: Supply assigned ApplicationId and ensure it's a valid GUID

  5. Invalid ApplicationId 
    HTTP/1.1 401 Unauthorized
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 93
Content-Type: application/json
Expires: -1
{"Error":"InvalidRequest","ErrorDescription":"application id does not match token"}

    Solution: Supply assigned applicationId for your application.

  6. Authentication Timeout 
    HTTP/1.1 419 Authentication Timeout
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.