Errors

Code Description
403 You are not authorized to access this page.
422 Param is missing or the value is empty: 'param'
422 'email':['has already been taken']

Examples

{
  'name':'user 596',
  'email':'user_596@example.com',
  'individual_info':'individual_info for user 596',
  'is_individual_info_html': true,
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
id
required

ID of the student's exam.

Validations:

  • Must be a number.

name
required

Name of the student.

Validations:

  • Must be a String

email
required

Email of the student.

Validations:

  • Must be a String

individual_info
optional

Individual information for the student.

Validations:

  • Must be a String

is_individual_info_html
optional

Individual information display mode: html or plain text

Validations:

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

open_time
optional

The earliest time in EPOCH format that a student is allowed to begin their exam.

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