Retire Question

This API is used to retiring a questions on the Sunbird-inQuiry Platform.

This API is used to retiring a questions on the Sunbird-inQuiry Platform.

DELETE /question/v2/retire/{question_id}

• It points to inquiry-api-service (assessment service)- /question/v5/retire • 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
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.

200: OK The Retire Question operation was successful!

{
  "id": "api.question.retire",
  "ver": "5.0",
  "ts": "2023-06-29T03:37:12ZZ",
  "params": {
    "resmsgid": "98c9f97d-f9d6-4da9-be88-2852294c2aaa",
    "msgid": null,
    "err": null,
    "status": "successful",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "identifier": "do_113207939069968384112",
    "versionKey": "1612297249754"
  }
}

400: Bad Request Question is already retired

404: Not Found The Retire 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
identifier	String	Unique Question identifier
versionKey	String	Unique version key for question

cURL

curl --location -g --request DELETE '{{host}}/question/v2/retire/{question_id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-Id: {{channel_id}}' \