Retire QuestionSet

This API is used to retire the question set on the Sunbird-inQuiry Platform.

This API is used to retire the question set on the Sunbird-inQuiry Platform.

DELETE /questionset/v2/retire/{questionSet_id}

• The /questionset/v2/retire/{questionSet_id} endpoint executes a "Retire QuestionSet" request based on QuestionSet_Id to delete the specific Question set. • It points to inquiry-api-service (assessment service) - /questionset/v5/retire/{questionSet_id} • It is mandatory to provide values for parameters. • Mandatory fields cannot be null or empty.

Path Parameters

Name	Type	Description
questionSet_id*	String	Please append a valid QuestionSet Id to the Request URL

Headers

Name	Type	Description
Authorization*	String	All questionset APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API. Set Bearer {{api_key}}
x-channel-id	String	Unique identification number associated with a root organization.

Request Body

Name	Type	Description
request	Object	The body is the representation of the resource object for retiring a question set

200: OK QuestionSet deletion operation was successfully executed.

{
  "id": "api.questionset.retire",
  "ver": "5.0",
  "ts": "2023-06-29T07:51:03ZZ",
  "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 QuestionSet is already retired.

404: Not Found QuestionSet Send for Retire operation failed! The possible reason for failure is that you may have provided wrong questionset 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}}/questionset/v2/retire/{{questionSet_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-Id: {{channel_id}}' \
--data-raw '{
  "request": {
    "questionset": {
    }
  }
}'