getstudentsforschoolresponsebody.md

GetStudentsForSchoolResponseBody

Collection of students successfully retrieved

Example Usage

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

let value: GetStudentsForSchoolResponseBody = {
  users: [
    {
      sourcedId: "<id>",
      status: "tobedeleted",
      enabledUser: false,
      givenName: "<value>",
      familyName: "<value>",
      roles: [
        {
          roleType: "secondary",
          role: "guardian",
          org: {
            href: "https://acceptable-impact.org/",
            sourcedId: "<id>",
            type: "<value>",
          },
          beginDate: "<value>",
          endDate: "<value>",
        },
      ],
      agents: [],
    },
  ],
  totalCount: 6436.26,
  pageCount: 9736.94,
  pageNumber: 9326.17,
  offset: 4176.03,
  limit: 8254.8,
};

Fields

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