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

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

200: OK Question sent for review operation successful!

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

400: Bad Request The Review Question operation failed. The possible reason for failure is that you may have missed providing input for a mandatory parameter

{
  "id": "api.question.review",
  "ver": "5.0",
  "ts": "2023-06-29T04:01:05ZZ",
  "params": {
    "resmsgid": "db7fd0f9-4aa5-4f06-b43b-1b89bec45c50",
    "msgid": null,
    "err": "ERR_QUESTION_REVIEW",
    "status": "failed",
    "errmsg": "Question with status other than Draft can't be sent for review."
  },
  "responseCode": "CLIENT_ERROR",
  "result": {
    "messages": null
  }
}

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

{
  "id": "api.question.review",
  "ver": "5.0",
  "ts": "2023-06-29T04:01:05ZZ",
  "params": {
    "resmsgid": "852b878c-a607-4d72-9458-6239e36adb9e",
    "msgid": null,
    "err": "NOT_FOUND",
    "status": "failed",
    "errmsg": "Error! Node(s) does not Exist. | [Invalid Node Id.]: do_1132079319215554561111"
  },
  "responseCode": "RESOURCE_NOT_FOUND",
  "result": {
    "messages": null
  }
}

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

{
  "id": "api.question.review",
  "ver": "5.0",
  "ts": "2023-06-29T03:37:12ZZ",
  "params": {
    "resmsgid": "f234a6f0-3ac4-11eb-b0a2-8d5c9f561887",
    "msgid": null,
    "status": "failed",
    "err": null,
    "errmsg": null
  },
  "responseCode": "SERVER_ERROR",
  "result": {}
}

Success result schema

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