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

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

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

{
  'name': 'Institute Name',
  'short_name': 'IName',
  'callback_url': 'http://hello.institutename.com',
  'global_proctor': true,
  'global_reviewer': true,
  'tawk_url': 'tawk.institute.com',
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

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

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

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

{
  'callback_url': 'http://hello.institutename.com',
  'global_proctor': true,
  'global_reviewer': true,
  'tawk_url': 'tawk.institute.com',
  'nonce': '1527500365',
  'timestamp': 1527500365052,
  'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
}

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

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

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

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