QuickSense API
  • Introduction
  • Authentication
  • Errors
  • Core Resources
    • Enrolments
      • The enrolment object
      • Create a user and add into a course
      • Create a user and add into a classroom
      • Remove user from a course
      • Remove user from a classroom
    • Users
      • The user object
      • Retrieve a user
      • Update a user
      • Delete a user
      • List all users
    • Courses/Classrooms
      • The courses object
      • List all clasrooms/courses
Powered by GitBook
On this page

Was this helpful?

Errors

PreviousAuthenticationNextEnrolments

Last updated 4 years ago

Was this helpful?

QuickSense uses conventional HTTP response codes to indicate the success or failure of an API request.

In general: Codes in the 2xx range indicate success.

Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.).

Codes in the 5xx range indicate an error with QuickSense's servers (these are rare).

Some 4xx errors that could be handled programmatically (e.g., an enrolment fails) include an that briefly explains the error reported.

HTTP Status Code Summary

200 - OK

Everything worked as expected

400 - Bad Request

The request was unacceptable, often due to missing a required parameter.

401 - Unauthorised

No valid API key provided.

402 - Request Failed

The parameters were valid but the request failed.

403 - Forbidden

The API key doesn't have permissions to perform the request.

500, 502, 503, 504 - Server Errors

Something went wrong on QuickSense's end. (These are rare.)

error code