Districts

List Districts

districts.list(options);

Retrieves a list of Districts. There is only ever one district per integration.

Arguments

Example Usage

for await (const district of edlink.districts.list()) {
    console.log(district.name);
}

Fetch District

districts.fetch(district_id, options);

Retrieve a single District. There is only ever one district per integration.

Arguments

Example Usage

const district = await edlink.districts.fetch(district_id);
console.log(district.name);

List District Administrators

districts.listAdministrators(district_id, options);

Retrieve the administrators in a District. Responds with an array of Person objects.

Arguments

Example Usage

for await (const admin of edlink.districts.listAdministrators(district_id)) {
    console.log(admin.display_name);
}