Errors

Code Description
403 You are not authorized to access this page.
422 Param is missing or the value is empty: 'param'

Examples

{
  'example_request_params': {
    'receives_reports':true,
    'report_frequency':'week',
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'user': {
      'id': 7,
      'institute_id': 1,
      'email': 'teacher@institute.com',
      'student_number': null,
      'name': 'Teacher name',
      'created_at': '2019-01-23T12:05:52.391+01:00',
      'updated_at': '2019-01-23T12:05:52.391+01:00',
      'role': 'teacher',
      'invitation_token': null,
      'invitation_created_at': null,
      'invitation_sent_at': null,
      'invitation_accepted_at': null,
      'invitation_limit': null,
      'invited_by_id': null,
      'invited_by_type': null,
      'api_token': 'jq560vN9KZdAdFtOYH5xXw',
      'secret_key': 'NNAK4kQK3hveFpuuRMeC-DFRgn0nnUn4XpPSWofvXxY',
      'receives_reports': true,
      'report_frequency': 'week',
      'first_visit_guide': true,
      'global_proctor': true,
      'global_reviewer': true,
      'logo_image': '/logo_images/original/missing.png',
      'institute_name': 'ProctorExam'
    }
  }
}

Params

Param name Description
id
required

ID of the requested user.

Validations:

  • Must be a number.

institute_id
required

ID of the user's institute.

Validations:

  • Must be a number.

receives_reports
optional

Boolean that defines if the user requires reports.

Validations:

  • Must be one of: true, false, 1, 0

report_frequency
optional

Refers to the user's desired report frequency. It can be day, week, month.

Validations:

  • Must be a String

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