GET /institutes
List all institutes ( Premium - Superuser only )

Errors

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

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff',
    'page': 1
  },
  'example_response': {
    'institutes': [
      {
        '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': 'en-GB', //DEPRECATED! use default_language field instead
        'default_locale': 'en-GB', //DEPRECATED! use default_language field instead
        'default_language': 'en-GB',
        'custom_languages': ['no-NO'],
        'logo_image': '/logo_images/original/missing.png',
        'tokens': [],
        'session_retention_period': '6',
        'pre_assigned_proctor_fallback_threshold': 0,
        'connected_proctor_fallback_threshold': 0,
        'block_students_until_proctor_connected': false
      }
    ]
  }
}

Params

Param name Description
page
optional

Page number, returns LIMIT items per page. The X-Pagination-* HTTP headers contain the information about the total number of items (X-Pagination-Item-Count), the total number of pages (X-Pagination-Page-Count), the current page number (X-Pagination-Page) and the number of items per page (X-Pagination-Limit).

Validations:

  • Must be a number.
limit
optional

Number of items returned per page. Default and maximum value is 300.

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
sort
optional

Sort by column(s). Stringified JSON constisting of an array of objects with column as key and sorting order as value. Example: sort=[{“column_name”: “asc”}, {“column_name”: “desc”}]

Validations:

  • Must be a String
filter
optional

Filter by column(s). Stringified JSON consisting of an object with column as key and an object with operator as key and filtering value as value. Example: filter={“column_name”: {“operator”: “value”}} available operators: eq(equal to), gt(greater than), gte(greater than or equal to), lt(less than), lte(less than or equal to), ne(not equal to), in(in), nin(not in)

Validations:

  • Must be a String