Create report settings

Create initial report card settings configuration (singleton pattern). Use Cases:

• Initial system setup: Configure report card generation settings for the first time
• Fresh installation: Set up report card priorities and ranking rules
• System reconfiguration: Create settings after complete reset Singleton Behavior:
• Only one ReportSettings instance can exist in the system
• If settings already exist, this endpoint returns an error
• Use the update endpoint to modify existing settings
• Use the reset endpoint to restore default settings Configuration Structure: The report settings typically contain:
• priority: Ranking priority rules for report cards
• o_level_rules: Array of rules for O-Level students (Subjects Passed, Grades, Total marks)
• a_level_rules: Array of rules for A-Level students (Subjects Passed, Symbol, Total marks)
• Each rule has: rule, priority (1, 2, 3…), and description Validation Rules:
• Settings must not already exist (enforced at endpoint level)
• Priority rules must be properly structured JSON
• Each level should have complete ranking criteria Important Notes:
• This is typically called once during initial system setup
• The settings affect how student rankings are calculated on report cards
• Default settings are provided by the reset endpoint if needed
• Deletion is handled separately via the destroy endpoint

POST /api/v1/school/report-settings

Create report settings

cURL

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

201

SuccessResponse

{ "created": 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" } ], "a_level_rules": [ { "rule": "Subjects Passed", "priority": 1, "description": "Students with the highest number of A's 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

201

application/json

{key} · any