Read QuestionSet
This API is used to read an existing question set on the Sunbird-inQuiry Platform.
This API is used to read an existing question set on the Sunbird-inQuiry Platform.
GET
/read/{QuestionSet_Id}
• The /questionset/v1/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/v1/read
• It points to inquiry-api-service (assessment service) - /questionset/v4/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 |
Query Parameters
Name | Type | Description |
---|---|---|
mode=edit | String | To fetch the latest version of node from the database for edit purpose |
fields=comma separated metadata names | String | To fetch the specific fields, this query parameter can be used eg. fields=name,description,outcomDeclaration... |
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. |
Success response schema
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 - |
status | String | Question status |
lastUpdatedOn | String | Last updated time |
cURL
Sample CURL to read all metadata
Sample CURL to read all metadata
Last updated