For Developers
List Classes
GET https://ed.link/api/v2/graph/classes
Retrieve a list of all Classes.
Request Parameters
This query allows for standard paging parameters.
Parameter | Location | Type | Description |
---|---|---|---|
$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/graph/classes', {
headers: {
authorization: `Bearer ${integration_access_token}`
}
});
Sample Response
{
"$data": [
{
"id": "c3cd44bc-2a9e-43c9-b32b-71e2b531604b",
"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": "en-GB",
"time_zone": "Europe/London",
"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"
}
]
},
{
"id": "c2a4179e-8f3d-4e7d-b1a1-72f5a09c5a9a",
"created_date": "1993-09-01T08:30:00.000Z",
"updated_date": "1993-12-15T14:45:10.000Z",
"name": "Care of Magical Creatures",
"description": "Explore and care for magical beasts, from Hippogriffs to Blast-Ended Skrewts.",
"picture_url": "https://static.wikia.nocookie.net/harrypotter/images/4/42/Hagrid_teaching.jpg",
"grade_levels": ["04", "05"],
"subjects": ["CEDS.11"],
"periods": ["2"],
"state": "active",
"locale": "en-GB",
"time_zone": "Europe/London",
"properties": {
"professor": "Rubeus Hagrid",
"location": "Hogwarts Grounds"
},
"session_ids": ["b0f123ab-6f12-4123-8c87-8a7b9c5c3a2b"],
"course_id": "9a5f83a1-ec15-47f2-84c7-4f9127a0d9af",
"school_id": "1d2f3a45-b678-49cd-9f01-8ea0b3b219ef",
"department_id": "7e98b431-1a2c-4b7f-a7a9-61234e50f12d",
"subject_id": "f88a7b31-12f9-4e8b-bce9-3aa541cbe789",
"period_ids": ["2cd5f831-82c4-47d9-b3e0-f12e1d9aa532"],
"room_ids": ["64db1f82-91f2-44ea-87c3-912b97f2d8ce"],
"product_ids": ["f6a317cd-1234-45c9-8b21-fc5d2a42c4a8", "2db1de04-55bb-4b59-b8ce-15bfcb757c61", "aa8f4e41-c64c-4fe8-bcba-d74e1351d6f9"],
"identifiers": [
{
"type": "sis_id",
"value": "CREATURES1993"
}
]
}
],
"$request": "00000000-0000-0000-0000-000000000000"
}