Introduction

This RESTful JSON API uses HTTP GET, POST, PUT, DELETE Requests to communicate with the System.

HTTP/1.1 Status Codes:

  • 200 OK
  • 201 Created
  • 202 Accepted
  • 204 No Content
  • 301 Moved Permanently
  • 302 Found
  • 303 See Other
  • 304 Not Modified
  • 400 Bad Request
  • 401 Unauthorized
  • 402 Payment Required
  • 403 Forbidden
  • 404 Not Found
  • 405 Method Not Allowed
  • 406 Not Acceptable
  • 408 Request Time-out
  • 409 Conflict
  • 410 Gone
  • 411 Length Required
  • 412 Precondition Failed
  • 414 Request-URI Too Large
  • 415 Unsupported Media Type
  • 416 Requested range not satisfiable
  • 500 Internal Server Error
  • 501 Not Implemented
  • 502 Bad Gateway
  • 505 HTTP Version not supported



JSON Errors (HTTP/1.1 STATUS CODES 4xx & 5xx)

{
  "success": false,
  "error": {
    "message": "The email field is required.",
    "code": 400
  }
}

Single Response (HTTP/1.1 STATUS CODES 2xx)

{
    "success": true,
    "data": {
        "id": 1,
    }
}

Collection Response (HTTP/1.1 STATUS CODES 2xx)

{
  "success": true,
  "items" : {
    "per_page" : 15,
    "from" : 1,
    "data" : [
      {
        "id" : 1,
      }
    ],
    "total" : 1,
    "current_page" : 1,
    "last_page" : 1,
    "to" : 1
  }
}

Subject

  • GET

  • getAll

  • v1/subjects

User

  • POST

  • requestPasswordReset

  • v1/user/password-reset/request

Request password reset token.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • email
    string
    The email of the reset user

  • POST

  • confirmPasswordReset

  • v1/user/password-reset/confirm

Confirm password reset.

Parameters

  • PARAMETER
    TYPE
    DESCRIPTION
    VALUE
  • reset_token$reset_token
    \reset_token
    The reset token. Obtain this by "requestPasswordReset"
  • password$password
    \password
    The new password