API Documentation
\

\Simplify_AuthenticationException

Exception raised where there are problems authenticating a request.

Summary

Methods
Properties
Constants
getErrorData()
getStatus()
getReference()
getErrorCode()
describe()
No public properties found
No constants found
No protected methods found
$errorData
$status
$errorCode
$reference
N/A
No private methods found
No private properties found
N/A

Properties

$errorData

$errorData

$status

$status

$errorCode

$errorCode

$reference

$reference

Methods

getErrorData()

getErrorData() : array

Returns a map of all error data returned by the API.

Returns

array —

a map containing API error data.

getStatus()

getStatus() : string

Returns the HTTP status for the request.

Returns

string —

HTTP status code (or null if there is no status).

getReference()

getReference() : string

Returns unique reference for the API error.

Returns

string —

a reference (or null if there is no reference).

getErrorCode()

getErrorCode() : string

Returns an code for the API error.

Returns

string —

the error code.

describe()

describe() : string

Returns a description of the error.

Returns

string —

Description of the error.