POST /exams/:exam_id/documents
Create a document

Errors

Code Description
403 You are not authorized to access this page.
422 Param is missing or the value is empty: 'param'

Examples

{
  'example_request_params': {
    'exam_content':'Exam instructions. Optional attachment {1548172086_image2.jpg}',
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'document': {
      'id': 1,
      'exam_content': 'Exam instructions. Optional attachment {1548172086_image2.jpg}',
      'created_at': '2019-01-22T16:07:23.183+01:00',
      'updated_at': '2019-01-22T16:07:28.315+01:00',
      'exam_id': 1,
      'file_file_name': null,
      'file_content_type': null,
      'file_file_size': null,
      'file_updated_at': null,
      'file_processing': false
    }
  }
}

Params

Param name Description
exam_id
required

ID of the document’s exam.

Validations:

  • Must be a number.
exam_content
required

The text of the document. To include an attachment use placeholder value which can be obtained from /attachments API.

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