POST /student_sessions/:id/end_exam
Ends a student session, stops the recordings and sends a notification to the student

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',
    'notification_title': 'Exam ended',
    'notification_text': 'The exam ended by api',
    'notification_type': 'warning'
  },
  'example_response': {
    'message': 'end_exam_time_success',
    'end_time': '2018-11-17T17:10:19.477+01:00',
    'recording_response': true
  }
}

Params

Param name Description
id
required

ID of the student_session.

Validations:

  • Must be a number.
notification_title
required

Validations:

  • Must be a String
notification_text
required

Validations:

  • Must be a String
notification_type
required

Validations:

  • Must be one of: warning, error, success, info.
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