Alert APIs |
Encouragement APIs |
Update APIs |
Success Metrics |
Alert APIs
Campuses can use the Notation APIs to create notations using data collected from other campus systems, as well as pull notation data into other systems and/or join this data with other datasets for custom reporting and analysis purposes. Here are just a few examples of how campuses are using the Notation APIs to support student success:
- To automate notations using data collected from other campus systems such as student conduct and judicial information or mid-term grades and attendance records captured in the Student Information or Learning Management systems.
- To better understand how notations are being used at the institution to identify any gaps in intervention efforts or training needs for the faculty and staff using the system.
- To evaluate the impact of notations on student outcomes such as course success, retention, and graduation rates.
Create an Alert using the API
Notations/alerts
| Description | Creates an open alert with the specified content for the specified user |
| Data to be supplied | Audience Type, can the student view the alert, categories, created by, details, student information |
Get information about Alerts using the API
Notations/alerts
| Description | Returns all alerts that were created within a specified date range for specified users |
| What will be returned | Alert ID, audience type, comments, created by, created on, categories, details, status, student information |
Notations/alerts/{alertID}
| Description | Returns an alert associated with the specific ID |
| What will be returned | Alert ID, audience type, comments, created by, created on, categories, details, status, student information |
Notations/alerts/{alertID}/categories
| Description | Returns the categories associated with the specific alert |
| What will be returned | Alert ID, audience type, comments, created by, created on, categories, details, status, student information |
Notations/alerts/{alertID}/createdBy
| Description | Returns the information of the user who created the specific alert |
| What will be returned | First name, last name, email address |
Notations/alerts/{alertId}/student
| Description | Returns the information of the student who the alert was created about |
| What will be returned | Alert ID, audience type, comments, created by, created on, categories, details, status, student information |
Encouragement APIs
Create an Encouragement using the API
Notations/encouragements
| Description | Creates an encouragement with the specified content for the specified user |
| Data to be supplied | Audience Type, encouragement type, created by, details, student information |
Get information about Encouragements using the API
Notations/encouragements
| Description | Returns all encouragements that were created within a specified date range for specified users |
| What will be returned | Encouragement ID, audience type, created on, created by, details, student information |
Notations/encouragements/{encouragementId}
| Description | Returns an encouragement associated with the specific ID |
| What will be returned | Encouragement ID, audience type, created on, created by, details, student information |
Update APIs
Create an Update using the API
Notations/updates
| Description | Creates an update with the specified content for the specified user |
| Data to be supplied | Audience Type, created by, details, student information |
Get information about Updates using the API
Notations/updates
| Description | Returns all updates that were created within a specified date range for specified users |
| What will be returned | Update ID, audience type, created on, created by, details, student information |
Notations/updates/{updatesId}
| Description | Returns an update associated with the specific ID |
| What will be returned |
Update ID, audience type, created on, created by, details, student information |
Success Metrics
Notations/reporting/people/{personId}
| Description | Returns success stats for the identified student |
| What will be returned | Data Insight count, encouragement count, lowered alert count, open alert count, update count |
Additional APIs available. Please see our API documentation.