Search Staff

POST 
/staff/search

Search for Staff members using a variety of filters.

Request

application/json

Body

Optional Filtering

schoolId string
communityIds string[]
surname string
given string
givenMode string
schoolStaffCode string
staffType objectnullable
id uuidrequired
description stringrequired
staffRoom objectnullable
id uuidrequired
description stringrequired
staffExtension string
staffActive string
staffCampusId string
staffHouseId string
employmentStatus string
departmentInMode string
departmentCodeIn string[]
qualificationType objectnullable
id uuidrequired
description stringrequired
trainingProvider objectnullable
id uuidrequired
description stringrequired
qualificationLevel objectnullable
id uuidrequired
description stringrequired
qualificationMajor objectnullable
id uuidrequired
description stringrequired
qualificationMinor objectnullable
id uuidrequired
description stringrequired
attainedDateQual string
expAttainmentYear string
skill string
skillLevel string
attainedDate string
expiryDate string
vehicleParkingSpace string
vehiclePermit string
registration string
interactionType objectnullable
id uuidrequired
description stringrequired
interactionCampus objectnullable
id uuidrequired
description stringrequired
anyInteraction boolean
incIntExpired boolean
activityType objectnullable
id uuidrequired
description stringrequired
activityStatus objectnullable
id uuidrequired
description stringrequired
incActExpired boolean
keyCode objectnullable
id uuidrequired
description stringrequired
keyNumber string
identityCodeType objectnullable
id uuidrequired
description stringrequired
identityCode string
pageLimit number
pageNum number
pageSortBy string
pageSortDir string
simpleSearchValue string

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

meta objectrequired

Meta options for search responses

page number

Possible values: >= 1

Default value: 1

page number starts with 1

limit number

Possible values: >= 1 and <= 100

Default value: 10

No of items per page

traceContext uuid

totalRecordCount number

number of records in the result set

pageNum number

Possible values: >= 1

Default value: 1

page number starts with 1

pageLimit number

Possible values: >= 1 and <= 100

Default value: 100

No of records to limit per page

pageRecordCount number

Possible values: <= 100

number of records in the current page

pageNumTotal number

number of pages in the result set

pageSortBy string

Default value: surname,givenName,schoolId

sort by field(s)

pageSortDir string

Default value: ASC

sort direction

range object

start number

Possible values: >= 1

Default value: 1

start range

end number

Default value: 100

end range

data object[]
Array [
communityId string
givenName stringnullable
preferredName stringnullable
surname stringnullable
nameSuffix stringnullable
schoolId string
recordType string
displayName string
displayNameList string
initials string
email stringnullable
genderId stringnullable
gender stringnullable
genderCode stringnullable
title stringnullable
staffId string
stafftype string
staffTypeCode stringnullable
employmentStatus stringnullable
]

Example (from schema)

{
  "code": "OK",
  "meta": {
    "page": 1,
    "limit": 10,
    "traceContext": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "totalRecordCount": 1,
    "pageNum": 1,
    "pageLimit": 100,
    "pageRecordCount": 1,
    "pageNumTotal": 1,
    "pageSortBy": "surname,givenName,schoolId",
    "pageSortDir": "ASC",
    "range": {
      "start": 1,
      "end": 1
    }
  },
  "data": [
    {
      "communityId": "string",
      "givenName": "string",
      "preferredName": "string",
      "surname": "string",
      "nameSuffix": "string",
      "schoolId": "string",
      "recordType": "string",
      "displayName": "string",
      "displayNameList": "string",
      "initials": "string",
      "email": "string",
      "genderId": "string",
      "gender": "string",
      "genderCode": "string",
      "title": "string",
      "staffId": "string",
      "stafftype": "string",
      "staffTypeCode": "string",
      "employmentStatus": "string"
    }
  ]
}

Successful

{
  "code": "OK",
  "data": [
    {
      "communityId": "7cedbe5f-187e-4b7a-8ecd-c8cf01fbaa57",
      "givenName": "Joe",
      "preferredName": "Joe",
      "otherGivenName": null,
      "surname": "Bloggs",
      "nameSuffix": null,
      "schoolId": "87",
      "recordType": "Person",
      "companyName": null,
      "sort_name": "Bloggs Joe",
      "modified": null,
      "displayName": "Mr Joe Bloggs",
      "displayNameList": "Bloggs, Mr Joe",
      "spouseCommunityId": null,
      "initials": "JB",
      "email": "joe@example.com",
      "mobile": null,
      "phone": null,
      "studentType": null,
      "studentTypeCode": null,
      "genderId": "e5ce905a-7525-4dd1-899d-a629ea840a35",
      "gender": "Male",
      "genderCode": "M",
      "genderSortOrder": 1,
      "genderSystemMeaning": "Male",
      "titleObj": {
        "id": "09b163d3-7821-45be-9611-a7f430b4d9a4",
        "description": "Mr"
      },
      "title": "Mr",
      "addressId": "6d82554b-06c4-43a5-adfd-1487c00b6c68",
      "internalNameFormat": "Bloggs, Joe",
      "internalName": "Bloggs, Joe",
      "externalName": "Joe Bloggs",
      "mailNameFormat": "Mr J Bloggs",
      "salutationFormat": "Mr Bloggs",
      "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": null,
      "constituenciesCsv": "@STF",
      "entityTypes": [
        "community",
        "staff"
      ],
      "photoId": null,
      "totalRecordCount": 1,
      "schoolStaffCode": "JB",
      "staffHouseId": null,
      "staffId": "8898cc2f-669b-4fc5-bad2-ed7880fdbcf2",
      "staffExtension": null,
      "staffCampusWithCode": null,
      "staffType": "Teacher",
      "staffTypeCode": "T",
      "staffRoom": null,
      "staffRoomCode": null,
      "isTeacher": true,
      "isHeadOfCampus": false,
      "isYearLevelCoordinator": false,
      "isHeadOfHouse": false,
      "isFormTeacher": false,
      "isRollGroupTeacher": false,
      "isTutorGroupTeacher": false,
      "isHomeRoomTeacher": false,
      "employmentStatus": "Current",
      "campuses": [],
      "staffDepartment": [],
      "staffCampusesAll": "",
      "staffCampusCode": null,
      "emailAddresses": [
        {
          "id": "ae0be82f-4b9a-43f3-9980-ee2d7668a39a",
          "emailType": {
            "id": "cbe66754-7137-4514-bbd6-35fc7284dbc9",
            "description": "Occupation"
          },
          "value": "joe@example.com",
          "default": true
        }
      ]
    }
  ],
  "meta": {
    "traceContext": "3b907939-1cec-4572-b25f-ea076e34115f",
    "totalRecordCount": 1,
    "pageNum": 1,
    "pageLimit": 100,
    "pageRecordCount": 1,
    "pageNumTotal": 1,
    "pageSortBy": "surname,givenName,schoolId",
    "pageSortDir": "ASC",
    "range": {
      "start": 1,
      "end": 1
    }
  }
}

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