read-private-question.md

description
This API is used to read the private question on the Sunbird-inQuiry Platform.

Read Private Question

{% swagger method="get" path="/question/v2/private/read/{question_id}" baseUrl="" summary="This API is used to read the private question on the Sunbird-inQuiry Platform." expanded="true" %} {% swagger-description %} Private Questions are created within a specific channel. The user can fetch the question by providing that channel id in a request header.

• It points to inquiry-api-service (assessment service) - /question/v5/private/read
• You need to provide a valid Question Id value in {question_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" type="String" name="question_id" required="true" %} Append a valid Question 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. It should be Application/json {% endswagger-parameter %}

{% swagger-parameter in="header" name="Authorization" type="String" required="true" %} 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" required="true" %} Unique identification number associated with a root organization. {% endswagger-parameter %}

{% swagger-response status="200: OK" description="Successful Operation. The "Read Private Question" operation was successfully executed" %} {% code overflow="wrap" %}

{
    "id": "api.question.private.read",
    "ver": "5.0",
    "ts": "2023-06-29T04:01:25ZZ",
    "params": {
        "resmsgid": "ca95b536-5403-4dab-a019-47e8064cd4ce",
        "msgid": null,
        "err": null,
        "status": "successful",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "question": {
            "code": "47f7fdfb-22c1-4d89-958d-f02e219246ec",
            "qumlVersion": 1.1,
            "channel": "test-001",
            "language": [
                "English"
            ],
            "mimeType": "application/vnd.sunbird.question",
            "showHints": false,
            "createdOn": "2023-06-29T04:01:05.631+0000",
            "objectType": "Question",
            "primaryCategory": "Multiple Choice Question",
            "contentDisposition": "inline",
            "lastUpdatedOn": "2023-06-29T04:01:05.631+0000",
            "contentEncoding": "gzip",
            "showSolutions": false,
            "allowAnonymousAccess": "Yes",
            "identifier": "do_2138281882873774081521",
            "lastStatusChangedOn": "2023-06-29T04:01:05.631+0000",
            "schemaVersion": "1.1",
            "visibility": "Private",
            "showTimer": false,
            "languageCode": [
                "en"
            ],
            "versionKey": "1688011265631",
            "showFeedback": false,
            "license": "CC BY 4.0",
            "compatibilityLevel": 5,
            "name": "FT_Q_1",
            "status": "Draft"
        }
    }
}

{% endcode %} {% endswagger-response %}

{% swagger-response status="404: Not Found" description="Question Private Read operation failed! The possible reason for failure is that you may have provided the wrong question ID." %}

{
    "id": "api.question.private.read",
    "ver": "5.0",
    "ts": "2023-06-29T04:02:42ZZ",
    "params": {
        "resmsgid": "bb64e78b-55a0-40bc-b351-ce04237a0e1f",
        "msgid": null,
        "err": "NOT_FOUND",
        "status": "failed",
        "errmsg": "Error! Node(s) doesn't Exists. | [Invalid Node Id.]: do_213828188287377408152"
    },
    "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.question.private.read",
  "ver": "5.0",
  "ts": "2023-06-29T03:50:10ZZ",
  "params": {
    "resmsgid": "f234a6f0-3ac4-11eb-b0a2-8d5c9f561887",
    "msgid": null,
    "status": "failed",
    "err": null,
    "errmsg": null
  },
  "responseCode": "SERVER_ERROR",
  "result": {}
}

{% endswagger-response %} {% endswagger %}

Sample Response

{
    "id": "api.question.private.read",
    "ver": "5.0",
    "ts": "2023-06-29T04:04:45ZZ",
    "params": {
        "resmsgid": "56b67c99-5beb-4bf5-a282-aee3193f24d9",
        "msgid": null,
        "err": null,
        "status": "successful",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "question": {
            "code": "47f7fdfb-22c1-4d89-958d-f02e219246ec",
            "qumlVersion": 1.1,
            "channel": "test-001",
            "language": [
                "English"
            ],
            "mimeType": "application/vnd.sunbird.question",
            "showHints": false,
            "createdOn": "2023-06-29T04:01:05.631+0000",
            "objectType": "Question",
            "primaryCategory": "Multiple Choice Question",
            "contentDisposition": "inline",
            "lastUpdatedOn": "2023-06-29T04:01:05.631+0000",
            "contentEncoding": "gzip",
            "showSolutions": false,
            "allowAnonymousAccess": "Yes",
            "identifier": "do_2138281882873774081521",
            "lastStatusChangedOn": "2023-06-29T04:01:05.631+0000",
            "schemaVersion": "1.1",
            "visibility": "Private",
            "showTimer": false,
            "languageCode": [
                "en"
            ],
            "versionKey": "1688011265631",
            "showFeedback": false,
            "license": "CC BY 4.0",
            "compatibilityLevel": 5,
            "name": "FT_Q_{{randomeUUID}}",
            "status": "Draft"
        }
    }
}

Success Result Schema

Name	Type	Description
identifier	String	Unique Question Identifier
name	String	Name of the Question
versionKey	String	Unique version key of Question
code	String	Unique Code for Question
lastStatusChangedOn	String	Last status changed time
visibility	String	Question Visibility eg. parent
mimeType	String	Question mimeType eg. application/vnd.sunbird.question
createdOn	String	Time of question creation
objectType	String	Question objectType
primaryCategory	String	Type of question - Multiple Choice Question or Subjective Question
status	String	Question status Draft/Review/Live
lastUpdatedOn	String	Last Updated time

cURL

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