getallstudentsrequest.md

GetAllStudentsRequest

Example Usage

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

let value: GetAllStudentsRequest = {
  fields: "sourcedId,name",
  filter: "status='active'",
};

Fields

Field	Type	Required	Description	Example
fields	string	➖	Comma-separated list of fields to include in the response	sourcedId,name
limit	number	➖	The maximum number of items to return in the paginated response	100
offset	number	➖	The number of items to skip in the paginated response	0
sort	string	➖	The field to sort the response by
orderBy	operations.GetAllStudentsOrderBy	➖	The order to sort the response by
filter	string	➖	The filter to apply to the response	status='active'
search	string	➖	The search query to apply to the response