retire-questionset.md

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

Retire QuestionSet

{% swagger method="delete" path="/retire/{QuestionSet_Id}" baseUrl="" summary="This API is used to retire the question set on the Sunbird-inQuiry Platform." expanded="true" %} {% swagger-description %} • The

/retire/{QuestionSet_Id}

endpoint executes a "Retire QuestionSet" request based on

QuestionSet_Id

to delete the specific Question set.

\

• The endpoint for Retire QuestionSet is

/questionset/v1/retire

\

• It points to inquiry-api-service (assessment service) -

/questionset/v4/retire

\

• It is mandatory to provide values for parameters.

\

• Mandatory fields cannot be null or empty. {% endswagger-description %}

{% swagger-parameter in="path" name="QuestionSet_Id" type="String" required="true" %} Please append a valid QuestionSet Id to the Request URL {% endswagger-parameter %}

{% swagger-parameter in="header" name="Authorization" type="String" required="true" %} 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}}

{% endswagger-parameter %}

{% swagger-parameter in="header" name="x-channel-id" type="String" %} Unique identification number associated with a root organization. {% endswagger-parameter %}

{% swagger-parameter in="body" name="request" type="Object" %} The body is the representation of the resource object for retiring a question set {% endswagger-parameter %}

{% swagger-response status="200: OK" description="QuestionSet deletion operation was successfully executed." %}

{
  "id": "api.questionset.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"
  }
}

{% endswagger-response %}

{% swagger-response status="400: Bad Request" description="QuestionSet is already retired." %}

{
  "id": "api.questionset.retire",
  "ver": "3.0",
  "ts": "2021-02-02T20:21:26ZZ",
  "params": {
    "resmsgid": "0608b59d-dfb9-4c0e-807f-1a19c9a163fe",
    "msgid": null,
    "err": "ERR_QUESTION_RETIRE",
    "status": "failed",
    "errmsg": "QuestionSet with identifier : do_113207939069968384112 is already Retired."
  },
  "responseCode": "CLIENT_ERROR",
  "result": {
    "messages": null
  }
}

{% endswagger-response %}

{% swagger-response status="404: Not Found" description="QuestionSet Send for Retire operation failed! The possible reason for failure is that you may have provided wrong questionset id." %}

{
  "id": "api.questionset.retire",
  "ver": "3.0",
  "ts": "2021-02-02T20:22:03ZZ",
  "params": {
    "resmsgid": "da7af22e-bdce-48f0-8743-f50fa6c2cd21",
    "msgid": null,
    "err": "NOT_FOUND",
    "status": "failed",
    "errmsg": "Error! Node(s) doesn't Exists. | [Invalid Node Id.]: do_1132079390699683841121"
  },
  "responseCode": "RESOURCE_NOT_FOUND",
  "result": {
    "messages": null
  }
}

{% endswagger-response %}

{% swagger-response status="500: Internal Server Error" description="Looks like something went wrong! These errors are tracked automatically" %}

{
  "result": {},
  "id": "string",
  "ver": "string",
  "ts": "string",
  "params": {
    "resmsgid": "string",
    "msgid": "string",
    "err": "string",
    "status": "string",
    "errmsg": "string"
  },
  "responseCode": "string"
}

{% endswagger-response %} {% endswagger %}

Success result schema

Attribute	Type	Description
identidier	String	Unique Question identifier
versionKey	String	Unique version key for question

cURL

curl --location -g --request DELETE '{{host}}/questionset/v1/retire/{{questionSet_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-Id: {{channel_id}}' \
--data-raw '{
  "request": {
    "questionset": {
    }
  }
}'