Publish Question
This API is used to publish the question on Sunbird platform.
This API is used to publish the question on Sunbird-inQuiry platform.
POST
/question/v2/publish/{question_id}
• /publish endpoint executes the "Publish Question" request based on parameters provided as metadata in the request body • It points to inquiry-api-service (assessment service)- /question/v5/publish • 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. • Asynchronous flink job : async-questionset-publish will takes care of the publishing activity.
Path Parameters
question_id*
String
Append a valid Question ID To the Request URL
Headers
Content-Type*
String
The Content-Type entity is the media type of the resource. It should 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.
Request Body
request
Object
metadata about the question to be published
{
"id": "api.question.publish",
"ver": "5.0",
"ts": "2023-06-29T04:01:05ZZ",
"params": {
"resmsgid": "9c64cc9c-bed5-44c7-85bf-4918c3a42f58",
"msgid": null,
"err": null,
"status": "successful",
"errmsg": null
},
"responseCode": "OK",
"result": {
"message": "Question is successfully sent for Publish",
"identifier": "do_2138282512518184961525"
}
}
Success result schema
identifier
String
Unique Question identifier
message
String
Publish success message
cURL
curl --location -g --request POST '{{host}}/question/v2/publish/{{question_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-Id: {{channel_id}}' \
--data-raw '{
"request": {}
}'
Last updated
Was this helpful?