Read Private QuestionSet
This API is used to read an existing private question set on the Sunbird-inQuiry Platform.
This API is used to read an existing private question set on the Sunbird-inQuiry Platform.
GET
/questionset/v1/private/read
• The /private/read/{QuestionSet_Id} endpoint executes a request for fetching the private and public question sets to be viewed and read. • The endpoint for reading Private QuestionSet is /questionset/v1/private/read • It points to inquiry-api-service (assessment service) - /questionset/v4/private/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.
Path Parameters
QuestionSet_Id*
String
Append a valid Question Set Id To the Request URL
Headers
Content-Type
String
The Content-Type entity is the media type of the resource. Possible media types can be: Application/json
Authorization*
String
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}}
x-channel-id*
String
Unique identification number associated with a root organization.
{
"id": "api.questionset.private.read",
"ver": "3.0",
"ts": "2021-09-20T21:53:00Z+05:30",
"params": {
"resmsgid": "33f5a33f-5b2a-43ef-a3e8-67a6fffad675",
"msgid": null,
"err": null,
"status": "successful",
"errmsg": null
},
"responseCode": "OK",
"result": {
"questionset": {
"copyright": "2021",
"code": "c288ea98-0a8d-c927-5ec3-e879a90e9e43",
"allowSkip": "Yes",
"keywords": [
"Hindi QuestionSet"
],
"containsUserData": "No",
"channel": "abc-123",
"description": "Hindi QuestionSet",
"language": [
"English"
],
"mimeType": "application/vnd.sunbird.questionset",
"showHints": "No",
"createdOn": "2021-09-18T13:55:52.003+0530",
"objectType": "QuestionSet",
"primaryCategory": "Practice Question Set",
"contentDisposition": "inline",
"additionalCategories": [
"Textbook"
],
"lastUpdatedOn": "2021-09-18T20:01:49.833+0530",
"contentEncoding": "gzip",
"generateDIALCodes": "No",
"showSolutions": "No",
"allowAnonymousAccess": "Yes",
"identifier": "do_11336896348850585611",
"lastStatusChangedOn": "2021-09-18T13:55:52.003+0530",
"createdFor": [
"01309282781705830427"
],
"audience": [
"Teacher"
],
"requiresSubmit": "Yes",
"visibility": "Private",
"showTimer": "Yes",
"author": "Test",
"childNodes": [
"do_11336896498434048013"
],
"setType": "materialised",
"lastPublishedBy": "testing",
"languageCode": [
"en"
],
"version": 1,
"versionKey": "1631975509833",
"showFeedback": "Yes",
"license": "CC BY 4.0",
"maxAttempts": 3,
"framework": "tn_k-12",
"depth": 0,
"createdBy": "5a587cc1-e018-4859-a0a8-e842650b9d64",
"compatibilityLevel": 5,
"name": "Hindi QuestionSet",
"navigationMode": "non-linear",
"timeLimits": [
{
"maxTime": "18549"
},
{
"warningTime": "7200"
}
],
"shuffle": true,
"attributions": [
"VB",
" Nk"
],
"status": "Draft"
}
}
}
cURL
curl --location -g --request GET '{{host}}/questionset/v1/private/read/{{questionSet_id}}' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-ID: {{channel_id}}'
Last updated
Was this helpful?