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/v2/private/read/{questionSet_id}

• The /questionset/v2/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/v2/private/read • It points to inquiry-api-service (assessment service) - /questionset/v5/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

Name	Type	Description
questionSet_id*	String	Append a valid Question Set Id To the Request URL

Headers

Name	Type	Description
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.

200: OK The "Read Private Question Set" operation was successfully executed

{
    "id": "api.questionset.private.read",
    "ver": "5.0",
    "ts": "2023-06-29T11:23:27ZZ",
    "params": {
        "resmsgid": "c14dcc78-4387-4a7d-acb5-2e071dbc3117",
        "msgid": null,
        "err": null,
        "status": "successful",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "questionset": {
            "code": "sunbird.qs.1",
            "allowSkip": "Yes",
            "containsUserData": "No",
            "qumlVersion": 1.1,
            "channel": "test-0001",
            "language": [
                "English"
            ],
            "mimeType": "application/vnd.sunbird.questionset",
            "showHints": false,
            "createdOn": "2023-06-29T11:22:49.141+0000",
            "objectType": "QuestionSet",
            "scoreCutoffType": "AssessmentLevel",
            "primaryCategory": "Practice Question Set",
            "contentDisposition": "inline",
            "lastUpdatedOn": "2023-06-29T11:22:49.141+0000",
            "contentEncoding": "gzip",
            "generateDIALCodes": "No",
            "showSolutions": false,
            "trackable": {
                "enabled": "No",
                "autoBatch": "No"
            },
            "allowAnonymousAccess": "Yes",
            "identifier": "do_2138284054041886721542",
            "lastStatusChangedOn": "2023-06-29T11:22:49.141+0000",
            "schemaVersion": "1.1",
            "requiresSubmit": "No",
            "visibility": "Private",
            "showTimer": true,
            "consumerId": "6968004d-c67e-434a-a350-773aa1e068a3",
            "setType": "materialised",
            "languageCode": [
                "en"
            ],
            "versionKey": "1688037769141",
            "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"
        }
    }
}

404: Not Found The Read Private Question Set operation failed! The possible reason for failure is that you may have provided wrong question set ID.

{
  "id": "api.questionset.private.read",
  "ver": "5.0",
  "ts": "2023-06-29T07:51:03ZZ",
  "params": {
    "resmsgid": "50bd44a0-ccc8-48fd-9361-3a2990f44e16",
    "msgid": null,
    "err": "NOT_FOUND",
    "status": "failed",
    "errmsg": "Error! Node(s) doesn't Exists. | [Invalid Node Id.]: do_11336896348850585612"
  },
  "responseCode": "RESOURCE_NOT_FOUND",
  "result": {
    "messages": null
  }
}

500: Internal Server Error Looks like something went wrong! These errors are tracked automatically

{
  "id": "api.questionset.private.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": {}
}

cURL

curl --location -g --request GET '{{host}}/questionset/v2/private/read/{{questionSet_id}}' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-ID: {{channel_id}}'