List of Future Students
GET/students/future
Fetches a list of Future Students.
Request
Query Parameters
Possible values: >= 1
Default value: 1
page number starts with 1
Possible values: >= 1
and <= 100
Default value: 10
No of items per page
Start date
End date
extra information
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 500
- application/json
- Schema
- Example (from schema)
- Successful
Schema
- Array [
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
Status Code
meta objectrequired
Meta options for list responses
Possible values: >= 1
Default value: 1
page number starts with 1
Possible values: >= 1
and <= 100
Default value: 10
No of items per page
Start date
End date
No of records in the result set
Possible values: <= 100
No of records in the current page
No of of pages in the result set
Optional comma separated list of student fields included in the response
data object[]
titleObj objectnullablerequired
contacts objectnullablerequired
emergencyContacts object[]required
relationship objectnullablerequired
phones object[]required
Possible values: [1
, 2
]
Can only be for Phone (1) and Alt Phone (2)
studentContacts object[]required
title objectnullablerequired
addresses object[]required
The type of address: 'Postal' for postal addresses, 'Home' for residential addresses, or null for other custom types.
UUID of the community member's address record
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')
UUID of the address type lookup
The address type (e.g. Alternative Home Address, Occupation Address, etc)
The address type code (e.g. ALT, OCC)
Burwood East
country objectnullablerequired
UUID of the country lookup
Country name (e.g. Australia)
Country code (e.g. AU)
state objectnullablerequired
UUID of the state lookup
State name (e.g. Tasmania)
Country code (e.g. TAS)
The community member's full address with commas separating the fields
The community member's full address with each field on a new line
phoneNumber object[]required
phoneType objectnullablerequired
UUID of the phone contact type lookup
The phone contact type (e.g. Home Phone, Personal Mobile, etc)
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
Phone number
Is this the default SMS number?
Optional extension for the phone number
The country calling code prefix for the phone number
country objectnullablerequired
Field is deprecated and is planning to be removed, refer to contactCommunityId instead
relationship objectnullablerequired
labels object[]required
overrideMailFormat objectnullablerequired
overrideSalutationFormat objectnullablerequired
overrideSalutationPreferredFormat objectnullablerequired
legalInfo objectnullablerequired
Field is deprecated and is planning to be removed, refer to "id" instead
parentalArrangement object[]required
lookup objectnullabledeprecated
Field is deprecated and is planning to be removed, refer directly to flattened id/description/code fields instead
courtOrders ListCourtOrder[]required
Field is deprecated and is planning to be removed, refer to "id" instead
courtOrderType objectnullablerequired
parentalNotes object[]required
medicalSummary object[]nullablerequired
medicalInfo objectnullablerequireddeprecated
Field is deprecated and is planning to be removed, refer to "medicalSummary" instead.
summaryData object[]nullablerequireddeprecated
studentAlerts objectnullablerequired
alerts objectrequired
custodyNoteRecords object[]required
courtOrderRecords object[]required
medicalConditionRecords object[]required
allergyRecords object[]required
anaphylaxisRecords object[]required
generalAlerts object[]required
Field is deprecated and is planning to be removed, refer to "id" instead.
alertCategory objectnullablerequired
Field is deprecated and is planning to be removed, refer to "alertCategory.id" instead.
Field is deprecated and is planning to be removed, refer to "alertCategory.description" instead.
identity object[]nullablerequired
extendedNames objectnullablerequired
{
"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.600Z",
"created": "2025-03-12T03:31:59.600Z",
"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",
"applicationCampusId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationCampus": "string",
"applicationCampusCode": "string",
"applicationCampusSortOrder": 0,
"applicationYearLevelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationYearLevel": "string",
"applicationYearLevelCode": "string",
"applicationYearLevelSortOrder": 0,
"applicationHouseCode": "string",
"applicationHouse": "string",
"enrolForYear": 0,
"enrolForDate": "2025-03-12T03:31:59.600Z",
"enrolForDateDMY": "string",
"applicationPriority": "string",
"applicationPriorityCode": "string",
"applicationStatusId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationStatusCode": "string",
"applicationStatus": "string",
"applicationStatusSortOrder": 0,
"enrolmentPeriod": "string",
"enrolmentPeriodCode": "string",
"originalEnquiryDate": "2025-03-12T03:31:59.600Z",
"originalApplicationDate": "2025-03-12T03:31:59.600Z",
"defaultApplicationDate": "2025-03-12T03:31:59.600Z",
"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"
}
}
]
}
{
"code": "OK",
"data": [
{
"communityId": "6806daf7-dd36-4522-8190-a66de03cea82",
"givenName": "Fozzie",
"preferredName": "Fozzie",
"otherGivenName": null,
"surname": "Bear",
"nameSuffix": null,
"schoolId": "39",
"recordType": "Person",
"companyName": null,
"modified": "2022-08-30T05:32:01.884Z",
"created": "2022-05-17T23:12:28.762Z",
"displayName": "Fozzie Bear",
"displayNameList": "Bear, Fozzie",
"spouseCommunityId": null,
"initials": "FB",
"email": null,
"mobile": null,
"phone": null,
"studentType": null,
"studentTypeCode": null,
"genderId": null,
"gender": null,
"genderCode": null,
"genderSortOrder": null,
"genderSystemMeaning": null,
"titleObj": null,
"title": null,
"addressId": "2f2de3c0-b6d8-4d50-9df6-76c395eeb4c6",
"internalNameFormat": "Bear, Fozzie",
"internalName": "Bear, Fozzie",
"externalName": "Fozzie Bear",
"mailNameFormat": "F Bear",
"salutationFormat": "Bear",
"addressFull": "",
"addressComma": "",
"postalAddressFull": "",
"postalAddressComma": "",
"homeAddress1": null,
"homeAddress2": null,
"homeAddress3": null,
"homeSuburb": null,
"homePostCode": null,
"homeCountry": "Australia",
"homeState": null,
"postalAddress1": null,
"postalAddress2": null,
"postalAddress3": null,
"postalSuburb": null,
"postalPostCode": null,
"postalCountry": "Australia",
"postalState": null,
"defaultSMS": null,
"preferredPhone": null,
"birthDate": "2022-05-18",
"constituenciesCsv": "@SF",
"entityTypes": [
"community",
"futureStudent"
],
"photoId": "33c8a07c-1993-426f-ba8f-8798a0e0548e",
"applicationCampusId": "a9c3b4a6-fef7-417f-bea5-e3dab946d49e",
"applicationCampus": "Queensland",
"applicationCampusCode": "QLD",
"applicationCampusSortOrder": 0,
"applicationYearLevelId": "4643935c-fa56-4e8b-951d-a388ebf7cb55",
"applicationYearLevel": "Year 9",
"applicationYearLevelCode": "09",
"applicationYearLevelSortOrder": 0,
"applicationHouseCode": null,
"applicationHouse": null,
"enrolForYear": 2023,
"enrolForDate": "2023-06-01T04:27:35.043Z",
"enrolForDateDMY": "01/06/2023",
"applicationPriority": null,
"applicationPriorityCode": null,
"applicationStatusId": "aea5dfab-7051-42e3-807e-236929facb3a",
"applicationStatusCode": "A",
"applicationStatus": "Application made",
"applicationStatusSortOrder": 1,
"enrolmentPeriod": "Semester 1",
"enrolmentPeriodCode": "S1",
"headOfCampus": null,
"subSchoolCode": null,
"subSchoolDescription": null,
"headOfHouse": null,
"formGroupCode": null,
"formGroup": null,
"formGroupTeacher": null,
"rollGroupTeacher": null,
"tutorGroupTeacher": null,
"homeGroupTeacher": null,
"learningPathwayCode": null,
"learningPathwayDescription": null,
"studentFTE": null,
"tutorGroupCode": null,
"tutorGroup": null,
"rollGroupCode": null,
"rollGroup": null,
"homeGroupCode": null,
"homeGroup": null,
"governmentStudentNumber": null,
"originalEnquiryDate": null,
"originalApplicationDate": "2022-05-17T23:11:11.970Z",
"defaultApplicationDate": "2022-05-17T23:11:11.970Z",
"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": [
{
"lookup": {
"id": "22acce34-d3a8-45f1-906f-213b7731f4b4",
"description": "Custody",
"code": "CUSTODY"
},
"id": "22acce34-d3a8-45f1-906f-213b7731f4b4",
"description": "Custody",
"code": "CUSTODY"
}
],
"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"
}
]
},
"studentAlerts": {
"communityId": "94e125f0-b061-484e-a5fd-207f76da92a5",
"alerts": {
"parentsSeparated": true,
"parentsSeparatedDetails": "Parents are legally separated",
"custodyNoteCurrentCount": 1,
"custodyNoteSummary": "Student has 1 current custody note alert(s)",
"custodyNoteRecords": [
{
"start": "2021-06-01",
"end": null,
"description": "test1"
}
],
"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"
},
{
"medicalCondition": "Anaphylaxis",
"description": "Needs epipen, allergic to nuts (test)",
"severity": "Life threatening"
}
],
"allergyCurrentCount": 1,
"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": "b4453a5f-367c-4d68-8113-1291cc881ebd",
"communityAlertId": "b4453a5f-367c-4d68-8113-1291cc881ebd",
"alertCategory": {
"id": "3bfe1275-b4ca-4d93-8595-fdb7cb1dd44b",
"description": "Pastoral Alert"
},
"lookupAlertCategoryId": "3bfe1275-b4ca-4d93-8595-fdb7cb1dd44b",
"lookupAlertCategoryDescription": "Pastoral Alert",
"message": "end only",
"start": null,
"end": "2020-10-05",
"isPopupAlert": true,
"isCurrent": false
}
]
},
"contacts": {
"emergencyContacts": [
{
"id": "b5ad04b0-c2b9-47bd-b41b-ffc93878dae1",
"name": "Mrs Mum Abadilla",
"address": "182 Ebbers Blvd NW, Line 2 ý ý ý, EDMONTON, T5Y 3B2, Canada",
"schoolId": "9427",
"email": "personal@gmail.com",
"contactOrder": 1,
"relationship": "Step Mother",
"phones": [
{
"id": "e7b8a1d4-5c3a-4b8a-9b1e-8f3b8a1d4e7b",
"phone": "78945612",
"phoneOrder": 1
},
{
"id": "a1d4e7b8-5c3a-4b8a-9b1e-8f3b8a1d4e7b",
"phone": "96328574",
"phoneOrder": 2
}
]
}
],
"studentContacts": [
{
"sms": false,
"email": false,
"mail": true,
"reports": true,
"id": "750424b0-44ea-47ea-990f-618468613565",
"portalAccess": false,
"livesWithStudent": true,
"parentGuardian": true,
"caregiver": null,
"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": null
}
]
},
"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
}
]
}
},
{
"extendedNames": {
"overrideLegalSurname": "Bird",
"nameSuffix": null,
"maidenName": null,
"familyNamePrevious": null,
"displayName": "Fozzie Bear",
"displayNameForList": "Bear, Fozzie",
"mailNameFormat": "F Bear",
"externalNameFormat": "Fozzie Bear",
"legalNameFormat": "Fozzie Bird",
"salutationFormat": "Bear",
"familyNameFormat": "The Bear Family",
"salutationJoint": "Bear",
"salutationPreferredFormat": "Fozzie",
"salutationPreferredJoint": "Fozzie",
"internalNameFormat": "Bear, Fozzie",
"mailNameJoint": "F Bear"
}
},
{
"sortName": "Bear Fozzie"
},
{
"academicStartDate": null
},
{
"yearLevelCoOrdinator": null
}
],
"meta": {
"traceContext": "7f5db7a2-547e-4f98-9bd0-8aee68a03ef4",
"totalRecordCount": 1,
"pageNum": "All",
"pageLimit": "All",
"pageRecordCount": "All",
"pageNumTotal": "All",
"pageSortBy": "surname,givenName,schoolId",
"pageSortDir": "ASC",
"range": {
"start": 1,
"end": 1
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
errors object[]required
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
{
"errors": [
{
"code": "PA1100",
"message": "Bad Request"
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
errors object[]required
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
{
"errors": [
{
"code": "PA1101",
"message": "Unauthorized"
}
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
errors object[]required
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
{
"errors": [
{
"code": "PA1102",
"message": "Forbidden"
}
]
}
Resource not found
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
errors object[]required
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
{
"errors": [
{
"code": "PA1103",
"message": "Not Found"
}
]
}
Unprocessable entity
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
errors object[]required
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
{
"errors": [
{
"code": "PA1108",
"message": "Unprocessable Entity"
}
]
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
errors object[]required
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
{
"errors": [
{
"code": "PA1109",
"message": "Internal Server Error"
}
]
}