Future Student

GET 
/students/future/:id

Fetches Future Student Data for a given ID.

A Future Student is someone who has enrolled with the school but not yet started their schooling. This API provides information relevant to a student who is soon to start with the school such as their enrolment year, application status and priority.

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
personalInfo objectrequired
communityId uuid
tenantId uuid
schoolId string
spouseCommunityId uuidnullable
givenName string
surname stringnullable
preferredName stringnullable
otherGivenName stringnullable
nameSuffix stringnullable
overrideLegalSurname stringnullable
overrideMailFormat objectnullable
id integernullablerequired
description stringnullablerequired
overrideSalutationFormat objectnullable
id integernullablerequired
description stringnullablerequired
overrideSalutationPreferredFormat objectnullable
id integernullablerequired
description stringnullablerequired
familyNamePrevious stringnullable
maidenName stringnullable
isPrimary boolean
initials stringnullable
title objectnullable
id stringnullablerequired
description stringnullablerequired
displayName string
displayNameForList string
birthDate datenullable
recordType string
gender objectnullable
id stringnullablerequired
description stringnullablerequired
deceasedDate datenullable
deceased booleannullable
communityDisplayNames object[]
Array [
id uuid
displayName string
displayType string
overridden boolean
]
contactDetails objectrequired
emailAddress object[]required
Array [
id uuid
UUID of the community member's email address record
emailType object
id
UUID of the email address type lookup
description
The email address type (e.g. Personal, Occupation, Company, etc)
value stringnullable
The community member's email address
default booleannullable
Is this the default email address?
sortOrder integernullable
]
internetAndSocialMedia object[]required
Array [
id uuid
UUID of the community member's website or social media account record
websiteType object
id
UUID for community website type lookup
description
The community website type (e.g. Facebook, LinkedIn, etc.)
value stringnullable
A URL to the website or social media account
sortOrder int32
Sort order for the website or social media account
]
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)
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
]
applicationDetails object[]required
Array [
id uuidrequired
applicationDate date-timerequired
enrolmentDate date-timerequired
campus objectnullablerequired
id stringnullablerequired
description stringnullablerequired
yearLevel objectnullablerequired
id stringnullablerequired
description stringnullablerequired
enrolmentPeriod objectnullablerequired
id stringnullablerequired
description stringnullablerequired
boarder objectnullablerequired
id stringnullablerequired
description stringnullablerequired
applicationStatus objectnullablerequired
id stringnullablerequired
description stringnullablerequired
comment stringnullablerequired
defaultApplication booleannullablerequired
]
applicantInfo objectrequired
id uuidrequired
originalEnquiryDate date-timenullablerequired
originalApplicationDate date-timenullablerequired
applicationPriority stringnullablerequired
applicationPriorityId stringnullablerequired
identity object[]nullablerequired
Array [
description stringrequired
code stringrequired
value stringnullablerequired
sortOrder numbernullablerequired
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "personalInfo": {
      "communityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "schoolId": "string",
      "spouseCommunityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "givenName": "string",
      "surname": "string",
      "preferredName": "string",
      "otherGivenName": "string",
      "nameSuffix": "string",
      "overrideLegalSurname": "string",
      "overrideMailFormat": {
        "id": 0,
        "description": "string"
      },
      "overrideSalutationFormat": {
        "id": 0,
        "description": "string"
      },
      "overrideSalutationPreferredFormat": {
        "id": 0,
        "description": "string"
      },
      "familyNamePrevious": "string",
      "maidenName": "string",
      "isPrimary": true,
      "initials": "string",
      "title": {
        "id": "string",
        "description": "string"
      },
      "displayName": "string",
      "displayNameForList": "string",
      "birthDate": "2025-03-12",
      "recordType": "string",
      "gender": {
        "id": "string",
        "description": "string"
      },
      "deceasedDate": "2025-03-12",
      "deceased": true,
      "communityDisplayNames": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "displayName": "string",
          "displayType": "string",
          "overridden": true
        }
      ]
    },
    "contactDetails": {
      "emailAddress": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "emailType": {},
          "value": "string",
          "default": true,
          "sortOrder": 0
        }
      ],
      "internetAndSocialMedia": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "websiteType": {},
          "value": "string",
          "sortOrder": 0
        }
      ],
      "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"
          }
        }
      ]
    },
    "applicationDetails": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "applicationDate": "2025-03-12T03:31:59.559Z",
        "enrolmentDate": "2025-03-12T03:31:59.559Z",
        "campus": {
          "id": "string",
          "description": "string"
        },
        "yearLevel": {
          "id": "string",
          "description": "string"
        },
        "enrolmentPeriod": {
          "id": "string",
          "description": "string"
        },
        "boarder": {
          "id": "string",
          "description": "string"
        },
        "applicationStatus": {
          "id": "string",
          "description": "string"
        },
        "comment": "string",
        "defaultApplication": true
      }
    ],
    "applicantInfo": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "originalEnquiryDate": "2025-03-12T03:31:59.559Z",
      "originalApplicationDate": "2025-03-12T03:31:59.559Z",
      "applicationPriority": "string",
      "applicationPriorityId": "string"
    },
    "identity": [
      {
        "description": "string",
        "code": "string",
        "value": "string",
        "sortOrder": 0
      }
    ]
  }
}

Successful

{
  "code": "OK",
  "data": {
    "personalInfo": {
      "communityId": "c7ec3f28-2f97-4996-bd8a-8b11a4cec89a",
      "tenantId": "83b49916-55b1-4301-ab57-91a6bc8dc30a",
      "schoolId": "25",
      "spouseCommunityId": null,
      "givenName": "Vulcan",
      "surname": "Summers",
      "preferredName": "Vulcan",
      "otherGivenName": "Gabriel",
      "nameSuffix": null,
      "overrideLegalSurname": null,
      "overrideMailFormat": null,
      "overrideSalutationFormat": null,
      "overrideSalutationPreferredFormat": null,
      "familyNamePrevious": null,
      "maidenName": null,
      "isPrimary": false,
      "initials": "VS",
      "title": {
        "id": "a00069f5-a2a4-41ea-9aee-15eff5d24d0a",
        "description": "Mr"
      },
      "displayName": "SUMMERS, Mr Vulcan",
      "displayNameForList": "SUMMERS, Mr Vulcan",
      "birthDate": "2009-05-06",
      "recordType": "Person",
      "gender": {
        "id": "c51620f6-93e5-4b0f-9e45-81a36d6d18fb",
        "description": "Male"
      },
      "deceasedDate": null,
      "deceased": null,
      "communityDisplayNames": [
        {
          "id": "231d689a-5065-45a4-b0a9-313278d2d574",
          "displayName": "SUMMERS, Mr Vulcan",
          "displayType": "displayName",
          "overridden": false
        }
      ]
    },
    "contactDetails": {
      "emailAddress": [],
      "internetAndSocialMedia": [],
      "phoneNumber": [
        {
          "id": "4d644044-c0a5-4ecf-8e1b-3aaa224b7ed2",
          "phoneType": {
            "id": "83a8cb95-4968-47e1-8d85-5cb861aa40c2",
            "description": "Personal mobile",
            "code": "PERSONALMOBILE"
          },
          "value": "123456",
          "countryCode": "AU +61",
          "country": {
            "id": "283a7817-5c27-48bb-9650-4ccfa11a3704",
            "description": "Australia",
            "code": "AU"
          },
          "confidential": false,
          "preferred": true,
          "defaultSMS": true,
          "extension": null,
          "sortOrder": 1
        }
      ]
    },
    "applicationDetails": [
      {
        "id": "bebdee71-26be-41d3-a4e4-2683e83e3280",
        "applicationDate": "2021-09-09T08:14:48.165Z",
        "enrolmentDate": "2023-05-28T08:14:52.313Z",
        "campus": {
          "id": "9bb1cff4-f6a0-4618-8a3e-7393876e9303",
          "description": "Queensland"
        },
        "yearLevel": {
          "id": "9239678b-c6c4-4627-8ed1-37985389986a",
          "description": "Year 7"
        },
        "enrolmentPeriod": null,
        "boarder": null,
        "applicationStatus": {
          "id": "b1572917-1464-4e46-9b18-6b2b1e017958",
          "description": "Application made"
        },
        "comment": null,
        "defaultApplication": true
      }
    ],
    "applicantInfo": {
      "id": "926fac87-74fc-4174-8bac-98460115da22",
      "originalEnquiryDate": "2019-08-11T00:58:28.579Z",
      "originalApplicationDate": "2021-09-09T08:14:48.165Z",
      "applicationPriority": "Relative at school",
      "applicationPriorityId": "dd8cab28-7e9b-454d-8279-360acc981555"
    },
    "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...