GET /institutes/:id
Show an institute

Errors

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

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'institute': {
      'id': 1,
      'name': 'ProctorExam',
      'created_at': '2018-08-20T15:11:09.284+02:00',
      'updated_at': '2019-01-22T10:30:59.794+01:00',
      'short_name': 'pe',
      'logo_image_file_name': null,
      'logo_image_content_type': null,
      'logo_image_file_size': null,
      'logo_image_updated_at': null,
      'callback_url': null,
      'tawk_url': null,
      'check_requirements_emails_enabled': true,
      'reminder_emails_enabled': true,
      'exam_link_emails_enabled': true,
      'exam_changed_emails_enabled': true,
      'exam_finalized_emails_enabled': true,
      'global_proctor': true,
      'global_reviewer': true,
      'token_value': 30,
      'tawk_api_key': null,
      'default_exam_languages': 'fr,nl,es,ar,no',
      'logo_image': '/logo_images/original/missing.png',
      'tokens': []
    }
  }
}

Params

Param name Description
id
required

ID of the requested institute.

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 /institutes
Create an institute

Errors

Code Description
403 You are not authorized to access this page.
422 Param is missing or the value is empty: 'param'
422 'name':['has already been taken']

Examples

{
  'example_request_params': {
    'name': 'ProctorExam',
    'short_name': 'pe',
    'global_proctor': true,
    'global_reviewer': true,
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'institute': {
      'id': 1,
      'name': 'ProctorExam',
      'created_at': '2018-08-20T15:11:09.284+02:00',
      'updated_at': '2019-01-22T10:30:59.794+01:00',
      'short_name': 'pe',
      'logo_image_file_name': null,
      'logo_image_content_type': null,
      'logo_image_file_size': null,
      'logo_image_updated_at': null,
      'callback_url': null,
      'tawk_url': null,
      'check_requirements_emails_enabled': true,
      'reminder_emails_enabled': true,
      'exam_link_emails_enabled': true,
      'exam_changed_emails_enabled': true,
      'exam_finalized_emails_enabled': true,
      'global_proctor': true,
      'global_reviewer': true,
      'token_value': 30,
      'tawk_api_key': null,
      'default_exam_languages': 'fr,nl,es,ar,no',
      'logo_image': '/logo_images/original/missing.png',
      'tokens': []
    }
  }
}

Params

Param name Description
name
required

Full name of the institute.

Validations:

  • Must be a String

short_name
required

Short name of the institute.

Validations:

  • Must be a String

callback_url
optional

Endpoint to receive the event callbacks.

Validations:

  • Must be a String

global_proctor
optional

True if global proctoring is set for the institute.

Validations:

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

global_reviewer
optional

True if global reviewing is set for the institute.

Validations:

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

tawk_url
optional

Url of the institute's tawk support.

Validations:

  • Must be a String

logo_image
optional

Logo of the institute, uploaded with multipart.

Validations:

  • Must be a File

default_exam_languages
optional

Default languages supported by the institute.

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


PATCH /institutes/:id
Update an institute

PUT /institutes/:id
Update an institute

Errors

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

Examples

{
  'example_request_params': {
    'callback_url': 'https://callback_url.com'
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'institute': {
      'id': 1,
      'name': 'ProctorExam',
      'created_at': '2018-08-20T15:11:09.284+02:00',
      'updated_at': '2019-01-22T10:30:59.794+01:00',
      'short_name': 'pe',
      'logo_image_file_name': null,
      'logo_image_content_type': null,
      'logo_image_file_size': null,
      'logo_image_updated_at': null,
      'callback_url': 'https://callback_url.com',
      'tawk_url': null,
      'check_requirements_emails_enabled': true,
      'reminder_emails_enabled': true,
      'exam_link_emails_enabled': true,
      'exam_changed_emails_enabled': true,
      'exam_finalized_emails_enabled': true,
      'global_proctor': true,
      'global_reviewer': true,
      'token_value': 30,
      'tawk_api_key': null,
      'default_exam_languages': 'fr,nl,es,ar,no',
      'logo_image': '/logo_images/original/missing.png',
      'tokens': []
    }
  }
}

Params

Param name Description
id
required

ID of the requested institute.

Validations:

  • Must be a number.

callback_url
optional

Url of the institute.

Validations:

  • Must be a String

global_proctor
optional

True if global proctoring is set for the institute.

Validations:

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

global_reviewer
optional

True if global reviewing is set for the institute.

Validations:

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

tawk_url
optional

Url of the institute's tawk support.

Validations:

  • Must be a String

logo_image
optional

Logo of the institute, uploaded with multipart.

Validations:

  • Must be a File

default_exam_languages
optional

Default languages supported by the institute.

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


DELETE /institutes/:id
Destroy an institute

Errors

Code Description
404 Couldn't find Institute with 'id'=':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 requested institute.

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