Returns the attendance of the student
Returns an Attendance object
client.attendance()
.then(console.log); // -> { type: 'Period', period: {...}, schoolName: 'University High School', absences: [...], periodInfos: [...] }
Returns a Calendar object
client.calendar({ interval: { start: new Date('5/1/2022'), end: new Date('8/1/2021') }, concurrency: null }); // -> Limitless concurrency (not recommended)
const calendar = await client.calendar({ interval: { ... }});
console.log(calendar); // -> { schoolDate: {...}, outputRange: {...}, events: [...] }
Options to provide for calendar method. An interval is required.
Gets the student's documents from synergy servers
Returns a list of student documents
const documents = await client.documents();
const document = documents[0];
const files = await document.get();
const base64collection = files.map((file) => file.base64);
Returns the gradebook of the student
Returns a Gradebook object
const gradebook = await client.gradebook();
console.log(gradebook); // { error: '', type: 'Traditional', reportingPeriod: {...}, courses: [...] };
await client.gradebook(0) // Some schools will have ReportingPeriodIndex 0 as "1st Quarter Progress"
await client.gradebook(7) // Some schools will have ReportingPeriodIndex 7 as "4th Quarter"
Optional reportingPeriodIndex: numberThe timeframe that the gradebook should return
Get a list of messages of the student
Returns an array of messages of the student
await client.messages(); // -> [{ id: 'E972F1BC-99A0-4CD0-8D15-B18968B43E08', type: 'StudentActivity', ... }, { id: '86FDA11D-42C7-4249-B003-94B15EB2C8D4', type: 'StudentActivity', ... }]
Gets a list of report cards
Returns a list of report cards that can fetch a file
const reportCards = await client.reportCards();
const files = await Promise.all(reportCards.map((card) => card.get()));
const base64arr = files.map((file) => file.base64); // ["JVBERi0...", "dUIoa1...", ...];
Gets the student's school's information
Returns the information of the student's school
await client.schoolInfo();
client.schoolInfo().then((schoolInfo) => {
console.log(_.uniq(schoolInfo.staff.map((staff) => staff.name))); // List all staff positions using lodash
})
Gets the info of a student
StudentInfo object
studentInfo().then(console.log) // -> { student: { name: 'Evan Davis', nickname: '', lastName: 'Davis' }, ...}
Static processGenerated using TypeDoc
The StudentVUE Client to access the API