Get Question Bank Details
Returns one question bank's details and its questions, one page at a time. Use it to read or export the questions in a bank, including their options and correct answers.
GET
/questionbank/questionsGet Question Bank Details
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/questionbank/questions?question_list_id=200&page=1&per_page=<per_page>' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"question_bank": {
"details": {
"question_list_id": 200,
"question_list_name": "Feb-Qb",
"description": "",
"num_questions": 1,
"create_date": 1549535438,
"last_updated": 1549535438,
"engage_exam_tag_id": 7,
"engage_subject_tag_id": 5,
"engage_topic_tag_id": 4,
"engage_topic_tag_name": null,
"difficulty": 3,
"question_type": 0,
"is_owner": 1
},
"questions": [
{
"question_id": 1107,
"question_list_id": 200,
"question_JSON": "[\"\\n\"]",
"input_JSON": "[{\"input_type\":0,\"question_string\":\"<p>7_9 <\\/p>\\n\",\"options\":[{\"index\":0,\"option_string\":\"<p>8 <\\/p>\\n\",\"is_correct\":1},{\"index\":1,\"option_string\":\"<p>0<\\/p>\\n\"},{\"index\":2,\"option_string\":\"<p>2 <\\/p>\\n\"},{\"index\":3,\"option_string\":\"<p>3<\\/p>\\n\"}],\"marks\":1,\"neg_mark\":0,\"hint\":\"<p>hhhhhhhhhhhhhhhhhhhhhhh<\\/p>\\n\",\"opposite_marking\":0,\"explanation\":\"<p>eeeeeeeeeeeeeeeeeeeeeeeeee<\\/p>\\n\"}]",
"answer_JSON": "[{\"answer\":[[0]],\"explanation\":\"<p>eeeeeeeeeeeeeeeeeeeeeeeeee<\\/p>\\n\"}]",
"display_index": 0,
"question_number": -1,
"is_removed": 0,
"sound_asset": null,
"sound_play_times": -1,
"video_asset": null,
"text_image_asset": null,
"html5_reading_str": "",
"reading_lnk": "",
"create_date": 1549535472,
"last_updated": 1634901036,
"engage_sub_topic_tag_id": 1,
"difficulty": 3,
"engage_topic_tag_id": 0
}
]
},
"page_context": {
"page": 1,
"per_page": 10,
"has_more_page": false,
"total_rows": 1
}
}Access: Institute admins, tutors, students and parents, plus custom roles that can view question banks or curriculum. You must have created the bank or it must be shared with one of your organizations.
Query parameters
The question bank.
pageinteger
Page number, starting at 1. Default 1.
per_pageinteger
Questions per page. Default 50.
searchstring
Matches part of a question's text, options or answer.
Response
codeinteger
Example:
200messagestring
Example:
Successquestion_bankobject
Show child attributesHide child attributes
question_bank.detailsobject
Show child attributesHide child attributes
Example:
200Example:
Feb-QbExample:
1Example:
1549535438Example:
7Example:
5Example:
4Example:
3Example:
0question_bank.questionsobject[]
Show child attributesHide child attributes
Example:
1107Example:
200Example:
["\n"]Example:
0Example:
-1Example:
0Example:
-1Example:
1549535472Example:
1Example:
3Example:
0page_contextobject
Show child attributesHide child attributes
page_context.pageinteger
Example:
1page_context.per_pageinteger
Example:
10page_context.has_more_pageboolean
Example:
falsepage_context.total_rowsinteger
Example:
1Notes: Removed questions are left out. Fails with "You do not have permission to access this question bank" if you can't see the bank. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.