People

List People

people.list(options);

Retrieve a list of People.

Arguments

Example Usage

for await (const person of edlink.people.list()) {
    console.log(person.first_name, person.last_name);
}

Fetch Person

people.fetch(person_id);

Retrieve an individual Person.

Function Arguments

Example Usage

const person = await edlink.people.fetch(person_id);
console.log(person.first_name, person.last_name);

List Person Enrollments

people.listEnrollments(person_id, options);

Retrieve a list of Enrollments for a Person.

Arguments

Example Usage

for await (const enrollment of edlink.people.listEnrollments(person_id)) {
    console.log(enrollment.role, enrollment.status);
}

List Person Districts

people.listDistricts(person_id, options);

Retrieve a list of Districts for a Person. There is only ever one district per integration.

Arguments

Example Usage

for await (const district of edlink.people.listDistricts(person_id)) {
    console.log(district.name);
}

List Person Schools

people.listSchools(person_id, options);

Retrieve a list of Schools for a Person.

Arguments

Example Usage

for await (const school of edlink.people.listSchools(person_id)) {
    console.log(school.name);
}

List Person Classes

people.listClasses(person_id, options);

Retrieve a list of Classes for a Person.

Arguments

Example Usage

for await (const clazz of edlink.people.listClasses(person_id)) {
    console.log(clazz.name);
}

List Person Sections

people.listSections(person_id, options);

Retrieve a list of Sections for a Person.

Arguments

Example Usage

for await (const section of edlink.people.listSections(person_id)) {
    console.log(section.name);
}

List Person Agents

people.listAgents(person_id, options);

Retrieve a list of Agents for a Person.

Arguments

Example Usage

for await (const agent of edlink.people.listAgents(person_id)) {
    console.log(agent.type, agent.status);
}