Reject QuestionSet

This API is used to reject the question set, which is sent for review on the Sunbird-inQuiry Platform.

This API is used to reject the question set, which is sent for review on the Sunbird-inQuiry Platform.

POST /questionset/v2/reject/{questionSet_Id}}

ā€¢ The /questionset/v2/reject/{questionSet_Id} endpoint executes the "Rejecting QuestionSet" request based on parameters provided as metadata in the request body. ā€¢ It points to inquiry-api-service (assessment service) - /questionset/v5/reject/{questionSet_Id} ā€¢ You need to provide a valid QuestionSet Id value in the {questionSet_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

NameTypeDescription

questionSet_Id*

String

Append a valid Question Set Id To the Request URL

Headers

NameTypeDescription

Content-Type*

String

The Content-Type entity is the media type of the resource. Possible media types can be: Application/json

Authorization*

String

All content 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

NameTypeDescription

request

Object

The metadata about the questionset to be rejected

{
  "id": "api.questionset.reject",
  "ver": "5.0",
  "ts": "2023-06-29T07:51:03ZZ",
  "params": {
    "resmsgid": "a505a723-616f-4e3f-9a52-2f0d9924f732",
    "msgid": null,
    "err": null,
    "status": "successful",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "identifier": "do_113208406116417536122",
    "versionKey": "1612354279918"
  }
}

Request Sample

{
  "request": {
    "questionset": {
      "rejectComment": "Rejected for testing"
    }
  }
}

Request Schema

AttributeTypeDescriptionRequired

rejectComment

String

Question set rejection comment/reason

Yes

Success result schema

AttributeTypeDescription

identifier

String

Unique Question identifier

versionKey

String

Unique version key for question

cURL

curl --location -g --request POST '{{host}}/questionset/v2/reject/{{questionSet_id}}' \
  -H 'Authorization: Bearer {{api_key}}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"request":{"questionset":{"rejectComment":"Not aligned"}}}' \
  --compressed

Last updated