POST /exams
Create an exam

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': {
    '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',
    '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': 'en-GB',
      'web_cam': true,
      'mobile_cam': true,
      'screen_share': true,
      'live_proctoring': false
    }
  }
}

Params

Param name Description
name
required

Name of the exam.

Validations:

  • Must be a String
type
required

Type of the exam, can be: demo, classroom, record_review, live_proctoring

Validations:

  • Must be a String
institute_id
optional

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

Validations:

  • Must be a number.
use_duration
optional

True if exam duration is required.

Validations:

  • Must be one of: true, false, 1, 0.
duration_minutes
optional

Duration of the exam in minutes.

Validations:

  • Must be a number.
global_proctoring
optional

True if global proctoring is set for the exam. Only for superuser accounts

Validations:

  • Must be one of: true, false, 1, 0.
global_reviewing
optional

True if global reviewing is set for the exam. Only for superuser accounts

Validations:

  • Must be one of: true, false, 1, 0.
start_time
optional

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

Validations:

  • Must be a number.
end_time
optional

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

Validations:

  • Must be a number.
for_reviewing
optional

True if you want to send the student videos to reviewers.

Validations:

  • Must be one of: true, false, 1, 0.
upload_answers
optional

True if student has to upload one or more document at the end of the exam through proctorexam platform.

Validations:

  • Must be one of: true, false, 1, 0.
mobile_cam
optional

True if mobile recording is required.

Validations:

  • Must be one of: true, false, 1, 0.
exam_language
optional

Language in which the exam can be displayed. Unless custom translations provided via administration website, must be one of en-GB, nl-NL, de-DE, fr-FR, it-IT.

Validations:

  • Must be a String
restrictions
optional

The instructions for the reviewer

Validations:

  • Must be a String
allow_websites
optional

Boolean for allowing websites to be used during the exam

Validations:

  • Must be one of: true, false, 1, 0.
allow_external_applications
optional

Boolean for allowing external applications to be used during the exam

Validations:

  • Must be one of: true, false, 1, 0.
allow_textbooks
optional

Boolean for allowing textbooks to be used during the exam

Validations:

  • Must be one of: true, false, 1, 0.
allow_calculator
optional

Boolean for allowing calculator to be used during the exam

Validations:

  • Must be one of: true, false, 1, 0.
allow_pen_paper
optional

Boolean for allowing pen and paper to be used during the exam

Validations:

  • Must be one of: true, false, 1, 0.
allow_additional
optional

Boolean for allowing additional materials to be used during the exam

Validations:

  • Must be one of: true, false, 1, 0.
allowed_websites
optional

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

Validations:

  • Must be a String
allowed_external_applications
optional

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

Validations:

  • Must be a String
allowed_textbooks
optional

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

Validations:

  • Must be a String
allowed_calculator_type
optional

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

Validations:

  • Must be a String
allowed_additional
optional

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

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