| description |
|---|
This API is used to read an existing question set on the Sunbird-inQuiry Platform. |
{% swagger method="get" path="/questionset/v2/read/{questionSet_id}" baseUrl="" summary="This API is used to read an existing question set on the Sunbird-inQuiry Platform." expanded="true" %}
{% swagger-description %}
• The /questionset/v2/read/{questionSet_id} endpoint executes a request for fetching the question to read.
• This API returns only the metadata of the question set not the hierarchical structure. To read hierarchical structure please use read questionset hierarchy API
• The endpoint for reading QuestionSet is /questionset/v2/read
• It points to inquiry-api-service (assessment service) - /questionset/v5/read
• You need to provide a valid QuestionSet Id value in {questionSet_id} field of the API URL.
• It is mandatory to provide values for parameters marked with *
• Mandatory fields cannot be null or empty.
{% endswagger-description %}
{% swagger-parameter in="path" name="questionSet_id" type="String" required="true" %} Append a valid Question Set Id To the Request URL {% endswagger-parameter %}
{% swagger-parameter in="header" name="Content-Type" type="String" required="false" %} The Content-Type entity is the media type of the resource. Possible media types can be: Application/json {% endswagger-parameter %}
{% swagger-parameter in="header" name="Authorization" type="String" required="false" %}
To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
Set Bearer {{api_key}}
{% endswagger-parameter %}
{% swagger-parameter in="header" name="x-channel-id" type="String" %} Unique identification number associated with a root organization. {% endswagger-parameter %}
{% swagger-parameter in="query" name="mode=edit" type="String" %} To fetch the latest version of node from the database for edit purpose {% endswagger-parameter %}
{% swagger-parameter in="query" name="fields=comma separated metadata names" type="String" %} To fetch the specific fields, this query parameter can be used eg. fields=name,description,outcomDeclaration... {% endswagger-parameter %}
{% swagger-response status="200: OK" description="The "Read Question Set" operation was successfully executed" %}
{
"id": "api.questionset.read",
"ver": "5.0",
"ts": "2023-06-29T11:15:59ZZ",
"params": {
"resmsgid": "813ea426-92f2-4e5b-b9bf-c19bbd8e2b23",
"msgid": null,
"err": null,
"status": "successful",
"errmsg": null
},
"responseCode": "OK",
"result": {
"questionset": {
"code": "sunbird.qs.1",
"allowSkip": "Yes",
"containsUserData": "No",
"qumlVersion": 1.1,
"language": [
"English"
],
"mimeType": "application/vnd.sunbird.questionset",
"showHints": false,
"createdOn": "2023-06-29T11:15:31.610+0000",
"objectType": "QuestionSet",
"scoreCutoffType": "AssessmentLevel",
"primaryCategory": "Practice Question Set",
"contentDisposition": "inline",
"lastUpdatedOn": "2023-06-29T11:15:31.610+0000",
"contentEncoding": "gzip",
"generateDIALCodes": "No",
"showSolutions": false,
"trackable": {
"enabled": "No",
"autoBatch": "No"
},
"allowAnonymousAccess": "Yes",
"identifier": "do_2138284018199265281540",
"lastStatusChangedOn": "2023-06-29T11:15:31.610+0000",
"schemaVersion": "1.1",
"requiresSubmit": "No",
"visibility": "Default",
"showTimer": true,
"consumerId": "6968004d-c67e-434a-a350-773aa1e068a3",
"setType": "materialised",
"languageCode": [
"en"
],
"versionKey": "1688037331610",
"showFeedback": false,
"license": "CC BY 4.0",
"createdBy": "sunbird-user-1",
"compatibilityLevel": 6,
"name": "QuestionSet-FT-1",
"navigationMode": "non-linear",
"allowBranching": "No",
"shuffle": true,
"status": "Draft"
}
}
}{% endswagger-response %}
{% swagger-response status="404: Not Found" description="The Read Question Set operation failed! The possible reason for failure is that you may have provided wrong question set ID." %}
{
"id": "api.questionset.read",
"ver": "5.0",
"ts": "2023-06-29T11:15:59ZZ",
"params": {
"resmsgid": "815b341a-7984-45a1-b1f9-4335da18985e",
"msgid": null,
"err": "NOT_FOUND",
"status": "failed",
"errmsg": "Error! Node(s) does not exist. | [Invalid Node Id.]: do_1132083238015549441201"
},
"responseCode": "RESOURCE_NOT_FOUND",
"result": {
"messages": null
}
}{% endswagger-response %}
{% swagger-response status="500: Internal Server Error" description="Looks like something went wrong! These errors are tracked automatically" %}
{
"id": "api.questionset.read",
"ver": "5.0",
"ts": "2023-06-29T07:51:03ZZ",
"params": {
"resmsgid": "f234a6f0-3ac4-11eb-b0a2-8d5c9f561887",
"msgid": null,
"status": "failed",
"err": null,
"errmsg": null
},
"responseCode": "SERVER_ERROR",
"result": {}
}{% endswagger-response %} {% endswagger %}
| Attribute | Type | Description |
|---|---|---|
| identifier | String | Unique Question set Identifier |
| name | String | Name of the Question set |
| versionKey | String | Unique version key of Question set |
| code | String | Unique Code for Question set |
| lastStatusChangedOn | String | Last status changed time |
| visibility | String | Question set Visibility eg. parent or default |
| mimeType | String | Question mimeType eg. application/vnd.sunbird.questionset |
| createdOn | String | Time of question set creation |
| objectType | String | QuestionSet objectType |
| primaryCategory | String | Eg - Practice Question set or Exam Question set |
| status | String | Question status Draft/Review/Live |
| lastUpdatedOn | String | Last updated time |
Sample CURL to read all metadata
curl --location -g --request GET '{{host}}/questionset/v2/read/{{questionSet_id}}' \
--header 'Authorization: Bearer {{api_key}}'Sample CURL to read all metadata
curl --location -g --request GET '{{host}}/questionset/v2/read/{{questionSet_id}}?fields=name,description' \
--header 'Authorization: Bearer {{api_key}}'