Reset report settings to defaults

Reset report settings to default factory configuration. Use Cases:

• System reconfiguration: Start fresh with default settings
• Fix corrupted settings: Restore known-good default configuration
• Testing purposes: Reset to baseline for testing scenarios
• After major changes: Revert to standard settings structure Operation Sequence:

1. Deletes existing ReportSettings instance (if exists)
2. Creates new instance with hardcoded default values
3. Returns the newly created default settings Default Configuration: The endpoint creates settings with predefined ranking priorities: O-Level Rules (Priority Order):
4. Subjects Passed - Students with highest number of passes ranked first
5. Grades - Students with most subjects ranked first
6. Total marks - Students with highest marks ranked first A-Level Rules (Priority Order):
7. Subjects Passed - Students with highest number of passes ranked first
8. Symbol - Students with most subjects ranked first
9. Total marks - Students with highest marks ranked first Important Notes:

• This is a destructive operation - existing settings are deleted
• The operation cannot be undone - no backup is created
• All custom priority rules and configurations will be lost
• The endpoint always succeeds (idempotent) - even if no settings exist
• New settings are created immediately after deletion

POST /api/v1/school/report-settings/reset

Reset report settings to defaults

cURL

curl --request POST \
  --url https://api.example.com/api/v1/school/report-settings/reset/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "priority": "<unknown>",
  "is_deleted": true
}
'

200

{
  "reset": true,
  "data": {
    "id": "uuid-123",
    "priority": {
      "o_level_rules": [
        {
          "rule": "Subjects Passed",
          "priority": 1,
          "description": "Students with the highest number of A's are ranked first"
        },
        {
          "rule": "Grades",
          "priority": 2,
          "description": "Students with the most number of subjects are ranked first"
        },
        {
          "rule": "Total marks",
          "priority": 3,
          "description": "Students with the highest marks are ranked first"
        }
      ],
      "a_level_rules": [
        {
          "rule": "Subjects Passed",
          "priority": 1,
          "description": "Students with the highest number of A's are ranked first"
        },
        {
          "rule": "Symbol",
          "priority": 2,
          "description": "Students with the most number of subjects are ranked first"
        },
        {
          "rule": "Total marks",
          "priority": 3,
          "description": "Students with the highest marks are ranked first"
        }
      ]
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Auto-populate created_by from request.user when available.

priority · any

is_deleted · boolean

Response

200 - application/json

{key} · any