Student Alerts

GET 
/students/:id/alerts

Fetches a summary of general, legal and medical Alerts for a given student ID.

General alerts are free-form alerts that can be set by the school for each student. They include categories, dates and messages.

The other alerts are summarised from medical and legal sections from important details such as severe medical conditions, custody information and parent relationship status.

Request

Path Parameters

id uuidrequired

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data objectnullable
alerts objectrequired
parentsSeparated booleanrequired
parentsSeparatedDetails stringnullablerequired
custodyNoteCurrentCount numberrequired
custodyNoteSummary stringnullablerequired
custodyNoteRecords object[]required
Array [
start datenullablerequired
end datenullablerequired
description stringrequired
]
courtOrderCurrentCount numberrequired
courtOrderSummary stringnullablerequired
courtOrderRecords object[]required
Array [
start datenullablerequired
end datenullablerequired
description stringnullablerequired
type stringrequired
]
medicalConditionCurrentCount numberrequired
medicalConditionSummary stringnullablerequired
medicalConditionRecords object[]required
Array [
medicalCondition stringrequired
severity stringrequired
description stringnullablerequired
]
allergyCurrentCount numberrequired
allergySummary stringnullablerequired
allergyRecords object[]required
Array [
allergy stringrequired
severity stringrequired
description stringnullablerequired
]
anaphylaxisCurrentCount numberrequired
anaphylaxisSummary stringnullablerequired
anaphylaxisRecords object[]required
Array [
medicalCondition stringrequired
severity stringrequired
description stringnullablerequired
]
generalAlerts object[]required
Array [
id stringrequired
alertCategory objectnullablerequired
id stringnullablerequired
description stringnullablerequired
message stringrequired
start datenullablerequired
end datenullablerequired
isPopupAlert booleanrequired
isCurrent booleanrequired
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "alerts": {
      "parentsSeparated": true,
      "parentsSeparatedDetails": "string",
      "custodyNoteCurrentCount": 0,
      "custodyNoteSummary": "string",
      "custodyNoteRecords": [
        {
          "start": "2025-03-12",
          "end": "2025-03-12",
          "description": "string"
        }
      ],
      "courtOrderCurrentCount": 0,
      "courtOrderSummary": "string",
      "courtOrderRecords": [
        {
          "start": "2025-03-12",
          "end": "2025-03-12",
          "description": "string",
          "type": "string"
        }
      ],
      "medicalConditionCurrentCount": 0,
      "medicalConditionSummary": "string",
      "medicalConditionRecords": [
        {
          "medicalCondition": "string",
          "severity": "string",
          "description": "string"
        }
      ],
      "allergyCurrentCount": 0,
      "allergySummary": "string",
      "allergyRecords": [
        {
          "allergy": "string",
          "severity": "string",
          "description": "string"
        }
      ],
      "anaphylaxisCurrentCount": 0,
      "anaphylaxisSummary": "string",
      "anaphylaxisRecords": [
        {
          "medicalCondition": "string",
          "severity": "string",
          "description": "string"
        }
      ]
    },
    "generalAlerts": [
      {
        "id": "string",
        "alertCategory": {
          "id": "string",
          "description": "string"
        },
        "message": "string",
        "start": "2025-03-12",
        "end": "2025-03-12",
        "isPopupAlert": true,
        "isCurrent": true
      }
    ]
  }
}

Successful

{
  "code": "OK",
  "data": {
    "alerts": {
      "parentsSeparated": false,
      "parentsSeparatedDetails": null,
      "custodyNoteCurrentCount": 1,
      "custodyNoteSummary": "Student has 1 current custody note alert(s)",
      "custodyNoteRecords": [
        {
          "start": "2024-05-16",
          "end": "2024-05-31",
          "description": "Details section of a test custody note"
        }
      ],
      "courtOrderCurrentCount": 1,
      "courtOrderSummary": "Student has 1 current court order alert(s)",
      "courtOrderRecords": [
        {
          "start": "2020-10-13",
          "end": null,
          "description": "details",
          "type": "Custody Order"
        }
      ],
      "medicalConditionCurrentCount": 1,
      "medicalConditionSummary": "Student has 1 current medical condition alert(s)",
      "medicalConditionRecords": [
        {
          "medicalCondition": "Anaphylaxis",
          "description": "Needs epipen, allergic to nuts (test)",
          "Severity": "Life threatening"
        }
      ],
      "allergySummary": "Student has 1 current allergy alert(s)",
      "allergyRecords": [
        {
          "allergy": "food",
          "description": "Allergic to shellfish",
          "severity": "Mild"
        }
      ],
      "anaphylaxisCurrentCount": 1,
      "anaphylaxisSummary": "Student has 1 current anaphylaxis alert(s)",
      "anaphylaxisRecords": [
        {
          "medicalCondition": "Anaphylaxis",
          "description": "Needs epipen, allergic to nuts (test)",
          "severity": "Life threatening"
        }
      ]
    },
    "generalAlerts": [
      {
        "id": "a8453a5f-367c-4d68-8113-1291cc881ebd",
        "alertCategory": {
          "id": "5bae1275-b4ca-4d93-8595-fdb7cb1dd44b",
          "description": "Pastoral Alert"
        },
        "message": "Student has a popup pastoral alert",
        "start": null,
        "end": "2020-10-05",
        "isPopupAlert": true,
        "isCurrent": false
      }
    ]
  }
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1100",
      "message": "Bad Request"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1101",
      "message": "Unauthorized"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1102",
      "message": "Forbidden"
    }
  ]
}

404

Resource not found

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1103",
      "message": "Not Found"
    }
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1108",
      "message": "Unprocessable Entity"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1109",
      "message": "Internal Server Error"
    }
  ]
}

Loading...