Student Contacts and Emergency Contacts

GET 
/students/:id/contacts

Fetches a list of contacts related to given student. A student may have many contacts, and this API will return a summary of those contacts including their personal details, contact details, and emergency contacts.

It also includes if those contacts are the student's parent/guardian, day to day carer and if they live with the student.

Request

Path Parameters

id uuidrequired

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data objectnullable
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
addressId uuidnullablerequired
addressFull stringnullablerequired
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)
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 booleanrequired
emailToDisplay stringnullablerequired
mail booleanrequired
reports booleanrequired
portalAccess booleanrequired
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
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "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",
        "addressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "addressFull": "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"
      }
    ]
  }
}

Successful

{
  "code": "OK",
  "meta": {
    "page": 1,
    "limit": 10
  },
  "data": {
    "emergencyContacts": [
      {
        "id": "a4992bcf-63e1-4116-8f72-f3a2d3ea09ed",
        "name": "Mrs Jennifer Ngyuen",
        "address": "123 Education Avenue, Australia",
        "schoolId": "3391",
        "email": "mtuemail@email.com",
        "contactOrder": 1,
        "relationship": "Business Partner",
        "phones": [
          {
            "id": "b4992bce-63e1-4116-8f72-f3a2d3ea09ed",
            "phone": "0456789012",
            "phoneOrder": 1
          },
          {
            "id": "6ceb589e-cab7-4188-9f7c-9b8cdb31fcb6",
            "phone": "90001000",
            "phoneOrder": 2
          }
        ]
      }
    ],
    "studentContacts": [
      {
        "id": "629a4e4e-8564-4bda-b9b9-6bf088d6207c",
        "sms": false,
        "email": false,
        "mail": false,
        "reports": false,
        "portalAccess": false,
        "livesWithStudent": true,
        "parentGuardian": true,
        "caregiver": true,
        "contactCommunityId": "7a152e6f-05d6-445f-87a8-134f96ad487b",
        "contactOrder": 1,
        "schoolId": "29",
        "photoId": null,
        "contactType": "person",
        "givenName": "Michael",
        "surname": "Frith",
        "preferredName": "Michael",
        "otherGivenName": null,
        "nameSuffix": null,
        "overrideLegalSurname": null,
        "overrideMailFormat": null,
        "overrideSalutationFormat": null,
        "overrideSalutationPreferredFormat": null,
        "familyNamePrevious": null,
        "maidenName": null,
        "phone": null,
        "phoneNumber": [],
        "defaultSMS": null,
        "emailToDisplay": null,
        "addressFull": "HA1, HA2, HA3, SUBURB  WA  6000",
        "addressId": "31edc43f-84da-43dc-b3bd-f9bdda9db5a9",
        "title": {
          "id": "09b163d3-7821-45be-9611-a7f430b4d9a4",
          "description": "Mr"
        },
        "initials": "MF",
        "displayName": "Mr Michael Frith",
        "relationship": {
          "id": "cc894b35-30d6-4110-9283-8cf040904cae",
          "description": "Father",
          "code": "FR"
        },
        "labels": [],
        "genderId": "4a5af5d6-989a-4dd9-8d62-8aac124bcab2",
        "gender": "Non-Binary",
        "genderCode": "X",
        "genderSortOrder": 1,
        "genderSystemMeaning": "Other"
      }
    ]
  }
}

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