For Developers

Get Class

GET https://ed.link/api/v2/my/classes/:class_id

Retrieve information about a specific Class that the current user has access to.

Request Parameters

ParameterTypeDescription
class_idstringThe UUID of the desired Class.

Sample Request

axios.get('https://ed.link/api/v2/my/classes/c3cd44bc-2a9e-43c9-b32b-71e2b531604b', {
    headers: {
        authorization: `Bearer ${person_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"
            }
        ]
    },
    "$request": "00000000-0000-0000-0000-000000000000"
}