# Read Private QuestionSet

## This API is used to read an existing private question set on the Sunbird-inQuiry Platform.

<mark style="color:blue;">`GET`</mark> `/questionset/v1/private/read`

• The <mark style="color:orange;">/private/read/{QuestionSet\_Id}</mark> endpoint executes a request for fetching the private and public question sets to be viewed and read. \
• The endpoint for reading Private QuestionSet is <mark style="color:orange;">/questionset/v1/private/read</mark>\
• It points to inquiry-api-service (assessment service) - <mark style="color:orange;">/questionset/v4/private/read</mark> \
• You need to provide a valid QuestionSet Id value in <mark style="color:orange;">{QuestionSet\_Id}</mark> field of the API URL.\
• It is mandatory to provide values for parameters marked with <mark style="color:red;">\*</mark>\
• Mandatory fields cannot be null or empty.

#### Path Parameters

| Name                                              | Type   | Description                                       |
| ------------------------------------------------- | ------ | ------------------------------------------------- |
| QuestionSet\_Id<mark style="color:red;">\*</mark> | 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: <mark style="color:green;">Application/json</mark>                                                                                                                  |
| Authorization<mark style="color:red;">\*</mark> | String | <p>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.<br>Set <mark style="color:green;">Bearer {{api\_key}}</mark></p> |
| x-channel-id<mark style="color:red;">\*</mark>  | String | Unique identification number associated with a root organization.                                                                                                                                                                                           |

{% tabs %}
{% tab title="200: OK The "Read Private Question Set" operation was successfully executed" %}

```javascript
{
  "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"
    }
  }
}
```

{% endtab %}

{% tab title="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." %}

```javascript
{
  "id": "api.questionset.private.read",
  "ver": "3.0",
  "ts": "2021-09-20T22:00:42Z+05:30",
  "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
  }
}
```

{% endtab %}

{% tab title="500: Internal Server Error Looks like something went wrong! These errors are tracked automatically" %}

```javascript
{
  "result": {},
  "id": "string",
  "ver": "string",
  "ts": "string",
  "params": {
    "resmsgid": "string",
    "msgid": "string",
    "err": "string",
    "status": "string",
    "errmsg": "string"
  },
  "responseCode": "string"
}
```

{% endtab %}
{% endtabs %}

#### cURL

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://inquiry.sunbird.org/learn/product-and-developer-guide/question-and-question-set-service/apis/v1/questionset-apis/read-private-questionset.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.