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/v1/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/v4/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. • Question schema check here • Asynchronous flink job : async-questionset-publish will takes care of the publishing activity.

Path Parameters

Name	Type	Description
Question_Id*	String	Append a valid Question ID To the Request URL

Headers

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

Name	Type	Description
request	Object	metadata about the question to be published

200: OK The Publish Question operation was successful!

{
  "id": "api.question.publish",
  "ver": "3.0",
  "ts": "2021-02-02T20:15:02ZZ",
  "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_113207931921555456111"
  }
}

404: Not Found The Publish Question operation failed. The possible reason for failure is that you may have provided wrong question ID

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

Success result schema

Attribute	Type	Description
identidier	String	Unique Question identifier
message	String	Publish success message

cURL

curl --location -g --request POST '{{host}}/question/v1/publish/{{question_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-Id: {{channel_id}}' \
--data-raw '{
    "request": {}
}'