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 requested 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

name
required

Name of the exam.

String

type
required

Type of the exam, can be: 'local_proctoring', 'local_reviewing', 'global_proctoring', 'global_reviewing'.

String

save_recording
optional

true if video streams of students should be saved.
Default: true

Boolean

institute_id
optional

Institute of the exam, if omitted will be set to the user's institute_id.

Number

duration
optional

Duration of the exam in minutes.

Number

start_time
optional

The first start time of the exam in epoch format in seconds. Will default to create time.

Number

end_time
optional

The last start time of the exam in epoch format in seconds. Will default to be nil.

Number

upload_answers
optional

true if student has to upload one or more document at the end of the exam through PRUEFSTER platform.
Default: false

Boolean

mobile_cam
optional

true if mobile recording is required.
Default: false

Boolean

web_cam
optional

true if web_cam recording is required.
Default: true

Boolean

screen_share
optional

true if screen sharing is required.
Default: true

Boolean

countdown
optional

true if countdown is required the remaining duration will be shown.
Default: false

Boolean

restrictions
optional

The instructions for the reviewer.

String

allow_websites
optional

Boolean for allowing websites to be used during the exam.
Default: false

Boolean

allow_external_applications
optional

Boolean for allowing external applications to be used during the exam.
Default: false

Boolean

allow_textbooks
optional

Boolean for allowing textbooks to be used during the exam.
Default: false

Boolean

allow_calculator
optional

Boolean for allowing calculator to be used during the exam.
Default: false

Boolean

allow_pen_paper
optional

Boolean for allowing pen and paper to be used during the exam.
Default: false

Boolean

allow_headphones
optional

Boolean for allowing headphones to be used during the exam.
Default: false

Boolean

allow_whiteboard
optional

Boolean for allowing a whiteboard to be used during the exam.
Default: false

Boolean

allow_leave_room
optional

Boolean for allowing the room to be left during the exam.
Default: false

Boolean

allow_additional
optional

Boolean for allowing additional materials to be used during the exam.
Default: false

Boolean

allowed_websites
optional

Comma separated string with the different websites that can be used in the exam.

String

allowed_external_applications
optional

Comma separated string with the different external applications that can be used in the exam.

String

allowed_textbooks
optional

Comma separated string with the different textbooks that can be used in the exam.

String

allowed_calculator_type
optional

String with the calculator type that can be used in the exam.

String

allowed_additional
optional

Comma separated string with the different additional materials that can be used in the exam.

String

exam_content
optional

String containing URLs or additional information that can be interpreted as HTML-Code have to be seperated with comma.
example: 'HTML:example-HTML-Code'

String

is_exam_content_html
optional

exam_content for the student.
Default: false

Boolean

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

name
optional

Name of the exam.

String

type
required

Type of the exam, can be: 'local_proctoring', 'local_reviewing', 'global_proctoring', 'global_reviewing'.

String

save_recording
optional

true if video streams of students should be saved.
Default: true

Boolean

duration
optional

Duration of the exam in minutes.

Number

start_time
optional

The first start time of the exam in epoch format in seconds or milliseconds. Will default to create time.

Number

end_time
optional

The last end time of the exam in epoch format in seconds or milliseconds. Will default to be nil.

Number

upload_answers
optional

true if student has to upload one or more document at the end of the exam through PRUEFSTER platform.
Default: false

Boolean

mobile_cam
optional

true if mobile recording is required.
Default: false

Boolean

web_cam
optional

true if web_cam recording is required.
Default: true

Boolean

screen_share
optional

true if screen sharing is required.
Default: true

Boolean

countdown
optional

true if countdown is required the remaining duration will be shown.
Default: false

Boolean

restrictions
optional

The instructions for the reviewer.

String

allow_websites
optional

Boolean for allowing websites to be used during the exam.
Default: false

Boolean

allow_external_applications
optional

Boolean for allowing external applications to be used during the exam.
Default: false

Boolean

allow_textbooks
optional

Boolean for allowing textbooks to be used during the exam.
Default: false

Boolean

allow_calculator
optional

Boolean for allowing calculator to be used during the exam.
Default: false

Boolean

allow_pen_paper
optional

Boolean for allowing pen and paper to be used during the exam.
Default: false

Boolean

allow_headphones
optional

Boolean for allowing headphones to be used during the exam.
Default: false

Boolean

allow_whiteboard
optional

Boolean for allowing a whiteboard to be used during the exam.
Default: false

Boolean

allow_leave_room
optional

Boolean for allowing the room to be left during the exam.
Default: false

Boolean

allow_additional
optional

Boolean for allowing additional materials to be used during the exam.
Default: false

Boolean

allowed_websites
optional

Comma separated string with the different websites that can be used in the exam.

String

allowed_external_applications
optional

Comma separated string with the different external applications that can be used in the exam.

String

allowed_textbooks
optional

Comma separated string with the different textbooks that can be used in the exam.

String

allowed_calculator_type
optional

String with the calculator type that can be used in the exam.

String

allowed_additional
optional

Comma separated string with the different additional materials that can be used in the exam

String

exam_content
optional

String containing URLs or additional information that can be interpreted as HTML-Code have to be seperated with comma example: 'HTML:example-HTML-Code'

String

is_exam_content_html
optional

exam_content for the student.
Default: false

Boolean

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

name
optional

Name of the exam.

String

type
required

Type of the exam, can be: 'local_proctoring', 'local_reviewing', 'global_proctoring', 'global_reviewing'.

String

save_recording
optional

true if video streams of students should be saved.
Default: true

Boolean

duration
optional

Duration of the exam in minutes.

Number

start_time
optional

The first start time of the exam in epoch format in seconds or milliseconds. Will default to create time.

Number

end_time
optional

The last end time of the exam in epoch format in seconds or milliseconds. Will default to be nil.

Number

upload_answers
optional

true if student has to upload one or more document at the end of the exam through PRUEFSTER platform.
Default: false

Boolean

mobile_cam
optional

true if mobile recording is required.
Default: false

Boolean

web_cam
optional

true if web_cam recording is required.
Default: true

Boolean

screen_share
optional

true if screen sharing is required.
Default: true

Boolean

countdown
optional

true if countdown is required the remaining duration will be shown.
Default: false

Boolean

restrictions
optional

The instructions for the reviewer.

String

allow_websites
optional

Boolean for allowing websites to be used during the exam.
Default: false

Boolean

allow_external_applications
optional

Boolean for allowing external applications to be used during the exam.
Default: false

Boolean

allow_textbooks
optional

Boolean for allowing textbooks to be used during the exam.
Default: false

Boolean

allow_calculator
optional

Boolean for allowing calculator to be used during the exam.
Default: false

Boolean

allow_pen_paper
optional

Boolean for allowing pen and paper to be used during the exam.
Default: false

Boolean

allow_headphones
optional

Boolean for allowing headphones to be used during the exam.
Default: false

Boolean

allow_whiteboard
optional

Boolean for allowing a whiteboard to be used during the exam.
Default: false

Boolean

allow_leave_room
optional

Boolean for allowing the room to be left during the exam.
Default: false

Boolean

allow_additional
optional

Boolean for allowing additional materials to be used during the exam.
Default: false

Boolean

allowed_websites
optional

Comma separated string with the different websites that can be used in the exam

String

allowed_external_applications
optional

Comma separated string with the different external applications that can be used in the exam

String

allowed_textbooks
optional

Comma separated string with the different textbooks that can be used in the exam.

String

allowed_calculator_type
optional

String with the calculator type that can be used in the exam

String

allowed_additional
optional

Comma separated string with the different additional materials that can be used in the exam

String

exam_content
optional

String containing URLs or additional information that can be interpreted as HTML-Code have to be seperated with comma example: 'HTML:example-HTML-Code'

String

is_exam_content_html
optional

exam_content for the student.
Default: false

Boolean

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 requested 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

id
required

ID of the student's exam.

Number

student_session_id
required

ID of the student_session.

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's exam.

Number

name
required

Name of the student.

String

email
optional

Email of the student.

String

individual_info
optional

Individual information for the student.

String

is_individual_info_html
optional

Individual information for the student.
Default: false

Boolean

skip_requirements
optional

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

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 requested 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

id
required

ID of the exam.

Number

proctor_pool
required

Array with ID's of proctors.

Number Array

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'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

id
required

ID of the student's exam.

Number

proctor_pool
required

Array with ID's of proctors.

Number Array