Students

Get Students

Changed on

Requires permissions: AcademicStaff or AcademicSupport or Guardian or Parent or Student or StudentFacing

Get a list of students with optional pagination, sorting, filtering and includes<br />Supported Includes: SendList, EalList, Photo, House, House.Staff, House.Staff.Photo, Year, Form, Form.Staff, Form.Photo, Relations, Relations.Contacts (This can be done infinitely, e.g. Relations.Contacts.To.Relations.Contacts or Relations.Contacts.From.Relations.Contacts), InverseRelations, InverseRelations.Contacts (This can be done infinitely, e.g. InverseRelations.Contacts.To.InverseRelations.Contacts or InverseRelations.Contacts.From.InverseRelations.Contacts), Classes, Classes.Staff, Classes.Staff.Photo, MusicLessons and Siblings (the pupil's brothers in the School, past and present; deliberately NOT part of Relations, which feeds the parent and guardian contacts)

get/Students

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/Students
  • Auth: HTTP bearer

Query parameters

academicYearinteger nullable
includeLeaversboolean required
pageinteger required
pageSizeinteger required
includesstring[] nullable
sortstring nullable
filterstring nullable

Response

Success - Success

Changes

  • 49f6b0978a48Revision changes
    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property // to the response with the status

  • e15a351e2573Revision changes
    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • breaking

      the /////// response's property format changed from int32 to int64 for status