API URL
Student Course Progress API Endpoint:
https://api.3rdmil.com/students/progress
Only GET requests are permitted to this API, and all requests must include the access-token header described under Authentication.
Authentication
Your token must be sent with all requests as the http header access-token.
If the token is not properly sent you will receive a 400 http error with a message that the token is missing or not valid.
Filters
You can filter the response based on the student Email, StudentID, StartDate, PartOneCompletionDate, PartTwoCompletionDate, and Active or Expired status.
Email and StudentID accept a single value on the URL query, for example:
- https://api.3rdmil.com/students/[email protected]
- https://api.3rdmil.com/students/progress?StudentID=1234567
The date related values need to be prefixed with either Min or Max and be formatted like YYYY-MM-DD, for example:
- https://api.3rdmil.com/students/progress?MinPartOneCompletionDate=2023-01-01
- https://api.3rdmil.com/students/progress?MinStartDate=2022-07-01&MaxStartDate=2023-06-30
Active status can be added as a filter point with status:
- https://api.3rdmil.com/students/progress?MinStartDate=2022-07-01&MaxStartDate=2023-06-30&status=1
Responses
You will receive a JSON response containing an array of student arrays with the keys: Email, FirstName, LastName, ControlNumber, StartDate, PartOneCompletionDate, PartTwoCompletionDate, LastLoginDate.
- Active or expired status can be added to the array by adding &columns=status
- Miscellaneous student information can be added to the array by adding &columns=misc
Courses that do not have a part 2 will show null for the PartTwoCompletionDate value. If there are no results, you will receive an empty array with 404 http response header.
Click this button to download a sheet with this information.