| Table of Contents |
|---|
Description
- User profile created, updated, deleted (excluding data imports).
- Appointment created, updated, deleted.
- Note created, updated, deleted (excluding data imports)deleted.
- Course Attendance created, updated, deleted.
- At-risk progress report created, updated, deleted.
Output
You will receive a HTTP POST containing a JSON object with the student's updated profile data.
Attribute Name | Definition |
success | (boolean) true or false value whether the method was returned successfully |
| transaction_id | (string) globally unique identifier for this API request |
| student: address_1 | (string) First line of the student's address |
| student: address_2 | (string) Second line of the student's address |
| student: alternate_id | (string) The student's Alternate ID in GradesFirst |
| student: cell_phone | (string) The student's cell phone number |
| student: city | (string) City of the student's address |
| student: created_at | (datetime) Date and time when this student record was first created in GradesFirst |
| student: current_classification | (string) The student's academic classification (Freshman, Sophomore, Junior, Senior) |
| student: date_of_birth | (date) The student's date of birth |
| student: email | (string) The student's email address |
| student: enrollment_goal | (string) The student's enrollment goal |
| student: enrollment_status | (string) The student's enrollment status |
| student: ethnicity | (string) The student's ethnicity |
student: first_name | (string) The student's first name |
| student: gender | (string) The student's gender |
| student: home_phone | (string) The student's home phone number |
| student: id | (integer) The student's GradesFirst system ID. |
| student: is_active | (boolean) The student's active status. |
| student: is_at_risk | (boolean) The student's at-risk status (as set on their profile) |
student: last_name | (string) The student's last name |
| student: login | (string) The student's GradesFirst login (username) |
| student: primary_id | (string) The student's primary ID in GradesFirst |
| student: sso_id | (string) The student's Single Sign-On ID |
| student: state | (string) The state of the student's address |
student: url | (string) The URL for the student’s profile page in GradesFirst |
student: work_phone | (string) The student's work phone number |
student: zip | (string) The zip code of the student's address |
| courses | (array[course]) An array representing the student's courses for the current term |
activity: recent_appointments | (array[appointment]) An array representing the student's 5 most recent appointments |
activity: next_appointments | (array[appointment]) An array representing the student's next 5 appointments |
| activity: recent_notes | (array[note]) An array representing the student's 5 most recently created or updated notes |
Appointment | DataType |
location | (string) location of appointment |
datetime | (datetime) The date and time of the appointment |
organizer: name | (string) The name of the organizer of the appointment |
| organizer: primary_id | (string) The Primary ID of the organizer in GradesFirst |
type | (string) type of appointment (e.g. Advising, Tutoring) |
Course | DataType |
| name | (string) name of course |
| section_name | (string) name of section |
| unexcused_absences | (int) number of the student's unexcused absences in this course |
| at_risk_progress_reports | (int) number of the student's at-risk progress reports in this course |
Note | DataType |
| datetime | (datetime) The date and time the note was created or last updated |
| reasons | (string) A comma-delimited list of the note reasons for the note |
| body | (string) The content of the note |
...