GET /exams/:exam_id/documents/:document_id/attachments
List attachments

Errors

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

Examples

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

Params

Param name Description
institute_id
required

ID of the exam.

Validations:

  • Must be a number.

document_id
required

ID of the document.

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 /exams/:exam_id/documents/:document_id/attachments/:id
Show an attachment

Errors

Code Description
404 Couldn't find Attachment 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 attachment.

Validations:

  • Must be a number.

institute_id
required

ID of the exam.

Validations:

  • Must be a number.

document_id
required

ID of the document.

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/documents/:document_id/attachments
Create an attachment

Errors

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

Examples

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

Params

Param name Description
exam_id
required

ID of the exam.

Validations:

  • Must be a number.

document_id
required

ID of the document.

Validations:

  • Must be a number.

document
required

Document of the attachment.

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 /exams/:exam_id/documents/:document_id/attachments/:id
Destroy an attachment

Errors

Code Description
404 Couldn't find Attachment 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 attachment.

Validations:

  • Must be a number.

institute_id
required

ID of the exam.

Validations:

  • Must be a number.

document_id
required

ID of the document.

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