getallstudentsuser.md

GetAllStudentsUser

Example Usage

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

let value: GetAllStudentsUser = {
  sourcedId: "<id>",
  status: "tobedeleted",
  enabledUser: true,
  givenName: "<value>",
  familyName: "<value>",
  roles: [],
  agents: [
    {
      href: "https://male-marimba.info",
      sourcedId: "<id>",
      type: "course",
    },
  ],
};

Fields

Field	Type	Required	Description
sourcedId	string	✔️	N/A
status	operations.GetAllStudentsStatus	✔️	N/A
dateLastModified	Date	➖	N/A
metadata	Record<string, any>	➖	N/A
userMasterIdentifier	string	➖	N/A
username	string	➖	N/A
userIds	operations.GetAllStudentsUserId[]	➖	N/A
enabledUser	boolean	✔️	N/A
givenName	string	✔️	N/A
familyName	string	✔️	N/A
middleName	string	➖	N/A
roles	operations.GetAllStudentsRole[]	✔️	N/A
agents	operations.GetAllStudentsAgent[]	✔️	N/A
primaryOrg	operations.GetAllStudentsPrimaryOrg	➖	N/A
email	string	➖	N/A
preferredFirstName	string	➖	N/A
preferredMiddleName	string	➖	N/A
preferredLastName	string	➖	N/A
pronouns	string	➖	N/A
grades	string[]	➖	N/A
password	string	➖	N/A
sms	string	➖	N/A
phone	string	➖	N/A
demographics	components.Demographics	➖	N/A