exam_id
required

ID of the student's exam.

Number

timestamp
required

Timestamp of the request in milliseconds.

Number

nonce
required

Random number, has to be unique for api calls within last 24 hours.

Number

signature
required

HMAC sha256 hex encoded hash, using the users secret_key as encryption key, has to be UTF8 formatted. The query string build with all the other parameters has to be ordered alphabeticaly and structured by the following schema: 'name=value' joined by '?'

String

timestamp
required

Timestamp of the request in milliseconds.

Number

nonce
required

Random number, has to be unique for api calls within last 24 hours.

Number

signature
required

HMAC sha256 hex encoded hash, using the users secret_key as encryption key, has to be UTF8 formatted. The query string build with all the other parameters has to be ordered alphabeticaly and structured by the following schema: 'name=value' joined by '?'

String

id
required

ID of the student_session.

timestamp
required

Timestamp of the request in milliseconds.

Number

nonce
required

Random number, has to be unique for api calls within last 24 hours.

Number

signature
required

HMAC sha256 hex encoded hash, using the users secret_key as encryption key, has to be UTF8 formatted. The query string build with all the other parameters has to be ordered alphabeticaly and structured by the following schema: 'name=value' joined by '?'

String

timestamp
required

Timestamp of the request in milliseconds.

Number

nonce
required

Random number, has to be unique for api calls within last 24 hours.

Number

signature
required

HMAC sha256 hex encoded hash, using the users secret_key as encryption key, has to be UTF8 formatted. The query string build with all the other parameters has to be ordered alphabeticaly and structured by the following schema: 'name=value' joined by '?'

String

exam_id
required

ID of the student's exam.

Number

name
required

Name of the student.

String

email
optional

Email of the student.

String

external_id
optional

External id of the student.

String

individual_info
optional

Individual information for the student.

String

is_individual_info_html
optional

Individual information for the student.

Boolean

skip_requirements
optional

Skips the requirements check for the student before getting the exam session email.

Boolean

open_time
optional

The earliest time in epoch format (in seconds) that a student is allowed to begin their exam. Defaults to the exams start_time.

Number

close_time
optional

The latest time in epoch format (in seconds) that a student is allowed to begin their exam. Defaults to null.

Number

timestamp
required

Timestamp of the request in milliseconds.

Number

nonce
required

Random number, has to be unique for api calls within last 24 hours.

Number

signature
required

HMAC sha256 hex encoded hash, using the users secret_key as encryption key, has to be UTF8 formatted. The query string build with all the other parameters has to be ordered alphabeticaly and structured by the following schema: 'name=value' joined by '?'

String

id
required

ID of the student_session.

Number

name
optional

Name of the student.

String

email
optional

Email of the student.

String

external_id
optional

External id of the student.

String

individual_info
optional

Individual information for the student.

String

is_individual_info_html
optional

Individual information for the student.

Boolean

skip_requirements
optional

Skips the requirements check for the student before getting the exam session email.

Boolean

open_time
optional

The earliest time in epoch format (in seconds) that a student is allowed to begin their exam. Defaults to the exams start_time.

Number

close_time
optional

The latest time in epoch format (in seconds) that a student is allowed to begin their exam. Defaults to null.

Number

timestamp
required

Timestamp of the request in milliseconds.

Number

nonce
required

Random number, has to be unique for api calls within last 24 hours.

Number

signature
required

HMAC sha256 hex encoded hash, using the users secret_key as encryption key, has to be UTF8 formatted. The query string build with all the other parameters has to be ordered alphabeticaly and structured by the following schema: 'name=value' joined by '?'

String

id
required

ID of the student_session.

Number

name
optional

Name of the student.

String

email
optional

Email of the student.

String

external_id
optional

External id of the student.

String

individual_info
optional

Individual information for the student.

String

is_individual_info_html
optional

Individual information for the student.

Boolean

skip_requirements
optional

Skips the requirements check for the student before getting the exam session email.

Boolean

open_time
optional

The earliest time in epoch format (in seconds) that a student is allowed to begin their exam. Defaults to the exams start_time.

Number

close_time
optional

The latest time in epoch format (in seconds) that a student is allowed to begin their exam. Defaults to null.

Number

timestamp
required

Timestamp of the request in milliseconds.

Number

nonce
required

Random number, has to be unique for api calls within last 24 hours.

Number

signature
required

HMAC sha256 hex encoded hash, using the users secret_key as encryption key, has to be UTF8 formatted. The query string build with all the other parameters has to be ordered alphabeticaly and structured by the following schema: 'name=value' joined by '?'

String

id
required

ID of the student_session.

Number