# aeriesjs An Aeries SIS (www.aeries.com) API helper library. Helping simplify using the Aeries API with Node applications.
More information on the API can be found here, https://support.aeries.com/support/solutions/articles/14000077926-aeries-api-full-documentation.
Requirements
- NodeJS 8+ (https://nodejs.org/en/download/)
- Access to an Aeries SIS API (http://www.aeries.com/)
Usage
Get a list of schools
let api = ; var aeries = certificate: '477abe9e7d27439681d62f4e0de1f5e1' url: 'https://demo.aeries.net/aeries/'; console; aeries;
Output
Getting list of schools:
0 - Eagle Unified School District
100 - ZZZ Basic Code Tables
200 - ZZZ Basic Data HS ADS SOC Etc
990 - Golden Eagle Elementary School
991 - Tawny Eagle YR Elementary School
992 - Hawk Elementary for ATT
993 - Bald Eagle Intermediate School
994 - Screaming Eagle High School
995 - Aeries Continuation School
996 - Eagle Flight School
997 - Eagle Alternative Education School
998 - Eagle Summer School
999 - ZZZ Inactive Students
Get information about a Course
let api = ; var aeries = certificate: '477abe9e7d27439681d62f4e0de1f5e1' url: 'https://demo.aeries.net/aeries/'; console;aeries;
Output
Get Information for course #0618:
0618 - PreCalculus
- LongDescription - PreCalculus
- Notes -
- ContentDescription -
- NonAcademicOrHonorsCode -
- SubjectArea1Code - D
- SubjectArea2Code - J
- SubjectArea3Code -
- DepartmentCode - M
- StateCourseCode - 2498
- CSFCourseList - A
- CollegePrepIndicatorCode - P
- CreditDefault - 5
- CreditMax - 10
- TermTypeCode - Y
- LowGrade - 10
- HighGrade - 12
- CSU_SubjectAreaCode - C
- CSU_Rule_CanBeAnElective - G
- CSU_Rule_HonorsCode -
- UC_SubjectAreaCode - C
- UC_Rule_CanBeAnElective - G
- UC_Rule_HonorsCode -
- PhysicalEducationIndicator - false
- InactiveStatusCode -
Real World - Creating a student CSV Export
'use strict'; let api = ;let csv = ;let fs = ; var aeries = certificate: '477abe9e7d27439681d62f4e0de1f5e1' url: 'https://demo.aeries.net/aeries/'; console;aeries;
Output
Creating student export CSV file for students at school 990...
Wrote 739 students to file "students.csv".
Configuration
The configuration takes the URL of the Aeries API, the security certificate and an option to disable SSL verification.
You can change the certificate or url using the setCertificate and setUrl functions as well.
var options = certificate: '477abe9e7d27439681d62f4e0de1f5e1' url: 'https://demo.aeries.net/aeries/' verifyCerts: true;
Usage
let api = ; var aeries = certificate: '477abe9e7d27439681d62f4e0de1f5e1' url: 'https://demo.aeries.net/aeries/' verifyCerts: false // disable SSL verification;
let api = ; var aeries = verifyCerts: false // disable SSL verification; aeries;aeries;
Callbacks
All functions implement a basic callback function to process the returned error or data. The callback includes an error, the response body and an HTTP status code.
aeries;