For Developers

List Aliases

GET https://ed.link/api/v2/graph/classes/:class_id/assignments/:assignment_id/aliases

Retrieve a list of Aliases for a given class.

ParameterTypeDescription
class_idstringThe UUID of the desired Class.
assignment_idstringThe UUID of the desired Assignment.

Sample Request

axios.get(`https://ed.link/api/v2/graph/classes/${class_id}/assignments/${assignment_id}/aliases`, {
    headers: {
        authorization: `Bearer ${integration_access_token}`
    }
});

Sample Response

{
    "$data": [
        {
            "identifier": "1",
            "type": "myAliasNamespace",
            "rule_ids": [],
            "references": {}
        },
        {
            "identifier": "2",
            "type": "myAliasNamespace",
            "rule_ids": [],
            "references": {}
        },
        {
            "identifier": "1",
            "type": "myOtherAliasNamespace",
            "rule_ids": [],
            "references": {}
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}

Supported Providers

  • aeries
  • aspen
  • blackbaud
  • blackboard
  • brightspace
  • canvas
  • classgather
  • facts
  • google
  • illuminate
  • microsoft
  • moodle
  • oneroster
  • powerschool
  • schoology
  • lti
  • skyward
  • veracross
  • qmlativ
  • infinitecampus
  • rapididentity
  • sapphire
  • genesis
  • rediker
  • renweb
  • synergy
  • managebac
  • tyler
  • banner
  • frontline
  • ascender