Submit for Review Question

This API is used to submit question for review on the Sunbird-inQuiry Platform.

This API is used to submit question for review on the Sunbird-inQuiry Platform.

POST /question/v2/review/{question_id}

ā€¢ /question/v2/review/{question_id} endpoint executes the "Submit for Review" request based on parameters provided as metadata in the request body ā€¢ It points to inquiry-api-service (assessment service) - /question/v5/review ā€¢ 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.

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 sent for review.

{
  "id": "api.question.review",
  "ver": "5.0",
  "ts": "2023-06-29T04:01:05ZZ",
  "params": {
    "resmsgid": "6a00ef94-b63d-4fb6-818a-8dfc66680577",
    "msgid": null,
    "err": null,
    "status": "successful",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "identifier": "do_113207931921555456111",
    "versionKey": "1612296382041"
  }
}

Success result schema

AttributeTypeDescription

identifier

String

Unique Question identifier

versionKey

String

Unique version key for question

cURL

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

Last updated