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

NameTypeDescription

Question_Id*

String

Append a valid Question ID To the Request URL

Headers

NameTypeDescription

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

NameTypeDescription

request

Object

metadata about the question to be published

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

Success result schema

AttributeTypeDescription

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": {}
}'

Last updated