Question Papers

Get a question paper

Metadata for a single paper — the same fields GET /v1/question-papers returns for each item. The questions themselves are not included.

Returns 404 if the paper does not belong to your organisation.

get/v1/question-papers/{question_paper_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/question-papers/{question_paper_id}
  • Auth: API key in header X-API-Key

Path parameters

question_paper_idstring required

Response

Successful Response

idstring required
namestring required
status'DRAFT' | 'QUEUED' | 'PROCESSING' | 'GENERATED' | 'APPROVED' | 'FAILED' required

Lifecycle of a question paper.

Mirrors the internal QuestionPaperStatus one-for-one — a paper being generated moves QUEUED -> PROCESSING -> GENERATED, and APPROVED once a teacher signs it off.

origin'IMPORTED' | 'GENERATED' | 'CLONED' | 'TRANSLATED' required

How a paper came into existence.

CLONED and TRANSLATED papers derive from another paper rather than being authored outright, and carry parent_ref pointing at it.

parent_refstring nullable

The paper this one derives from. Set only when origin is CLONED or TRANSLATED.

language'ENGLISH' | 'HINDI' | 'SANSKRIT' | 'GUJARATI' | 'MARATHI' | 'BENGALI' | 'KANNADA' | 'ODIYA' | 'TELUGU' | 'TAMIL' | 'URDU' required

Language a paper is written in. Mirrors the internal QuestionPaperLanguage.

course_idstring required
subject_idstring required
total_marksnumber required
total_questionsinteger required

Question count for the paper. 0 while it is still being generated.

created_atstring date-time required
approved_atstring date-time nullable

Null unless status is APPROVED.

Example response

{
  "id": "QPR_2msnplIgOEXImjfvuihUqhIqNJO",
  "name": "Physics Term 1",
  "parent_ref": "QPR_2msnplIgOEXImjfvuihUqhIqNJO",
  "course_id": "ORG_CRS_2msnplIgOEXImjfvuihUqhIqNJO",
  "subject_id": "ORG_SUB_2msnplIgOEXImjfvuihUqhIqNJO",
  "total_marks": 100,
  "total_questions": 30,
  "created_by": {
    "id": "USR_2msnplIgOEXImjfvuihUqhIqNJO",
    "name": "Anita Sharma"
  },
  "approved_by": {
    "id": "USR_2msnplIgOEXImjfvuihUqhIqNJO",
    "name": "Anita Sharma"
  }
}

Changes

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