For Developers
List Classes
GET https://ed.link/api/v2/my/classes
Retrieve a list of Classes that the current user is enrolled in. A person may be associated with any number of classes, including zero (e.g., if they're an administrators/model).
Request Parameters
This query allows for standard paging parameters.
Parameter | Location | Type | Description |
---|---|---|---|
class_id | url | string | The UUID of the desired Class. |
$first | query | number | Returns the first n elements from the list. |
$last | query | number | Returns the last n elements from the list. |
$before | query | uuid | Returns the elements in the list that come before the specified item. |
$after | query | uuid | Returns the elements in the list that come after the specified item. |
It is best practice to use either $first
or $last
in conjunction with the $next
value returned by the API to paginate through results.
Read More About Paging
Developer Guide
Click to Read
This query allows for filtering results.
Sample Request
axios.get('https://ed.link/api/v2/my/classes', {
headers: {
authorization: `Bearer ${person_access_token}`
}
});
Sample Response
{
"$data": [
{
"id": "5e319313-3acc-4c2c-95f2-55399e24796e",
"created_date": "2021-07-13T17:45:27.685Z",
"updated_date": "2021-07-13T17:45:27.685Z",
"name": "Defense Against the Dark Arts",
"description": "Learn how to protect yourself against the dark arts.",
"picture_url": "https://static.wikia.nocookie.net/harrypotter/images/2/2c/Harry-potter2-lockhart_professor.jpg",
"grade_levels": ["06"],
"subjects": ["CEDS.08"],
"periods": ["1"],
"state": "active",
"locale": null,
"time_zone": "America/New_York",
"properties": {},
"session_ids": ["dec40712-9e51-4133-b5e0-e7ec3e3c1041"],
"course_id": "5e9683a1-e515-40d8-9d45-ee2036b3ed7e",
"school_id": "f507d94a-c6c7-4442-8d08-c205b9b232ae",
"department_id": "7326b372-8383-4788-8bed-4def36ee608a",
"subject_id": "17844f50-9fcd-4104-a94f-13c809518393",
"period_ids": ["500a57e3-2e3e-451a-8a76-9d59a85f42c8"],
"room_ids": ["0ac9d989-4df9-4d5c-a2cd-5c071474de29"],
"product_ids": ["6c3618cb-6f1e-4c29-9b17-bed26de68729", "9db1de04-686b-4b59-b8ce-15bfcb757c60", "de8f4e41-c64c-4fe8-bcba-d74e1351d6d5"],
"identifiers": [
{
"type": "sis_id",
"value": "DADA2021"
}
]
}
],
"$request": "00000000-0000-0000-0000-000000000000"
}