getallstudentsresponsebody.md

GetAllStudentsResponseBody

Successful response containing a collection of students

Example Usage

import { GetAllStudentsResponseBody } from "@superbuilders/oneroster/models/operations";

let value: GetAllStudentsResponseBody = {
  users: [
    {
      sourcedId: "<id>",
      status: "active",
      enabledUser: false,
      givenName: "<value>",
      familyName: "<value>",
      roles: [
        {
          roleType: "secondary",
          role: "aide",
          org: {
            href: "https://unfinished-quart.org",
            sourcedId: "<id>",
            type: "<value>",
          },
          beginDate: "<value>",
          endDate: null,
        },
      ],
      agents: [],
    },
  ],
  totalCount: 463.79,
  pageCount: 9395.4,
  pageNumber: 6658.25,
  offset: 9954.84,
  limit: 8345.68,
};

Fields

Field	Type	Required	Description
users	operations.GetAllStudentsUser[]	✔️	N/A
totalCount	number	✔️	N/A
pageCount	number	✔️	N/A
pageNumber	number	✔️	N/A
offset	number	✔️	N/A
limit	number	✔️	N/A