List of Current Students

GET 
/students/current

Fetches a list of Current Students.

Request

Query Parameters

page number
Possible values: >= 1
Default value: 1
page number starts with 1
Example: 1
limit number
Possible values: >= 1 and <= 100
Default value: 10
No of items per page
Example: 10
modifiedAfter date
Start date
Example: 2024-01-01
modifiedBefore date
End date
Example: 2024-11-01
include string
extra information
Example: legal,contacts,alerts,medical,identity,extendedNames

Responses

200

OK

application/json

Schema

Schema

code stringrequired

Status Code

meta objectrequired
Meta options for list responses
page numberrequired
Possible values: >= 1
Default value: 1
page number starts with 1
limit numberrequired
Possible values: >= 1 and <= 100
Default value: 10
No of items per page
modifiedAfter date
Start date
modifiedBefore date
End date
totalRecordCount numberrequired
No of records in the result set
pageRecordCount numberrequired
Possible values: <= 100
No of records in the current page
pageNumTotal numberrequired
No of of pages in the result set
include string
Optional comma separated list of student fields included in the response
traceContext uuid
data object[]
Array [
communityId uuidrequired
givenName stringrequired
preferredName stringnullablerequired
otherGivenName stringnullablerequired
surname stringnullablerequired
nameSuffix stringnullablerequired
schoolId stringrequired
recordType stringrequired
companyName stringnullablerequired
modified date-timenullablerequired
created date-timerequired
displayName stringrequired
displayNameList stringrequired
spouseCommunityId uuidnullablerequired
initials stringrequired
email stringnullablerequired
mobile stringnullablerequired
phone stringnullablerequired
studentType stringnullablerequired
studentTypeCode stringnullablerequired
genderId uuidnullablerequired
gender stringnullablerequired
genderCode stringnullablerequired
genderSortOrder integernullablerequired
genderSystemMeaning stringnullablerequired
titleObj objectnullablerequired
id uuidrequired
description stringrequired
title stringnullablerequired
addressId uuidnullablerequired
internalNameFormat stringrequired
internalName stringrequired
externalName 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
defaultSMS stringnullablerequired
preferredPhone stringnullablerequired
birthDate datenullablerequired
constituenciesCsv stringrequired
entityTypes string[]required
photoId uuidnullablerequired
sortName stringrequired
headOfCampus stringnullablerequired
headOfHouse stringnullablerequired
subSchoolCode stringnullablerequired
subSchoolDescription stringnullablerequired
yearLevelCoOrdinator stringnullablerequired
formGroup stringnullablerequired
formGroupCode stringnullablerequired
formGroupTeacher stringnullablerequired
rollGroup stringnullablerequired
rollGroupCode stringnullablerequired
rollGroupTeacher stringnullablerequired
tutorGroup stringnullablerequired
tutorGroupCode stringnullablerequired
tutorGroupTeacher stringnullablerequired
homeGroup stringnullablerequired
homeGroupCode stringnullablerequired
homeGroupTeacher stringnullablerequired
studentFTE numbernullablerequired
learningPathwayCode stringnullablerequired
learningPathwayDescription stringnullablerequired
governmentStudentNumber stringnullablerequired
academicStartDate daterequired
campus stringnullablerequired
campusId uuidnullablerequired
campusCode stringnullablerequired
campusSortOrder numbernullablerequired
yearLevel stringnullablerequired
yearLevelId uuidnullablerequired
yearLevelCode stringnullablerequired
yearLevelSortOrder numbernullablerequired
houseGroup stringnullablerequired
houseGroupId stringnullablerequired
houseGroupCode stringnullable
rollGroupId stringnullablerequired
leavingDate datenullablerequired
prevSchool stringnullablerequired
academicPeriodCode stringnullablerequired
academicPeriodDescription stringnullablerequired
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
lookup objectnullablerequireddeprecated
Field is deprecated and is planning to be removed, refer to "language"
id uuiddeprecated
description stringdeprecated
code stringdeprecated
sortOrder integernullablerequired
]
nationalities object[]required
Array [
id uuidrequired
nationality objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
sortOrder integernullablerequired
]
contacts objectnullablerequired
emergencyContacts object[]required
Array [
id uuidrequired
contactCommunityId uuidnullablerequired
contactOrder integerrequired
name stringrequired
schoolId stringnullablerequired
relationship objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
phones object[]required
Array [
phone stringrequired
phoneOrder numberrequired
Possible values: [1, 2]
Can only be for Phone (1) and Alt Phone (2)
id uuidrequired
]
email stringnullablerequired
address stringnullablerequired
]
studentContacts object[]required
Array [
id uuidrequired
schoolId stringrequired
photoId stringnullablerequired
givenName stringnullablerequired
surname stringnullablerequired
preferredName stringnullablerequired
otherGivenName stringnullablerequired
nameSuffix stringnullablerequired
title objectnullablerequired
id uuidrequired
description stringrequired
initials stringnullablerequired
displayName stringrequired
addresses object[]required
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
]
sms booleanrequired
defaultSMS stringnullablerequired
phone stringnullablerequired
phoneNumber object[]required
Array [
phoneType objectnullablerequired
id uuid
UUID of the phone contact type lookup
description string
The phone contact type (e.g. Home Phone, Personal Mobile, etc)
code string
The unique code indicating the phone contact type (e.g. PERSONALMOBILE)
lookup objectnullablerequireddeprecated
Field is deprecated and is planning to be removed, refer to "phoneType" instead
id uuiddeprecated
description stringdeprecated
code stringdeprecated
value stringnullablerequired
Phone number
confidential booleanrequired
preferred booleanrequired
defaultSMS booleanrequired
Is this the default SMS number?
extension stringnullablerequired
Optional extension for the phone number
countryCode stringnullablerequired
The country calling code prefix for the phone number
country objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]
email booleannullablerequired
emailToDisplay stringnullablerequired
mail booleanrequired
reports booleanrequired
portalAccess booleanrequired
communityId uuiddeprecated
Field is deprecated and is planning to be removed, refer to contactCommunityId instead
contactCommunityId uuidrequired
contactOrder integerrequired
livesWithStudent booleanrequired
parentGuardian booleanrequired
caregiver booleanrequired
contactType stringrequired
relationship objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
labels object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
]
overrideLegalSurname stringnullablerequired
overrideMailFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
overrideSalutationFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
overrideSalutationPreferredFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
familyNamePrevious stringnullablerequired
maidenName stringnullablerequired
genderId uuidnullablerequired
gender stringnullablerequired
genderSortOrder numbernullablerequired
genderCode stringnullablerequired
genderSystemMeaning stringnullablerequired
]
legalInfo objectnullablerequired
id uuidnullablerequired
communityLegalId uuidnullabledeprecated
Field is deprecated and is planning to be removed, refer to "id" instead
parentsSeparated booleanrequired
parentsSeparatedDetails stringnullablerequired
deceasedParent booleanrequired
deceasedParentDetails stringnullablerequired
privacyPolicy booleanrequired
parentalArrangement object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
lookup objectnullabledeprecated
Field is deprecated and is planning to be removed, refer directly to flattened id/description/code fields instead
id uuiddeprecated
description stringdeprecated
code stringdeprecated
]
courtOrders ListCourtOrder[]required
Array [
id uuidrequired
communityCourtOrderId uuiddeprecated
Field is deprecated and is planning to be removed, refer to "id" instead
courtOrderStart daterequired
courtOrderEnd datenullablerequired
courtOrderDetails stringnullablerequired
courtOrderType objectnullablerequired
id stringnullablerequired
description stringnullablerequired
]
parentalNotes object[]required
Array [
id uuid
start date
end datenullable
description string
]
medicalSummary object[]nullablerequired
Array [
id stringrequired
condition stringrequired
colour stringnullablerequired
severity stringrequired
sortOrder numberrequired
conditionDetails stringnullablerequired
emergencyTreatment stringnullablerequired
type stringrequired
confidential booleannullablerequired
visibility stringnullablerequired
]
medicalInfo objectnullablerequireddeprecated
Field is deprecated and is planning to be removed, refer to "medicalSummary" instead.
summaryData object[]nullablerequireddeprecated
Array [
id stringrequired
condition stringrequired
colour stringnullablerequired
severity stringrequired
sortOrder numberrequired
conditionDetails stringnullablerequired
emergencyTreatment stringnullablerequired
type stringrequired
confidential booleannullablerequired
visibility stringnullablerequired
]
studentAlerts objectnullablerequired
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 uuidrequired
communityAlertId uuiddeprecated
Field is deprecated and is planning to be removed, refer to "id" instead.
alertCategory objectnullablerequired
id stringnullablerequired
description stringnullablerequired
lookupAlertCategoryId uuiddeprecated
Field is deprecated and is planning to be removed, refer to "alertCategory.id" instead.
lookupAlertCategoryDescription stringdeprecated
Field is deprecated and is planning to be removed, refer to "alertCategory.description" instead.
message stringrequired
start datenullablerequired
end datenullablerequired
isPopupAlert booleanrequired
isCurrent booleanrequired
]
identity object[]nullablerequired
Array [
description stringrequired
code stringrequired
value stringnullablerequired
sortOrder numbernullablerequired
]
extendedNames objectnullablerequired
overrideLegalSurname stringnullablerequired
nameSuffix stringnullablerequired
maidenName stringnullablerequired
familyNamePrevious stringnullablerequired
displayName stringrequired
displayNameForList stringrequired
mailNameFormat stringrequired
externalNameFormat stringrequired
legalNameFormat stringrequired
salutationFormat stringrequired
familyNameFormat stringrequired
salutationJoint stringrequired
salutationPreferredFormat stringnullablerequired
salutationPreferredJoint stringrequired
internalNameFormat stringrequired
mailNameJoint stringrequired
photoPermissions object[]nullable
Array [
id uuidrequired
comment stringnullablerequired
photoPermissionGranted booleanrequired
sortOrder int32required
photoPermissionType objectrequired
id uuidrequired
description stringrequired
code stringrequired
active booleanrequired
visibleCommunity booleanrequired
]
]

Example (from schema)

{
  "code": "OK",
  "meta": {
    "page": 1,
    "limit": 10,
    "modifiedAfter": "2024-01-01",
    "modifiedBefore": "2024-11-01",
    "totalRecordCount": 1,
    "pageRecordCount": 1,
    "pageNumTotal": 1,
    "include": "contacts,alerts,legal,medical,identity,extendedNames",
    "traceContext": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "data": [
    {
      "communityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "givenName": "string",
      "preferredName": "string",
      "otherGivenName": "string",
      "surname": "string",
      "nameSuffix": "string",
      "schoolId": "string",
      "recordType": "string",
      "companyName": "string",
      "modified": "2025-03-12T03:31:59.335Z",
      "created": "2025-03-12T03:31:59.335Z",
      "displayName": "string",
      "displayNameList": "string",
      "spouseCommunityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "initials": "string",
      "email": "string",
      "mobile": "string",
      "phone": "string",
      "studentType": "string",
      "studentTypeCode": "string",
      "genderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "gender": "string",
      "genderCode": "string",
      "genderSortOrder": 0,
      "genderSystemMeaning": "string",
      "titleObj": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string"
      },
      "title": "string",
      "addressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "internalNameFormat": "string",
      "internalName": "string",
      "externalName": "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",
      "defaultSMS": "string",
      "preferredPhone": "string",
      "birthDate": "2025-03-12",
      "constituenciesCsv": "string",
      "entityTypes": [
        "string"
      ],
      "photoId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sortName": "string",
      "headOfCampus": "string",
      "headOfHouse": "string",
      "subSchoolCode": "string",
      "subSchoolDescription": "string",
      "yearLevelCoOrdinator": "string",
      "formGroup": "string",
      "formGroupCode": "string",
      "formGroupTeacher": "string",
      "rollGroup": "string",
      "rollGroupCode": "string",
      "rollGroupTeacher": "string",
      "tutorGroup": "string",
      "tutorGroupCode": "string",
      "tutorGroupTeacher": "string",
      "homeGroup": "string",
      "homeGroupCode": "string",
      "homeGroupTeacher": "string",
      "studentFTE": 0,
      "learningPathwayCode": "string",
      "learningPathwayDescription": "string",
      "governmentStudentNumber": "string",
      "academicStartDate": "2025-03-12",
      "campus": "string",
      "campusId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "campusCode": "string",
      "campusSortOrder": 0,
      "yearLevel": "string",
      "yearLevelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "yearLevelCode": "string",
      "yearLevelSortOrder": 0,
      "houseGroup": "string",
      "houseGroupId": "string",
      "houseGroupCode": "string",
      "rollGroupId": "string",
      "leavingDate": "2025-03-12",
      "prevSchool": "string",
      "academicPeriodCode": "string",
      "academicPeriodDescription": "string",
      "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
          }
        ]
      },
      "contacts": {
        "emergencyContacts": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "contactCommunityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "contactOrder": 0,
            "name": "string",
            "schoolId": "string",
            "relationship": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "description": "string",
              "code": "string"
            },
            "phones": [
              {
                "phone": "string",
                "phoneOrder": 1,
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
              }
            ],
            "email": "string",
            "address": "string"
          }
        ],
        "studentContacts": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "schoolId": "string",
            "photoId": "string",
            "givenName": "string",
            "surname": "string",
            "preferredName": "string",
            "otherGivenName": "string",
            "nameSuffix": "string",
            "title": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "description": "string"
            },
            "initials": "string",
            "displayName": "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"
              }
            ],
            "sms": true,
            "defaultSMS": "string",
            "phone": "string",
            "phoneNumber": [
              {
                "phoneType": {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "description": "string",
                  "code": "string"
                },
                "value": "string",
                "confidential": true,
                "preferred": true,
                "defaultSMS": true,
                "extension": "string",
                "countryCode": "string",
                "country": {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "description": "string",
                  "code": "string"
                }
              }
            ],
            "email": true,
            "emailToDisplay": "string",
            "mail": true,
            "reports": true,
            "portalAccess": true,
            "contactCommunityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "contactOrder": 0,
            "livesWithStudent": true,
            "parentGuardian": true,
            "caregiver": true,
            "contactType": "string",
            "relationship": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "description": "string",
              "code": "string"
            },
            "labels": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "description": "string",
                "code": "string"
              }
            ],
            "overrideLegalSurname": "string",
            "overrideMailFormat": {
              "id": 0,
              "description": "string"
            },
            "overrideSalutationFormat": {
              "id": 0,
              "description": "string"
            },
            "overrideSalutationPreferredFormat": {
              "id": 0,
              "description": "string"
            },
            "familyNamePrevious": "string",
            "maidenName": "string",
            "genderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "gender": "string",
            "genderSortOrder": 0,
            "genderCode": "string",
            "genderSystemMeaning": "string"
          }
        ]
      },
      "legalInfo": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "parentsSeparated": true,
        "parentsSeparatedDetails": "string",
        "deceasedParent": true,
        "deceasedParentDetails": "string",
        "privacyPolicy": true,
        "parentalArrangement": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string",
            "code": "string"
          }
        ],
        "courtOrders": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "courtOrderStart": "2025-03-12",
            "courtOrderEnd": "2025-03-12",
            "courtOrderDetails": "string",
            "courtOrderType": {
              "id": "string",
              "description": "string"
            }
          }
        ],
        "parentalNotes": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "start": "2025-03-12",
            "end": "2025-03-12",
            "description": "string"
          }
        ]
      },
      "medicalSummary": [
        {
          "id": "string",
          "condition": "string",
          "colour": "string",
          "severity": "string",
          "sortOrder": 0,
          "conditionDetails": "string",
          "emergencyTreatment": "string",
          "type": "string",
          "confidential": true,
          "visibility": "string"
        }
      ],
      "studentAlerts": {
        "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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "alertCategory": {
              "id": "string",
              "description": "string"
            },
            "message": "string",
            "start": "2025-03-12",
            "end": "2025-03-12",
            "isPopupAlert": true,
            "isCurrent": true
          }
        ]
      },
      "identity": [
        {
          "description": "string",
          "code": "string",
          "value": "string",
          "sortOrder": 0
        }
      ],
      "extendedNames": {
        "overrideLegalSurname": "string",
        "nameSuffix": "string",
        "maidenName": "string",
        "familyNamePrevious": "string",
        "displayName": "string",
        "displayNameForList": "string",
        "mailNameFormat": "string",
        "externalNameFormat": "string",
        "legalNameFormat": "string",
        "salutationFormat": "string",
        "familyNameFormat": "string",
        "salutationJoint": "string",
        "salutationPreferredFormat": "string",
        "salutationPreferredJoint": "string",
        "internalNameFormat": "string",
        "mailNameJoint": "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
          }
        }
      ]
    }
  ]
}

Successful

{
  "code": "OK",
  "data": [
    {
      "communityId": "94e125f0-b061-484e-a5fd-207f76da92a5",
      "givenName": "Angelo",
      "preferredName": "Angelo",
      "otherGivenName": "George",
      "surname": "Adamski",
      "nameSuffix": null,
      "schoolId": "6814",
      "recordType": "Person",
      "companyName": null,
      "sortName": "Adamski Angelo",
      "modified": "2021-05-27T06:49:32.091Z",
      "created": "2020-09-01T05:04:11.203Z",
      "displayName": "ADAMSKI, Mr Angelo George",
      "displayNameList": "ADAMSKI, Angelo George",
      "spouseCommunityId": "34be3ec2-d85a-4ce7-9cd0-f5d4ed96c593",
      "initials": "AA",
      "email": null,
      "mobile": null,
      "phone": null,
      "studentType": "Enrolled student",
      "studentTypeCode": "ENROL",
      "genderId": "cbe364ef-3d88-4dcb-bb57-6ea151f4b561",
      "gender": "Male",
      "genderCode": "M",
      "genderSortOrder": 1,
      "genderSystemMeaning": "Male",
      "titleObj": {
        "id": "432a7034-a75a-49ea-a5fa-bb46cbe53ea6",
        "description": "Mr"
      },
      "title": "Mr",
      "addressId": "0e9f1d24-0b24-43cb-b585-6b145359b211",
      "internalNameFormat": "Adamski, Angelo George",
      "internalName": "Adamski, Angelo George",
      "externalName": "Angelo George Adamski",
      "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": "Unit 1 303 Burwood Hwy\nBURWOOD EAST\nVIC\n3151",
      "postalAddressComma": "Unit 1 303 Burwood Hwy, BURWOOD EAST, VIC, 3151",
      "homeAddress1": "Unit 1 303 Burwood Hwy",
      "homeAddress2": null,
      "homeAddress3": null,
      "homeSuburb": "BURWOOD EAST",
      "homePostCode": "3151",
      "homeCountry": "Australia",
      "homeState": "Victoria",
      "postalAddress1": "Unit 1 303 Burwood Hwy",
      "postalAddress2": null,
      "postalAddress3": null,
      "postalSuburb": "BURWOOD EAST",
      "postalPostCode": "3151",
      "postalCountry": "Australia",
      "postalState": "Victoria",
      "defaultSMS": null,
      "preferredPhone": null,
      "birthDate": "2002-04-20",
      "constituenciesCsv": "@SC",
      "entityTypes": [
        "community",
        "student"
      ],
      "campusId": "5ae7cc6c-bd68-4211-8844-079315e2fbe5",
      "campus": "New Junior",
      "campusCode": "NEWJ",
      "campusSortOrder": 7,
      "yearLevelId": "6f3d31b0-3337-4509-a694-01a8c92578ca",
      "yearLevel": "New Year 10",
      "yearLevelCode": "N10",
      "yearLevelSortOrder": 2,
      "houseGroup": null,
      "formGroup": null,
      "rollGroup": null,
      "tutorGroup": null,
      "homeGroup": null,
      "startDate": "2023-11-14T00:00:00.000Z",
      "leavingDate": null,
      "governmentStudentNumber": null,
      "houseGroupCode": null,
      "formGroupCode": null,
      "rollGroupCode": null,
      "tutorGroupCode": null,
      "homeGroupCode": null,
      "formGroupTeacher": null,
      "rollGroupTeacher": null,
      "tutorGroupTeacher": null,
      "homeGroupTeacher": null,
      "headOfCampus": null,
      "yearLevelCoOrdinator": null,
      "headOfHouse": null,
      "studentFTE": 1,
      "learningPathwayCode": "AL",
      "learningPathwayDescription": "Applied learning",
      "subSchoolCode": null,
      "subSchoolDescription": null,
      "academicPeriodCode": "Y_2023",
      "academicPeriodDescription": "Year 2023",
      "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": "617c09aa-310b-4d8b-9033-bc13846a519f",
          "startDate": "2021-08-24",
          "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": "64a48038-517f-4f28-a057-f971bdb7b3dc",
              "description": "Welsh",
              "code": "1106"
            },
            "lookup": {
              "id": "64a48038-517f-4f28-a057-f971bdb7b3dc",
              "description": "Welsh",
              "code": "1106"
            },
            "sortOrder": 1
          }
        ],
        "nationalities": [
          {
            "id": "3c4cc3c7-d2f1-4ce2-af98-2215c44bd31f",
            "nationality": {
              "id": "64a48038-517f-4f28-a057-f971bdb7b3dc",
              "description": "Spanish",
              "code": "SP"
            },
            "sortOrder": 1
          }
        ]
      },
      "legalInfo": {
        "id": "caf1850a-4e1d-4fdd-b1f5-a024c74667fd",
        "communityLegalId": "caf1850a-4e1d-4fdd-b1f5-a024c74667fd",
        "parentsSeparated": false,
        "parentsSeparatedDetails": "Parents are legally separated",
        "deceasedParent": false,
        "deceasedParentDetails": null,
        "privacyPolicy": false,
        "parentalArrangement": null,
        "courtOrders": [
          {
            "id": "2d16348c-bd63-4386-a891-dbbc11a9a9c1",
            "communityCourtOrderId": "2d16348c-bd63-4386-a891-dbbc11a9a9c1",
            "courtOrderStart": "2020-10-20",
            "courtOrderEnd": null,
            "courtOrderDetails": null,
            "courtOrderType": {
              "id": "cc2eaf01-d930-4b2b-9fe4-41cc4b52a563",
              "description": "Custody Order"
            }
          }
        ],
        "parentalNotes": [
          {
            "id": "9fc63159-6290-4899-af0c-9a9f82d40aa1",
            "start": "2020-10-20",
            "end": null,
            "description": "test"
          }
        ]
      },
      "medicalSummary": [
        {
          "id": "a1219c2d-c06f-4741-b9d7-6f96903ee28f",
          "condition": "Bites Desc",
          "colour": "#e8411c",
          "severity": "Life Threatening",
          "conditionDetails": null,
          "emergencyTreatment": null,
          "sortOrder": 1,
          "type": "Allergy",
          "confidential": false,
          "visibility": null
        }
      ],
      "medicalInfo": {
        "summaryData": [
          {
            "id": "a1219c2d-c06f-4741-b9d7-6f96903ee28f",
            "condition": "Bites Desc",
            "colour": "#e8411c",
            "severity": "Life Threatening",
            "conditionDetails": null,
            "emergencyTreatment": null,
            "sortOrder": 1,
            "type": "Allergy",
            "confidential": false,
            "visibility": null
          }
        ]
      },
      "contacts": {
        "communityId": "94e125f0-b061-484e-a5fd-207f76da92a5",
        "studentContacts": [
          {
            "id": "750424b0-44ea-47ea-990f-618468613565",
            "sms": false,
            "email": false,
            "mail": true,
            "reports": true,
            "portalAccess": false,
            "livesWithStudent": true,
            "parentGuardian": true,
            "caregiver": false,
            "contactCommunityId": "4d068648-f40f-4258-8a03-ab097806fa88",
            "contactOrder": 1,
            "schoolId": "6812",
            "communityId": "4d068648-f40f-4258-8a03-ab097806fa88",
            "photoId": null,
            "contactType": "person",
            "givenName": "Guy",
            "surname": "Adamski",
            "preferredName": "Guy",
            "otherGivenName": "",
            "nameSuffix": null,
            "overrideLegalSurname": null,
            "overrideMailFormat": null,
            "overrideSalutationFormat": null,
            "overrideSalutationPreferredFormat": null,
            "familyNamePrevious": null,
            "maidenName": null,
            "phone": null,
            "phoneNumber": [
              {
                "lookup": {
                  "id": "96347537-4049-49b9-9284-fd6be14c8c01",
                  "code": "OCCUPATIONPHONE",
                  "description": "Occupation phone"
                },
                "phoneType": {
                  "id": "96347537-4049-49b9-9284-fd6be14c8c01",
                  "code": "OCCUPATIONPHONE",
                  "description": "Occupation phone"
                },
                "value": "9803 8000",
                "confidential": false,
                "preferred": false,
                "defaultSMS": false,
                "extension": null
              }
            ],
            "defaultSMS": null,
            "emailToDisplay": null,
            "addressFull": "Unit 1 303 Burwood Hwy, BURWOOD EAST, VIC, 3151",
            "addressId": "0e9f1d24-0b24-43cb-b585-6b145359b211",
            "title": {
              "id": "432a7034-a75a-49ea-a5fa-bb46cbe53ea6",
              "description": "Mr"
            },
            "initials": "GA",
            "displayName": "Mr Guy Adamski",
            "relationship": {
              "id": "fae58258-a307-4a49-b0aa-8008e273b632",
              "description": "Father",
              "code": "FR"
            },
            "labels": [],
            "genderId": "4a5af5d6-989a-4dd9-8d62-8aac124bcab2",
            "gender": "Non-Binary",
            "genderCode": "X",
            "genderSortOrder": 1,
            "genderSystemMeaning": "Other"
          }
        ],
        "emergencyContacts": [
          {
            "id": "bae68258-a307-4a49-b0aa-8008e273b632",
            "schoolId": "1234",
            "name": "Mr Guy Adamski",
            "address": "Unit 1 303 Burwood Hwy, BURWOOD EAST, VIC, 3151",
            "email": null,
            "contactOrder": 1,
            "relationship": null,
            "phones": {
              "id": "a5e68258-a307-4a49-b0aa-8008e273b632",
              "phone": "9803 8000",
              "phoneOrder": 1
            }
          }
        ]
      },
      "studentAlerts": {
        "alerts": {
          "parentsSeparated": false,
          "parentsSeparatedDetails": null,
          "custodyNoteCurrentCount": 1,
          "custodyNoteSummary": "Student has 1 current custody note alert(s)",
          "custodyNoteRecords": [
            {
              "start": "2021-06-01",
              "end": null,
              "description": "Mother has custody"
            }
          ],
          "courtOrderCurrentCount": 1,
          "courtOrderSummary": "Student has 1 current court order alert(s)",
          "courtOrderRecords": [
            {
              "start": "2021-05-27",
              "end": null,
              "description": "test",
              "type": "Custody Order"
            }
          ],
          "medicalConditionCurrentCount": 1,
          "medicalConditionSummary": "Student has 1 current medical condition alert(s)",
          "medicalConditionRecords": [
            {
              "medicalCondition": "Asthma",
              "description": "Carries an inhaler with them",
              "Severity": "Mild"
            }
          ],
          "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": "f8453a5f-367c-4d68-8113-1291cc881ebd",
            "communityAlertId": "f8453a5f-367c-4d68-8113-1291cc881ebd",
            "alertCategory": {
              "id": "6bae1275-b4ca-4d93-8595-fdb7cb1dd44b",
              "description": "Pastoral Alert"
            },
            "lookupAlertCategoryId": "6bae1275-b4ca-4d93-8595-fdb7cb1dd44b",
            "lookupAlertCategoryDescription": "Pastoral Alert",
            "message": "end only",
            "start": null,
            "end": "2020-10-05",
            "isPopupAlert": true,
            "isCurrent": false
          }
        ]
      },
      "identity": [
        {
          "description": "Vocational Education Code",
          "code": "VOC",
          "value": "1234567890",
          "sortOrder": 4
        }
      ],
      "extendedNames": {
        "overrideLegalSurname": "SMITH",
        "nameSuffix": null,
        "maidenName": null,
        "familyNamePrevious": "Baker",
        "displayName": "Adamski, Mr Angelo George",
        "displayNameForList": "Adamski, Angelo George",
        "mailNameFormat": "Angelo Adamski",
        "externalNameFormat": "Angelo George Adamski",
        "legalNameFormat": "Mr Angelo SMITH",
        "salutationFormat": "Mr Adamski",
        "familyNameFormat": "The Adamski Family",
        "salutationJoint": "Mr Adamski",
        "salutationPreferredFormat": "Angelo",
        "salutationPreferredJoint": "Angelo",
        "internalNameFormat": "Adamski, Angelo George",
        "mailNameJoint": "Angelo Adamski"
      }
    }
  ]
}

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