Student

GET 
/students/current/:id

Fetches Current Student data for a given ID and date string.

A Current student is enrolled at the school. This API will will return key personal details of the student, their photo, contact details, identity codes, school information and if they are attending the school as a boarding student.

Request

Path Parameters

id uuidrequired

Query Parameters

asAt daterequiredExamples:

date

Example: 2024-03-01

include string
extra information
Example: identity

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
givenName stringrequired
preferredName stringnullablerequired
otherGivenName stringnullablerequired
surname stringrequired
nameSuffix stringnullablerequired
schoolId stringrequired
modified date-timenullablerequired
displayName stringrequired
displayNameList stringrequired
spouseCommunityId stringnullablerequired
email stringnullablerequired
mobile stringnullablerequired
phone stringnullablerequired
studentType stringnullablerequired
studentTypeCode stringnullablerequired
gender stringnullablerequired
genderCode stringnullablerequired
title stringnullablerequired
addressId stringnullablerequired
internalNameFormat stringrequired
internalName stringrequired
mailNameFormat stringrequired
salutationFormat stringrequired
addressFull stringnullablerequired
addressComma stringnullablerequired
postalAddressFull stringnullablerequired
postalAddressComma stringnullablerequired
homeAddress1 stringnullablerequired
homeAddress2 stringnullablerequired
homeAddress3 stringnullablerequired
homeSuburb stringnullablerequired
homePostCode stringnullablerequired
homeCountry stringnullablerequired
homeState stringnullablerequired
postalAddress1 stringnullablerequired
postalAddress2 stringnullablerequired
postalAddress3 stringnullablerequired
postalSuburb stringnullablerequired
postalPostCode stringnullablerequired
postalCountry stringnullablerequired
postalState stringnullablerequired
photoId stringnullablerequired
campus stringnullablerequired
yearLevel stringnullablerequired
houseGroup stringnullablerequired
formGroup stringnullablerequired
rollGroup stringnullablerequired
tutorGroup stringnullablerequired
homeGroup stringnullablerequired
prevSchool stringnullablerequired
startDate daterequired
leavingDate datenullablerequired
governmentStudentNumber stringnullablerequired
yearLevelCode stringnullablerequired
houseGroupCode stringnullablerequired
formGroupCode stringnullablerequired
rollGroupCode stringnullablerequired
tutorGroupCode stringnullablerequired
homeGroupCode stringnullablerequired
formGroupTeacher stringnullablerequired
rollGroupTeacher stringnullablerequired
tutorGroupTeacher stringnullablerequired
homeGroupTeacher stringnullablerequired
headOfCampus stringnullablerequired
yearLevelCoOrdinator stringnullablerequired
headOfHouse stringnullablerequired
studentFTE numbernullablerequired
learningPathwayCode stringnullablerequired
learningPathwayDescription stringnullablerequired
subSchoolCode stringnullablerequired
subSchoolDescription stringnullablerequired
academicPeriodCode stringnullablerequired
academicPeriodDescription stringnullablerequired
communityId stringrequired
sortName stringnullablerequired
photoPermissions object[]nullable
Array [
id uuidrequired
comment stringnullablerequired
photoPermissionGranted booleanrequired
sortOrder int32required
photoPermissionType objectrequired
id uuidrequired
description stringrequired
code stringrequired
active booleanrequired
visibleCommunity booleanrequired
]
boarding object[]required
Array [
id uuidrequired
schoolId stringrequired
startDate stringnullablerequired
endDate stringnullablerequired
boarder objectnullablerequired
id uuidrequired
description stringrequired
boardingHouse objectnullablerequired
id stringnullablerequired
description stringnullablerequired
]
enrolment object[]required
Array [
id stringrequired
startDate stringrequired
leavingDate stringnullablerequired
leavingDestination objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
sort_order number
leavingReason objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
sort_order number
]
demographics objectnullablerequired
overrideRegion booleanrequired
religion objectnullablerequired
id stringnullablerequired
description stringnullablerequired
indigenousStatus objectnullablerequired
id stringnullablerequired
description stringnullablerequired
parish objectnullablerequired
id stringnullablerequired
description stringnullablerequired
region objectnullablerequired
id stringnullablerequired
description stringnullablerequired
birthCountry objectnullablerequired
id stringnullablerequired
description stringnullablerequired
addresses object[]nullablerequired
Array [
systemMeaning stringnullablerequired
The type of address: 'Postal' for postal addresses, 'Home' for residential addresses, or null for other custom types.
id uuidrequired
UUID of the community member's address record
addressId uuidrequired
UUID of the record containing details for a given address (street name/number, postcode, etc)
addressType objectnullablerequired
The lookup for the address type (null if systemMeaning is not 'home' or 'postal')
id
UUID of the address type lookup
description
The address type (e.g. Alternative Home Address, Occupation Address, etc)
code
The address type code (e.g. ALT, OCC)
addressLine1 stringnullablerequired
addressLine2 stringnullablerequired
addressLine3 stringnullablerequired
suburb stringnullablerequired
Burwood East
postalCode stringnullablerequired
confidential booleannullablerequired
country objectnullablerequired
id
UUID of the country lookup
description
Country name (e.g. Australia)
code
Country code (e.g. AU)
state objectnullablerequired
id
UUID of the state lookup
description
State name (e.g. Tasmania)
code
Country code (e.g. TAS)
displayAddressComma stringrequired
The community member's full address with commas separating the fields
displayAddressFull stringrequired
The community member's full address with each field on a new line
]
homeLanguages object[]required
Array [
id uuidrequired
language objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
sortOrder integernullablerequired
]
nationalities object[]required
Array [
id uuidrequired
nationality objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
sortOrder integernullablerequired
]
identity object[]nullable
Array [
description stringrequired
code stringrequired
value stringnullablerequired
sortOrder numbernullablerequired
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "givenName": "string",
    "preferredName": "string",
    "otherGivenName": "string",
    "surname": "string",
    "nameSuffix": "string",
    "schoolId": "string",
    "modified": "2025-03-12T03:31:59.273Z",
    "displayName": "string",
    "displayNameList": "string",
    "spouseCommunityId": "string",
    "email": "string",
    "mobile": "string",
    "phone": "string",
    "studentType": "string",
    "studentTypeCode": "string",
    "gender": "string",
    "genderCode": "string",
    "title": "string",
    "addressId": "string",
    "internalNameFormat": "string",
    "internalName": "string",
    "mailNameFormat": "string",
    "salutationFormat": "string",
    "addressFull": "string",
    "addressComma": "string",
    "postalAddressFull": "string",
    "postalAddressComma": "string",
    "homeAddress1": "string",
    "homeAddress2": "string",
    "homeAddress3": "string",
    "homeSuburb": "string",
    "homePostCode": "string",
    "homeCountry": "string",
    "homeState": "string",
    "postalAddress1": "string",
    "postalAddress2": "string",
    "postalAddress3": "string",
    "postalSuburb": "string",
    "postalPostCode": "string",
    "postalCountry": "string",
    "postalState": "string",
    "photoId": "string",
    "campus": "string",
    "yearLevel": "string",
    "houseGroup": "string",
    "formGroup": "string",
    "rollGroup": "string",
    "tutorGroup": "string",
    "homeGroup": "string",
    "prevSchool": "string",
    "startDate": "2025-03-12",
    "leavingDate": "2025-03-12",
    "governmentStudentNumber": "string",
    "yearLevelCode": "string",
    "houseGroupCode": "string",
    "formGroupCode": "string",
    "rollGroupCode": "string",
    "tutorGroupCode": "string",
    "homeGroupCode": "string",
    "formGroupTeacher": "string",
    "rollGroupTeacher": "string",
    "tutorGroupTeacher": "string",
    "homeGroupTeacher": "string",
    "headOfCampus": "string",
    "yearLevelCoOrdinator": "string",
    "headOfHouse": "string",
    "studentFTE": 0,
    "learningPathwayCode": "string",
    "learningPathwayDescription": "string",
    "subSchoolCode": "string",
    "subSchoolDescription": "string",
    "academicPeriodCode": "string",
    "academicPeriodDescription": "string",
    "communityId": "string",
    "sortName": "string",
    "photoPermissions": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "comment": "string",
        "photoPermissionGranted": true,
        "sortOrder": 0,
        "photoPermissionType": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string",
          "active": true,
          "visibleCommunity": true
        }
      }
    ],
    "boarding": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "schoolId": "string",
        "startDate": "string",
        "endDate": "string",
        "boarder": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string"
        },
        "boardingHouse": {
          "id": "string",
          "description": "string"
        }
      }
    ],
    "enrolment": [
      {
        "id": "string",
        "startDate": "string",
        "leavingDate": "string",
        "leavingDestination": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string",
          "sort_order": 0
        },
        "leavingReason": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string",
          "sort_order": 0
        }
      }
    ],
    "demographics": {
      "overrideRegion": true,
      "religion": {
        "id": "string",
        "description": "string"
      },
      "indigenousStatus": {
        "id": "string",
        "description": "string"
      },
      "parish": {
        "id": "string",
        "description": "string"
      },
      "region": {
        "id": "string",
        "description": "string"
      },
      "birthCountry": {
        "id": "string",
        "description": "string"
      },
      "addresses": [
        {
          "systemMeaning": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "addressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "addressType": {},
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "suburb": "string",
          "postalCode": "string",
          "confidential": true,
          "country": {},
          "state": {},
          "displayAddressComma": "string",
          "displayAddressFull": "string"
        }
      ],
      "homeLanguages": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "language": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string",
            "code": "string"
          },
          "sortOrder": 0
        }
      ],
      "nationalities": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "nationality": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string",
            "code": "string"
          },
          "sortOrder": 0
        }
      ]
    },
    "identity": [
      {
        "description": "string",
        "code": "string",
        "value": "string",
        "sortOrder": 0
      }
    ]
  }
}

Successful

{
  "code": "OK",
  "data": {
    "givenName": "Angelo",
    "preferredName": "Angelo",
    "otherGivenName": "George",
    "surname": "Adamski",
    "nameSuffix": null,
    "schoolId": "6814",
    "modified": "2022-03-01T10:33:46.255Z",
    "displayName": "ADAMSKI, Mr Angelo George",
    "displayNameList": "ADAMSKI, Angelo George",
    "spouseCommunityId": "34be3ec2-d85a-4ce7-9cd0-f5d4ed96c593",
    "email": null,
    "mobile": null,
    "phone": null,
    "studentType": "Enrolled student",
    "studentTypeCode": "ENROL",
    "gender": "Male",
    "genderCode": "M",
    "title": "Mr",
    "addressId": "0e9f1d24-0b24-43cb-b585-6b145359b211",
    "internalNameFormat": "Adamski, Angelo George",
    "internalName": "Adamski, Angelo George",
    "mailNameFormat": "Mr Angelo Adamski",
    "salutationFormat": "Mr Adamski Angelo George",
    "addressFull": "Unit 1 303 Burwood Hwy\nBURWOOD EAST\nVIC\n3151",
    "addressComma": "Unit 1 303 Burwood Hwy, BURWOOD EAST, VIC, 3151",
    "postalAddressFull": null,
    "postalAddressComma": null,
    "homeAddress1": "Unit 1 303 Burwood Hwy",
    "homeAddress2": null,
    "homeAddress3": null,
    "homeSuburb": "BURWOOD EAST",
    "homePostCode": "3151",
    "homeCountry": "Australia",
    "homeState": "Victoria",
    "postalAddress1": null,
    "postalAddress2": null,
    "postalAddress3": null,
    "postalSuburb": null,
    "postalPostCode": null,
    "postalCountry": null,
    "postalState": null,
    "photoId": null,
    "campus": "Senior",
    "yearLevel": "Year 11",
    "houseGroup": "Bryce-S Description Edit",
    "formGroup": "C",
    "rollGroup": null,
    "tutorGroup": "Tutor Group C",
    "homeGroup": null,
    "prevSchool": null,
    "startDate": "2010-01-01",
    "leavingDate": null,
    "governmentStudentNumber": null,
    "yearLevelCode": "11",
    "houseGroupCode": "BR-S",
    "formGroupCode": "C",
    "rollGroupCode": null,
    "tutorGroupCode": "TC",
    "homeGroupCode": null,
    "formGroupTeacher": "Miss Stephanie Lynne Aalberts",
    "rollGroupTeacher": null,
    "tutorGroupTeacher": null,
    "homeGroupTeacher": null,
    "headOfCampus": "Miss Stephanie Lynne Aalberts",
    "yearLevelCoOrdinator": null,
    "headOfHouse": null,
    "studentFTE": 1,
    "learningPathwayCode": null,
    "learningPathwayDescription": null,
    "subSchoolCode": null,
    "subSchoolDescription": null,
    "academicPeriodCode": "TEST-TOBEDELETED",
    "academicPeriodDescription": "TEST-TOBEDELETED",
    "communityId": "94e125f0-b061-484e-a5fd-207f76da92a5",
    "sortName": "Adamski Angelo",
    "boarding": [
      {
        "id": "9016ee34-d3a9-414a-844f-065086de93b1",
        "schoolId": "6814",
        "startDate": "2022-06-30",
        "endDate": null,
        "boarder": {
          "id": "f9ea5567-c7fc-4b02-a262-94ed637185d9",
          "description": "New Boarder J"
        },
        "boardingHouse": {
          "id": "0e10bd1a-cabf-4e05-99e9-b2ccc2f7840e",
          "description": "House 2"
        }
      }
    ],
    "enrolment": [
      {
        "id": "9dd9651f-3cd1-4360-b56b-f047a98ab8ed",
        "startDate": "2010-01-01",
        "leavingDate": null,
        "leavingDestination": null,
        "leavingReason": null
      }
    ],
    "demographics": {
      "overrideRegion": false,
      "religion": {
        "id": "b05ccdc0-79fd-4637-bc1b-411dcde66817",
        "description": "Anglican Catholic Church"
      },
      "indigenousStatus": null,
      "parish": {
        "id": "141f2871-d033-4343-a0a0-68411f7361b0",
        "description": "Burwood"
      },
      "region": null,
      "birthCountry": {
        "id": "283a7817-5c27-48bb-9650-4ccfa11a3704",
        "description": "Australia"
      },
      "addresses": [
        {
          "systemMeaning": "home",
          "id": "4075ab19-c155-42a8-9fdd-282049a7191f",
          "addressId": "0e9f1d24-0b24-43cb-b585-6b145359b211",
          "addressType": null,
          "addressLine1": "Unit 1 303 Burwood Hwy",
          "addressLine2": null,
          "addressLine3": null,
          "suburb": "BURWOOD EAST",
          "postalCode": "3151",
          "confidential": false,
          "country": {
            "id": "283a7817-5c27-48bb-9650-4ccfa11a3704",
            "description": "Australia",
            "code": "AU"
          },
          "state": {
            "id": "1ec93d5d-f2ea-4aa4-8c1e-1b0eec8ad194",
            "description": "Victoria"
          },
          "displayAddressComma": "Unit 1 303 Burwood Hwy, BURWOOD EAST, VIC, 3151",
          "displayAddressFull": "Unit 1 303 Burwood Hwy\nBURWOOD EAST\nVIC\n3151"
        }
      ],
      "homeLanguages": [
        {
          "id": "b9f188c3-b0f0-463f-aaa2-540c288166d4",
          "language": {
            "id": "01baec2f-8201-4aad-b798-d803eedc1a3b",
            "description": "English",
            "code": "1106"
          },
          "sortOrder": 1
        }
      ],
      "nationalities": [
        {
          "id": "3c4cc3c7-d2f1-4ce2-af98-2215c44bd31f",
          "nationality": {
            "id": "64a48038-517f-4f28-a057-f971bdb7b3dc",
            "description": "German",
            "code": "DE"
          },
          "sortOrder": 1
        }
      ]
    }
  }
}

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