The NTN Gradebook Plugin relies on native Canvas API calls and LiveEvents triggers to function within the Canvas ecosystem. Below is a comprehensive list of the API commands and LiveEvent triggers to function as intended within a school's instance.
To learn more about how the NTN Gradebook works, see How does the NTN Gradebook work?.
API Commands
| Command | Action(s) | Use(s) |
|---|---|---|
| Accounts | GET | Obtain a list of accounts and sub-accounts. |
| Account Reports | GET, POST | Nightly mass sync of all above entities. |
| Assignments | GET, DELETE, PUT, POST | Create, manage, delete, modify, and list assignments within a course. |
| Assignment Groups | GET, DELETE, PUT, POST | Create, manage, modify assignment groups within a course. |
| Course | GET, PUT | Obtain a list of courses. Set assignment groups and weighting to reflect outcome scoring categories within a course. |
| Enrollments | GET | Obtain a list of students and teachers enrolled in a course. |
| Grading Periods | GET | Obtain a list of grading periods used in the school. |
| Rubrics | GET, POST | Create a rubric for an assignment aligned to the outcome scoring categories. |
| Quizzes | GET, DELETE, PUT, POST | Create and manage quizzes within a course. |
| Terms | GET | Obtain a list of terms used in the account |
| Users | GET | Get user profile information (name, ID) to display Gradebook views and lists. |
LiveEvent Triggers
| Category |
Event | Use(s) |
|---|---|---|
| Assignment | assignment_created | Notification when a new assingment is created in Canvas. |
| assignment_updated | Notification when an assignment has been edited in Canvas. | |
| Assignment Group | assignment_group_created | Notification when an assignment group has been created in a Canvas course. |
| assignment_group_updated |
Notification when an assignment group has been modified in a Canvas course. | |
| Course | course_created | Notification when a course has been created. |
| course_updated | Notification when a course has been modified. | |
| Course Section | course_section_created | Notification when a section has been created in a course. |
| course_section_updated | Notification when a section has been modified in a course. | |
| Enrollment | enrollment_created | Notification when a new enrollment has been added to a course. |
| enrollment_updated | Notification when a new enrollment has been modified in a course. | |
| Submission | submission_created | Notificaiton when a new assingment submission has been created. |
| submission_updated |
Notification when an assignment submssion has been modified. | |
| User | user_created | Notification when a new user has been created. |
| user_updated | Notification when an existing user has been modified. | |
| Group | group_created | Notification when a group has been created. |
| group_updated | Notification when an existing group has been modified. | |
| Group Category | group_category_created | Notification when a group category has been created. |
| group_category_modified | Notification when a group category has been modified | |
| Group Membership | group_membership_created | Notification when a group membership has been created. |
| group_membership_updated | Notification when an existing group membership has been modified. |
The NTN Gradebook is constantly being improved based on the feedback from users and we strive to keep our documentation up to date. If this document doesn't match what you are seeing in Echo, please let us know.
Comments
0 comments
Please sign in to leave a comment.