reject-question.md

description
This API is used to reject the questions on the Sunbird-inQuiry Platform.

Reject Question

{% swagger method="delete" path="/question/v2/reject/{question_id}" baseUrl="" summary="This API is used to reject the questions on the Sunbird-inQuiry Platform." expanded="true" %} {% swagger-description %} • /question/v2/reject/{question_id} endpoint executes the "Reject Question" request based on parameters provided as metadata in the request body
• This API is used to send back the question to the creator by the reviewer. The API changes the question object status from review to draft.
• It points to inquiry-api-service (assessment service) - /question/v5/reject
• It is mandatory to provide values for parameters marked with *.
• Mandatory fields cannot be null or empty. {% endswagger-description %}

{% swagger-parameter in="path" name="question_id" type="String" required="true" %} Append a valid Question ID To the Request URL {% endswagger-parameter %}

{% swagger-parameter in="header" name="Authorization" type="String" required="true" %} 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}} {% 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" required="true" %} Metadata about the question to be rejected. {% endswagger-parameter %}

{% swagger-response status="200: OK" description="The Reject Question operation was successfully executed" %}

{
  "id": "api.question.reject",
  "ver": "5.0",
  "ts": "2023-06-29T03:37:12ZZ",
  "params": {
    "resmsgid": "70dc4cef-b7d0-4794-ae78-e80cc85b4770",
    "msgid": null,
    "err": null,
    "status": "successful",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "identifier": "do_11336893480941158415",
    "versionKey": "1634627965206"
  }
}

{% endswagger-response %}

{% swagger-response status="400: Bad Request" description="The Reject Question operation was unsuccessful. You may have missed providing input for a mandatory parameter.'" %}

{
  "id": "api.question.reject",
  "ver": "5.0",
  "ts": "2023-06-29T03:37:12ZZ",
  "params": {
    "resmsgid": "415e19d2-01e3-4690-b5c7-040316c56f5b",
    "msgid": null,
    "err": "ERR_QUESTION_REJECT",
    "status": "failed",
    "errmsg": "Question is not in Review state for identifier: do_11336893480941158415"
  },
  "responseCode": "CLIENT_ERROR",
  "result": {
    "messages": null
  }
}

{% endswagger-response %}

{% swagger-response status="404: Not Found" description="The Reject Question operation failed. The possible reason for failure is that you may have provided wrong question ID" %}

{
  "id": "api.question.reject",
  "ver": "5.0",
  "ts": "2023-06-29T03:37:12ZZ",
  "params": {
    "resmsgid": "da7af22e-bdce-48f0-8743-f50fa6c2cd21",
    "msgid": null,
    "err": "NOT_FOUND",
    "status": "failed",
    "errmsg": "Error! Node(s) does not Exist. | [Invalid Node Id.]: do_11336893480941158908"
  },
  "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." %}

{
  "id": "api.question.reject",
  "ver": "5.0",
  "ts": "2023-06-29T03:37:12ZZ",
  "params": {
    "resmsgid": "f234a6f0-3ac4-11eb-b0a2-8d5c9f561887",
    "msgid": null,
    "status": "failed",
    "err": null,
    "errmsg": null
  },
  "responseCode": "SERVER_ERROR",
  "result": {}
}

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

Success result schema

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

cURL

curl --location -g --request POST '{{host}}/question/v2/reject/{{question_id}}' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-ID: {{channel_id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request": {
        "question": {
            "rejectComment":"Rejected for testing"
        }
    }
}'