Student Medical Summary

GET 
/students/:id/medical

Fetches a summary of a student's relevant medical information such as allergies, life threatening medical conditions and treatment details.

Request

Path Parameters

id uuidrequired

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object[]nullable
Array [
id stringrequired
condition stringrequired
colour stringnullablerequired
severity stringrequired
sortOrder numberrequired
conditionDetails stringnullablerequired
emergencyTreatment stringnullablerequired
type stringrequired
confidential booleannullablerequired
visibility stringnullablerequired
]

Example (from schema)

{
  "code": "OK",
  "data": [
    {
      "id": "string",
      "condition": "string",
      "colour": "string",
      "severity": "string",
      "sortOrder": 0,
      "conditionDetails": "string",
      "emergencyTreatment": "string",
      "type": "string",
      "confidential": true,
      "visibility": "string"
    }
  ]
}

Successful

{
  "code": "OK",
  "data": [
    {
      "id": "a1219c2d-c06f-4741-b9d7-6f96903ee28f",
      "condition": "Bites",
      "colour": "#e8411c",
      "severity": "Life Threatening",
      "sortOrder": 1,
      "conditionDetails": null,
      "emergencyTreatment": null,
      "type": "Allergy",
      "confidential": false,
      "visibility": "Medical Maintenance + Community Portal + School Staff (All)"
    }
  ]
}

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...