Code | Description |
---|---|
403 | You are not authorized to access this page. |
422 | Param is missing or the value is empty: 'param' |
{ 'example_request_params': { 'id': 1, 'name':'Psychostasia', 'type': 'record_review', 'institute_id': 1, 'use_duration': true, 'duration_minutes': 90, 'global_proctoring': true, 'global_reviewing': true, 'start_time': '2018-11-21T00:54:00.000+01:00', 'for_reviewing': true, 'upload_answers': false, 'mobile_cam': true, 'restrictions': 'Example of restrictions to be added.', 'allow_websites': true, 'allow_external_applications': true, 'allow_textbooks': true, 'allow_calculator': true, 'allow_pen_paper': true, 'allow_additional': true, 'allowed_websites': 'www.proctorexam.com, docs.proctorexam.com', 'allowed_external_applications': 'External application', 'allowed_textbooks': 'Reference book', 'allowed_calculator_type': 'Basic', 'allowed_additional': 'Headphones', 'student_experience': true, 'nonce': '1527500365', 'timestamp': 1527500365052, 'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff' }, 'example_response': { 'exam': { 'id': 1, 'institute_id': 1, 'name': 'Psychostasia', 'terms': null, 'created_at': '2018-11-21T00:54:59.934+01:00', 'updated_at': '2018-11-25T21:26:08.664+01:00', 'duration_minutes': 90, 'clipboard': null, 'start_time': '2018-11-21T00:54:00.000+01:00', 'mode': '01110000', 'upload_answers': false, 'token': 'b1342678e28f2b895ff6834408a33bd7', 'user_id': 5, 'end_time': null, 'restrictions': '[[false,['']],[false,['']],[false,['']],[false,['']],[false,['']],[false,['']],[true,['']]]', 'published': false, 'status': 'open', 'for_reviewing': true, 'uploaded_exam_documents_file_name': null, 'uploaded_exam_documents_content_type': null, 'uploaded_exam_documents_file_size': null, 'uploaded_exam_documents_updated_at': null, 'timezone': 0, 'use_duration': true, 'global_proctoring': true, 'global_reviewing': true, 'exam_language': 'fr,nl,es,ar,no', 'web_cam': true, 'mobile_cam': true, 'screen_share': true, 'live_proctoring': false, 'student_experience': false } } }
Param name | Description |
---|---|
id required |
ID of the requested exam. Validations:
|
name optional |
Name of the exam. Validations:
|
type optional |
Type of the exam, can be: demo, classroom, record_review, live_proctoring Validations:
|
use_duration optional |
True if exam duration is required. Validations:
|
duration_minutes optional |
Duration of the exam in minutes. Validations:
|
global_proctoring optional |
True if global proctoring is set for the exam. Validations:
|
global_reviewing optional |
True if global reviewing is set for the exam. Validations:
|
start_time optional |
The first start time of the exam in epoch format. Will default to create time. Validations:
|
end_time optional |
The last start time of the exam in epoch format. Will default to be nil. Validations:
|
for_reviewing optional |
True if you want to send the student videos to reviewers. Validations:
|
upload_answers optional |
True if student has to upload one or more document at the end of the exam through proctorexam platform. Validations:
|
mobile_cam optional |
True if mobile recording is required. Validations:
|
exam_language optional |
Languages in which the exam can be displayed. Validations:
|
restrictions optional |
The instructions for the reviewer Validations:
|
allow_websites optional |
Boolean for allowing websites to be used during the exam Validations:
|
allow_external_applications optional |
Boolean for allowing external applications to be used during the exam Validations:
|
allow_textbooks optional |
Boolean for allowing textbooks to be used during the exam Validations:
|
allow_calculator optional |
Boolean for allowing calculator to be used during the exam Validations:
|
allow_pen_paper optional |
Boolean for allowing pen and paper to be used during the exam Validations:
|
allow_additional optional |
Boolean for allowing additional materials to be used during the exam Validations:
|
allowed_websites optional |
Comma separated string with the different websites that can be used in the exam Validations:
|
allowed_external_applications optional |
Comma separated string with the different external applications that can be used in the exam Validations:
|
allowed_textbooks optional |
Comma separated string with the different textbooks that can be used in the exam Validations:
|
allowed_calculator_type optional |
String with the calculator type that can be used in the exam Validations:
|
allowed_additional optional |
Comma separated string with the different additional materials that can be used in the exam Validations:
|
student_experience optional |
When set to true it enables the new exam-taker experience, if available for your environment. Default value is false. Validations:
|
timestamp required |
Timestamp of the request in milliseconds. Validations:
|
nonce required |
Random number unique between the api calls made in the previous 24 hours. Validations:
|
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:
|