Add General Question
PUT
/api/generalQuestion
Summary
Adds a new question into the set of questions that are answered for a given industry.
Description
The Add General Question API adds a new question into the set of questions that are answered for a given industry in the database.
Key characteristics of this endpoint:
- Private access only.
- Three query parameters, no request body
- Clear separation between database errors and unexpected server failures
Endpoint
PUT /api/generalQuestionRequest
This endpoint accepts three parameters.
Parameters
| Parameters | Required | Type | Description |
|---|---|---|---|
type | mandatory | string | Whether the question belongs to social or governance sections |
question | mandatory | string | The question itself. Note that all special characters must be appropriately encoded |
qualitative | mandatory | boolean | Whether the question is of type qualitative or not |
Headers
This endpoint accepts a singular optional header.
| Header | Required | Description |
|---|---|---|
Accept | optional | Defaults to application/json |
Response Schema
Success - 200 OK
Example Response
[]Error Codes & Response Types
503 Service Unavailable
Returned when the database is temporarily unavailable, a query fails due to a database issue, or Gemini is overloaded.
Response Body
{
"detail" : "Database temporarily unavailable"
}Typical Causes
- MongoDB Connection Issues
- Database timeout or query failure for a non-general reason
500 Internal Server Error
Returned when an unexpected server-side error occurs.
Response Body
{
"detail" : "Internal server error"
}Typical Causes
- Unhandled runtime exception
- Application-level failure outside database operations.
Implementation Notes
- Logs both database-specific and unexpected errors for observability
- Treats empty datasets as a valid state, not an error condition
Last updated on