GET /exams
List exams

Errors

Code Description
403 You are not authorized to access this page.

Examples

{
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
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


GET /exams/:id
Show an exam

Errors

Code Description
404 Couldn't find Exam with 'id'=':id'
403 You are not authorized to access this page.

Examples

{
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
id
required

ID of the requested exam.

Validations:

  • Must be a number.


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

{
  'name':'Psychostasia',
  'type': 'record_review',
  'institute_id':1,
  'use_duration': true,
  'duration_minutes':90,
  'global_proctoring': true,
  'global_reviewing': true,
  'start_time':'2017-09-20T08:37:00.000Z',
  'for_reviewing':true,
  'upload_answers':false,
  'mobile_cam':false,
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

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

restrictions
optional

The instructions for the reviewer, formatted in HTML.

Validations:

  • Must be a String

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

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


PATCH /exams/:id
Update an exam

PUT /exams/:id
Update 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

{
  'name':'Psychostasia',
  'type': 'record_review',
  'use_duration': true,
  'duration_minutes':90,
  'global_proctoring': true,
  'global_reviewing': true,
  'start_time':'2017-09-20T08:37:00.000Z',
  'for_reviewing':true,
  'upload_answers':false,
  'mobile_cam':false,
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
id
required

ID of the requested exam.

Validations:

  • Must be a number.

name
optional

Name of the exam.

Validations:

  • Must be a String

type
optional

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

Validations:

  • Must be a String

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.

Validations:

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

global_reviewing
optional

True if global reviewing is set for the exam.

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

restrictions
optional

The instructions for the reviewer, formatted in HTML.

Validations:

  • Must be a String

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

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


DELETE /exams/:id
Destroy an exam

Errors

Code Description
404 Couldn't find Exam with 'id'=':id'
403 You are not authorized to access this page.

Examples

{
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
id
required

ID of the requested 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


GET /exams/:id/index_students
List the students in an exam

Errors

Code Description
403 You are not authorized to access this page.

Examples

{
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
id
required

ID of the student's 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


GET /exams/id/show_student
Show a student in an exam

Errors

Code Description
404 Couldn't find Student Session with 'id'=':student_session_id'
403 You are not authorized to access this page.

Examples

{
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
id
required

ID of the student's exam.

Validations:

  • Must be a number.

student_session_id
required

ID of the student_session.

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


POST /exams/:id/add_student
Create and add a student to an exam

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


DELETE /exams/:id/delete_student
Destroy and remove a student from an exam

Errors

Code Description
404 Couldn't find Student Session with 'id'=':student_session_id'
403 You are not authorized to access this page.

Examples

{
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
id
required

ID of the student's exam.

Validations:

  • Must be a number.

student_session_id
required

ID of the student_session.

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


POST /exams/:id/send_emails
Send the exam emails for all the students in an exam

Errors

Code Description
404 Couldn't find Exam with 'id'=':id'
403 You are not authorized to access this page.

Examples

{
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
id
required

ID of the requested 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


PUT /exams/:id/add_comanager
Add a user as a comanager to 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

{
  'comanager_id':'5',
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
id
required

ID of the exam.

Validations:

  • Must be a number.

comanager_id
required

User ID of the comanager.

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


DELETE /exams/:id/remove_comanager
Remove a user as a comanger to 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

{
  'comanager_id':'5',
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

Params

Param name Description
id
required

ID of the exam.

Validations:

  • Must be a number.

comanager_id
required

User ID of the comanager.

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