Skip to main content

Search Current Students

POST 
/students/current/search

Search for Current Students using a variety of filters.

Request​

Body

required
    schoolFteX number
    schoolFteY number
    learningPathway string
    campus uuid[]
    yearLevel uuid[]
    staffHouseId uuid[]
    staffFormId uuid[]
    tutorGroup uuid[]
    rollGroup uuid[]
    homeRoom uuid[]
    subSchool uuid[]
    schoolId string
    surname string
    gender string
    studentTypeCodeIn uuid[]
    studentTypeSystemMeaningIn uuid[]
    fullTimeStatus string
    nationality string
    homeLanguage string
    asAtDate date-time
    ignoreDates boolean
    given string
    givenMode string
    studentActivityType string
    studentActivityStatus string
    activityByStaffId uuid
    followUp boolean
    followUpDate date-time
    followUpStaffId uuid
    transportType string
    boarder uuid
    borderHouse uuid
    boarderType string
    boarderMode string
    boarderHouseMode string
    boarderTypeMode string
    lock string
    lockMode string
    locker uuid
    lockerMode string
    identityCode string
    identityCodeType string
    academicPeriodSelectId uuid
    pageNum number
    pageLimit number
    simpleSearchValue string
    type string

Responses​

OK

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 uuidrequired
    givenName stringrequired
    preferredName stringnullablerequired
    otherGivenName stringnullablerequired
    surname stringnullablerequired
    nameSuffix stringnullablerequired
    schoolId stringrequired
    recordType stringrequired
    companyName stringnullablerequired
    modified date-timenullablerequired
    created date-timerequired
    displayName stringrequired
    displayNameList stringrequired
    spouseCommunityId uuidnullablerequired
    initials stringrequired
    email stringnullablerequired
    mobile stringnullablerequired
    phone stringnullablerequired
    studentType stringnullablerequired
    studentTypeCode stringnullablerequired
    genderId uuidnullablerequired
    gender stringnullablerequired
    genderCode stringnullablerequired
    genderSortOrder integernullablerequired
    genderSystemMeaning stringnullablerequired
    titleObj objectnullablerequired
    id uuidrequired
    description stringrequired
    title stringnullablerequired
    addressId uuidnullablerequired
    internalNameFormat stringrequired
    internalName stringrequired
    externalName stringrequired
    mailNameFormat stringrequired
    salutationFormat stringrequired
    addressFull stringnullablerequired
    addressComma stringnullablerequired
    postalAddressFull stringnullablerequired
    postalAddressComma stringnullablerequired
    homeAddress1 stringnullablerequired
    homeAddress2 stringnullablerequired
    homeAddress3 stringnullablerequired
    homeSuburb stringnullablerequired
    homePostCode stringnullablerequired
    homeCountry stringnullablerequired
    homeState stringnullablerequired
    postalAddress1 stringnullablerequired
    postalAddress2 stringnullablerequired
    postalAddress3 stringnullablerequired
    postalSuburb stringnullablerequired
    postalPostCode stringnullablerequired
    postalCountry stringnullablerequired
    postalState stringnullablerequired
    defaultSMS stringnullablerequired
    preferredPhone stringnullablerequired
    birthDate datenullablerequired
    constituenciesCsv stringrequired
    entityTypes string[]required
    photoId uuidnullablerequired
    sortName stringrequired
    headOfCampus stringnullablerequired
    headOfHouse stringnullablerequired
    subSchoolCode stringnullablerequired
    subSchoolDescription stringnullablerequired
    yearLevelCoOrdinator stringnullablerequired
    formGroup stringnullablerequired
    formGroupCode stringnullablerequired
    formGroupTeacher stringnullablerequired
    rollGroup stringnullablerequired
    rollGroupCode stringnullablerequired
    rollGroupTeacher stringnullablerequired
    tutorGroup stringnullablerequired
    tutorGroupCode stringnullablerequired
    tutorGroupTeacher stringnullablerequired
    homeGroup stringnullablerequired
    homeGroupCode stringnullablerequired
    homeGroupTeacher stringnullablerequired
    studentFTE numbernullablerequired
    learningPathwayCode stringnullablerequired
    learningPathwayDescription stringnullablerequired
    governmentStudentNumber stringnullablerequired
    academicStartDate daterequired
  • ]
Loading...