Table of Contents
Description
Returns appointments based on specified filter criterial
Endpoint Specification
Path: api/appointments
Parameters:
Parameter Name | Data Type | Required | Definition |
|---|---|---|---|
begin_date | date | Yes | mm/dd/yyyy |
end_date | date | Yes | mm/dd/yyyy |
| appointment_type | varchar | No | "advising","tutoring","general_event". Returns all appointments if blank. |
| organizer_ids | varchar | No | Comma-separated list of primary user ids of appointment organizers (advisors, tutors, etc) |
| attendee_ids | varchar | No | Comma-separated list of primary user ids of appointment attendees (students) |
| locations | varchar | No | Comma-separated list of location names |
| student_services | varchar | No | Comma-separated list of student service names |
Template API Call using cURL
curl -u <YourApiUserName>:<YourApiKey> "https://<yourschoolsubdomain>.gradesfirst.com/api/appointments?begin_date="<begin_date>"&end_date="<end_date>"
Example API Call using cURL
curl -u vendor@school.edu:ebd6b6470d35d12675fcbd308125b7 "https://coastalcollege.gradesfirst.com/api/appointments?begin_date="01/01/2014"&end_date="06/30/2014"
Output
This call outputs a JSON array. Each element in the array represents an appointment.
...