Skip to main content
POST
/
api
/
v1
/
school
/
sessions
/
{session_pk}
/
exam-sessions
/
{exam_session_pk}
/
report-cards
/
bulk-head-comments
Apply head comments to selected classes
curl --request POST \
  --url https://test-api.afrainity.com/api/v1/school/sessions/{session_pk}/exam-sessions/{exam_session_pk}/report-cards/bulk-head-comments/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "academic_classes": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440001",
    "550e8400-e29b-41d4-a716-446655440002"
  ]
}
'
{
  "success": true,
  "results": [
    {
      "academic_class": "550e8400-e29b-41d4-a716-446655440000",
      "class_name": "Form 1A",
      "level": "O Level",
      "updated_count": 45,
      "skipped_count": 0,
      "error": null
    },
    {
      "academic_class": "550e8400-e29b-41d4-a716-446655440001",
      "class_name": "Form U6A",
      "level": "A Level",
      "updated_count": 38,
      "skipped_count": 2,
      "error": null
    }
  ],
  "summary": {
    "total_classes": 2,
    "successful_classes": 2,
    "failed_classes": 0,
    "total_students_updated": 83,
    "total_students_skipped": 2
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
exam_session_pk
string<uuid>
required

Exam Session ID

​
id
string<uuid>
required

Report card UUID

​
session_pk
string<uuid>
required

Academic session UUID

Body

application/json
​
academic_classes
string<uuid>[]
required

Array of academic class IDs to apply head comments to

Example:
[
  "550e8400-e29b-41d4-a716-446655440000",
  "550e8400-e29b-41d4-a716-446655440001"
]

Response

​
{key}
any