Past Student

GET 
/students/past/:id

Fetches Past Student Data for a given ID.

A Past Student has graduated or otherwise left the school. This API provides information relevant to a school leaver such as when they left and the last schooling details they held.

Request

Path Parameters

id uuidrequired

Query Parameters

include string
extra information
Example: identity

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
communityId stringrequired
givenName string
preferredName string
otherGivenName stringnullable
surname stringrequired
nameSuffix stringnullable
schoolId stringrequired
company_name stringnullable
sortName string
modified date-timerequired
displayName stringrequired
displayNameList stringrequired
spouseCommunityId stringnullable
email stringnullable
mobile stringnullable
phone stringnullable
studentType stringnullablerequired
studentTypeCode stringnullable
gender stringnullable
genderCode stringnullable
title stringnullable
addressId stringnullablerequired
internalNameFormat string
internalName stringrequired
mailNameFormat stringrequired
salutationFormat string
addressFull stringnullable
addressComma stringnullable
postalAddressFull stringnullable
postalAddressComma stringnullable
homeAddress1 stringnullable
homeAddress2 stringnullable
homeAddress3 stringnullable
homeSuburb stringnullable
homePostCode stringnullable
homeCountry stringnullable
homeState stringnullable
postalAddress1 stringnullable
postalAddress2 stringnullable
postalAddress3 stringnullable
postalSuburb stringnullable
postalPostCode stringnullable
postalCountry stringnullable
postalState stringnullable
photoId stringnullable
campus stringnullable
yearLevel stringnullable
houseGroup stringnullable
formGroup stringnullable
rollGroup stringnullable
tutorGroup stringnullable
homeGroup stringnullable
startDate date
leavingDate datenullable
governmentStudentNumber stringnullable
yearLevelCode stringnullable
houseGroupCode stringnullable
formGroupCode stringnullable
rollGroupCode stringnullable
tutorGroupCode stringnullable
homeGroupCode stringnullable
formGroupTeacher stringnullable
rollGroupTeacher stringnullable
tutorGroupTeacher stringnullable
homeGroupTeacher stringnullable
headOfCampus stringnullable
yearLevelCoOrdinator stringnullable
headOfHouse stringnullable
studentFTE numbernullable
learningPathwayCode stringnullable
learningPathwayDescription stringnullable
subSchoolCode stringnullable
subSchoolDescription stringnullable
academicPeriodCode stringnullable
academicPeriodDescription stringnullable
academicStartDate date
boarding object[]
Array [
id uuidrequired
schoolId stringrequired
startDate stringnullablerequired
endDate stringnullablerequired
boarder objectnullablerequired
id uuidrequired
description stringrequired
boardingHouse objectnullablerequired
id stringnullablerequired
description stringnullablerequired
]
enrolment object[]
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 objectnullable
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": {
    "communityId": "string",
    "givenName": "string",
    "preferredName": "string",
    "otherGivenName": "string",
    "surname": "string",
    "nameSuffix": "string",
    "schoolId": "string",
    "company_name": "string",
    "sortName": "string",
    "modified": "2025-03-12T03:31:59.468Z",
    "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",
    "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",
    "academicStartDate": "2025-03-12",
    "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": {
    "communityId": "7fca9081-f179-477e-bf0f-8a5ff47c91b7",
    "givenName": "Suzette",
    "preferredName": "Suzette",
    "otherGivenName": "",
    "surname": "Aguilar",
    "nameSuffix": null,
    "schoolId": "4554",
    "modified": "2020-09-01T04:53:15.904Z",
    "displayName": "AGUILAR, Ms Suzette",
    "displayNameList": "AGUILAR, Suzette",
    "spouseCommunityId": null,
    "email": null,
    "mobile": null,
    "phone": null,
    "studentType": "Enrolled student",
    "studentTypeCode": "ENROL",
    "gender": "Female",
    "genderCode": "F",
    "title": "Ms",
    "addressId": "d0e414bd-cb03-4431-9922-ee4de4e7b5e3",
    "internalNameFormat": "Aguilar, Suzette",
    "internalName": "Aguilar, Suzette",
    "mailNameFormat": "Ms Suzette Aguilar",
    "salutationFormat": "Ms Aguilar Suzette",
    "addressFull": "88 Burden St\nSPRINGVALE\nVIC\n3171",
    "addressComma": "88 Burden St, SPRINGVALE, VIC, 3171",
    "postalAddressFull": null,
    "postalAddressComma": null,
    "homeAddress1": "88 Burden St",
    "homeAddress2": null,
    "homeAddress3": null,
    "homeSuburb": "Springvale",
    "homePostCode": "3171",
    "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",
    "yearLevelCode": "11",
    "houseGroup": null,
    "formGroup": null,
    "rollGroup": null,
    "tutorGroup": null,
    "homeGroup": null,
    "leavingDate": null,
    "governmentStudentNumber": null,
    "houseGroupCode": null,
    "formGroupCode": null,
    "rollGroupCode": null,
    "tutorGroupCode": null,
    "homeGroupCode": null,
    "formGroupTeacher": null,
    "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": "Y_2023",
    "academicPeriodDescription": "Year 2023",
    "boarding": [
      {
        "id": "d4c44086-a3b6-438d-af3d-afec88858ef3",
        "schoolId": "9425",
        "startDate": "2021-08-24",
        "endDate": "2022-07-26",
        "boarder": {
          "id": "0ff09f86-aa14-45d8-a138-f14ca88338e5",
          "description": "Day student"
        },
        "boardingHouse": {
          "id": null,
          "description": null
        }
      }
    ],
    "enrolment": [
      {
        "id": "617c09aa-310b-4d8b-9033-bc13846a519f",
        "startDate": "2021-08-24",
        "leavingDate": "2022-12-19",
        "leavingDestination": null,
        "leavingReason": null
      }
    ],
    "demographics": {
      "overrideRegion": false,
      "religion": {
        "id": "2a204d1f-5341-4bfa-9294-b04b6018ea0a",
        "description": "Baptist"
      },
      "indigenousStatus": {
        "id": "ace8f637-40b0-4922-a682-3ed2cfd2f965",
        "description": "Not Indigenous"
      },
      "parish": {
        "id": "e90cf93e-3a0c-4f28-9333-b51a5a1d4cd8",
        "description": "Alphington"
      },
      "region": null,
      "birthCountry": {
        "id": "3192d1fd-b56d-4176-b940-400c3bfb882a",
        "description": "Denmark"
      },
      "addresses": [
        {
          "systemMeaning": "home",
          "id": "749fda1e-7f8e-4b98-ae28-68b69ae91073",
          "addressId": "cf3ddf17-15f2-4cb8-b005-2c180946c3f8",
          "addressType": null,
          "addressLine1": "Line 1",
          "addressLine2": "Line 2",
          "addressLine3": "Line 3",
          "suburb": "Abbotsford",
          "postalCode": "3077",
          "confidential": false,
          "country": {
            "id": "283a7817-5c27-48bb-9650-4ccfa11a3704",
            "description": "Australia",
            "code": "AU"
          },
          "state": {
            "id": "1ec93d5d-f2ea-4aa4-8c1e-1b0eec8ad194",
            "description": "Victoria"
          },
          "displayAddressComma": "Line 1, Line 2, Line 3, ABBOTSFORD  VIC  3077, Australia",
          "displayAddressFull": "Line 1\nLine 2\nLine 3\nABBOTSFORD  VIC  3077\nAustralia"
        }
      ],
      "homeLanguages": [
        {
          "id": "0f2816a5-0a54-4207-ac9a-585d689b84d3",
          "language": {
            "id": "627eb5fc-a6cb-4e5c-9140-cf8eb989f375",
            "description": "Irish",
            "code": "1121"
          },
          "sortOrder": null
        }
      ],
      "nationalities": [
        {
          "id": "90f74181-33ef-44e4-b215-50fda1476590",
          "nationality": {
            "id": "4e7c3be3-bdb0-4837-9712-1773ab0e3cb2",
            "description": "Austrian",
            "code": "AT"
          },
          "sortOrder": null
        }
      ]
    },
    "identity": [
      {
        "description": "Vocational Education Code",
        "code": "VOC",
        "value": "1234567890",
        "sortOrder": 4
      }
    ]
  }
}

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