Exceptions

Methods in this module may throw the following exceptions.

mPulseAPI.mPulseAPIAuthExceptionType

Thrown when the token used to authenticate with the REST API is invalid or has expired

Fields

msg::AbstractString : This message is always set to "Error Authenticating with REST API"

response::Response : The response object from the REST API call. You can inspect headers, data, cookies, redirects, and the initiating request.

responseBody::AbstractString : The body of the HTTP response from the server

source
mPulseAPI.mPulseAPIBugExceptionType

Thrown when the REST API has an internal server error and returns a 500 Internal Server Error

Fields

msg::AbstractString : The string "Internal Server Error, please report this. Timestamp: <current unix timestamp in seconds since the epoch>"

response::Response : The response object from the REST API call. You can inspect headers, data, cookies, redirects, and the initiating request.

responseBody::AbstractString : The body of the HTTP response from the server

source
mPulseAPI.mPulseAPIExceptionType

Thrown when the REST API has a problem and returns something other than a 2xx response.

Fields

msg::AbstractString : The error message

response::Response : The response object from the REST API call. You can inspect headers, data, cookies, redirects, and the initiating request.

responseBody::AbstractString : The body of the HTTP response from the server

source
mPulseAPI.mPulseAPIRequestExceptionType

Thrown when a request parameter is invalid

Fields

msg::AbstractString : The error message sent from the mPulse server

code::AbstractString : The error code sent from the mPulse server

parameter::AbstractString : The parameter that the mPulse server had a problem with

value::AbstractString : The value of the parameter that the mPulse server had a problem with

response::Response : The response object from the REST API call. You can inspect headers, data, cookies, redirects, and the initiating request.

source