Error Responses
If your request to the Screenleap API fails, you will receive two indications of the failure: a status code and an error message.
Status Codes
| 400 - Bad Request | You provided a parameter value which could not be processed. This could also indicate that your
request was missing a mandatory parameter.
The most common trigger for this kind of error is a call that provides an incorrect authtoken.
See your Developer Account summary to verify. |
| 401 - Unauthorized | At least one of the required credentials (accountid and authtoken) was missing.
This could also indicate tha the accountid was incorrect. Note that the authtoken
can only be passed in the header. See Authentication for details. |
| 403 - Forbidden | You do not have appropriate access for the request that you made. If you have exceeded the free hours for your account for this month, you will need to upgrade your account by entering billing information for continued access. |
| 404 - Not Found | You made a call (e.g. a stop call) for a share code that can not be found or has already ended. |
| 5xx - Server Error | There was an error in the API or the Screenleap site is unavailable. Please try your request later or contact us for assistance. |
Error Message
For any 4xx error, the response will also include JSON with an errorMessage. The message will contain details about what caused the error.
This information can be helpful for resolving errors quickly.
Sample Error Response JSON
{
"errorMessage": "Authentication Failed: No accountid was passed with this request."
}
