GET /exams/:exam_id/student_sessions
List the students in an exam

Errors

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

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'students': [
      {
        'id': 1,
        'session_id': null,
        'student_id': null,
        'time_slot': 1,
        'created_at': '2018-11-17T17:01:25.788+01:00',
        'updated_at': '2018-11-17T17:13:30.427+01:00',
        'email': 'student1@example.com',
        'pin_code': 803754,
        'operating_system': 'OS X 10.14.1',
        'browser': 'Chrome',
        'browser_version': '70.0.3538.102',
        'status': 'exam_finished',
        'token': null,
        'screenshare_check': 'not_started',
        'microphone_check': 'not_started',
        'speakers_check': 'not_started',
        'webcam_check': 'not_started',
        'mobile_check': 'not_started',
        'dummy_exam_survey': null,
        'skip_requirements': false,
        'send_confirmation': false,
        'name': 'Student 1',
        'start_time': '2018-11-17T17:09:39.373+01:00',
        'exam_id': 1,
        'expires_at': null,
        'end_time': '2018-11-17T17:10:19.477+01:00',
        'entered_room': true,
        'reservation_time': '2018-11-17T17:04:28.633+01:00',
        'exam_document_content_type': null,
        'exam_document_file_size': null,
        'exam_document_updated_at': null,
        'reviewed': '10',
        'id_card_file_name': 'data',
        'id_card_content_type': 'image/png',
        'id_card_file_size': 187297,
        'face_photo_file_name': 'data',
        'face_photo_content_type': 'image/png',
        'face_photo_file_size': 206025,
        'bandwidth_check': 'not_started',
        'bandwidth_speed': null,
        'open_time': '2018-11-13T11:13:00.000+01:00',
        'individual_info': 'individual_info for user 1',
        'rtc_session_id': 0,
        'in_setup': false,
        'in_check_requirements': false,
        'attempt': 0,
        'archived': true,
        'current_exam_mode': '01010000',
        'rtc_session_ids': [],
        'transcoding_status': 'not_sent_to_queue',
        'is_individual_info_html': true,
        'priority': '01',
        'recording_started_at': null,
        'recording_ended_at': null,
        'is_email_sent': false,
        'incidents': [{'id': 1,
          'student_session_id': 1,
          'comment': 'comment',
          'created_at': '2018-11-17T17:10:19.477+01:00',
          'updated_at': '2018-11-17T17:10:19.477+01:00',
          'offset_time':0}
        ]
      }
    ]
  }
}

Params

Param name Description
exam_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 /student_sessions
List all student_sessions

Errors

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

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'students': [
      {
        'id': 1,
        'session_id': null,
        'student_id': null,
        'time_slot': 1,
        'created_at': '2018-11-17T17:01:25.788+01:00',
        'updated_at': '2018-11-17T17:13:30.427+01:00',
        'email': 'student1@example.com',
        'pin_code': 803754,
        'operating_system': 'OS X 10.14.1',
        'browser': 'Chrome',
        'browser_version': '70.0.3538.102',
        'status': 'exam_finished',
        'token': null,
        'screenshare_check': 'not_started',
        'microphone_check': 'not_started',
        'speakers_check': 'not_started',
        'webcam_check': 'not_started',
        'mobile_check': 'not_started',
        'dummy_exam_survey': null,
        'skip_requirements': false,
        'send_confirmation': false,
        'name': 'Student 1',
        'start_time': '2018-11-17T17:09:39.373+01:00',
        'exam_id': 1,
        'expires_at': null,
        'end_time': '2018-11-17T17:10:19.477+01:00',
        'entered_room': true,
        'reservation_time': '2018-11-17T17:04:28.633+01:00',
        'exam_document_content_type': null,
        'exam_document_file_size': null,
        'exam_document_updated_at': null,
        'reviewed': '10',
        'id_card_file_name': 'data',
        'id_card_content_type': 'image/png',
        'id_card_file_size': 187297,
        'face_photo_file_name': 'data',
        'face_photo_content_type': 'image/png',
        'face_photo_file_size': 206025,
        'bandwidth_check': 'not_started',
        'bandwidth_speed': null,
        'open_time': '2018-11-13T11:13:00.000+01:00',
        'individual_info': 'individual_info for user 1',
        'rtc_session_id': 0,
        'in_setup': false,
        'in_check_requirements': false,
        'attempt': 0,
        'archived': true,
        'current_exam_mode': '01010000',
        'rtc_session_ids': [],
        'transcoding_status': 'not_sent_to_queue',
        'is_individual_info_html': true,
        'priority': '01',
        'recording_started_at': null,
        'recording_ended_at': null,
        'is_email_sent': false,
        'incidents': [{'id': 1,
          'student_session_id': 1,
          'comment': 'comment',
          'created_at': '2018-11-17T17:10:19.477+01:00',
          'updated_at': '2018-11-17T17:10:19.477+01:00',
          'offset_time':0}
        ]
      }
    ]
  }
}

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 /student_sessions/:id
Show a student by its id

Errors

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

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'student': {
      'id': 1,
      'session_id': null,index
      'student_id': null,
      'time_slot': 1,
      'created_at': '2018-11-17T17:01:25.788+01:00',
      'updated_at': '2018-11-17T17:13:30.427+01:00',
      'email': 'student1@example.com',
      'pin_code': 803754,
      'operating_system': 'OS X 10.14.1',
      'browser': 'Chrome',
      'browser_version': '70.0.3538.102',
      'status': 'exam_finished',
      'token': null,
      'screenshare_check': 'not_started',
      'microphone_check': 'not_started',
      'speakers_check': 'not_started',
      'webcam_check': 'not_started',
      'mobile_check': 'not_started',
      'dummy_exam_survey': null,
      'skip_requirements': false,
      'send_confirmation': false,
      'name': 'Student 1',
      'start_time': '2018-11-17T17:09:39.373+01:00',
      'exam_id': 1,
      'expires_at': null,
      'end_time': '2018-11-17T17:10:19.477+01:00',
      'entered_room': true,
      'reservation_time': '2018-11-17T17:04:28.633+01:00',
      'exam_document_content_type': null,
      'exam_document_file_size': null,
      'exam_document_updated_at': null,
      'reviewed': '10',
      'id_card_file_name': 'data',
      'id_card_content_type': 'image/png',
      'id_card_file_size': 187297,
      'face_photo_file_name': 'data',
      'face_photo_content_type': 'image/png',
      'face_photo_file_size': 206025,
      'bandwidth_check': 'not_started',
      'bandwidth_speed': null,
      'open_time': '2018-11-13T11:13:00.000+01:00',
      'individual_info': 'individual_info for user 1',
      'rtc_session_id': 0,
      'in_setup': false,
      'in_check_requirements': false,
      'attempt': 0,
      'archived': true,
      'current_exam_mode': '01010000',
      'rtc_session_ids': [],
      'transcoding_status': 'not_sent_to_queue',
      'is_individual_info_html': true,
      'priority': '01',
      'recording_started_at': null,
      'recording_ended_at': null,
      'is_email_sent': false,
      'incidents': [{'id': 1,
        'student_session_id': 1,
        'comment': 'comment',
        'created_at': '2018-11-17T17:10:19.477+01:00',
        'updated_at': '2018-11-17T17:10:19.477+01:00',
        'offset_time':0}
      ]
    }
  }
}

Params

Param name Description
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/:exam_id/student_sessions
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

{
  'example_request_params': {
    'name':'Student 1',
    'email':'student1@example.com',
    'individual_info':'individual_info for user 1',
    'is_individual_info_html': true,
    'skip_requirements': true,
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'student': {
      'id': 1,
      'session_id': null,
      'student_id': null,
      'time_slot': 1,
      'created_at': '2018-11-17T17:01:25.788+01:00',
      'updated_at': '2018-11-17T17:13:30.427+01:00',
      'email': 'student1@example.com',
      'pin_code': 803754,
      'operating_system': 'OS X 10.14.1',
      'browser': 'Chrome',
      'browser_version': '70.0.3538.102',
      'status': 'exam_finished',
      'token': null,
      'screenshare_check': 'not_started',
      'microphone_check': 'not_started',
      'speakers_check': 'not_started',
      'webcam_check': 'not_started',
      'mobile_check': 'not_started',
      'dummy_exam_survey': null,
      'skip_requirements': true,
      'send_confirmation': false,
      'name': 'Student 1',
      'start_time': '2018-11-17T17:09:39.373+01:00',
      'exam_id': 1,
      'expires_at': null,
      'end_time': '2018-11-17T17:10:19.477+01:00',
      'entered_room': true,
      'reservation_time': '2018-11-17T17:04:28.633+01:00',
      'exam_document_content_type': null,
      'exam_document_file_size': null,
      'exam_document_updated_at': null,
      'reviewed': '10',
      'id_card_file_name': 'data',
      'id_card_content_type': 'image/png',
      'id_card_file_size': 187297,
      'face_photo_file_name': 'data',
      'face_photo_content_type': 'image/png',
      'face_photo_file_size': 206025,
      'bandwidth_check': 'not_started',
      'bandwidth_speed': null,
      'open_time': '2018-11-13T11:13:00.000+01:00',
      'individual_info': 'individual_info for user 1',
      'rtc_session_id': 0,
      'in_setup': false,
      'in_check_requirements': false,
      'attempt': 0,
      'archived': true,
      'current_exam_mode': '01010000',
      'rtc_session_ids': [],
      'transcoding_status': 'not_sent_to_queue',
      'is_individual_info_html': true,
      'priority': '01',
      'recording_started_at': null,
      'recording_ended_at': null
    }
  }
}

Params

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

skip_requirements
optional

The student does not have to go through the requirements check before getting the exam session email

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 /student_sessions/:id
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

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

Params

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