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/v1/retire/{Question_Id}

ā€¢ It points to inquiry-api-service (assessment service)- /question/v4/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. ā€¢ Question schema check here

Path Parameters

NameTypeDescription

Question_Id*

String

Append a valid Question ID To the Request URL

Headers

NameTypeDescription

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.

{
  "id": "api.question.retire",
  "ver": "3.0",
  "ts": "2021-02-02T20:20:56ZZ",
  "params": {
    "resmsgid": "98c9f97d-f9d6-4da9-be88-2852294c2aaa",
    "msgid": null,
    "err": null,
    "status": "successful",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "identifier": "do_113207939069968384112",
    "versionKey": "1612297249754"
  }
}

Success result Schema

AttributeTypeDescription

identidier

String

Unique Question identifier

versionKey

String

Unique version key for question

cURL

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

Last updated