[−][src]Module canvasapi::parameters
Parameters that can be passed with a request.
Example
For example, the EnrollmentType
is added as a parameter, which will return only the students
for the specific course.
To know which parameters can be used for a request, the official Canvas LMS API documentation
needs to be consulted.
let students = course .get_users() .add_parameter(EnrollmentType::Student) .fetch(&canvas).await.unwrap().inner();
Structs
RequestParameter | Parameter that can be added to a request. |
UserId | If this parameter is given and it corresponds to a user in the course, the page parameter will be ignored and the page containing the specified user will be returned instead. |
Enums
EnrollmentState | |
EnrollmentType | Parameter to specify the enrollment type of a user. |
Include | |
SortOn | Parameter to specify on wich field the output is sorted. |