Tests

Get a test

One test by id, in the same shape as a listed one. Returns 404 if the test does not exist, has been deleted, or belongs to another organisation.

get/v1/tests/{test_id}

Request

  • Base URL: https://api.acadine.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.acadine.ai/v1/tests/{test_id}
  • Auth: API key in header X-API-Key

Path parameters

test_idstring required

Response

Successful Response

test_idstring required
namestring required
status'CREATED' | 'COMPLETED' | 'CANCELLED' required

Lifecycle of a test. Mirrors the internal TestStatus one-for-one.

question_paper_idstring required
course_idstring required
subject_idstring required
total_marksnumber required

Copied from the question paper.

starts_atstring date-time nullable
ends_atstring date-time nullable
duration_minsinteger required

The per-student clock actually applied — the full window length when none was given.

batch_idsstring[] required

The batches this test is scheduled for.

is_cbtboolean required
is_omrboolean required
shuffle_questionsboolean required
allow_student_answer_sheet_uploadboolean required
created_atstring date-time required
external_test_refstring nullable

Your own identifier for this test, if you set one at creation.

Example response

{
  "test_id": "TST_2msnplIgOEXImjfvuihUqhIqNJO",
  "name": "Physics Term 1 — Morning",
  "question_paper_id": "QPR_2msnplIgOEXImjfvuihUqhIqNJO",
  "course_id": "ORG_CRS_2msnplIgOEXImjfvuihUqhIqNJO",
  "subject_id": "ORG_SUB_2msnplIgOEXImjfvuihUqhIqNJO",
  "total_marks": 100,
  "duration_mins": 180,
  "batch_ids": [
    "BCH_2msnplIgOEXImjfvuihUqhIqNJO"
  ],
  "created_by": {
    "id": "USR_2msnplIgOEXImjfvuihUqhIqNJO",
    "name": "Anita Sharma"
  },
  "external_test_ref": "their-test-4471"
}

Changes

No recorded changes to this operation across all 1 revision of this API.