...
Parameters:
Parameter Name | Definition |
| batchSize | For pagination. The number of notes to retrieve at a time. Default value is 500. Maximum value is 1000. If you set this parameter, you'll also need to set the batchIndex parameter. |
batchIndex | For pagination. The number of the page in the set you'd like to retrieve. Defaults to 1. If you set this parameter, you'll also need to set the batchSize parameter. |
| noteType | Will return notes of a given type. The possible options are "note", "reminder" and "statusChange". The "note" option will return all notes. The "reminder" option will return only notes with a due date. The "statusChange" option will return only notes with one or more note reasons. If It is possible for a note to have both a due date and note reasons, so the "reminder" and "statusChange" sets of notes will not be mutually exclusive. If you want to include all types of notes, you could either specify "note", or not include this parameter in the query at all. |
| anyDateFrom | Will return notes whose create date or update date is on or after the date specified, date inclusive (in MM/DD/YYYY format). This will capture all notes for which there has been any activity on or after the date specified. |
anyDateTo | Will return notes whose create date or update date is on or before the date specified, date inclusive (in MM/DD/YYYY format). This will capture all notes for which there has been any activity on or before the date specified. |
createDateFrom | Will return notes created on or after the date specified, date inclusive (in MM/DD/YYYY format) |
| createDateTo | Will return notes created on or before the date specified, date inclusive (in MM/DD/YYYY format) |
updateDateFrom | Will return notes updated on or after the date specified, date inclusive (in MM/DD/YYYY format) |
updateDateTo | Will return notes updated on or before the date specified, date inclusive (in MM/DD/YYYY format) |
date | Deprecated. The createDateFrom parameter will provide the same functionality. Will return notes created on or after the date specified, date inclusive (in MM/DD/YYYY format) |
| displayDateFrom | Deprecated. The createDateFrom parameter will provide the same functionality. |
| displayDateTo | Deprecated. The createDateTo parameter will provide the same functionality. |
...
https://coastalcollege.gradesfirst.com/api/notes?batchSize=500&batchIndex=1¬eType=statusChange
To fetch all notes associated with a due date that have been updated on or before 11/01/2014
https://coastalcollege.gradesfirst.com/api/notes?batchSize=500&batchIndex=1¬eType=reminder&updateDateTo=11/01/2014
Output
This call outputs a JSON array.
...