Staff Member

GET 
/staff/:id

Fetches Staff member personal details, school information and qualifications for a provided ID.

Request

Path Parameters

id uuidrequired

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
communityId uuidrequired
tenantId uuidrequired
schoolId stringrequired
spouseCommunityId uuidnullablerequired
givenName stringrequired
surname stringrequired
preferredName stringrequired
otherGivenName stringnullablerequired
nameSuffix stringnullablerequired
overrideLegalSurname stringnullablerequired
overrideMailFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
overrideSalutationFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
overrideSalutationPreferredFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
familyNamePrevious stringnullablerequired
maidenName stringnullablerequired
isPrimary booleanrequired
initials stringrequired
Initials of the staff member
title objectnullablerequired
id uuidrequired
description stringrequired
displayName stringrequired
displayNameForList stringrequired
birthDate daterequired
recordType stringrequired
gender objectnullablerequired
id uuidrequired
description stringrequired
deceasedDate datenullablerequired
deceased booleannullablerequired
schoolInfo objectrequired
tenantId uuidrequired
staffId stringrequired
schoolStaffCode stringnullablerequired
staffType objectnullablerequired
id uuidrequired
description stringrequired
staffRoom objectnullablerequired
id uuidrequired
description stringrequired
staffExtension stringnullablerequired
staffDepartment object[]required
Array [
id uuidrequired
description stringrequired
code stringrequired
]
campuses 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
]
staffHouse objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
employment objectrequired
employmentPeriods object[]required
Array [
id uuidrequired
startDate datenullablerequired
endDate datenullablerequired
comments stringnullablerequired
fte numberrequired
employmentType objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
employmentStatus StaffEmploymentStatusrequired
Possible values: [Commencing, Current, Left]
The status of an employee based on their start and end date. Defaults to "Current" if dates are null.
]
employmentHistory object[]required
Array [
id uuidrequired
employer stringrequired
The name of the staff member's employer
employerCommunityId stringnullablerequired
employerSchoolId stringnullablerequired
employerRecordType RecordTypenullablerequired
Possible values: [Person, Company, null]
Whether the community member is a Person or a Company
employmentType objectnullablerequired
id uuidrequired
description stringrequired
position objectnullablerequired
id uuidrequired
description stringrequired
modified date-timerequired
modifiedId uuidrequired
startDate datenullablerequired
endDate datenullablerequired
fte numbernullablerequired
comment stringnullablerequired
]
qualifications object[]required
Array [
id uuidrequired
registrationCode stringnullablerequired
description stringnullablerequired
attainedDate date-timenullablerequired
expAttainmentYear int32nullablerequired
comment stringnullablerequired
qualificationLevel objectnullablerequired
id stringnullablerequired
description stringnullablerequired
qualificationType objectnullablerequired
id stringnullablerequired
description stringnullablerequired
trainingProvider objectnullablerequired
id stringnullablerequired
description stringnullablerequired
qualificationMajorsList object[]required
Array [
id uuidrequired
sortOrder int32required
major objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]
qualificationMinorsList object[]required
Array [
id uuidrequired
sortOrder int32required
minor objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]
]
checks object[]required
Array [
id uuidrequired
checkType objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
checkStatus objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
verifiedByStaff stringnullablerequired
verifiedByStaffId uuidnullablerequired
verifiedByStaffRecordType RecordTypenullablerequired
Possible values: [Person, Company, null]
Whether the community member is a Person or a Company
reference stringnullablerequired
required booleanrequired
comment stringnullablerequired
startDate datenullablerequired
endDate datenullablerequired
verifiedDate stringnullablerequired
active booleanrequired
modified date-timerequired
modifiedId uuidrequired
]

Example (from schema)

{
  "code": "OK",
  "data": {
    "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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "string"
    },
    "displayName": "string",
    "displayNameForList": "string",
    "birthDate": "2025-03-12",
    "recordType": "string",
    "gender": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "string"
    },
    "deceasedDate": "2025-03-12",
    "deceased": true,
    "schoolInfo": {
      "tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "staffId": "string",
      "schoolStaffCode": "string",
      "staffType": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string"
      },
      "staffRoom": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string"
      },
      "staffExtension": "string",
      "staffDepartment": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string"
        }
      ],
      "campuses": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string"
        }
      ],
      "staffHouse": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "string",
        "code": "string"
      }
    },
    "employment": {
      "employmentPeriods": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "startDate": "2025-03-12",
          "endDate": "2025-03-12",
          "comments": "string",
          "fte": 0,
          "employmentType": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string",
            "code": "string"
          },
          "employmentStatus": "Commencing"
        }
      ],
      "employmentHistory": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "employer": "string",
          "employerCommunityId": "string",
          "employerSchoolId": "string",
          "employerRecordType": "Person",
          "employmentType": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string"
          },
          "position": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string"
          },
          "modified": "2025-03-12T03:31:59.628Z",
          "modifiedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "startDate": "2025-03-12",
          "endDate": "2025-03-12",
          "fte": 0,
          "comment": "string"
        }
      ]
    },
    "qualifications": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationCode": "string",
        "description": "string",
        "attainedDate": "2025-03-12T03:31:59.629Z",
        "expAttainmentYear": 0,
        "comment": "string",
        "qualificationLevel": {
          "id": "string",
          "description": "string"
        },
        "qualificationType": {
          "id": "string",
          "description": "string"
        },
        "trainingProvider": {
          "id": "string",
          "description": "string"
        },
        "qualificationMajorsList": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "sortOrder": 0,
            "major": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "description": "string",
              "code": "string"
            }
          }
        ],
        "qualificationMinorsList": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "sortOrder": 0,
            "minor": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "description": "string",
              "code": "string"
            }
          }
        ]
      }
    ],
    "checks": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "checkType": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string"
        },
        "checkStatus": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "description": "string",
          "code": "string"
        },
        "verifiedByStaff": "string",
        "verifiedByStaffId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "verifiedByStaffRecordType": "Person",
        "reference": "string",
        "required": true,
        "comment": "string",
        "startDate": "2025-03-12",
        "endDate": "2025-03-12",
        "verifiedDate": "string",
        "active": true,
        "modified": "2025-03-12T03:31:59.629Z",
        "modifiedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ]
  }
}

Successful

{
  "code": "OK",
  "data": {
    "id": "08da1044-cc4d-4395-a31b-7a815a5f2ec0",
    "tenantId": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
    "schoolId": "7864",
    "spouseCommunityId": "8d35e001-6286-4fc2-9b34-c52ff9184f1e",
    "givenName": "Stephanie",
    "surname": "Aalberts",
    "preferredName": "Stephanie",
    "otherGivenName": "Lynnes",
    "nameSuffix": null,
    "overrideLegalSurname": null,
    "overrideMailFormat": null,
    "overrideSalutationFormat": null,
    "overrideSalutationPreferredFormat": null,
    "familyNamePrevious": "PS",
    "maidenName": null,
    "isPrimary": false,
    "initials": "SA",
    "title": {
      "id": "44178df1-b539-4673-ad7a-94d982bdca9f",
      "description": "Miss"
    },
    "displayName": "AALBERTS, Miss Stephanie Lynnes",
    "displayNameForList": "AALBERTS, Stephanie Lynnes",
    "birthDate": "1978-05-01",
    "recordType": "Person",
    "gender": {
      "id": "f54b66eb-bcc0-48f5-99e4-21e561c1ee25",
      "description": "Female"
    },
    "deceasedDate": null,
    "deceased": null,
    "schoolInfo": {
      "tenantId": "0dfaa251-bb48-4c99-a26c-a22e45fe3ab8",
      "communityId": "08da1044-cc4d-4395-a31b-7a815a5f2ec0",
      "staffId": "c7b609ac-ccb6-45ce-a62b-3d2b23e7cc9b",
      "schoolStaffCode": "STEPH",
      "staffType": {
        "id": "583347e0-3cce-49d5-a66e-c1daabc0cfd3",
        "description": "Accounts Payable / Receivable"
      },
      "staffRoom": {
        "id": "354a0b44-9aa8-43d2-8600-9b308362c4f2",
        "description": "Room 1",
        "active": true
      },
      "staffExtension": "1223",
      "staffHouse": {
        "id": "7384a31e-717e-4566-9a29-7f233d517bee",
        "description": "Isaacs-J",
        "code": "IS-J",
        "houseGroupId": "7384a31e-717e-4566-9a29-7f233d517bee"
      },
      "campuses": [
        {
          "lookup": {
            "id": "496dee75-b347-4bf9-b4cf-137d7abbd259",
            "code": "BE_CAMP1",
            "description": "BE Campus 1"
          },
          "id": "496dee75-b347-4bf9-b4cf-137d7abbd259",
          "code": "BE_CAMP1",
          "description": "BE Campus 1"
        }
      ],
      "staffDepartment": [
        {
          "id": "746a9002-613c-4c4f-b86c-aa35a4bea20c",
          "code": "DEPT2",
          "description": "Department 2"
        }
      ]
    },
    "qualifications": [
      {
        "id": "14f9a399-088e-4a59-9fdc-3e94f94b4918",
        "communityId": "08da1044-cc4d-4395-a31b-7a815a5f2ec0",
        "registrationCode": "1234",
        "description": "test",
        "attainedDate": "2021-05-26T23:09:31.391Z",
        "expAttainmentYear": 2000,
        "comment": "Qualification comment",
        "qualificationLevel": {
          "id": "c5153bde-3e13-43ca-98be-f26d3f622383",
          "description": "Certificate I to IV (including trade certificate)"
        },
        "qualificationType": {
          "id": "1422e4d6-82ca-4ac4-94e5-48c0848c90c3",
          "description": "Bachelors Degree"
        },
        "trainingProvider": {
          "id": "6fb0d78a-5f2d-409b-a208-5df78a02a711",
          "description": "St John's Ambulance"
        },
        "qualificationMajorsList": [
          {
            "id": "14f9a399-088e-4a59-9fdc-3e94f94b4918",
            "sortOrder": 0,
            "major": {
              "id": "35877f94-ecd4-462d-bee7-014212864aff",
              "code": "CODE1",
              "description": "Code 1"
            }
          }
        ],
        "qualificationMinorsList": [
          {
            "id": "14f9a399-088e-4a59-9fdc-3e94f94b4918",
            "sortOrder": 0,
            "minor": {
              "id": "cc464301-9f76-4d27-8df9-7b819a2905f1",
              "code": "CODE2",
              "description": "Code 2"
            }
          }
        ]
      }
    ]
  }
}

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