Errors

Code Description
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'users': [
      {
          'id': 1,
          'email': 'administrator@proctorexam.com',
          'name': 'ProctorExam Administrator',
          'role': 'administrator',
          'logo_image': '/logo_images/original/missing.png',
          'institute_name': 'ProctorExam'
      },
      {
          'id': 2,
          'email': 'teacher@proctorexam.com',
          'name': 'ProctorExam Teacher',
          'role': 'teacher',
          'logo_image': '/logo_images/original/missing.png',
          'institute_name': 'ProctorExam'
      }
    ]
  }
}

Params

Param name Description
institute_id
required

ID of the user's institute.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String