Introduction

The Aeries API is a web-based, REST API system. Currently, only Test Scores, Gradebook Data, and Gradebook Scores are updatable through the API, although future versions will contain more updatable objects. The API can output JSON or XML. This document describes all end-points for the API and how to construct the HTTP GET and POST Requests.


NOTE: This document is intended for use by vendors wishing to interface with the Aeries API.

 

Things to Know Before You Begin

  • Join the "Interfacing With Aeries" Google Group for updates and information about the Aeries API:
    https://groups.google.com/forum/#!forum/interfacing-with-aeries
    interfacing-with-aeries+subscribe@googlegroups.com
  • Every customer using Aeries will have an independent website with an independent URL. This includes BOTH districts hosted by Aeries Software and those who host their own installations of Aeries.
  • Not every customer has a public-facing instance of Aeries for you to tap into the API through. Districts have a wide range of options in the implementation of the Aeries SIS. The majority have some instance of Aeries somewhere in their environment, but not EVERY.
  • Some districts will only have an instance of Aeries available to you through a Windows-authenticated URL. This happens when a district is not using the Aeries Parent/Student Portal and only has an instance of Aeries for Teachers accessible through the Internet and that access point is secured using Active Directory Integration / Windows Authentication (aka no anonymous access to the website).
  • Some districts will use SSL and some will not. So besides needing to code for both anonymous and Windows-authorized requests, you need to code for both HTTPS and HTTP. Aeries Software ALWAYS recommends the use of HTTPS, but it is up to individual districts to implement what they feel is best for their district. If you use Java, be aware that there are known Certificate Authority issues with some JREs.

Certificate and Security Permissions

Unless you are an "Aeries Software Elite Partner"(1) and have a certificate issued directly from Aeries Software, each district will issue you a certificate that is unique for that district.

A "certificate" for purposes of interacting with the Aeries API is a 32 character alpha-numeric string.


When a district creates a certificate for a vendor, they can grant access to certain APIs and restrict access to others. This document describes the security area that each end point requires. It would be prudent to document the security areas that you need access to and relay that information to your customers.


It is VERY important to NEVER share or expose your district-issued certificate to end users. That includes being output to the client in Javascript or HTML. All uses of the certificate should be from your server to the district's Aeries web server.


The Aeries demo website can be used to test your code: https://demo.aeries.net/aeries/. The certificate for the demo website that you can use is "477abe9e7d27439681d62f4e0de1f5e1". You can also log into the demo website using the username "admin" and password "admin". Your certificate is case-sensitive!


(1) "Aeries Software Elite Partners" are companies that have formal business relationships with Aeries Software that can involve co-marketing and sales campaigns as well as financial relationships.


Building a Request

The Aeries API is a REST API. Although all current end points use GET and POST requests, PUT and DELETE actions will be supported in future versions for certain areas.


Request Header:

You will use the Request Header to tell the Aeries API what format you want the response (JSON or XML) and also what your certificate is.

For the response format, include the following:

  • XML
    • Accept: text/xml, text/html, application/xhtml+xml, */*
  • JSON
    • Accept: application/json, text/html, application/xhtml+xml, */*

To give the system your certificate with each request:

  • AERIES-CERT: 477abe9e7d27439681d62f4e0de1f5e1

The certificate is case sensitive!


Query String Filters:

All API end points support a query string parameter named DatabaseYear to retrieve data from a specific school year’s database. The DatabaseYear parameter should be in the format of “YYYY”, using the year at the start of the school year (e.g., ?DatabaseYear=2017 for the 2017-2018 school year). If the DatabaseYear parameter is omitted, invalid, or does not match an available school year in the customer’s configuration, then the API will connect to the customer’s Default Year instead, which in most all cases is the current school year.

Certain API end points, such as Student Information and Programs, support query string parameters to filter the records returned. These parameters are documented with each applicable end point.


Sample Code

C# - This will return the list of schools using the V3 API:

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
 
namespace AeriesWebAPI_Test
{
    public class School
    {
        public int SchoolCode { get; set; }
        public string Name { get; set; }
        public string InactiveStatusCode { get; set; }
        public string Address { get; set; }
        public string AddressCity { get; set; }
        public string AddressState { get; set; }
        public string AddressZipCode { get; set; }
        public string AddressZipExt { get; set; }
        public bool DoNotReport { get; set; }
        public string StateCountyID { get; set; }
        public string StateDistrictID { get; set; }
        public string StateSchoolID { get; set; }
        public int LowGradeLevel { get; set; }
        public int HighGradeLevel { get; set; }
        public Term[] Terms { get; set; }
        public string PrincipalName { get; set; }
        public string PrincipalEmailAddress { get; set; }
        public int AttendancePeriod { get; set; }
        public int Tracks { get; set; }
        public string ScheduleType { get; set; }
        public string SessionType { get; set; }
        public string AttendanceType { get; set; }
        public string AttendanceReporting { get; set; }
        public string ScheduleBasis { get; set; }
    }
 
    public class Term
    {
        public string TermCode { get; set; }
        public string TermDescription { get; set; }
        public DateTime StartDate { get; set; }
        public DateTime EndDate { get; set; }
    }
 
    public partial class Form1 : Form
    {
        private static HttpClient client = new HttpClient();
        public Form1()
        {
            InitializeComponent();
        }
 
        private void btnCallAeries_Click(object sender, EventArgs e)
        {
            ProcessNew();
        }
 
        static void ProcessNew()
        {
            using (client)
            {
                try
                {
                    client = new HttpClient();
                    client.BaseAddress = new Uri(@"https://demo.aeries.net/aeries");
                    client.DefaultRequestHeaders.Accept.Clear();
                    client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
                    client.DefaultRequestHeaders.Add("AERIES-CERT", "477abe9e7d27439681d62f4e0de1f5e1");
 
                    var response = client.GetAsync("https://demo.aeries.net/aeries/api/v3/schools/").Result;
 
                    string resultSchools = response.Content.ReadAsStringAsync().Result;
                    School[] objSchools = JsonConvert.DeserializeObject<School[]>(resultSchools);
 
                    foreach (var item in objSchools.ToList())
                    {
                        MessageBox.Show(item.Name);
                    }
                   
                }
                catch (Exception ex)
                {
                    MessageBox.Show(ex.Message);
                }
            }
        }
    }
}


Other Notes

Dates that contain NULL values will use the following format in XML:

<FieldName i:nil="true"/>


In previous versions of the API, this same information would have been output like:

<FieldName>0001-01-01T00:00:00</FieldName>


Revision History

4/16/2014

  • Original Release of API

5/16/2014

  • SSO Released

10/31/2014

  • Gradebook API Released

4/29/2015

  • School Info now contains Terms
  • Terms is a new End Point
  • Student Programs is a new End Point
  • Class Roster by Section is a new End Point
  • Staff data now contains Email Address, Username and Primary School
  • Gradebooks for a section can now be retrieved
    • Documented in the Gradebook Information End Point
  • Gradebook API End Points upgraded to V2
    • Gradebook Information object changed to include multiple Terms
    • Gradebook Students End Point changed to require "Term Code" as now student have different overall grades for each Term in a Gradebook

7/24/2015

  • "Staff-Teacher Information" is a new end point that returns a list of teachers associated with a given Staff ID.
  • Student Class Schedules and Section Class Rosters now display information before the beginning of the school year.
  • "Student Test Scores" is a new end point (and security area) that will return a full history of all State and locally administered Standardized Tests in Aeries. This includes tests like CST, CELDT, and CAHSEE but does not include tests like SAT I, SAT II, ACT, IB, or AP (yet).

8/28/2015

  • "Student Information Extended" is a new end point that returns additional student fields that are more rarely used than the fields available in the primary Student Information end point. Use this additional end point if there are fields it provides that you need to access.
  • Adjusted documentation to include grades -2 through 18. Grade -2 is normally used for PreSchool, -1 for Transitional Kindergarten, 0 for Kindergarten. The higher grade levels (those above 12) are used for Special Ed students included ungraded students, infants, and adults. Consult with each customer to see how they are using each grade level and which ones you should care about when interfacing with Aeries.
  • Student Programs now, for some program codes, has an ExtendedProperties collection to output information that is specific to the program. The specific extended properties are documented in the Student Programs section of this document.
  • Student Programs now supported pulling data from the new "504 Program" area of Aeries.
  • Various text fields now filter for characters that would be considered invalid in JSON and XML objects: ", <, >.
  • Enrollment History is a new End Point. This data set contains a full history of enrollment for a student in the current district, including the current school year. It will not contain current enrollment information until about the first day of school as most schools do not intialize enrollment until that time. This might be adjusted in the future. There are multiple end points that allow for retrieving just enrollment for a specific school and/or school year.
  • New end points have been added to return lists of students, courses, sections, class rosters, and staff who have had data changes since a given date and time.

9/9/2015

  • Adjusted Student Information Extended End Points URLs. They were previously documented incorrectly.

2/17/2017

  • Upgraded to Version 3
  • Many New End Points Added:
    • Absence Codes
    • Attendance
    • Attendance History
    • Bell Schedule
    • Calendar
    • Assertive Discipline
    • College Test Scores
    • District Supplemental Student Data
    • School Supplemental Student Data
    • Fees and Fines
    • Report Cards
    • Report Card Marking Periods
    • Transcripts
    • Graduation Requirements
    • Student Graduation Status Summary
    • Student Picture
    • Staff Classes/Sections
  • Enrollment History V3
    • "ID" changed to "PermanentID"
  • Section (from Master Schedule)
    • Many new fields added
  • Student Information
    • "DisplayName" and "DisplayNameAlias" fields removed (never used)
    • Added "HomeroomTeacher" for all Daily Attendance Schools (Elementary and Secondary)
    • Changed "TeacherNumber" to "CounselorNumber"
  • Student Information, GPA, and Student Extended
    • Added Pagination Support: "?StartingRecord={#}&EndingRecord={#}" Query String Parameters
  • School Information
    • New fields: PrincipalName, PrincipalEmailAddress, AttendancePeriod, Tracks
    • Changed single "School" end point to return an "Array" of "School" objects with a single item in it. This matches the data structure when not requesting a single school.
  • Terms
    • No changes, but added "V3" end point to match School Information End Point
  • Staff
    • New Fields: NetworkLoginID, AlternateEmailAddress, HumanResourcesSystemID
    • QueryString conditions can now be included to filter on any Staff object field.
  • Codes
    • Added support for newly added end points and fields
  • Assignment
    • Added "UniqueID" and "ExternalID" fields
  • "V3" end points added for all gradebook end points
  • Added new end points to allow Assignment Unique ID to be sent instead of Gradebook Number and Assignment Number.
  • New "Insert Assignment" End Point.
  • “V3” Contacts end point added
  • The V3 Staff API now includes additional fields as well as School and Communications Access permissions
  • Added support for “DatabaseYear” query string parameter to connect to a previous year database
  • Added 5 new fields to the School Information end point
  • Added NotificationPreferenceCode field to the Student Information end point
  • Gradebook Assignments can now be updated/changed.
  • New fields have been added to the Student Extended end point: EnglishLearnerProgram, EnglishLearnerServiceCode, EnglishLearnerStartDate, EnglishLearnerEndDate, LongTermEnglishLearnerCode, YearsAsEnglishLearner, BirthCity, BirthStateCode, BirthCountryCode
  • A Title field has been added to the Staff Information end point
  • A PhoneNumber field has been added to the School Information end point
  • A Comments field has been added to the Contacts end point
  • Code Sets now has a “V3” end point that includes more fields from the Aeries COD table
  • Programs now has a “V3” end point and supports filtering for a specific program code using a query string parameter (?code=144)
  • The Student Transcripts end point now supports pagination using "StartingStudent" and "EndingStudent" query string Parameters (?StartingStudent=11&EndingStudent=20).
  • Gradebook Information “V3” end point would sometimes throw a SerializationException, fixed.
  • Support for many missing Code Sets has been added.
  • The Staff Information query string filters now support searching for “null” date fields.
  • The following spelling corrections have been made to “V3”. If your code uses the misspelled properties, you should update your code immediately:
  • School Information
  • AttendanceType (was AttendenceType)
  • AttendanceReporting (was AttendenceReporting)
  • Student Information
  • CounselorNumber (was CouselorNumber)
  • Gradebook Information
  • Comment (was Commment)

2/27/2017

  • Field-level documentation has been completed. There is now an Aeries database table.column reference and a description for every field output by the API.

3/10/2017

  • Gradebook “V3”
    • Gradebook Settings new fields added: AddDropStudentsAutomatically, HideDroppedStudents, HideOverallScore, HideOverallScoreFromParentStudent, ShowFinalMarkToParentStudent
    • Assignment Category new field added: Color

9/15/2017

  • Student Groups end point added


School-Related

 

School Information

Security Area:

  • None Required (certificate in request is still required though)

URL(s):

  • /api/v3/schools/{SchoolCode}
    • SchoolCode (optional) – the Aeries School Code. This is normally 1-999.

Notes:

  • If School Code is not passed, all schools for the current district will be returned.

Example School Information Results:

https://demo.aeries.net/aeries/api/v3/schools

<ArrayOfSchool xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.School">
  <School>
    <Address>9950 Comet Street</Address>
    <AddressCity>Eagle Point</AddressCity>
    <AddressState>CA</AddressState>
    <AddressZipCode>95990</AddressZipCode>
    <AddressZipExt/>
    <AttendancePeriod>0</AttendancePeriod>
    <AttendanceReporting>Negative</AttendanceReporting>
    <AttendanceType>Daily</AttendanceType>
    <DoNotReport>false</DoNotReport>
    <HighGradeLevel>6</HighGradeLevel>
    <InactiveStatusCode/>
    <LowGradeLevel>0</LowGradeLevel>
    <Name>Golden Eagle Elementary School</Name>
    <PhoneNumber>9995559990</PhoneNumber>
    <PrincipalEmailAddress>mrogers@example.com</PrincipalEmailAddress>
    <PrincipalName>Ms Michele Rogers</PrincipalName>
    <ScheduleBasis>Trimester</ScheduleBasis>
    <ScheduleType>Elementary</ScheduleType>
    <SchoolCode>990</SchoolCode>
    <SessionType>Regular</SessionType>
    <StateCountyID>65</StateCountyID>
    <StateDistrictID>99999</StateDistrictID>
    <StateSchoolID>9999990</StateSchoolID>
    <Terms>
      <Term>
        <EndDate>2015-10-02T00:00:00</EndDate>
        <StartDate>2015-07-08T00:00:00</StartDate>
        <TermCode>1</TermCode>
        <TermDescription>First Quarter</TermDescription>
      </Term>
      …
      …
    </Terms>
    <Tracks>0</Tracks>
  </School>
  …
  …
</ArrayOfSchool>

Field Documentation:

Name
Aeries Table.Column
Description
Address
LOC.AD
Street address
AddressCity
LOC.CY
City
AddressState
LOC.ST
State
AddressZipCode
LOC.ZC
Zip code
AddressZipExt
LOC.ZX
Zip code extension
AttendancePeriod
LOC.J
The homeroom period for the school. This is used to determine the student’s homeroom teacher where applicable.
AttendanceReporting
LOC.B
Indicates whether the school uses Negative or Positive attendance reporting
AttendanceType
LOC.A
Indicates whether the school takes Daily or Period attendance
DoNotReport
LOC.DNR
Flag indicating that information from this school code is not to be included in federal/state reporting (e.g., CALPADS)
HighGradeLevel
LOC.HI
The highest academic grade level offered at this school
InactiveStatusCode
LOC.TG
If anything other than a blank value, this school code is inactive in Aeries
LowGradeLevel
LOC.LO
The lowest academic grade level offered at this school
Name
LOC.NM
The name of the school
PhoneNumber
LOC.AC + LOC.TL
The phone number for the school, including area code (digits only)
PrincipalEmailAddress
LOC.PEM
The email address of the school principal
PrincipalName
LOC.PR
The name of the school principal
ScheduleBasis
LOC.Q
Indicates whether the school schedule is based on Semester or Trimester
ScheduleType
LOC.E
Indicates the schedule type of the school. Return value will be Elementary, ElementaryAndMasterSchedule, or MasterSchedule
SchoolCode
LOC.CD
The numeric Aeries school code
SessionType
LOC.U
Indicates whether the school code represents a Regular, Summer, or Intersession school
StateCountyID
LOC.CC
The 2-digit county part of the school’s county-district-school (CDS) code
StateDistrictID
LOC.DC
The 5-digit district part of the school’s CDS code
StateSchoolID
LOC.SC
The 7-digit school part of the CDS code
Tracks
LOC.K
The number of different attendance tracks used by the school


School Terms

Security Area:

  • None Required (certificate in request is still required though)

URL(s):

  • /api/v3/schools/{SchoolCode}/terms
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.

Notes:

  • This information is already available on each school returned from the "School Information" end point.

Example School Term Results:

https://demo.aeries.net/aeries/api/v3/schools/994/terms

<ArrayOfTerm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.School">
  <Term>
    <EndDate>2016-10-14T00:00:00</EndDate>
    <StartDate>2016-07-11T00:00:00</StartDate>
    <TermCode>1</TermCode>
    <TermDescription>First Quarter</TermDescription>
  </Term>
  <Term>
    <EndDate>2016-12-23T00:00:00</EndDate>
    <StartDate>2016-10-17T00:00:00</StartDate>
    <TermCode>2</TermCode>
    <TermDescription>Second Quarter</TermDescription>
  </Term>
  <Term>
    <EndDate>2017-03-31T00:00:00</EndDate>
    <StartDate>2017-01-02T00:00:00</StartDate>
    <TermCode>3</TermCode>
    <TermDescription>Third Quarter</TermDescription>
  </Term>
  <Term>
    <EndDate>2017-07-07T00:00:00</EndDate>
    <StartDate>2017-04-03T00:00:00</StartDate>
    <TermCode>4</TermCode>
    <TermDescription>Fourth Quarter</TermDescription>
  </Term>
  <Term>
    <EndDate>2016-12-23T00:00:00</EndDate>
    <StartDate>2016-07-11T00:00:00</StartDate>
    <TermCode>F</TermCode>
    <TermDescription>Fall</TermDescription>
  </Term>
  <Term>
    <EndDate>2017-07-07T00:00:00</EndDate>
    <StartDate>2017-01-02T00:00:00</StartDate>
    <TermCode>S</TermCode>
    <TermDescription>Spring</TermDescription>
  </Term>
  …
  …
</ArrayOfTerm>

Field Documentation:

Name
Aeries Table.Column
Description
EndDate
TRM.D2
End date of the term
StartDate
TRM.D1
Start date of the term
TermCode
TRM.TM
Code value of the term
TermDescription

Description of the term

 

School Calendar

Security Area:

  • "Calendar"

URL(s):

  • /api/v3/schools/{SchoolCode}/calendar
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.

Notes:

  • Pass a School Code of 0 (zero) for the district-level calendar. Not all districts configure a district-level calendar though.
  • Track Holidays might be a blank data element if the School.Tracks field is 0.

Example School Calendar Results:

https://demo.aeries.net/aeries/api/v3/schools/990/calendar

<ArrayOfCalendar xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Attendance">
  <Calendar>
    <ABDay></ABDay>
    <AttendanceMonth>1</AttendanceMonth>
    <AttendanceMonthLocked>false</AttendanceMonthLocked>
    <CalendarDate>2015-07-06T00:00:00</CalendarDate>
    <CalendarDayNumber>1</CalendarDayNumber>
    <HolidayCode>#</HolidayCode>
    <PeriodBlockPattern></PeriodBlockPattern>
    <SchoolCode>990</SchoolCode>
    <TotalApportionment>0</TotalApportionment>
    <TotalEnrollment>0</TotalEnrollment>
    <TrackHolidays>
      <TrackHoliday>
        <HolidayCode>#</HolidayCode>
        <TrackCode>A</TrackCode>
        <TrackNumber>1</TrackNumber>
      </TrackHoliday>
      <TrackHoliday>
        <HolidayCode>#</HolidayCode>
        <TrackCode>B</TrackCode>
        <TrackNumber>2</TrackNumber>
      </TrackHoliday>
      <TrackHoliday>
        <HolidayCode>#</HolidayCode>
        <TrackCode>C</TrackCode>
        <TrackNumber>3</TrackNumber>
      </TrackHoliday>
      <TrackHoliday>
        <HolidayCode>#</HolidayCode>
        <TrackCode>D</TrackCode>
        <TrackNumber>4</TrackNumber>
      </TrackHoliday>
    </TrackHolidays>
  </Calendar>
  <Calendar>
    <ABDay></ABDay>
    <AttendanceMonth>1</AttendanceMonth>
    <AttendanceMonthLocked>false</AttendanceMonthLocked>
    <CalendarDate>2015-07-07T00:00:00</CalendarDate>
    <CalendarDayNumber>2</CalendarDayNumber>
    <HolidayCode/>
    <PeriodBlockPattern></PeriodBlockPattern>
    <SchoolCode>990</SchoolCode>
    <TotalApportionment>0</TotalApportionment>
    <TotalEnrollment>0</TotalEnrollment>
    <TrackHolidays>
      <TrackHoliday>
        <HolidayCode>*</HolidayCode>
        <TrackCode>A</TrackCode>
        <TrackNumber>1</TrackNumber>
      </TrackHoliday>
      <TrackHoliday>
        <HolidayCode/>
        <TrackCode>B</TrackCode>
        <TrackNumber>2</TrackNumber>
      </TrackHoliday>
      <TrackHoliday>
        <HolidayCode/>
        <TrackCode>C</TrackCode>
        <TrackNumber>3</TrackNumber>
      </TrackHoliday>
      <TrackHoliday>
        <HolidayCode/>
        <TrackCode>D</TrackCode>
        <TrackNumber>4</TrackNumber>
      </TrackHoliday>
    </TrackHolidays>
  </Calendar>
  …
  …
</ArrayOfCalendar>


Field Documentation:

Name
Aeries Table.Column
Description
ABDay
DAY.AB
Whether this school day is an “A” day or “B” day if applicable
AttendanceMonth
DAY.MO
The attendance month number for this calendar day. In Aeries, an attendance month represents 4 weeks of Mondays-Fridays, for 20 total days
AttendanceMonthLocked
DAY.ML
Flag indicating whether this attendance month is locked for editing. Districts typically lock an attendance month after reconciling the apportionment data for that month for fiscal accountability purposes.
CalendarDate
DAY.DT
The date for this calendar day number
CalendarDayNumber
DAY.DY
The calendar day number. This is normally a value between 1 and 200
HolidayCode
DAY.HO
A code representing a special status for this day such as minimum day, school holiday, staff development day, etc.
PeriodBlockPattern
DAY.BL
A string indicating which class periods meet on this day. For each digit 0-9 that is present in this string, that class period meets on this day.
SchoolCode
DAY.SC
The Aeries school code
TotalApportionment
DAY.AP
The total apportioned attendance for this day
TotalEnrollment
DAY.EN
The total student enrollment for this day
TrackHoliday.HolidayCode
DAY.T1 – T26
Similar to HolidayCode, but for a specific track
TrackHoliday.TrackCode

The track code, a letter from A-Z
TrackHoliday.TrackNumber

The track number, a number from 1-26


Bell Schedule

Security Area:

  • "Bell Schedule"

URL(s):

  • /api/v3/schools/{SchoolCode}/BellSchedule
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
  • /api/v3/schools/{SchoolCode}/BellSchedule/day/{CalendarDayNumber}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • CalendarDayNumber (required) – the day number from the school's calendar. This is normally a value between 1 and 200. If a school has a custom bell schedule for the given day, it will be returned. Otherwise, the default bell schedule will be returned.

Notes:

  • A CalendarDayNumber of 0 represents the "default" bell schedule. Records with a value other than 0 represent the bell schedule for a specific day/date.

Example Bell Schedule Results:

https://demo.aeries.net/aeries/api/v3/schools/994/bellschedule

<ArrayOfBellSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Scheduling">
  <BellSchedule>
    <CalendarDayNumber>0</CalendarDayNumber>
    <EndTime>1900-12-30T09:00:00</EndTime>
    <Period>0</Period>
    <SchoolCode>990</SchoolCode>
    <StartTime>1900-12-30T08:00:00</StartTime>
  </BellSchedule>
  <BellSchedule>
    <CalendarDayNumber>0</CalendarDayNumber>
    <EndTime>1900-12-30T10:00:00</EndTime>
    <Period>1</Period>
    <SchoolCode>990</SchoolCode>
    <StartTime>1900-12-30T09:00:00</StartTime>
  </BellSchedule>
  <BellSchedule>
    <CalendarDayNumber>0</CalendarDayNumber>
    <EndTime>1900-12-30T11:00:00</EndTime>
    <Period>2</Period>
    <SchoolCode>990</SchoolCode>
    <StartTime>1900-12-30T10:00:00</StartTime>
  </BellSchedule>
  <BellSchedule>
    <CalendarDayNumber>0</CalendarDayNumber>
    <EndTime>1900-12-30T12:00:00</EndTime>
    <Period>3</Period>
    <SchoolCode>990</SchoolCode>
    <StartTime>1900-12-30T11:00:00</StartTime>
  </BellSchedule>
  …
  …
</ArrayOfBellSchedule>


Field Documentation:

Name
Aeries Table.Column
Description
CalendarDayNumber
BEL.DY
The day number from the school’s calendar
EndTime
BEL.T2
The time this class period ends according to the bell schedule. Value is a datetime format, but only the time part is relevant.
Period
BEL.PD
The class period (0-9)
SchoolCode
BEL.SC
The Aeries school code
StartTime
BEL.T1
The time this class period starts according to the bell schedule. Value is a datetime format, but only the time part is relevant.


Absence Codes

Security Area:

  • "Absence Code Table"

URL(s):

  • /api/v3/schools/{SchoolCode}/AbsenceCodes/{AbsenceCode}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • AbsenceCode (optional) – The Attendance Code.

Notes:

  • If Absence Code is not passed, all absence codes for the chosen school will be returned.

Example Absence Code Results:

https://demo.aeries.net/aeries/api/v3/schools/994/absencecodes

<ArrayOfAbsenceCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Attendance">
  <AbsenceCode>
    <Abbreviation>UNV</Abbreviation>
    <AbsenceCode>A</AbsenceCode>
    <CountOnReportCard>true</CountOnReportCard>
    <CountsForADA>false</CountsForADA>
    <IncludeInParentNotifications>true</IncludeInParentNotifications>
    <IncludeOnLetters>true</IncludeOnLetters>
    <IncludeOnReports>true</IncludeOnReports>
    <IsPartialDayTruant>false</IsPartialDayTruant>
    <IsSuspension>false</IsSuspension>
    <SchoolCode>994</SchoolCode>
    <Title>UNVERIFIED</Title>
    <TypeCode>1</TypeCode>
    <TypeDescription>Unverified Absence</TypeDescription>
  </AbsenceCode>
  <AbsenceCode>
    <Abbreviation>DR</Abbreviation>
    <AbsenceCode>D</AbsenceCode>
    <CountOnReportCard>false</CountOnReportCard>
    <CountsForADA>false</CountsForADA>
    <IncludeInParentNotifications>false</IncludeInParentNotifications>
    <IncludeOnLetters>true</IncludeOnLetters>
    <IncludeOnReports>true</IncludeOnReports>
    <IsPartialDayTruant>false</IsPartialDayTruant>
    <IsSuspension>false</IsSuspension>
    <SchoolCode>994</SchoolCode>
    <Title>Dr Note</Title>
    <TypeCode>2</TypeCode>
    <TypeDescription>Excused Absence</TypeDescription>
  </AbsenceCode>
  …
  …
</ArrayOfAbsenceCode>


Field Documentation:

Name
Aeries Table.Column
Description
Abbreviation
ABS.AB
The abbreviated name (max 3 characters) for this absence code
AbsenceCode
ABS.CD
The absence code (1 character). This will typically be a letter A-Z but may be a digit.
CountOnReportCard
ABS.GR
Indicates whether this absence code counts toward attendance totals on the grade report card.
CountsForADA
ABS.AD
Indicates whether this absence code counts toward the school’s ADA apportionment calculation.
IncludeInParentNotifications
ABS.DI
Indicates whether this absence code should be included when notifications are sent to parents (e.g., automated attendance calls).
IncludeOnLetters
ABS.LT
Indicates whether this absence code should be included on letters sent to parents
IncludeOnReports
ABS.OT
Indicates whether this absence code should print on attendance reports.
IsPartialDayTruant
ABS.PT
Indicates whether this absence code represents a partial day truancy. It would normally be used for a student who is more than 30 minutes late for class.
IsSuspension
ABS.SU
Indicates whether this absence code represents a suspension (may be in-school or out-of-school).
SchoolCode
ABS.SC
The Aeries school code
Title
ABS.TI
The full name (max 10 characters) for this absence code
TypeCode
ABS.TY
A code representing the type of absence code.
TypeDescription

The description corresponding to the TypeCode.
1 = Unverified Absence
2 = Excused Absence
3 = Unexcused Absence
4 = Verified Not Absent
5 = Tardy
6 = Present
7 (not currently used)
8 = Verified Excused Tardy
9 = Verified Unexcused Tardy


Code Sets

Security Area:

  • None Required (certificate in request is still required though)

URL(s):

  • /api/v3/codes/{Table}/{Field}
    • Table (required) – The 3 character Aeries Table Code or the API Object name. If you know the 3 character Aeries Table Code, feel free to use it. Otherwise, use the object name returned through the API. Examples include: "STU", "student", "contact", "course", "staff", "teacher", and "section".
    • Field (required) – the 2-4 character Aeries Field Code or the API Object name. If you know the 2-4 character Aeries Field Code, feel free to use it. Otherwise, use the object name returned through the API. Examples include: "HL", "HomeLanguage", or "HomeLanguageCode". Fields/Properties in objects ending in "Code" have a code set associated with them. The "Field" passed to this end point can include the word "Code" or not.

Notes:

  • The code set for all field objects whose name ends in "Code" can be looked up using this API End Point.

Example Code Set Results:

https://demo.aeries.net/aeries/api/v3/codes/Student/Grade

<ArrayOfCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.CodeSets">
  <Code>
    <AeriesCode>1</AeriesCode>
    <Category></Category>
    <Code>1</Code>
    <CorrespondenceLanguageCode1>01</CorrespondenceLanguageCode1>
    <CorrespondenceLanguageCode2>02</CorrespondenceLanguageCode2>
    <CorrespondenceLanguageCode3>04</CorrespondenceLanguageCode3>
    <CorrespondenceLanguageCode4></CorrespondenceLanguageCode4>
    <CorrespondenceLanguageCode5></CorrespondenceLanguageCode5>
    <CorrespondenceLanguageCode6></CorrespondenceLanguageCode6>
    <Description>First Grade</Description>
    <DescriptionForLanguage1>Primer Grado</DescriptionForLanguage1>
    <DescriptionForLanguage2>LỚP MỘT</DescriptionForLanguage2>
    <DescriptionForLanguage3>1 학년</DescriptionForLanguage3>
    <DescriptionForLanguage4></DescriptionForLanguage4>
    <DescriptionForLanguage5></DescriptionForLanguage5>
    <DescriptionForLanguage6></DescriptionForLanguage6>
    <Field>GR</Field>
    <NumericValue>0.0000</NumericValue>
    <SortOrder>0</SortOrder>
    <Status></Status>
    <Table>STU</Table>
  </Code>
  <Code>
    <AeriesCode>10</AeriesCode>
    <Category></Category>
    <Code>10</Code>
    <CorrespondenceLanguageCode1></CorrespondenceLanguageCode1>
    <CorrespondenceLanguageCode2></CorrespondenceLanguageCode2>
    <CorrespondenceLanguageCode3></CorrespondenceLanguageCode3>
    <CorrespondenceLanguageCode4></CorrespondenceLanguageCode4>
    <CorrespondenceLanguageCode5></CorrespondenceLanguageCode5>
    <CorrespondenceLanguageCode6></CorrespondenceLanguageCode6>
    <Description>Tenth Grade</Description>
    <DescriptionForLanguage1></DescriptionForLanguage1>
    <DescriptionForLanguage2></DescriptionForLanguage2>
    <DescriptionForLanguage3></DescriptionForLanguage3>
    <DescriptionForLanguage4></DescriptionForLanguage4>
    <DescriptionForLanguage5></DescriptionForLanguage5>
    <DescriptionForLanguage6></DescriptionForLanguage6>
    <Field>GR</Field>
    <NumericValue>0.0000</NumericValue>
    <SortOrder>0</SortOrder>
    <Status></Status>
    <Table>STU</Table>
  </Code>
  …
  …
</ArrayOfCode>


Field Documentation:

Name
Aeries Table.Column
Description
AeriesCode
COD.AC
Identifies the internal Aeries code corresponding to the code value. Currently this is only used to match coded Grade Level values to the numeric grade levels that Aeries uses internally. For example, Kindergarten is coded as “K” but internally stored as 0.
Category
COD.CAT
The category for this code. In some areas of the system, Aeries supports grouping related codes by categories.
Code
COD.CD
The code value
CorrespondenceLanguageCode1
COD.CL1
The first language code for which a translated description is available
CorrespondenceLanguageCode2
COD.CL2
The second language code for which a translated description is available
CorrespondenceLanguageCode3
COD.CL3
The third language code for which a translated description is available
CorrespondenceLanguageCode4
COD.CL4
The fourth language code for which a translated description is available
CorrespondenceLanguageCode5
COD.CL5
The fifth language code for which a translated description is available
CorrespondenceLanguageCode6
COD.CL6
The sixth language code for which a translated description is available
Description
COD.DE
The description for the code in English
DescriptionForLanguage1
COD.DE1
The first translated description of the code
DescriptionForLanguage2
COD.DE2
The second translated description of the code
DescriptionForLanguage3
COD.DE3
The third translated description of the code
DescriptionForLanguage4
COD.DE4
The fourth translated description of the code
DescriptionForLanguage5
COD.DE5
The fifth translated description of the code
DescriptionForLanguage6
COD.DE6
The sixth translated description of the code
Field
COD.FC
The Aeries field to which this code belongs
NumericValue
COD.N1
Only used for certain table/field codes. The meaning depends on the table/field. Ex: for Fees/FeeCode, the NumericValue is the default amount of the fee.
SortOrder
COD.SRT
The sort order for this code. In Aeries drop-down lists, codes are sorted alphabetically unless a sort order greater than zero is specified
Status
COD.TG
Any value other than a blank means this code is inactive. It may still be found on existing records, but users are not able to select this code for new records.
Table
COD.TC
The Aeries table to which this code belongs

 

Student-Related

 

Student Information

Security Area:

  • "Student Data"

URL(s):

  • /api/v3/schools/{SchoolCode}/students/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – the Aeries Student District Permanent ID Number.
  • /api/v3/schools/{SchoolCode}/students/grade/{GradeLevel}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • GradeLevel (required) – the academic grade level of the set of students to return.
  • /api/v3/schools/{SchoolCode}/students/sn/{StudentNumber}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentNumber (required) – the School-Based Student Number of the student to return.

Query String Filters:

  • StartingRecord – (numeric) The Record-Count value of the first record to return (inclusive).
  • EndingRecord – (numeric) The Record-Count value of the last record to return (inclusive).

Notes:

  • If Student ID is not passed, all students for the given school will be returned.
  • Results are always returned in the form of an "Array of Students" because often students have multiple records in a district if they are concurrently enrolled or have switched between schools during the school year.

Example Student Information Results:

https://demo.aeries.net/aeries/api/v3/schools/994/students/99400001

<ArrayOfStudent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Student">
  <Student>
    <AddressVerified>false</AddressVerified>
    <AtRiskPoints>60.0000</AtRiskPoints>
    <AttendanceProgramCodeAdditional1></AttendanceProgramCodeAdditional1>
    <AttendanceProgramCodeAdditional2></AttendanceProgramCodeAdditional2>
    <AttendanceProgramCodePrimary></AttendanceProgramCodePrimary>
    <Birthdate>1998-11-11T00:00:00</Birthdate>
    <CorrespondanceLanguageCode>00</CorrespondanceLanguageCode>
    <CounselorNumber>708</CounselorNumber>
    <DistrictEnterDate>2004-11-11T00:00:00</DistrictEnterDate>
    <EthnicityCode>N</EthnicityCode>
    <FamilyKey>1480</FamilyKey>
    <FirstName>Allan</FirstName>
    <FirstNameAlias>AJ</FirstNameAlias>
    <Grade>12</Grade>
    <HighSchedulingPeriod>9</HighSchedulingPeriod>
    <HomeLanguageCode>01</HomeLanguageCode>
    <HomePhone>7775559448</HomePhone>
    <HomeRoomTeacherNumber>0</HomeRoomTeacherNumber>
    <InactiveStatusCode></InactiveStatusCode>
    <LanguageFluencyCode>L</LanguageFluencyCode>
    <LastName>Abbott</LastName>
    <LastNameAlias></LastNameAlias>
    <LockerNumber></LockerNumber>
    <LowSchedulingPeriod>0</LowSchedulingPeriod>
    <MailingAddress>1118 Glenview Lane</MailingAddress>
    <MailingAddressCity>Eagle Rock</MailingAddressCity>
    <MailingAddressState>CA</MailingAddressState>
    <MailingAddressZipCode>99999</MailingAddressZipCode>
    <MailingAddressZipExt>1234</MailingAddressZipExt>
    <MiddleName>James</MiddleName>
    <MiddleNameAlias></MiddleNameAlias>
    <NetworkLoginID></NetworkLoginID>
    <NotificationPreferenceCode></NotificationPreferenceCode>
    <ParentEdLevelCode>12</ParentEdLevelCode>
    <ParentEmailAddress>Parent.Abbott@example.com</ParentEmailAddress>
    <ParentGuardianName>M/M A Abbott</ParentGuardianName>
    <PermanentID>99400001</PermanentID>
    <RaceCode1>700</RaceCode1>
    <RaceCode2></RaceCode2>
    <RaceCode3></RaceCode3>
    <RaceCode4></RaceCode4>
    <RaceCode5></RaceCode5>
    <ResidenceAddress>1118 Glenview Lane</ResidenceAddress>
    <ResidenceAddressCity>Eagle Rock</ResidenceAddressCity>
    <ResidenceAddressState>CA</ResidenceAddressState>
    <ResidenceAddressZipCode>99999</ResidenceAddressZipCode>
    <ResidenceAddressZipExt>1234</ResidenceAddressZipExt>
    <SchoolCode>994</SchoolCode>
    <SchoolEnterDate>2011-09-05T00:00:00</SchoolEnterDate>
    <SchoolLeaveDate i:nil="true" />
    <Sex>M</Sex>
    <StateStudentID>1234567890</StateStudentID>
    <StudentEmailAddress>student@aeries.com</StudentEmailAddress>
    <StudentMobilePhone></StudentMobilePhone>
    <StudentNumber>1</StudentNumber>
    <Track></Track>
    <UserCode1></UserCode1>
    <UserCode10></UserCode10>
    <UserCode11></UserCode11>
    <UserCode12></UserCode12>
    <UserCode13></UserCode13>
    <UserCode2></UserCode2>
    <UserCode3></UserCode3>
    <UserCode4>N</UserCode4>
    <UserCode5></UserCode5>
    <UserCode6>G</UserCode6>
    <UserCode7>C</UserCode7>
    <UserCode8></UserCode8>
    <UserCode9></UserCode9>
  </Student>
  …
  …
</ArrayOfStudent>


Field Documentation:

Name
Aeries Table.Column
Description
AddressVerified
STU.AV
Indicates whether the student’s residence address has been verified
AtRiskPoints
STU.RP
The total number of “at-risk” points. Used by the Aeries Analytics Early Warning System
AttendanceProgramCodeAdditional1
STU.AP1
An additional specialized attendance program to which this student belongs
AttendanceProgramCodeAdditional2
STU.AP2
An additional specialized attendance program to which this student belongs
AttendanceProgramCodePrimary
STU.SP
The primary specialized attendance program to which this student currently belongs. Attendance programs are used to separate certain students’ attendance data in the monthly apportionment (ADA) calculations.
Birthdate
STU.BD
Date of Birth
CorrespondanceLanguageCode
STU.CL
The preferred language for correspondence sent regarding this student
CounselorNumber
STU.CU
A school-based Aeries teacher number (0-999). Represents the student’s counselor (secondary schools) or classroom teacher (elementary schools).
DistrictEnterDate
STU.DD
Date student entered the district
EthnicityCode
STU.ETH
“Y” or “N” Hispanic indicator
FamilyKey
STU.FK
Numeric. Students with the same nonzero Family Key are considered “siblings” in Aeries.
FirstName
STU.FN
Student’s legal first name
FirstNameAlias
STU.FNA
Student’s first name alias
Grade
STU.GR
0-18 Student’s grade level
HighSchedulingPeriod
STU.HI
0-9 Highest scheduling period
HomeLanguageCode
STU.HL
The student’s primary language for purposes of English Learner classification
HomePhone
STU.TL
Student’s home phone number
HomeRoomTeacherNumber
(calculated value)
A school-based Aeries teacher number. The student’s homeroom teacher based on the class period the school designates as homeroom.
InactiveStatusCode
STU.TG
Student’s status (blank is active)
LanguageFluencyCode
STU.LF
Language fluency code
LastName
STU.LN
Student’s legal last name
LastNameAlias
STU.LNA
Student’s last name alias
LockerNumber
STU.LK
Locker number
LowSchedulingPeriod
STU.LO
0-9 Lowest scheduling period
MailingAddress
STU.AD
Student’s mailing address
MailingAddressCity
STU.CY
Student’s mailing address city
MailingAddressState
STU.ST
Student’s mailing address state
MailingAddressZipCode
STU.ZC
Student’s mailing address zip code
MailingAddressZipExt
STU.ZX
Student’s mailing address zip code extension
MiddleName
STU.MN
Student’s legal middle name
MiddleNameAlias
STU.MNA
Student’s middle name alias
NetworkLoginID
STU.NID
Student’s Network Login ID. Districts may use this for various purposes, but most commonly for a directory services (e.g., Active Directory) username
NotificationPreferenceCode
STU.NP
Indicates the Aeries Communications notification preference of this student
ParentEdLevelCode
STU.PED
Highest level of education completed by either of the student’s parents (for socioeconomically disadvantaged classification purposes)
ParentEmailAddress
STU.PEM
(deprecated, but still in use by some customers) The primary parent/guardian email address
ParentGuardianName
STU.PG
Parent/Guardian name
PermanentID
STU.ID
Student’s Permanent ID
RaceCode1
STU.RC1
Student’s first reported race
RaceCode2
STU.RC2
Student’s second reported race
RaceCode3
STU.RC3
Student’s third reported race
RaceCode4
STU.RC4
Student’s fourth reported race
RaceCode5
STU.RC5
Student’s fifth reported race
ResidenceAddress
STU.RAD
Residence address
ResidenceAddressCity
STU.RCY
Residence address city
ResidenceAddressState
STU.RST
Residence address state
ResidenceAddressZipCode
STU.RZC
Residence address zip code
ResidenceAddressZipExt
STU.RZX
Residence address zip code extension
SchoolCode
STU.SC
Aeries school code
SchoolEnterDate
STU.ED
Date student first entered this school
SchoolLeaveDate
STU.LD
Date student left this school
Sex
STU.SX
M or F Sex
StateStudentID
STU.CID
Statewide Student ID
StudentEmailAddress
STU.SEM
Student’s email address
StudentMobilePhone
STU.MPH
Mobile phone number
StudentNumber
STU.SN
School-based Student Number
Track
STU.TR
Student’s attendance track
UserCode1
STU.U1
User-defined code 1
UserCode10
STU.U10
User-defined code 10
UserCode11
STU.U11
User-defined code 11
UserCode12
STU.U12
User-defined code 12
UserCode13
STU.U13
User-defined code 13
UserCode2
STU.U2
User-defined code 2
UserCode3
STU.U3
User-defined code 3
UserCode4
STU.U4
User-defined code 4
UserCode5
STU.U5
User-defined code 5
UserCode6
STU.U6
User-defined code 6
UserCode7
STU.U7
User-defined code 7
UserCode8
STU.U8
User-defined code 8
UserCode9
STU.U9
User-defined code 9


Student Information Extended

Security Area:

  • "Student Data"

URL(s):

  • /api/v3/schools/{SchoolCode}/students/{StudentID}/extended
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (required) – the Aeries Student District Permanent ID Number.
  • /api/v3/schools/{SchoolCode}/students/grade/{GradeLevel}/extended
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • GradeLevel (required) – the academic grade level of the set of students to return.
  • /api/v3/schools/{SchoolCode}/students/sn/{StudentNumber}/extended
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentNumber (required) – the School-Based Student Number of the student to return.

Query String Filters:

  • StartingRecord – (numeric) The Record-Count value of the first record to return (inclusive).
  • EndingRecord – (numeric) The Record-Count value of the last record to return (inclusive).

Notes:

  • If 0 is passed for Student ID, all students for the given school will be returned.
  • Results are always returned in the form of an "Array of Student Extended" because often students have multiple records in a district if they are concurrently enrolled or have switched between schools during the school year.

Example Student Information Extended Results:

https://demo.aeries.net/aeries/api/v3/schools/994/students/99400001/extended

<ArrayOfStudentExtended xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Student">
  <StudentExtended>
    <BirthCity>Hermosillo</BirthCity>
    <BirthCountryCode>MX</BirthCountryCode>
    <BirthStateCode>SO</BirthStateCode>
    <CourseCompletionCSU>Y</CourseCompletionCSU>
    <CourseCompletionUC>Y</CourseCompletionUC>
    <DateRedesignatedFluentEnglishProficient i:nil="true" />
    <DistrictMobility>1</DistrictMobility>
    <EndOfYearStatusCode></EndOfYearStatusCode>
    <EnglishLearnerEndDate i:nil="true" />
    <EnglishLearnerProgramCode></EnglishLearnerProgramCode>
    <EnglishLearnerServiceCode>330</EnglishLearnerServiceCode>
    <EnglishLearnerStartDate>2010-09-05T00:00:00</EnglishLearnerStartDate>
    <ExpectedGraduationDate i:nil="true" />
    <GraduationRequirementsTrack></GraduationRequirementsTrack>
    <HomeLanguageSurveyAdultLanguageCode>00</HomeLanguageSurveyAdultLanguageCode>
    <HomeLanguageSurveyFirstLanguageCode>00</HomeLanguageSurveyFirstLanguageCode>
    <HomeLanguageSurveyHomeLanguageCode>00</HomeLanguageSurveyHomeLanguageCode>
    <HomeLanguageSurveyPrimaryLanguageCode>00</HomeLanguageSurveyPrimaryLanguageCode>
    <InterIntraDistrictStateCode></InterIntraDistrictStateCode>
    <InterIntraDistrictTransferCode></InterIntraDistrictTransferCode>
    <LongTermEnglishLearnerCode></LongTermEnglishLearnerCode>
    <PermanentID>99400001</PermanentID>
    <QualifiedCSU>Y</QualifiedCSU>
    <QualifiedUC>Y</QualifiedUC>
    <RecordAddedDateTime i:nil="true" />
    <RecordAddedSystem></RecordAddedSystem>
    <SafeSchoolsActViolationDate>2017-02-28T00:00:00</SafeSchoolsActViolationDate>
    <SchedulingGroup></SchedulingGroup>
    <SchoolCode>994</SchoolCode>
    <SchoolCompletionDate i:nil="true" />
    <SchoolCompletionStatusCode></SchoolCompletionStatusCode>
    <SchoolMobility>9</SchoolMobility>
    <StateSchoolEnterDate>2003-09-08T00:00:00</StateSchoolEnterDate>
    <StateStudentID>1234567890</StateStudentID>
    <StudentNumber>1</StudentNumber>
    <SummerWithdrawalReasonCode></SummerWithdrawalReasonCode>
    <USEnterDate>2006-01-01T00:00:00</USEnterDate>
    <USSchoolEnterDate>2003-09-08T00:00:00</USSchoolEnterDate>
    <USSchoolsLessThan3Years></USSchoolsLessThan3Years>
    <YearsAsEnglishLearner>0</YearsAsEnglishLearner></StudentExtended>
  …
  …
</ArrayOfStudentExtended>


Field Documentation:

Name
Aeries Table.Column
Description
BirthCity
STU.BCY
The city name where the student was born
BirthCountryCode
STU.BCU
The country code where the student was born
BirthStateCode
STU.BST
The state or province in the US, Canada, or Mexico where the student was born
CourseCompletionCSU
STU.CCS
The indicator for if this student has completed the course sequence for entrance into the CA State University (CSU) system
CourseCompletionUC
STU.CUC
The indicator for if this student has completed the course sequence for entrance into the University of CA (UC) system
DateRedesignatedFluentEnglishProficient
LAC.RD1
The Date the Student was redesignated/reclassified as Fluent English Proficient from an English Learner
DistrictMobility
STU.DM
The "District Mobility" - the grade level the student entered this District during the most recent span of contiguous enrollment.
EndOfYearStatusCode
STU.EOY
The End of Year Status Code for a student. This is populated at the end of the year when a student is going to be active through the last day of school but will leave the school over the summer and not be returning next school year.
EnglishLearnerEndDate
LAC.ED
The date the student was reclassified to no longer be an English Learner
EnglishLearnerProgramCode
LAC.PR
English Learner Program Code
EnglishLearnerServiceCode
LAC.SR
English Learner Services Received Code
EnglishLearnerStartDate
LAC.SD
The date the student began receiving English Learner services
ExpectedGraduationDate
STU.EGD
The Expected Graduation Date for this Student. This field is normally inconsistently populated as it is no longer required by CALPADS.
GraduationRequirementsTrack
STU.GRT
The Graduation Requirements Track for a student
HomeLanguageSurveyAdultLanguageCode
LAC.L4
From the Home Language Survey (HLS) - The language spoken most frequently by adults at home
HomeLanguageSurveyFirstLanguageCode
LAC.L1
From the Home Language Survey (HLS) - The language first spoken by the student growing up
HomeLanguageSurveyHomeLanguageCode
LAC.L3
From the Home Language Survey (HLS) - The language spoken most frequently at home by the student
HomeLanguageSurveyPrimaryLanguageCode
LAC.L2
From the Home Language Survey (HLS) - The language primarily spoken by the student
InterIntraDistrictStateCode
STU.ITD
The Inter/Intra-District Transfer State Code for a student
InterIntraDistrictTransferCode
STU.IT
The Inter/Intra-District Transfer Code for a student
LongTermEnglishLearnerCode
LAC.LT
Student Identified as a Long Term English Learner
PermanentID
STU.ID
The Permanent ID for the student
QualifiedCSU
STU.QCS
The indicator for if this student has qualified for entrance into the CA State University (CSU) system
QualifiedUC
STU.QUC
The indicator for if this student has qualified for entrance into the University of CA (UC) system
RecordAddedDateTime
STU.RDT
The Date/Time the student record was added to the system.
RecordAddedSystem
STU.RSY
The system used to add this student record.
SafeSchoolsActViolationDate
STU.SD
The Safe Schools Act Violation Date for this Student. I.e., the date the student violated a "Violent" 48900 Ed Code.
SchedulingGroup
STU.SG
The Scheduling Group for a student
SchoolCode
STU.SC
The Aeries school code for this student
SchoolCompletionDate
STU.DG
The School Completion Date for this Student. For High Schools, this is the Graduation Date.
SchoolCompletionStatusCode
STU.HSG
The Completion Status Code for this student from the current school. For High Schools, this is the Graduation Status Code.
SchoolMobility
STU.SM
The "School Mobility" - the grade level the student entered this school during the most recent span of contiguous enrollment.
StateSchoolEnterDate
LAC.STS
The Date the Student first entered a school in the current state
StateStudentID
STU.CID
The State Student ID (SSID) for this Student
StudentNumber
STU.SN
The school-level Aeries Student Number for this student
SummerWithdrawalReasonCode
STU.SWR
The Summer Withdrawal Reason Code for a student. This is populated at the beginning of the year when a student is found to have left the school during the summer and is not attending the first day of school.
USEnterDate
LAC.USE
The Date the Student first entered the US
USSchoolEnterDate
LAC.USS
The Date the Student first entered a US school to receive instruction
USSchoolsLessThan3Years
SSD.SUS
The indicator for when a student has been enrolled in US Schools for less than 3 years. This is normally the definition of an "Eligible Immigrant" for SNOR reporting.
YearsAsEnglishLearner
LAC.YEL
The Number of Years the student has been or was identified as an English Learner


Student Data Changes

Security Area:

  • "Student Data"

URL(s):

  • /api/v2/StudentDataChanges/{DataArea}/{year}/{month}/{day}/{hour}/{minute}
    • DataArea (required) – the Aeries Student Data Area to be evaluated:
    • Valid Values: "student", "contact", "program", "test", "class", "enrollment"
    • year, month, day, hour, minute – required – The parts of the Date/Time from which you want to system to return students with data changes. All parameters are required although 0 is valid for hour and minute. Valid values for "hour" are 0-23. "AM" and "PM" values are invalid

Notes:

  • This should be used for advanced interfaces with Aeries where you may be pulling data hourly or daily and want to only get the changes since the last time you pulled data from the Aeries API. After you get the list of students with changes in the given data area, you will have to loop through the corresponding API to pull the new records one student at a time.

Example Student Data Changes Results:

https://demo.aeries.net/aeries/api/v2/StudentDataChanges/class/2016/1/3/0/0

<ArrayOfStudentKeys xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v2.Models.Student">
  <StudentKeys>
    <PermanentID>99401589</PermanentID>
    <SchoolCode>994</SchoolCode>
    <StudentNumber>1589</StudentNumber>
  </StudentKeys>
  <StudentKeys>
    <PermanentID>99401630</PermanentID>
    <SchoolCode>994</SchoolCode>
    <StudentNumber>1630</StudentNumber>
  </StudentKeys>
  …
  …
</ArrayOfStudentKeys>


Contacts

Security Area:

  • "Contacts"

URL(s):

  • /api/v3/schools/{SchoolCode}/contacts/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – the Aeries Student District Permanent ID Number.

Notes:

  • If Student ID is not passed, all student contacts for the given school will be returned.

Example Contact Results:

https://demo.aeries.net/aeries/api/v3/schools/994/contacts/99400001

<ArrayOfContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Student">
  <Contact>
    <AccessToPortal></AccessToPortal>
    <Address>5647 Elm St</Address>
    <AddressCity>Eagle rock</AddressCity>
    <AddressState>CA</AddressState>
    <AddressZipCode>99998</AddressZipCode>
    <AddressZipExt></AddressZipExt>
    <CellPhone></CellPhone>
    <Comments></Comments>
    <ContactOrder>1</ContactOrder>
    <CorrespondanceLanguageCode></CorrespondanceLanguageCode>
    <EmailAddress>parent@aeries.com</EmailAddress>
    <EmployerLocation></EmployerLocation>
    <EmployerName></EmployerName>
    <FirstName>Adam</FirstName>
    <HomePhone></HomePhone>
    <LastName>Abbott</LastName>
    <LivesWithStudentIndicator></LivesWithStudentIndicator>
    <MailingName>Adam Abbott</MailingName>
    <MiddleName></MiddleName>
    <MilitaryBranchCode>AR</MilitaryBranchCode>
    <MilitaryRankCode>SGT</MilitaryRankCode>
    <MilitaryStatusCode>X</MilitaryStatusCode>
    <MilitarySupervisorName>John Brown</MilitarySupervisorName>
    <MilitarySupervisorPhone>9995551234</MilitarySupervisorPhone>
    <NamePrefix></NamePrefix>
    <NameSuffix></NameSuffix>
    <NotificationPreferenceCode>1</NotificationPreferenceCode>
    <Pager></Pager>
    <PermanentID>99400001</PermanentID>
    <RedFlag>false</RedFlag>
    <RelationshipToStudentCode>11</RelationshipToStudentCode>
    <SchoolCode>994</SchoolCode>
    <SequenceNumber>1</SequenceNumber>
    <WorkPhone>7775557537</WorkPhone>
    <WorkPhoneExt></WorkPhoneExt>
  </Contact>
  …
  …
</ArrayOfContact>


Field Documentation:

Name
Aeries Table.Column
Description
AccessToPortal
CON.AP
Indicates whether the contact can access the Aeries Parent Portal
Address
CON.AD
The street address of this contact
AddressCity
CON.CY
The city
AddressState
CON.ST
The state abbreviation
AddressZipCode
CON.ZC
The zip code
AddressZipExt
CON.ZX
The zip code extension
CellPhone
CON.CP
The contact’s mobile phone number
Comments
CON.ME
A free-text comment for this contact
ContactOrder
CON.OR
The order in which this contact displays in Aeries
CorrespondanceLanguageCode
CON.CL
The language in which this contact prefers to receive correspondence
EmailAddress
CON.EM
The email address of this contact
EmployerLocation
CON.ELC
The location of this contact’s employer
EmployerName
CON.ENM
The name of this contact’s employer
FirstName
CON.FN
The contact’s first name
HomePhone
CON.TL
The contact’s home phone number
LastName
CON.LN
The contact’s last name
LivesWithStudentIndicator
CON.LW
Indicates whether the student lives with this contact
MailingName
CON.NM
The name for this contact that should appear on mailing labels
MiddleName
CON.MN
The contact’s middle name
MilitaryBranchCode
CON.MBR
If this contact is in the military, the code indicates the branch of service
MilitaryRankCode
CON.MRA
If this contact is in the military, the code indicates the rank
MilitaryStatusCode
CON.MTG
If this contact is/was in the military, the code indicates this contact’s military service status
MilitarySupervisorName
CON.MSN
If this contact is/was in the military, the name of the military supervisor
MilitarySupervisorPhone
CON.MSP
If this contact is/was in the military, the phone number of the military supervisor
NamePrefix
CON.PF
The name prefix for this contact
NameSuffix
CON.SF
The name suffix for this contact
NotificationPreferenceCode
CON.NP
Indicates the Aeries Communications notification preference of this contact
Pager
CON.PA
The contact’s pager number
PermanentID
STU.ID
The Permanent ID for this student
RedFlag
CON.RF
Indicates whether the contact has been red-flagged
RelationshipToStudentCode
CON.RL
A code indicating the contact’s relationship to the student
SchoolCode
STU.SC
The Aeries school code
SequenceNumber
CON.SQ
The sequence number makes up the primary key of the Contacts table and has no independent meaning.
WorkPhone
CON.WP
The contact’s work phone number
WorkPhoneExt
CON.WX
The contact’s work phone extension

For descriptions of the various coded fields, use our "Code Sets" API:

https://demo.aeries.net/aeries/api/v3/codes/Contacts/MilitaryBranch

https://demo.aeries.net/aeries/api/v3/codes/Contacts/MilitaryRank

https://demo.aeries.net/aeries/api/v3/codes/Contacts/MilitaryStatus

https://demo.aeries.net/aeries/api/v3/codes/Contacts/NotificationPreference

https://demo.aeries.net/aeries/api/v3/codes/Contacts/RelationshipToStudent


Programs

Security Area:

  • "Student Programs"

URL(s):

  • /api/v3/schools/{SchoolCode}/students/{StudentID}/programs
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (required) – Pass "0" for all students. The Aeries Student District Permanent ID Number.

Query String Filters:

  • code – A single Program Code to limit the records returned (e.g., ?code=144 to return only Special Education program records).

Notes:

  • If Student ID is not passed and you pass a 0 (zero) instead, all programs for the given school will be returned.

Example Student Program Results:

https://demo.aeries.net/aeries/api/v3/schools/994/students/99400001/programs

<ArrayOfStudentProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Student">
  <StudentProgram>
    <EligibilityEndDate i:nil="true" />
    <EligibilityStartDate>2009-11-22T00:00:00</EligibilityStartDate>
    <ExtendedProperties>
      <ExtendedProperty>
        <Name>DisabilityCode</Name>
        <Value>240</Value>
      </ExtendedProperty>
      <ExtendedProperty>
        <Name>DisabilityCodeDescription</Name>
        <Value>Speech or Language Impairment (SLI)</Value>
      </ExtendedProperty>
      <ExtendedProperty>
        <Name>DisabilityCode2</Name>
        <Value>260</Value>
      </ExtendedProperty>
      <ExtendedProperty>
        <Name>DisabilityCode2Description</Name>
        <Value>Emotional Disturbance (ED)</Value>
      </ExtendedProperty>
    </ExtendedProperties>
    <ParticipationEndDate i:nil="true" />
    <ParticipationStartDate i:nil="true" />
    <ProgramCode>144</ProgramCode>
    <ProgramDescription>Special Education</ProgramDescription>
    <StudentID>99400001</StudentID>
  </StudentProgram>
  …
  …
</ArrayOfStudentProgram>


Field Documentation:


Note: Program data may be pulled from several Aeries tables depending on the program. Each one is documented below.


Name
Aeries Table.Column
Description
EligibilityEndDate
ProgramCode
Table.Column
127
GTE.EED
101
FOF.ED
144
CSE.XD
181
FRE.EED
182
FRE.EED
All Others
PGM.EED
The last date the student is/was eligible for the program
EligibilityStartDate
ProgramCode
Table.Column
127
GTE.ESD
101
FOF.SD
144
CSE.ED
181
FRE.ESD
182
FRE.ESD
All Others
PGM.ESD
The first date the student was eligible for the program
ParticipationEndDate
ProgramCode
Table.Column
127
GTE.PED
101
FOF.ED
144
N/A
181
FRE.PED
182
FRE.PED
All Others
PGM.PED
The last date the student participated in the program
ParticipationStartDate
ProgramCode
Table.Column
127
GTE.PSD
101
FOF.SD
144
N/A
181
FRE.PSD
182
FRE.PSD
All Others
PGM.PSD
The first date the student participated in the program
ProgramCode
Program
Table
ProgramCode
GATE
GTE
127
504
FOF
101
Special Education
CSE
144
NSLP Free
FRE.CD = “F”
181
NSLP Reduced
FRE.CD = “R”
182
All Others
PGM
PGM.CD
The code identifying the program. This is usually a 3-character numeric string.

Note: If the student's Special Education record indicates the student is being evaluated for services (CSE.ED is null and CSE.EV = "Y"), then the API will return ProgramCode "144x" instead of "144".
ProgramDescription
Table
ProgramDescription
GTE
Gifted and Talented Education (GATE)
FOF
504 Accommodation Plan
CSE
Special Education
FRE.CD = “F”
NSLP Free Meal Program
FRE.CD = “R”
NSLP Reduced-Price Meal Program
PGM (All Others)
COD table for PGM.CD
The name/description of the program.

Note: If the student's Special Education record indicates the student is being evaluated for services (CSE.ED is null and CSE.EV = "Y"), then the API will return ProgramDescription "Evaluating for Special Education Services" instead of "Special Education".
StudentID
STU.ID
The Permanent ID for the student

Extended Properties:

  • Program Code 144 – Special Education
    • DisabilityCode (CSE.DI)
    • DisabilityCodeDescription
    • DisabilityCode2 (CSE.DI2)
    • DisabilityCode2Description
  • Program Code 190 – Foster Program
    • FosterID (SSD.FID)
  • Program Code 191 – Homeless Program
    • DwellingTypeCode (PGM.HDT)
    • DwellingTypeCodeDescription




Test Scores

Security Area:

  • "Test Scores"

URL(s):

  • /api/v2/students/{StudentID}/tests
    • StudentID (required) – The Aeries Student District Permanent ID Number.

Notes:

  • This end point will return a full history of all State and locally administered Standardized Tests in Aeries. This does not include SAT I, SAT II, ACT, IB, or AP tests though. Examples include CST, CAHSEE, and CELDT.

Example Student Test Score Results:

https://demo.aeries.net/aeries/api/v2/students/99400001/tests

<ArrayOfTest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v2.Models.Student">
  <Test>
    <GradeLevel>6</GradeLevel>
    <PermanentID>99400001</PermanentID>
    <Scores>
      <TestScore>
        <Score>38</Score>
        <Type>RawScore</Type>
      </TestScore>
      <TestScore>
        <Score>539</Score>
        <Type>ScaleScore</Type>
      </TestScore>
    </Scores>
    <SequenceNumber>27</SequenceNumber>
    <TestDate>2010-11-01T00:00:00</TestDate>
    <TestDescription>Comprehension</TestDescription>
    <TestID>CELDT</TestID>
    <TestPart>6</TestPart>
    <TestSource></TestSource>
    <TestType></TestType>
    <TestingAdministration>1109</TestingAdministration>
  </Test>
  …
  …
</ArrayOfTest>


Field Documentation:


Test

Name
Aeries Table.Column
Description
GradeLevel
TST.GR / 10
The student’s grade level when the test was taken
PermanentID
STU.ID / TST.PID
The Permanent ID for the student
TestScore
* See separate table below
Depending on the test, a single result can have multiple score types. For each nonzero value, a TestScore element will be included in the Scores container.
SequenceNumber
TST.SQ
The sequence number makes up the primary key of the Test Scores table and has no independent meaning
TestDate
TST.TD
The date the test was taken
TestDescription
CTL.NM
The description of the Test Part
TestID
TST.ID
The ID of the test. Ex: CST, CAHSEE, CELDT
TestPart
TST.PT
A numeric value to indicate which part of the test this Test Score result represents. Many standardized tests have multiple parts, such as Math and English/Language Arts.
TestSource
TST.SRC
The source of this test result in Aeries. This may be blank. Other valid values include:
LOC = Local Administration
RT = Records Transfer
VND = Testing Vendor
TestType
TST.TY
The type of test. Codes are set by the District.
TestingAdministration
TST.TA
The testing administration during which this test was taken. Depending on the test, this value may be in one of several formats. The most common are as follows:
SPRG16 = Spring 2016. This format is used for tests that are typically administered only once per year in the spring term.
0916 = September 2016. This format is used for tests that are administered several times throughout the school year.


Test Score

Type
Score
RawScore
TST.RS
ScaleScore
TST.SS
PerformanceLevel
TST.PL
Other
TST.OT
GradeEquivalency
TST.GE
Percentile
TST.PC
PercentCorrect
TST.PR
Stanine
TST.ST
CurveEquivalent
TST.CE
Rubric
TST.RU


For descriptions of the “TestType” codes, use the Code Sets API:

https://demo.aeries.net/aeries/api/v3/codes/TST/TY


Update Test Scores

Security Area:

  • "Test Scores" - Update

URL(s):

  • /api/v2/testing/UpdateScores

Notes:

  • If an existing record is found matched on Permanent ID, Test ID, Test Part, and Testing Administration, it will be updated. Otherwise, a new record will be added.
  • This end point returns an “ArrayOfTest” container of “Test” objects similar to the regular Test Scores end point; however, it contains only those records which were added or updated by the current Update request.

POST Payload Object:

  • Array of “TestScoreUpdate” objects

“TestScoreUpdate” Object Definition:

Name
Data Type
Notes
PermanentID
Int32
REQUIRED The Permanent ID for the student
TestID
String
REQUIRED Max length: 6. The ID of the test
TestPart
Int16
REQUIRED A numeric value to indicate which part of the test this Test Score result represents. Many standardized tests have multiple parts, such as Math and English/Language Arts.
TestingAdministration
String
REQUIRED Max length: 6. The testing administration during which this test was taken
TestDate
Date
REQUIRED The date the test was taken
RawScore
Int16
The Raw Score achieved on the test
PercentCorrect
Int32
The Percent Correct achieved on the test
PerformanceLevel
Int32
The Performance Level achieved on the test


Example Payload:

[
  {
     "PermanentID":99400001,
     "TestID":"CELDT",
     "TestPart":0,
     "TestingAdministration":"1014",
     "TestDate":"10/28/2014",
     "RawScore":93,
     "PercentCorrect":0,
     "PerformanceLevel":0
  },
  {
     "PermanentID":99400002,
     "TestID":"CELDT",
     "TestPart":0,
     "TestingAdministration":"1014",
     "TestDate":"10/29/2014",
     "RawScore":92
  }
]



College Entrance Test Scores

Security Area:

  • "College Entrance Tests"

URL(s):

  • /api/v3/schools/{SchoolCode}/CollegeTestScores/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Notes:

  • This end point will return a full history of all tests normally taken in preparation for college. These include: SAT I, SAT II, ACT, IB, and AP tests.

Example Student College Test Score Results:

https://demo.aeries.net/aeries/api/v3/schools/994/CollegeTestScores

<ArrayOfCollegeTestScores xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Testing">
  <CollegeTestScores>
    <PermanentID>99400001</PermanentID>
    <SchoolCode>994</SchoolCode>
    <TestScores>
      <CollegeTestScore>
        <OverallScore>101</OverallScore>
        <SubTests>
          <CollegeSubTestScore>
            <Code>EN</Code>
            <Score>24</Score>
          </CollegeSubTestScore>
          <CollegeSubTestScore>
            <Code>MT</Code>
            <Score>22</Score>
          </CollegeSubTestScore>
          <CollegeSubTestScore>
            <Code>RD</Code>
            <Score>31</Score>
          </CollegeSubTestScore>
          <CollegeSubTestScore>
            <Code>SC</Code>
            <Score>24</Score>
          </CollegeSubTestScore>
          …
          …
        </SubTests>
        <TestDate>2015-06-09T00:00:00</TestDate>
        <TestName>ACT</TestName>
      </CollegeTestScore>
      …
      …
    </TestScores>
  </CollegeTestScores>
  …
  …
</ArrayOfCollegeTestScores>


Field Documentation:

Name
Aeries Table.Column
Description
PermanentID
CTS.PID / STU.ID
The Permanent ID for the student
SchoolCode
STU.SC
The Aeries school code
OverallScore
CTS.TTL
The overall score achieved on the test
Code
CTS.ST1 – ST13
The code representing this subtest. See note below*
Score
CTS.SC1 – SC13
The score achieved on this subtest
TestDate
CTS.DT
The date the test was taken
TestName
CTS.NM
The name of the test. Ex: ACT, SAT I, SAT II, AP

*For descriptions of the "SubTest" Codes, use our "Code Sets" API:

https://demo.aeries.net/aeries/api/v3/codes/CollegeTestScores/SubTestCode


Assertive Discipline

Security Area:

  • "Assertive Discipline"

URL(s):

  • /api/v3/schools/{SchoolCode}/AssertiveDiscipline/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Notes:

  • This end point will return a full history of all "Assertive Discipline" records for all students in the selected school. This will include incidents from previous school years and those from different schools. An "Assertive Discipline" record normally represents a behavioral incident that resulted in punitive action.

Example Student Assertive Discipline Results:

https://demo.aeries.net/aeries/api/v3/schools/994/AssertiveDiscipline

<ArrayOfStudentAssertiveDisciplines xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Guidance">
  <StudentAssertiveDisciplines>
    <PermanentID>123456789</PermanentID>
    <AssertiveDisciplines>
      <AssertiveDiscipline>
        <AdministrativeDecisions>
          <Disposition>
            <ActionAuthorityCode>10</ActionAuthorityCode>
            <Days>5.0000</Days>
            <DispositionCode>SUS</DispositionCode>
            <EndDate>2016-03-09T00:00:00</EndDate>
            <Hours>0.0000</Hours>
            <PermanentID>99400001</PermanentID>
            <PlacementCode></PlacementCode>
            <ResultCode></ResultCode>
            <ReturnDate>2016-03-10T00:00:00</ReturnDate>
            <ReturnLocationCode></ReturnLocationCode>
            <ReturnStatusCode>2</ReturnStatusCode>
            <SequenceNumber>1</SequenceNumber>
            <StartDate>2016-03-03T00:00:00</StartDate>
            <SuspensionTagCode></SuspensionTagCode>
          </Disposition>
          …
          …
        </AdministrativeDecisions>
        <ApproximateTimeCode>L</ApproximateTimeCode>
        <Comment>Student was part of an attack on another student.</Comment>
        <Demerits>8.0000</Demerits>
        <ExactTime>1901-01-01T12:30:00</ExactTime>
        <IncidentDate>2016-03-02T00:00:00</IncidentDate>
        <IncidentID>16382</IncidentID>
        <Initials></Initials>
        <InstructionalSupportIndicator></InstructionalSupportIndicator>
        <IsSubstituteTeacherReferral>false</IsSubstituteTeacherReferral>
        <LocationCode>S</LocationCode>
        <PossibleMotivationCode>HC</PossibleMotivationCode>
        <PreReferralInterventionCode1></PreReferralInterventionCode1>
        <PreReferralInterventionCode2></PreReferralInterventionCode2>
        <PreReferralInterventionCode3></PreReferralInterventionCode3>
        <SchoolOfIncidentCode>994</SchoolOfIncidentCode>
        <SequenceNumber>16</SequenceNumber>
        <StaffReferral>Alvarado</StaffReferral>
        <UserCode1></UserCode1>
        <UserCode2></UserCode2>
        <UserCode3></UserCode3>
        <UserCode4></UserCode4>
        <UserCode5></UserCode5>
        <UserCode6></UserCode6>
        <UserCode7></UserCode7>
        <UserCode8></UserCode8>
        <ViolationCode1>04</ViolationCode1>
        <ViolationCode2></ViolationCode2>
        <ViolationCode3></ViolationCode3>
        <ViolationCode4></ViolationCode4>
        <ViolationCode5></ViolationCode5>
        <WeaponTypeCode></WeaponTypeCode>
      </AssertiveDiscipline>
      …
      …
    </AssertiveDisciplines>
    …
    …
  </StudentAssertiveDisciplines>
  …
  …
</ArrayOfStudentAssertiveDisciplines>


Field Documentation:

Assertive Discipline

Name
Aeries Table.Column
Description
ApproximateTimeCode
ADS.AXT
The approximate time the incidnt occurred
Comment
ADS.CO
A comment describing the incident
Demerits
ADS.DM
The number of demerits the student received for the incident
ExactTime
ADS.ET
The exact time the incident occurred
IncidentDate
ADS.DT
The date the incident occurred
IncidentID
ADS.IID
The Incident ID. This ID is used to link student Assertive Discipline records pertaining to the same incident (i.e., if two or more students were involved in the same incident, the Incident ID will be the same on those records).
Initials
ADS.INI
The initials of the staff member entering the record
InstructionalSupportIndicator
ADS.ISI
For special education students, indicates whether instructional support was provided during a suspension or expulsion resulting from this incident
IsSubstituteTeacherReferral
ADS.SR
Indicates whether the incident was referred by a substitute teacher
LocationCode
ADS.LCN
The location where the incident occurred
PossibleMotivationCode
ADS.PM
The student’s possible motivation for the incident
PreReferralInterventionCode1
ADS.PI1
A first intervention that was attempted prior to making the disciplinary referral
PreReferralInterventionCode2
ADS.PI2
A second intervention that was attempted prior to making the disciplinary referral
PreReferralInterventionCode3
ADS.PI3
A third intervention that was attempted prior to making the disciplinary referral
SchoolOfIncidentCode
ADS.SCL
The Aeries school code where the incident occurred
SequenceNumber
ADS.SQ
The sequence number is part of the primary key. It has no independent meaning.
StaffReferral
ADS.RF
The staff member who made the referral
UserCode1
ADS.U1
User-defined code 1
UserCode2
ADS.U2
User-defined code 2
UserCode3
ADS.U3
User-defined code 3
UserCode4
ADS.U4
User-defined code 4
UserCode5
ADS.U5
User-defined code 5
UserCode6
ADS.U6
User-defined code 6
UserCode7
ADS.U7
User-defined code 7
UserCode8
ADS.U8
User-defined code 8
ViolationCode1
ADS.CD
The first violation committed in this incident (the first should be the most severe)
ViolationCode2
ADS.CD2
The second violation committed in this incident
ViolationCode3
ADS.CD3
The third violation committed in this incident
ViolationCode4
ADS.CD4
The fourth violation committed in this incident
ViolationCode5
ADS.CD5
The fifth violation committed in this incident
WeaponTypeCode
ADS.WT
The type of weapon used in this incident


Disposition

Name
Aeries Table.Column
Description
ActionAuthorityCode
DSP.AA
The authority under which the disposition was administered
Days
DSP.DY
The number of days of disposition (e.g., days of suspension if this is a suspension)
DispositionCode
DSP.DS
The disposition taken
EndDate
DSP.ED
The end date of the disposition
Hours
DSP.HR
The number of hours of disposition
PermanentID
DSP.PID
The Permanent ID for the student
PlacementCode
DSP.PL
The student’s placement for this disposition
ResultCode
DSP.RS
The result of the disposition
ReturnDate
DSP.RD
The date the student returned from this disposition
ReturnLocationCode
DSP.RL
The return location for this disposition
ReturnStatusCode
DSP.RST
The return status for this disposition
SequenceNumber
DSP.SQ1
The sequence number is part of the primary key. It has no independent meaning.
StartDate
DSP.DD
The start date of the disposition
SuspensionTagCode
DSP.ST
The suspension tag for this disposition

For descriptions of the various coded fields, use our "Code Sets" API:

https://demo.aeries.net/aeries/api/v3/codes/AssertiveDiscipline/ViolationCode

https://demo.aeries.net/aeries/api/v3/codes/AssertiveDiscipline/ApproximateTime

https://demo.aeries.net/aeries/api/v3/codes/AssertiveDiscipline/Location

https://demo.aeries.net/aeries/api/v3/codes/AssertiveDiscipline/PossibleMotivation

https://demo.aeries.net/aeries/api/v3/codes/AssertiveDiscipline/PreReferralIntervention

https://demo.aeries.net/aeries/api/v3/codes/AssertiveDiscipline/UserCode1

https://demo.aeries.net/aeries/api/v3/codes/AssertiveDiscipline/WeaponType

https://demo.aeries.net/aeries/api/v3/codes/Disposition/ActionAuthority

https://demo.aeries.net/aeries/api/v3/codes/Disposition/DispositionCode

https://demo.aeries.net/aeries/api/v3/codes/Disposition/Placement

https://demo.aeries.net/aeries/api/v3/codes/Disposition/Result

https://demo.aeries.net/aeries/api/v3/codes/Disposition/ReturnLocation

https://demo.aeries.net/aeries/api/v3/codes/Disposition/ReturnStatus

https://demo.aeries.net/aeries/api/v3/codes/Disposition/SuspensionTag


District Supplemental Student Data

Security Area:

  • "District Supplemental Data"

URL(s):

  • /api/v3/schools/{SchoolCode}/DistrictSupplemental/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Notes:

  • This end point will return student information from the "DSD" table in Aeries. This is a table that can be customized by each district with a set of fields that are consistent for all instances of a student record throughout the district (when the student is enrolled in multiple schools during the year).

Example District Supplemental Student Data Results:

https://demo.aeries.net/aeries/api/v3/schools/994/DistrictSupplemental

<ArrayOfDistrictSupplemental xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Student">
  <DistrictSupplemental>
    <Columns>
      <ColumnInfo>
        <ColumnCode>XX</ColumnCode>
        <ColumnDescription>Other Comment</ColumnDescription>
        <ColumnType>varchar</ColumnType>
        <Value>some data</Value>
      </ColumnInfo>
      <ColumnInfo>
        <ColumnCode>GI</ColumnCode>
        <ColumnDescription>General Info</ColumnDescription>
        <ColumnType>varchar</ColumnType>
        <Value>some more data</Value>
      </ColumnInfo>
      …
      …
    </Columns>
    <PermanentID>123456789</PermanentID>
  </DistrictSupplemental>
  …
  …
</ArrayOfDistrictSupplemental>


School Supplemental Student Data

Security Area:

  • "Supplemental Data"

URL(s):

  • /api/v3/schools/{SchoolCode}/SchoolSupplemental/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Notes:

  • This end point will return student information from the "SUP" table in Aeries. This is a table that can be customized by each district with a set of fields whose values are unique for each school a student is enrolled.

Example School Supplemental Student Data Results:

https://demo.aeries.net/aeries/api/v3/schools/994/SchoolSupplemental

<ArrayOfSupplemental xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Student">
  <Supplemental>
    <Columns>
      <ColumnInfo>
        <ColumnCode>PI</ColumnCode>
        <ColumnDescription>Student Lives With</ColumnDescription>
        <ColumnType>varchar</ColumnType>
        <Value>Mother</Value>
      </ColumnInfo>
      <ColumnInfo>
        <ColumnCode>HS</ColumnCode>
        <ColumnDescription>Home School</ColumnDescription>
        <ColumnType>varchar</ColumnType>
        <Value>ABC School</Value>
      </ColumnInfo>
      …
      …
    </Columns>
    <PermanentID>123456789</PermanentID>
    <SchoolCode>994</SchoolCode>
  </Supplemental>
  …
  …
</ArrayOfSupplemental>


Fees and Fines

Security Area:

  • "Fees and Fines"

URL(s):

  • /api/v3/schools/{SchoolCode}/fees/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Notes:

  • This end point will return a full history of all fees and fines incurred by the student, including those that have already been paid.

Example Student Fees and Fines Results:

https://demo.aeries.net/aeries/api/v3/schools/994/fees

<ArrayOfStudentFees xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Student">
  <StudentFees>
    <Fees>
      <Fee>
        <AmountCharged>20.0000</AmountCharged>
        <AmountPaid>0.0000</AmountPaid>
        <Comment></Comment>
        <DateCharged>2017-05-17T00:00:00</DateCharged>
        <DatePaid i:nil="true" />
        <FeeCode>ASB-02</FeeCode>
        <LetterCount>0</LetterCount>
        <ReceiptNumber></ReceiptNumber>
        <SchoolCode>0</SchoolCode>
        <SequenceNumber>1</SequenceNumber>
      </Fee>
      <Fee>
        <AmountCharged>25.0000</AmountCharged>
        <AmountPaid>15.0000</AmountPaid>
        <Comment></Comment>
        <DateCharged>2016-11-20T00:00:00</DateCharged>
        <DatePaid i:nil="true" />
        <FeeCode>LIB-06</FeeCode>
        <LetterCount>0</LetterCount>
        <ReceiptNumber>0</ReceiptNumber>
        <SchoolCode>0</SchoolCode>
        <SequenceNumber>2</SequenceNumber>
      </Fee>
    </Fees>
    <PermanentID>99400001</PermanentID>
  </StudentFees>
  …
  …
</ArrayOfStudentFees>


Field Documentation:

Name
Aeries Table.Column
Description
AmountCharged
FEE.AM
The dollar amount of the Fee
AmountPaid
FEE.PD
The dollar amount that has been paid toward the Fee
Comment
FEE.CO
A comment or note that the school has entered about this Fee
DateCharged
FEE.DT
The date the Fee was charged
DatePaid
FEE.DP
The date the Fee was paid
FeeCode
FEE.CD
A code representing the reason for the Fee
LetterCount
FEE.LT
The school can send Fee Letters to remind/warn students and parents about unpaid Fees. This is the number of such letters that have been sent pertaining to this Fee.
ReceiptNumber
FEE.RN
When a Fee is paid, the school can store the receipt number for the payment
SchoolCode
FEE.SCL
The Aeries school code of the school where the Fee was charged
SequenceNumber
FEE.SQ
The sequence number is part of the primary key. It has no independent meaning.
PermanentID
FEE.PID / STU.ID
The Permanent ID for the student

For descriptions of the "FeeCode" Codes, use our "Code Sets" API:

https://demo.aeries.net/aeries/api/v3/codes/Fee/FeeCode


Student Picture

Security Area:

  • "Student Pictures"

URL(s):

  • /api/v3/schools/{SchoolCode}/StudentPictures/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Query String Filters:

  • StartingRecord – (numeric) The Record-Count value of the first record to return (inclusive).
  • EndingRecord – (numeric) The Record-Count value of the last record to return (inclusive).

Notes:

  • This end point will return the most recent photo of the student stored in Aeries.
  • Due to the large amount of data that this end point may return, it is HIGHLY recommended to use either an individual student ID or query string filters to limit the number of records returned.

Example Student Pictures Results:

https://demo.aeries.net/aeries/api/v3/schools/994/StudentPictures/99400001

<ArrayOfStudentPictures xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Student">
  <StudentPictures>
    <PermanentID>99400001</PermanentID>
    <Pictures>
      <Picture>
        <FileExtension>jpg</FileExtension>
        <FileSize>13768</FileSize>
        <RawBinary>[not shown for purpose of document readabiliy]</RawBinary>
        <SchoolYear>2016</SchoolYear>
      </Picture>
    </Pictures>
    <SchoolCode>994</SchoolCode>
  </StudentPictures>
</ArrayOfStudentPictures>


Field Documentation:

Name
Aeries Table.Column
Description
PermanentID
PIC.ID
The Permanent ID for the student
FileExtension
PIC.XT
The original file extension of the photo (e.g., “jpg”)
FileSize
PIC.SZ
The size in bytes of the photo
RawBinary
PIC.RB
A serialized byte array containing the student photo
SchoolYear
PIC.YR
The school year the photo was taken (e.g., 2016 for the 2016-2017 school year)
SchoolCode
STU.SC
The Aeries school code


Student Groups

Security Area:

  • "Student Groups"

URL(s):

  • /api/v3/schools/{SchoolCode}/StudentGroups
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999. To return Student Groups for all schools, pass “all” for the SchoolCode.

Notes:

  • Student Groups are lists of students that schools have grouped together for any purpose, such as athletic team membership, club participation, academic reasons, special programs, etc.

Example Student Groups Results:

https://demo.aeries.net/aeries/api/v3/schools/994/StudentGroups

<ArrayOfStudentGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.StudentGroups">
  <StudentGroup>
    <Description></Description>
    <ExpirationDate i:nil="true" />
    <GroupId>3</GroupId>
    <IsCommunicationGroup>false</IsCommunicationGroup>
    <Name>Chronic Absent</Name>
    <SchoolCode>994</SchoolCode>
    <Staff>
      <Staff>
        <StaffId>994605</StaffId>
      </Staff>
      …
    </Staff>
    <Students>
      <Student>
        <StudentId>99400001</StudentId>
      </Student>
      <Student>
        <StudentId>99400002</StudentId>
      </Student>
      …
    </Students>
  </StudentGroup>
  …
  …
</ArrayOfStudentGroup>


Field Documentation:

Name
Aeries Table.Column
Description
Description
SGD.GD
The description of the group
ExpirationDate
SGD.DX
The date the group expires. If the expiration date is populated and has passed, the group should be considered inactive.
GroupId
SGD.GI
The unique identifier for the group
IsCommunicationGroup
SGD.CM
Indicates whether the group is synced with the Aeries Communication platform
Name
SGD.GN
The name of the group
StaffId
SGS.ID
The staff ID of a staff member associated with the group
StudentId
SGM.ID
The permanent ID of a student who is a member of the group


Attendance & Enrollment

 

Student Enrollment History

Security Area:

  • "Enrollment History"

URL(s):

  • /api/v3/enrollment/{StudentID}
    • StudentID (required) – Pass “0” for all students. The Aeries Student District Permanent ID Number.
  • /api/v3/enrollment/{StudentID}/year/{AcademicYear}
    • StudentID (required) – Pass “0” for all students. The Aeries Student District Permanent ID Number.
    • AcademicYear (required) – The academic year of the enrollment. Format: yyyy. Ex: “2017” for the 2017-2018 academic year
  • /api/v3/schools/{SchoolCode}/enrollment/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
  • StudentID (required) – Pass “0” for all students. The Aeries Student District Permanent ID Number.
  • /api/v3/schools/{SchoolCode}/enrollment/{StudentID}/year/{AcademicYear}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (required) – Pass “0” for all students. The Aeries Student District Permanent ID Number.
    • AcademicYear (required) – The academic year of the enrollment. Format: yyyy. Ex: “2017” for the 2017-2018 academic year

Notes:

  • This end point will return the enrollment history for one or all students. It can be limited to a specific school code and/or specific academic year.

Example Student Enrollment History Results:

https://demo.aeries.net/aeries/api/v3/enrollment/99400001/year/2016

<ArrayOfEnrollmentHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Attendance">
  <EnrollmentHistory>
    <AcademicYear>2016</AcademicYear>
    <AttendanceProgramCode></AttendanceProgramCode>
    <AttendanceProgramCodeAdditional1></AttendanceProgramCodeAdditional1>
    <AttendanceProgramCodeAdditional2></AttendanceProgramCodeAdditional2>
    <ElementaryTeacherName></ElementaryTeacherName>
    <ElementaryTeacherNumber>0</ElementaryTeacherNumber>
    <EnterDate>2016-08-13T00:00:00</EnterDate>
    <ExitReasonCode></ExitReasonCode>
    <Grade>12</Grade>
    <InterIntraDistrictTransferCode></InterIntraDistrictTransferCode>
    <LeaveDate i:nil="true" />
    <PermanentID>99400001</PermanentID>
    <SchoolCode>994</SchoolCode>
    <StudentNumber>1</StudentNumber>
    <Track></Track>
  </EnrollmentHistory>
  …
  …
</ArrayOfEnrollmentHistory>


Field Documentation:

Name
Aeries Table.Column
Description
AcademicYear
ENR.YR
The 4-digit academic year of this enrollment period; e.g., 2016 for the 2016-2017 academic year
AttendanceProgramCode
ENR.PR
The specialized attendance program to which this student belonged during this enrollment period. Attendance programs are used to separate certain students’ attendance data in the monthly apportionment (ADA) calculations.
AttendanceProgramCodeAdditional1
ENR.AP1
An additional specialized attendance program to which this student belonged during this enrollment period
AttendanceProgramCodeAdditional2
ENR.AP2
An additional specialized attendance program to which this student belonged during this enrollment period
ElementaryTeacherName
ENR.TE
For elementary schools, the display name of the teacher to whom the student was assigned during this enrollment period
ElementaryTeacherNumber
ENR.TN
For elementary schools, the school-based teacher number of the teacher to whom the student was assigned during this enrollment period
EnterDate
ENR.ED
The start date of this enrollment period
ExitReasonCode
ENR.ER
A coded value indicating the reason the enrollment period ended. These codes align with state reporting requirements.
Grade
ENR.GR
The student’s grade level during this enrollment period
InterIntraDistrictTransferCode
ENR.IT
The student’s interdistrict or intradistrict transfer status during this enrollment period
LeaveDate
ENR.LD
The end date of this enrollment period
PermanentID
ENR.ID
The Permanent ID for the student
SchoolCode
ENR.SC
The Aeries school code of the school where this enrollment took place
StudentNumber
ENR.SN
The school-based Aeries student number assigned to the student during this enrollment period
Track
ENR.TR
The student’s attendance track during this enrollment period

For descriptions of the ExitReason codes, use our Code Sets API:

https://demo.aeries.net/aeries/api/v3/codes/EnrollmentHistory/ExitReason


Student Attendance

Security Area:

  • "Attendance"

URL(s):

  • /api/v3/schools/{SchoolCode}/attendance/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Query String Filters:

  • StartDate – (YYYYMMDD format) The earliest date of attendance to include (inclusive).
  • EndDate – (YYYYMMDD format) The latest date of attendance to include (inclusive).

Notes:

  • This end point will return detailed student attendance data for the selected school.
  • An “AttendanceDay” is only returned if the student has an attendance code for that day or for at least one period in that day. For negative attendance schools, it is normal for many days to be “missing” from student attendance results because no attendance code is entered when the student is present for the day or period.

Example Student Attendance Results:

https://demo.aeries.net/aeries/api/v3/schools/994/attendance/99400001

<ArrayOfStudentAttendance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Attendance">
  <StudentAttendance>
    <AttendanceDays>
      <AttendanceDay>
        <AllDayAttendanceCode>Q</AllDayAttendanceCode>
        <CalendarDate>2016-07-11T00:00:00</CalendarDate>
        <CalendarDayNumber>1</CalendarDayNumber>
        <Periods>
          <PeriodAttendance>
            <AttendanceCode>Q</AttendanceCode>
            <Period>1</Period>
          </PeriodAttendance>
          <PeriodAttendance>
            <AttendanceCode>Q</AttendanceCode>
            <Period>2</Period>
          </PeriodAttendance>
          …
          …
        </Periods>
      </AttendanceDay>
      …
      …
    </AttendanceDays>
    <PermanentID>99400001</PermanentID>
    <SchoolCode>994</SchoolCode>
  </StudentAttendance>
  …
  …
</ArrayOfStudentAttendance>


Field Documentation:

Name
Aeries Table.Column
Description
AllDayAttendanceCode
ATT.AL
The attendance code for the whole day. In a daily attendance school, this will be the only attendance code populated for the day. For a period attendance school, this should ordinarily be populated only if all period attendance codes are the same.
CalendarDate
ATT.DT
The calendar date for this attendance
CalendarDayNumber
ATT.DY
The day number from the school's calendar. This is normally a value between 1 and 200.
AttendanceCode
ATT.A0 – ATT.A9
The attendance code for a single period. Aeries supports periods 0 – 9, but not all students meet in each period each day depending on their class schedule.
Period

The period number 0 – 9.
PermanentID
STU.ID
The Permanent ID for the student
SchoolCode
ATT.SC
The Aeries school code

For descriptions of the AttendanceCode and AllDayAttendanceCode, use the Absence Codes API:

https://demo.aeries.net/aeries/api/v3/schools/994/absencecodes


Attendance History Summary

Security Area:

  • "Attendance History"

URL(s):

  • /api/v3/schools/{SchoolCode}/AttendanceHistory/summary/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.
  • /api/v3/schools/{SchoolCode}/AttendanceHistory/summary/year/{year}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • Year (required) – The academic year in the format yyyy-yyyy (e.g., “2016-2017”)

Notes:

  • This end point will return a summary of Attendance History data and can be limited to a specific student or to a specific academic year.
  • Passing “SchoolCode” without “StudentID” will limit the results to students who currently have a record in the selected school, but the Attendance History may include data from other schools.
  • Passing “StudentID” will effectively ignore the passed “SchoolCode” and return all Attendance History for the selected student regardless of whether the student is currently in the selected school.

Example Attendance History Summary Results:

https://demo.aeries.net/aeries/api/v3/schools/994/AttendanceHistory/summary

<ArrayOfAttendanceHistorySummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Attendance">
  <AttendanceHistorySummary>
    <HistorySummaries>
      <HistorySummary>
        <DaysAbsence>16</DaysAbsence>
        <DaysEnrolled>250</DaysEnrolled>
        <DaysExcused>10</DaysExcused>
        <DaysOfTruancy>0</DaysOfTruancy>
        <DaysPresent>234</DaysPresent>
        <DaysSuspension>0</DaysSuspension>
        <DaysTardy>0</DaysTardy>
        <DaysUnexcused>6</DaysUnexcused>
        <SchoolCode>990</SchoolCode>
        <SchoolYear>2011-2012</SchoolYear>
      </HistorySummary>
      <HistorySummary>
        <DaysAbsence>20</DaysAbsence>
        <DaysEnrolled>249</DaysEnrolled>
        <DaysExcused>8</DaysExcused>
        <DaysOfTruancy>0</DaysOfTruancy>
        <DaysPresent>229</DaysPresent>
        <DaysSuspension>0</DaysSuspension>
        <DaysTardy>0</DaysTardy>
        <DaysUnexcused>12</DaysUnexcused>
        <SchoolCode>996</SchoolCode>
        <SchoolYear>2012-2013</SchoolYear>
      </HistorySummary>
      …
      …
    </HistorySummaries>
    <PermanentID>99400001</PermanentID>
  </AttendanceHistorySummary>
  …
  …
</ArrayOfAttendanceHistorySummary>


Field Documentation:

Name
Aeries Table.Column
Description
DaysAbsence
AHS.AB
The total number of days (according to the All Day attendance code) of absence this student has in the given school year and school code
DaysEnrolled
AHS.EN
The total number of days (according to the All Day attendance code) of enrollment this student has in the given school year and school code
DaysExcused
AHS.AE
The total number of days (according to the All Day attendance code) of excused absence this student has in the given school year and school code
DaysOfTruancy
AHS.TRU
The total number of days the student has any truancy attendance code in the given school year and school code
DaysPresent
AHS.PR
The total number of days (according to the All Day attendance code) present this student has in the given school year and school code
DaysSuspension
AHS.SU
The total number of days (according to the All Day attendance code) of suspension this student has in the given school year and school code
DaysTardy
AHS.TD
The total number of days (according to the All Day attendance code) tardy this student has in the given school year and school code
DaysUnexcused
AHS.AU
The total number of days (according to the All Day attendance code) of unexcused absence this student has in the given school year and school code
SchoolCode
AHS.SCL
The Aeries school code
SchoolYear
AHS.HR
The school year, in the format “yyyy-yyyy”; e.g., “2016-2017”
PermanentID
AHS.ID
The Permanent ID of the student


Attendance History Details

Security Area:

  • "Attendance History"

URL(s):

  • /api/v3/schools/{SchoolCode}/AttendanceHistory/details/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.
  • /api/v3/schools/{SchoolCode}/AttendanceHistory/details/year/{year}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • Year (required) – The academic year in the format yyyy-yyyy (e.g., “2017-2018”)

Notes:

  • This end point will return details of Attendance History data and can be limited to a specific student or to a specific academic year.
  • Passing “SchoolCode” without “StudentID” will limit the results to students who currently have a record in the selected school, but the Attendance History may include data from other schools.
  • Passing “StudentID” will effectively ignore the passed “SchoolCode” and return all Attendance History for the selected student regardless of whether the student is currently in the selected school.

Example Attendance History Details Results:

https://demo.aeries.net/aeries/api/v3/schools/994/AttendanceHistory/details/year/2016-2017

<ArrayOfAttendanceHistoryDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Attendance">
  <AttendanceHistoryDetails>
    <HistoryDetails>
      <HistoryDetail>
        <AllDayTotal>5</AllDayTotal>
        <Code>#</Code>
        <Description>TOTAL EXCUSED</Description>
        <Period0Total>5</Period0Total>
        <Period1Total>5</Period1Total>
        <Period2Total>5</Period2Total>
        <Period3Total>5</Period3Total>
        <Period4Total>0</Period4Total>
        <Period5Total>0</Period5Total>
        <Period6Total>0</Period6Total>
        <Period7Total>0</Period7Total>
        <Period8Total>0</Period8Total>
        <Period9Total>0</Period9Total>
        <SchoolCode>994</SchoolCode>
        <SchoolYear>2016-2017</SchoolYear>
      </HistoryDetail>
      <HistoryDetail>
        <AllDayTotal>1</AllDayTotal>
        <Code>*</Code>
        <Description>TOTAL UNEXCUSED</Description>
        <Period0Total>8</Period0Total>
        <Period1Total>3</Period1Total>
        <Period2Total>1</Period2Total>
        <Period3Total>1</Period3Total>
        <Period4Total>0</Period4Total>
        <Period5Total>0</Period5Total>
        <Period6Total>0</Period6Total>
        <Period7Total>0</Period7Total>
        <Period8Total>0</Period8Total>
        <Period9Total>0</Period9Total>
        <SchoolCode>994</SchoolCode>
        <SchoolYear>2016-2017</SchoolYear>
      </HistoryDetail>
      <HistoryDetail>
        <AllDayTotal>2</AllDayTotal>
        <Code>I</Code>
        <Description>ILLNESS</Description>
        <Period0Total>2</Period0Total>
        <Period1Total>2</Period1Total>
        <Period2Total>2</Period2Total>
        <Period3Total>2</Period3Total>
        <Period4Total>0</Period4Total>
        <Period5Total>0</Period5Total>
        <Period6Total>0</Period6Total>
        <Period7Total>0</Period7Total>
        <Period8Total>0</Period8Total>
        <Period9Total>0</Period9Total>
        <SchoolCode>994</SchoolCode>
        <SchoolYear>2016-2017</SchoolYear>
      </HistoryDetail>
      …
      …
    </HistoryDetails>
    <PermanentID>99400001</PermanentID>
  </AttendanceHistoryDetails>
  …
  …
</ArrayOfAttendanceHistoryDetails>


Field Documentation:

Name
Aeries Table.Column
Description
AllDayTotal
AHD.AL
The total number of days the student had this Attendance Code as the All Day code
Code
AHD.CD
The Attendance Code (1 character). This will typically be a letter but may be a digit. There are two special values that represent totals of certain types of attendance codes:
# = TOTAL EXCUSED
* = TOTAL UNEXCUSED
Description
AHD.DE
The description of the Attendance Code
Period#Total
AHD.P0 – AHD.P9
The total number of days the student had this Attendance Code in the given period (0 – 9)
SchoolCode
AHD.SCL
The Aeries School code to which this Attendance History belongs
SchoolYear
AHD.YR
The school year to which this Attendance History pertains
PermanentID
AHD.ID
The Permanent ID for the student


Attendance History Attendance Codes

Security Area:

  • "Attendance History"

URL(s):

  • /api/v3/schools/{SchoolCode}/AttendanceHistory/AbsenceCodes
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
  • /api/v3/schools/{SchoolCode}/AttendanceHistory/AbsenceCodes/year/{year}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • Year (required) – The academic year in the format yyyy-yyyy (e.g., “2017-2018”)

Notes:

  • This end point will return a history of Attendance Codes used by the selected school and can be limited to a specific academic year.

Example Attendance History Attendance Codes Results:

https://demo.aeries.net/aeries/api/v3/schools/994/AttendanceHistory/AbsenceCodes

<ArrayOfAttendanceHistoryCodes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Attendance">
  <AttendanceHistoryCodes>
    <Abbreviation>UNV</Abbreviation>
    <AbsenceCode>A</AbsenceCode>
    <CountOnReportCard>true</CountOnReportCard>
    <CountsForADA>false</CountsForADA>
    <IncludeInParentNotifications>true</IncludeInParentNotifications>
    <IncludeOnLetters>true</IncludeOnLetters>
    <IncludeOnReports>true</IncludeOnReports>
    <IsPartialDayTruant>false</IsPartialDayTruant>
    <IsSuspension>false</IsSuspension>
    <SchoolCode>994</SchoolCode>
    <SchoolYear>2011-2012</SchoolYear>
    <Title>UNVERIFIED</Title>
    <Type>1</Type>
  </AttendanceHistoryCodes>
  <AttendanceHistoryCodes>
    <Abbreviation>ILL</Abbreviation>
    <AbsenceCode>I</AbsenceCode>
    <CountOnReportCard>true</CountOnReportCard>
    <CountsForADA>false</CountsForADA>
    <IncludeInParentNotifications>false</IncludeInParentNotifications>
    <IncludeOnLetters>true</IncludeOnLetters>
    <IncludeOnReports>true</IncludeOnReports>
    <IsPartialDayTruant>false</IsPartialDayTruant>
    <IsSuspension>false</IsSuspension>
    <SchoolCode>994</SchoolCode>
    <SchoolYear>2011-2012</SchoolYear>
    <Title>ILLNESS</Title>
    <Type>2</Type>
  </AttendanceHistoryCodes>
  …
  …
</ArrayOfAttendanceHistoryCodes>


Field Documentation:

Name
Aeries Table.Column
Description
Abbreviation
AHC.AB
The abbreviated name (max 3 characters) for this absence code
AbsenceCode
AHC.CD
The absence code (1 character). This will typically be a letter A-Z but may be a digit.
CountOnReportCard
AHC.GR
Indicates whether this absence code counts toward attendance totals on the grade report card.
CountsForADA
AHC.AD
Indicates whether this absence code counts toward the school’s ADA apportionment calculation.
IncludeInParentNotifications
AHC.DI
Indicates whether this absence code should be included when notifications are sent to parents (e.g., automated attendance calls).
IncludeOnLetters
AHC.LT
Indicates whether this absence code should be included on letters sent to parents
IncludeOnReports
AHC.OT
Indicates whether this absence code should print on attendance reports.
IsPartialDayTruant
AHC.PT
Indicates whether this absence code represents a partial day truancy. It would normally be used for a student who is more than 30 minutes late for class.
IsSuspension
AHC.SU
Indicates whether this absence code represents a suspension (may be in-school or out-of-school).
SchoolCode
AHC.SCL
The Aeries school code
SchoolYear
AHC.YR
The school year to which this record applies
Title
AHC.TI
The full name (max 10 characters) for this absence code
Type
AHC.TY
A code representing the type of absence code.

For a description of the various “Type” values, see the Field Documentation for “Absence Codes”.


Student Grades

 

Student GPAs

Security Area:

  • "Student Data"

URL(s):

  • /api/v3/schools/{SchoolCode}/gpas/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Query String Filters:

  • StartingRecord – (numeric) The Record-Count value of the first record to return (inclusive).
  • EndingRecord – (numeric) The Record-Count value of the last record to return (inclusive).

Notes:

  • If Student ID is not passed, all students for the given school will be returned.

Example Student GPAs Results:

https://demo.aeries.net/aeries/api/v3/schools/994/gpas

<ArrayOfStudentGPAs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Student">
  <StudentGPAs>
    <ClassRank>18</ClassRank>
    <ClassRank1012>16</ClassRank1012>
    <ClassSize>522</ClassSize>
    <CreditsAttempted>242.5000</CreditsAttempted>
    <CreditsCompleted>242.5000</CreditsCompleted>
    <GPA_CSU_Preliminary>3.8966</GPA_CSU_Preliminary>
    <GPA_CumulativeAcademic>3.9647</GPA_CumulativeAcademic>
    <GPA_CumulativeAcademic1012>4.0492</GPA_CumulativeAcademic1012>
    <GPA_CumulativeAcademic1012NonWeighted>3.6230</GPA_CumulativeAcademic1012NonWeighted>
    <GPA_CumulativeAcademicNonWeighted>3.6588</GPA_CumulativeAcademicNonWeighted>
    <GPA_CumulativeCitizenship>0.0000</GPA_CumulativeCitizenship>
    <GPA_CumulativeTotal>3.9691</GPA_CumulativeTotal>
    <GPA_CumulativeTotalNonWeighted>3.7010</GPA_CumulativeTotalNonWeighted>
    <GPA_GradeReportingAcademic>0.0000</GPA_GradeReportingAcademic>
    <GPA_GradeReportingAcademicNonWeighted>0.0000</GPA_GradeReportingAcademicNonWeighted>
    <GPA_GradeReportingCitizenship>0.0000</GPA_GradeReportingCitizenship>
    <GPA_GradeReportingTotal>0.0000</GPA_GradeReportingTotal>
    <GPA_GradeReportingTotalNonWeighted>0.0000</GPA_GradeReportingTotalNonWeighted>
    <GPA_UC_Preliminary>3.9091</GPA_UC_Preliminary>
    <GradePointsCumulative>168.5000</GradePointsCumulative>
    <GradeReportingClassRank>0</GradeReportingClassRank>
    <GradeReportingClassSize>0</GradeReportingClassSize>
    <GradeReportingCreditsAttempted>0.0000</GradeReportingCreditsAttempted>
    <GradeReportingCreditsCompleted>0.0000</GradeReportingCreditsCompleted>
    <PermanentID>99400001</PermanentID>
    <SchoolCode>994</SchoolCode>
  </StudentGPAs>
  …
  …
</ArrayOfStudentGPAs>


Field Documentation:

Name
Aeries Table.Column
Description
ClassRank
STU.CR
The cumulative class rank based on the school’s selection of which GPA calculation to use
ClassRank1012
STU.UR
The cumulative class rank based on the grades 10-12 Academic GPA
ClassSize
STU.CS
The class size including active and graduated students
CreditsAttempted
STU.CA
The cumulative number of course credits attempted by the student
CreditsCompleted
STU.CC
The cumulative number of course credits completed by the student
GPA_CSU_Preliminary
STU.PCS
The preliminary academic GPA for California State University entrance
GPA_CumulativeAcademic
STU.GP
The cumulative, weighted academic GPA (i.e., excludes all non-academic courses)
GPA_CumulativeAcademic1012
STU.CP
The cumulative, weighted academic GPA including only academic courses taken in grades 10-12
GPA_CumulativeAcademic1012NonWeighted
STU.CPN
The cumulative, non-weighted academic GPA including only academic courses taken in grades 10-12
GPA_CumulativeAcademicNonWeighted
STU.GPN
The cumulative, non-weighted academic GPA (i.e., excludes all non-academic courses)
GPA_CumulativeCitizenship
STU.CCG
The cumulative “Citizenship GPA”
GPA_CumulativeTotal
STU.TP
The cumulative, weighted total GPA (includes non-academic courses))
GPA_CumulativeTotalNonWeighted
STU.TPN
The cumulative, nonweighted total GPA (includes non-academic courses)
GPA_GradeReportingAcademic
STU.GG
The weighted, academic GPA calculated from the current marking period
GPA_GradeReportingAcademicNonWeighted
STU.GGN
The non-weighted, academic GPA calculated from the current marking period
GPA_GradeReportingCitizenship
STU.GCG
The “Citizenship GPA” calculated from the current marking period
GPA_GradeReportingTotal
STU.GT
The weighted total GPA calculated from the current marking period
GPA_GradeReportingTotalNonWeighted
STU.GTN
The non-weighted total GPA calculated from the current marking period
GPA_UC_Preliminary
STU.PUC
The preliminary academic GPA for University of California entrance
GradePointsCumulative
STU.PTS
The number of grade points used to calculate UC and CSU GPAs
GradeReportingClassRank
STU.GK
The class rank, based on the school’s selection of which GPA calculation to use, calculated from the current marking period
GradeReportingClassSize
STU.GS
The class size including active students only
GradeReportingCreditsAttempted
STU.GA
The number of course credits attempted by the student in the current marking period
GradeReportingCreditsCompleted
STU.GD
The number of course credits completed by the student in the current marking period
PermanentID
STU.ID
The Permanent ID for the student
SchoolCode
STU.SC
The Aeries school code


Student Report Cards

Security Area:

  • "Grades"

URL(s):

  • /api/v3/schools/{SchoolCode}/ReportCard/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Notes:

  • If Student ID is not passed, all students for the given school will be returned.

Example Student Report Cards Results:

https://demo.aeries.net/aeries/api/v3/schools/994/ReportCard

<ArrayOfStudentReportCard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.GradeReporting">
  <StudentReportCard>
    <PermanentID>99400001</PermanentID>
    <StudentReportCardCourses>
      <StudentReportCardCourse>
        <CourseID>0317</CourseID>
        <CourseTitle>IB Eng HL2</CourseTitle>
        <MarkingPeriodGrades>
          <MarkingPeriodGrade>
            <CitizenshipCode></CitizenshipCode>
            <Comment1Code></Comment1Code>
            <Comment2Code></Comment2Code>
            <Comment3Code></Comment3Code>
            <Credit>5</Credit>
            <Mark>A</Mark>
            <MarkingPeriod>1</MarkingPeriod>
            <SectionNumber>2257</SectionNumber>
            <TotalAbsences>0</TotalAbsences>
            <TotalDaysEnrolled>29</TotalDaysEnrolled>
            <TotalDaysOfSuspension>0</TotalDaysOfSuspension>
            <TotalDaysPresent>29</TotalDaysPresent>
            <TotalExcusedAbsences>0</TotalExcusedAbsences>
            <TotalTardies>0</TotalTardies>
            <TotalUnExcusedAbsences>0</TotalUnExcusedAbsences>
            <WorkHabitsCode></WorkHabitsCode>
          </MarkingPeriodGrade>
          <MarkingPeriodGrade>
            <CitizenshipCode></CitizenshipCode>
            <Comment1Code></Comment1Code>
            <Comment2Code></Comment2Code>
            <Comment3Code></Comment3Code>
            <Credit>5</Credit>
            <Mark>A</Mark>
            <MarkingPeriod>2</MarkingPeriod>
            <SectionNumber>2257</SectionNumber>
            <TotalAbsences>0</TotalAbsences>
            <TotalDaysEnrolled>28</TotalDaysEnrolled>
            <TotalDaysOfSuspension>0</TotalDaysOfSuspension>
            <TotalDaysPresent>28</TotalDaysPresent>
            <TotalExcusedAbsences>0</TotalExcusedAbsences>
            <TotalTardies>0</TotalTardies>
            <TotalUnExcusedAbsences>0</TotalUnExcusedAbsences>
            <WorkHabitsCode></WorkHabitsCode>
          </MarkingPeriodGrade>
          …
          …
        </MarkingPeriodGrades>
        <Period>1</Period>
        <SchoolCode>994</SchoolCode>
        <TeacherName>Stockton</TeacherName>
        <TeacherNumber>804</TeacherNumber>
      </StudentReportCardCourse>
      …
      …
    </StudentReportCardCourses>
  </StudentReportCard>
  …
  …
</ArrayOfStudentReportCard>


Field Documentation:

Name
Aeries Table.Column
Description
PermanentID
STU.ID
The Permanent ID for the student
CourseID
GRD.CN
The District course ID
CourseTitle
CRS.CO
The title of the course
CitizenshipCode
GRH.CI
A code describing the student’s meeting of satisfactory citizenship for this marking period
Comment1Code
GRH.C1
A comment chosen by the teacher for this student for this marking period from a list of pre-defined comments
Comment2Code
GRH.C2
Additional comment
Comment3Code
GRH.C3
Additional comment
Credit
GRH.CR
The credits earned by this student for this course during this marking period
Mark
GRH.MK
The mark (e.g., “A”, “B+”) received. Note: For the current marking period only, the respective field from GRD.M1 – M12 will be used instead
MarkingPeriod

The marking period (1 – 12) for this grade reporting entry
SectionNumber
GRH.SE
The master schedule section number for this report card course
TotalAbsences
GRH.AB
The total number of days the student was absent from this class during this marking period
TotalDaysEnrolled
GRH.EN
The total number of days the student was enrolled in this class during this marking period
TotalDaysOfSuspension
GRH.SU
The total number of days the student was suspended from this class during this marking period
TotalDaysPresent
GRH.PR
The total number of days the student was present in this class during this marking period
TotalExcusedAbsences
GRH.EA
The total number of days the student had an excused absence from this class during this marking period
TotalTardies
GRH.TD
The total number of days the student was tardy to this class during this marking period
TotalUnExcusedAbsences
GRH.UA
The total number of days the student had an unexcused absence from this class during this marking period
WorkHabitsCode
GRH.WH
A code describing the student’s meeting of satisfactory work habits for this marking period
Period
GRD.PD
The class period (0 – 9)
SchoolCode
STU.SC
The Aeries school code
TeacherName
TCH.TE
The display name of the teacher
TeacherNumber
GRD.TN
The school-based teacher number


Note: For the current marking period, the “GRD” table will be used instead of the “GRH” table, so all references in Field Documentation to “GRH will be replaced with “GRD”. The current marking period can be identified by calling the “School Report Card Marking Periods” API


For descriptions of the various coded values, use our Code Sets API:

https://demo.aeries.net/aeries/api/v3/codes/ReportCard/Citizenship

https://demo.aeries.net/aeries/api/v3/codes/ReportCard/Comment1

https://demo.aeries.net/aeries/api/v3/codes/ReportCard/WorkHabits


School Report Card Marking Periods

Security Area:

  • "Grades"

URL(s):

  • /api/v3/schools/{SchoolCode}/ReportCardMarkingPeriods
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.

Notes:

  • This end point returns information about each Report Card Marking Period for the school and can be used to cross-reference with the “MarkingPeriod” number from the Student Report Cards API

Example School Report Card Marking Periods Results:

https://demo.aeries.net/aeries/api/v3/schools/994/ReportCardMarkingPeriods

<ArrayOfMarkingPeriodInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.GradeReporting">
  <MarkingPeriodInfo>
    <IsCurrentMarkingPeriod>false</IsCurrentMarkingPeriod>
    <LongDescription>First Quarter</LongDescription>
    <MarkingPeriod>1</MarkingPeriod>
    <ShortDescription>1st Qtr</ShortDescription>
  </MarkingPeriodInfo>
  <MarkingPeriodInfo>
    <IsCurrentMarkingPeriod>false</IsCurrentMarkingPeriod>
    <LongDescription>First Semester</LongDescription>
    <MarkingPeriod>2</MarkingPeriod>
    <ShortDescription>1st Sem</ShortDescription>
  </MarkingPeriodInfo>
  <MarkingPeriodInfo>
    <IsCurrentMarkingPeriod>false</IsCurrentMarkingPeriod>
    <LongDescription>Third Quarter</LongDescription>
    <MarkingPeriod>3</MarkingPeriod>
    <ShortDescription>3rd Qtr</ShortDescription>
  </MarkingPeriodInfo>
  …
  …
</ArrayOfMarkingPeriodInfo>


Field Documentation:

Name
Aeries Table.Column
Description
IsCurrentMarkingPeriod
Based on LOC.TM
True or False. Indicates whether this marking period is the school’s current marking period.
LongDescription
GRP.T#
(where # is 1-12)
The full description of the marking period
MarkingPeriod

The marking period (1 – 12)
ShortDescription
GRP.H# + “ “ + GRP.S#
(where # is 1-12)
The abbreviated description of the marking period. This is used as the column heading on the printed report card.


School Graduation Requirements

Security Area:

  • "Graduation Requirements"

URL(s):

  • /api/v3/schools/{SchoolCode}/GraduationRequirements
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.

Notes:

Example School Graduation Requirements Results:

https://demo.aeries.net/aeries/api/v3/schools/994/GraduationRequirements

<ArrayOfGraduationRequirementTracks xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.GradeReporting">
  <GraduationRequirementTracks>
    <GraduationRequirementTrack></GraduationRequirementTrack>
    <SchoolCode>994</SchoolCode>
    <SubjectAreas>
      <GraduationRequirements>
        <RequiredCreditFor10thGraders>40.0000</RequiredCreditFor10thGraders>
        <RequiredCreditFor11thGraders>40.0000</RequiredCreditFor11thGraders>
        <RequiredCreditFor12thGraders>40.0000</RequiredCreditFor12thGraders>
        <RequiredCreditFor9thGraders>40.0000</RequiredCreditFor9thGraders>
        <SubjectAreaCode>A</SubjectAreaCode>
        <SubjectAreaDescription>English</SubjectAreaDescription>
      </GraduationRequirements>
      <GraduationRequirements>
        <RequiredCreditFor10thGraders>20.0000</RequiredCreditFor10thGraders>
        <RequiredCreditFor11thGraders>20.0000</RequiredCreditFor11thGraders>
        <RequiredCreditFor12thGraders>30.0000</RequiredCreditFor12thGraders>
        <RequiredCreditFor9thGraders>20.0000</RequiredCreditFor9thGraders>
        <SubjectAreaCode>B</SubjectAreaCode>
        <SubjectAreaDescription>Physical Education</SubjectAreaDescription>
      </GraduationRequirements>
      <GraduationRequirements>
        <RequiredCreditFor10thGraders>30.0000</RequiredCreditFor10thGraders>
        <RequiredCreditFor11thGraders>30.0000</RequiredCreditFor11thGraders>
        <RequiredCreditFor12thGraders>30.0000</RequiredCreditFor12thGraders>
        <RequiredCreditFor9thGraders>30.0000</RequiredCreditFor9thGraders>
        <SubjectAreaCode>C</SubjectAreaCode>
        <SubjectAreaDescription>Social Science</SubjectAreaDescription>
      </GraduationRequirements>
      …
      …
    </SubjectAreas>
  </GraduationRequirementTracks>
  …
  …
</ArrayOfGraduationRequirementTracks>


Field Documentation:

Name
Aeries Table.Column
Description
GraduationRequirementTrack
REQ.GRT
The Graduation Track to which this requirement applies. Graduation Tracks can be used to establish different graduation requirements for specific groups of students and are also used to separate specific groups of students for class rank/size calculations.
SchoolCode
REQ.SC
The Aeries school code
RequiredCreditFor10thGraders
REQ.C3
The number of course credits required in this subject area for students currently in grade 10
RequiredCreditFor11thGraders
REQ.C2
The number of course credits required in this subject area for students currently in grade 11
RequiredCreditFor12thGraders
REQ.C1
The number of course credits required in this subject area for students currently in grade 12
RequiredCreditFor9thGraders
REQ.C4
The number of course credits required in this subject area for students currently in grade 9
SubjectAreaCode
REQ.CD
The subject area code (single character) for this requirement
SubjectAreaDescription
REQ.SA
The name/description of the subject area for this requirement


Student Graduation Status Summary

Security Area:

  • "Graduation Status"

URL(s):

  • /api/v3/schools/{SchoolCode}/GraduationStatusSummary/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – the Aeries Student District Permanent ID Number.
  • /api/v3/schools/{SchoolCode}/GraduationStatusSummary/grade/{GradeLevel}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • GradeLevel (required) – the academic grade level of the set of students to return.

Query String Filters:

  • StartingRecord – (numeric) The Record-Count value of the first record to return (inclusive).
  • EndingRecord – (numeric) The Record-Count value of the last record to return (inclusive).

Notes:

  • If StudentID is not passed, all students in the selected school will be returned.

Example Student Graduation Status Summary Results:

https://demo.aeries.net/aeries/api/v3/schools/994/GraduationStatusSummary/grade/12

<ArrayOfGraduationStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.GradeReporting">
  <GraduationStatus>
    <GraduationRequirementTrack></GraduationRequirementTrack>
    <PermanentID>99400001</PermanentID>
    <SchoolCode>994</SchoolCode>
    <SubjectAreas>
      <SubjectArea>
        <CreditsCompleted>35</CreditsCompleted>
        <CreditsCurrentlyEnrolled>5</CreditsCurrentlyEnrolled>
        <CreditsNeeded>0.0000</CreditsNeeded>
        <CreditsRequired>40.0000</CreditsRequired>
        <SubjectAreaCode>A</SubjectAreaCode>
        <SubjectAreaDescription>English</SubjectAreaDescription>
      </SubjectArea>
      <SubjectArea>
        <CreditsCompleted>30</CreditsCompleted>
        <CreditsCurrentlyEnrolled>0</CreditsCurrentlyEnrolled>
        <CreditsNeeded>0.0000</CreditsNeeded>
        <CreditsRequired>30.0000</CreditsRequired>
        <SubjectAreaCode>B</SubjectAreaCode>
        <SubjectAreaDescription>Physical Education</SubjectAreaDescription>
      </SubjectArea>
      …
      …
    </SubjectAreas>
  </GraduationStatus>
  …
  …
</ArrayOfGraduationStatus>


Field Documentation:

Name
Aeries Table.Column
Description
GraduationRequirementTrack
STU.GRT
The Graduation Track to which this student belongs (if any). Graduation Tracks can be used to establish different graduation requirements for specific groups of students and are also used to separate specific groups of students for class rank/size calculations.
PermanentID
STU.ID
The Permanent ID for the student
SchoolCode
STU.SC
The Aeries school code
CreditsCompleted
* See notes below
The number of credits the student has completed in this subject area.
CreditsCurrentlyEnrolled
* See notes below
The number of credits in this subject area in which the student is currently enrolled.
CreditsNeeded
* See notes below
The number of credits in this subject area that the student still needs.
CreditsRequired
REQ.C# (where # is 1 – 4)
The credits required in this subject area based on the student’s grade level.
Grade 9 = C4
Grade 10 = C3
Grade 11 = C2
Grade 12 = C1
SubjectAreaCode
REQ.CD
The subject area code (single character)
SubjectAreaDescription
REQ.SA
The name/description of the subject area

* These values are based on calculations for which the logic is too complex to detail in this document.


Note: Excess credits in a subject area are always allocated to the “Electives” subject area. Therefore, CreditsCompleted will never exceed CreditsRequired except possibly in the “Electives” subject area.


Student Transcripts

Security Area:

  • "Transcripts"

URL(s):

  • /api/v3/schools/{SchoolCode}/Transcript/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Query String Filters:

  • StartingStudent – (numeric) The Record-Count value of the first record to return (inclusive).
  • EndingStudent – (numeric) The Record-Count value of the last record to return (inclusive).

Notes:

  • If StudentID is not passed, all students in the selected school will be returned.

Example Student Transcripts Results:

https://demo.aeries.net/aeries/api/v3/schools/994/Transcript

<ArrayOfTranscript xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.GradeReporting">
  <Transcript>
    <CourseGrades>
      <TranscriptCourseGrade>
        <CitizenshipMark>O</CitizenshipMark>
        <CourseID>100386</CourseID>
        <CreditAttempted>0.0000</CreditAttempted>
        <CreditCompleted>0.0000</CreditCompleted>
        <Mark>B</Mark>
        <RepeatTagCode></RepeatTagCode>
        <SchoolTakenID>993</SchoolTakenID>
        <SchoolTakenName>Bald Eagle Intermediate School</SchoolTakenName>
        <SchoolTakenStateID>65999999999993</SchoolTakenStateID>
        <SchoolYear>2012-2013</SchoolYear>
        <SectionNumber>0</SectionNumber>
        <SequenceNumber>35</SequenceNumber>
        <StaffID>0</StaffID>
        <StudentGrade>8</StudentGrade>
        <Term>1</Term>
        <TermDescription>Fall</TermDescription>
        <TotalAbsences>0</TotalAbsences>
        <TotalDaysEnrolled>89</TotalDaysEnrolled>
        <TotalDaysOfSuspension>0</TotalDaysOfSuspension>
        <TotalDaysPresent>89</TotalDaysPresent>
        <TotalExcusedAbsences>0</TotalExcusedAbsences>
        <TotalTardies>0</TotalTardies>
        <TotalUnExcusedAbsences>0</TotalUnExcusedAbsences>
        <TranscriptCourseTitle></TranscriptCourseTitle>
      </TranscriptCourseGrade>
      …
      …
    </CourseGrades>
    <PermanentID>99400001</PermanentID>
    <SchoolCode>994</SchoolCode>
  </Transcript>
  …
  …
</ArrayOfTranscript>


Field Documentation:

Name
Aeries Table.Column
Description
CitizenshipMark
HIS.CI
The mark the student received for the meeting of satisfactory citizenship.
CourseID
HIS.CN
The District course ID of the course taken
CreditAttempted
HIS.CR
The number of credits the student attempted
CreditCompleted
HIS.CC
The number of credits the student earned
Mark
HIS.MK
The mark (e.g., “A”, “B+”) received.
RepeatTagCode
HIS.RT
If this record represents a repeated course, this code indicates whether the repeat counts toward the student’s total Credit Attempted, Credit Completed, and the GPA calculation.
SchoolTakenID
HIS.ST
An identifier for the school at which this course was taken. For courses taken within the current district, this will usually match the respective Aeries school code.
SchoolTakenName
CHI.NM
The name of the school at which this course was taken
SchoolTakenStateID
CHI.ID
The state school ID (e.g., CDS code) for the school at which this course was taken.
SchoolYear
Based on HIS.YR
The school year when the course was taken (e.g., “2016-2017”)
SectionNumber
HIS.SE
The master schedule section number of the course taken
SequenceNumber
HIS.SQ
The sequence number is part of the primary key. It has no independent meaning.
StaffID
HIS.SID
The Aeries staff ID of the teacher who taught the course taken
StudentGrade
HIS.GR
The student’s grade level at the time the course was taken
Term
HIS.TE
The term during which the course was taken
TermDescription
TDF.S# (where # is 0 – 8)
The description for the Term.
TotalAbsences
HIS.AB
The total number of days the student was absent from this class during the term taken
TotalDaysEnrolled
HIS.EN
The total number of days the student was enrolled in this class during the term taken
TotalDaysOfSuspension
HIS.SU
The total number of days the student was suspended from this class during the term taken
TotalDaysPresent
HIS.PR
The total number of days the student was present in this class during the term taken
TotalExcusedAbsences
HIS.EA
The total number of days the student had an excused absence from this class during the term taken
TotalTardies
HIS.TD
The total number of days the student was tardy to this class during the term taken
TotalUnExcusedAbsences
HIS.UA
The total number of days the student had an unexcused absence from this class during the term taken
TranscriptCourseTitle
HIS.CO
The title of the course to be printed on the transcript, if different from the District’s course title. This is typically populated when the course was taken at a different district so the other district’s exact course title can be used. This should generally be blank for courses taken inside the District.
PermanentID
HIS.PID / STU.ID
The Permanent ID for the student
School Code
STU.SC
The Aeries school code

For descriptions of the "RepeatTag" Codes, use our "Code Sets" API:

https://demo.aeries.net/aeries/api/v3/codes/Transcript/RepeatTag


Scheduling

 

Student Class Schedule

Security Area:

  • "Class Schedules/History"

URL(s):

  • /api/schools/{SchoolCode}/classes/{StudentID}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (optional) – The Aeries Student District Permanent ID Number.

Notes:

  • If Student ID is not passed, all classes for all students for the given school will be returned.
  • When this information is requested before the beginning of the school year, the SequenceNumber and SectionNumber values will match.
  • Be aware that Class Schedules are highly prone to large scale adjustments before the start of school through the first 2 weeks of the school year.

Example Student Class Schedule Results:

https://demo.aeries.net/aeries/api/schools/994/classes

<ArrayOfStudentClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.Models.Scheduling">
  <StudentClass>
    <CourseID>0674</CourseID>
    <DateEnded>2017-08-04T00:00:00</DateEnded>
    <DateStarted>2016-07-11T00:00:00</DateStarted>
    <Period>0</Period>
    <PeriodBlock>1</PeriodBlock>
    <PermanentID>99400003</PermanentID>
    <SchoolCode>994</SchoolCode>
    <SectionNumber>108</SectionNumber>
    <SequenceNumber>5</SequenceNumber>
    <TeacherNumber>713</TeacherNumber>
  </StudentClass>
  …
  …
</ArrayOfStudentClass>


Field Documentation:

Name
Aeries Table.Column
Description
CourseID
CAR.CN
The District course ID
DateEnded
CAR.DE
The date the student’s enrollment in this class ended
DateStarted
CAR.DS
The date the student’s enrollment in this class started
Period
CAR.PD
The period (0 – 9) this class meets
PeriodBlock
CAR.BL
If the class spans multiple consecutive periods, this value will be greater than 1. E.g., if Period is 3 and PeriodBlock is 2, then the class spans period 3 – 4.
PermanentID
STU.ID
The Permanent ID for the student
SchoolCode
CAR.SC
The Aeries school code
SectionNumber
CAR.SE
The section number for this class from the master schedule
SequenceNumber
CAR.SQ
The sequence number is part of the primary key. It has no independent meaning.
TeacherNumber
CAR.TN
The school-specific teacher number for the primary teacher of this class.


Note: Before the CAR (Course Attendance Record) table is initialized at the beginning of the school year, data will be pulled from a join of SEC (Student Class Sections), MST (Master Schedule), and TRM (Terms) instead.


Course Information

Security Area:

  • "Course Data"

URL(s):

  • /api/courses/{CourseID}
    • CourseID (optional) – The Aeries Course ID (alphanumeric).

Notes:

  • If Course ID is not passed, all courses in the district will be returned.

Example Multiple Course Information Results:

https://demo.aeries.net/aeries/api/courses

<ArrayOfCourse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.Models.Scheduling">
  <Course>
    <CSFCourseList>A</CSFCourseList>
    <CSU_Rule_CanBeAnElective>G</CSU_Rule_CanBeAnElective>
    <CSU_Rule_HonorsCode></CSU_Rule_HonorsCode>
    <CSU_Rule_ValidationLevelCode></CSU_Rule_ValidationLevelCode>
    <CSU_SubjectAreaCode>C</CSU_SubjectAreaCode>
    <CollegePrepIndicatorCode>P</CollegePrepIndicatorCode>
    <ContentDescription></ContentDescription>
    <CreditDefault>5.0000</CreditDefault>
    <CreditMax>10.0000</CreditMax>
    <DepartmentCode>M</DepartmentCode>
    <HighGrade>12</HighGrade>
    <ID>0618</ID>
    <InactiveStatusCode></InactiveStatusCode>
    <LongDescription>PreCalculus</LongDescription>
    <LowGrade>10</LowGrade>
    <NonAcademicOrHonorsCode></NonAcademicOrHonorsCode>
    <Notes></Notes>
    <PhysicalEducationIndicator>false</PhysicalEducationIndicator>
    <StateCourseCode>2498</StateCourseCode>
    <SubjectArea1Code>D</SubjectArea1Code>
    <SubjectArea2Code>J</SubjectArea2Code>
    <SubjectArea3Code> </SubjectArea3Code>
    <TeacherAideIndicator>false</TeacherAideIndicator>
    <TermTypeCode>Y</TermTypeCode>
    <Title>PreCalculus</Title>
    <UC_Rule_CanBeAnElective>G</UC_Rule_CanBeAnElective>
    <UC_Rule_HonorsCode></UC_Rule_HonorsCode>
    <UC_Rule_ValidationLevelCode>0</UC_Rule_ValidationLevelCode>
    <UC_SubjectAreaCode>C</UC_SubjectAreaCode>
  </Course>
  …
  …
</ArrayOfCourse>


Example Single Course Information Results:

https://demo.aeries.net/aeries/api/courses/0618

<Course xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.Models.Scheduling">
  <CSFCourseList>A</CSFCourseList>
  …
  <UC_SubjectAreaCode>C</UC_SubjectAreaCode>
</Course>


Field Documentation:

Name
Aeries Table.Column
Description
CSFCourseList
CRS.C1
The standardized list from the California Scholarship Federation to which this course belongs.
CSU_Rule_CanBeAnElective
CRS.CSE
If flagged with a ‘G’ this course can roll into CSU
Electives when the assigned subject area is full.
CSU_Rule_HonorsCode
CRS.CSH
If flagged with ‘H’ this course is counted as an honors course for purposes of CSU Eligibility.
CSU_Rule_ValidationLevelCode
CRS.VL
Course Validation Level is allowed by CSU for certain flexibilities when evaluating whether or not a student has completed a particular subject and gained requirements necessary to enter college.
CSU_SubjectAreaCode
CRS.E1
The Subject Area that this course will count toward for completing the CSU entrance requirements.
CollegePrepIndicatorCode
CRS.CP
Indicates whether the course is counted as a college preparatory course.
ContentDescription
CRS.CD
More detailed description of the course and/or the course content.
CreditDefault
CRS.CR
Default number of credits that a student will receive by passing this course
CreditMax
CRS.MC
Maximum Credit that a student can receive by taking this course multiple times.
DepartmentCode
CRS.DC
The department code allows sorting reports by department, such as English.
HighGrade
CRS.HI
Highest grade level that would normally take this course. Used in Scheduling to prevent students outside the grade range from being scheduled into the class.
ID
CRS.CN
Identification assigned to a course that can be up to 6 characters in length. The ID can contain letters and/or numbers, for example ENG123 but MUST not start with a space or special character, such as an asterisk *
InactiveStatusCode
CRS.TG
Any non-blank value will inactivate the course and prevent sections from being added to the Master Schedule and Scheduling Master Schedule.
LongDescription
CRS.DE
The long course title (max 30 characters)
LowGrade
CRS.LO
Lowest grade level that would normally take this course. Used in Scheduling to prevent students outside the Grade Range from being scheduled into the class.
NonAcademicOrHonorsCode
CRS.NA
Indicates whether the course is a (N) Non Academic or (H) Honors.
Notes
CRS.CM
Free-text note about this course
PhysicalEducationIndicator
CRS.PE
Indicates whether this course is a physical education course. Primarily used to single out the PE teacher among all a student’s teachers for purposes of entering Physical Fitness Test data.
StateCourseCode
CRS.C3
Specific code assigned to courses by the California Department of Education that corresponds to the content of the course.
SubjectArea1Code
CRS.S1
The first Graduation Requirements subject area that this course satisfies. Code description can be found through the Graduation Requirements API
SubjectArea2Code
CRS.S2
The second Graduation Requirements subject area that this course satisfies if all requirements have been met for the S1 subject area. Code description can be found through the Graduation Requirements API
SubjectArea3Code
CRS.S3
The third Graduation Requirements subject area that this course satisfies if all requirements have been met for the S1 and S2 subject areas. Code description can be found through the Graduation Requirements API
TeacherAideIndicator
CRS.TA
Indicates whether the course is a Teacher Aide course. Many reports within Aeries give users the option to skip TA courses.
TermTypeCode
CRS.TM
Indicates the length of a given course.
Title
CRS.CO
The short course title (max 15 characters)
UC_Rule_CanBeAnElective
CRS.U2
If flagged with a ‘G’ this course can roll into UC
Electives when the assigned subject area is full.
UC_Rule_HonorsCode
CRS.U3
If flagged with ‘H’ this course is counted as an honors course for purposes of UC Eligibility.
UC_Rule_ValidationLevelCode
CRS.VLU
Course Validation Level is allowed by UC for certain flexibilities when evaluating whether or not a student has completed a particular subject and gained requirements necessary to enter college.
UC_SubjectAreaCode
CRS.U1
The Subject Area that this course will count toward for completing the UC entrance requirements.

For descriptions of the various coded fields, use our "Code Sets" API:

https://demo.aeries.net/aeries/api/v3/codes/Courses/CSFCourseLIst

https://demo.aeries.net/aeries/api/v3/codes/Courses/CSU_Elective

https://demo.aeries.net/aeries/api/v3/codes/Courses/CSU_Honors

https://demo.aeries.net/aeries/api/v3/codes/Courses/CSU_ValidationLevel

https://demo.aeries.net/aeries/api/v3/codes/Courses/CSU_SubjectArea

https://demo.aeries.net/aeries/api/v3/codes/Courses/CollegePrepIndicator

https://demo.aeries.net/aeries/api/v3/codes/Courses/Department

https://demo.aeries.net/aeries/api/v3/codes/Courses/NonAcademicOrHonors

https://demo.aeries.net/aeries/api/v3/codes/Courses/StateCourse

https://demo.aeries.net/aeries/api/v3/codes/Courses/TermType

https://demo.aeries.net/aeries/api/v3/codes/Courses/UC_Elective

https://demo.aeries.net/aeries/api/v3/codes/Courses/UC_Honors

[UC_ValidationLevel uses the same code set as CSU_Validation_Level]

https://demo.aeries.net/aeries/api/v3/codes/Courses/UC_SubjectArea


Course Data Changes

Security Area:

  • "Course Data"

URL(s):

  • /api/v2/CourseDataChanges/{year}/{month}/{day}/{hour}/{minute}
    • year, month, day, hour, minute – required – The parts of the Date/Time from which you want to system to return courses with data changes. All parameters are required although 0 is valid for hour and minute. Valid values for "hour" are 0-23. "AM" and "PM" values are invalid

Notes:

  • This should be used for advanced interfaces with Aeries where you may be pulling data hourly or daily and want to only get the changes since the last time you pulled data from the Aeries API. After you get the list of courses with changes, you will have to loop through the dataset and call the Course Information API one record at a time.

Example Course Data Changes Results:

https://demo.aeries.net/aeries/api/v2/CourseDataChanges/2016/8/1/0/0

<ArrayOfCourseKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v2.Models.Scheduling">
  <CourseKey>
    <ID>0013</ID>
  </CourseKey>
  <CourseKey>
    <ID>0720</ID>
  </CourseKey>
  <CourseKey>
    <ID>0899</ID>
  </CourseKey>
  <CourseKey>
    <ID>0902</ID>
  </CourseKey>
  …
  …
</ArrayOfCourseKey>


Staff Information

Security Area:

  • "Staff Data"

URL(s):

  • /api/v3/staff/{StaffID}
    • StaffID (optional) – The Aeries District Staff ID (numeric).

Query String Filters:

  • Most fields below can be passed as query string filters to limit the records returned.
    • Example: ?primaryaeriesschool=994&fulltimepercentage=100
    • Example: ?username=JohnSmith
    • The date fields will accept “null” as a comparison; e.g., ?leavedate=null

Notes:

  • If Staff ID is not passed, all staff records in the district will be returned.

Example Staff Information Results:

https://demo.aeries.net/aeries/api/v3/staff

<ArrayOfStaff xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Scheduling">
  <Staff>
    <AlternateEmailAddress></AlternateEmailAddress>
    <BirthDate i:nil="true" />
    <BirthYear>1962</BirthYear>
    <CellPhone></CellPhone>
    <EmailAddress>teacher@aeries.com</EmailAddress>
    <ExtendedProperties>
      <ExtendedProperty>
        <Name>AllowPostingToStaffSpecificSchoolLevelCommunicationGroups</Name>
        <Value>True</Value>
      </ExtendedProperty>
    </ExtendedProperties>
    <FirstName>Heather</FirstName>
    <FullTimePercentage>100</FullTimePercentage>
    <HireDate>2007-08-31T00:00:00</HireDate>
    <HumanResourcesSystemID></HumanResourcesSystemID>
    <ID>994605</ID>
    <InactiveStatusCode> </InactiveStatusCode>
    <LastName>Acosta</LastName>
    <LeaveDate i:nil="true" />
    <MiddleName></MiddleName>
    <NetworkLoginID></NetworkLoginID>
    <NotificationPreferenceCode>1</NotificationPreferenceCode>
    <PrimaryAeriesSchool>994</PrimaryAeriesSchool>
    <SchoolAccessPermissions>
      <SchoolAccessPermission>
        <CommunicationGroup>true</CommunicationGroup>
        <ReadOnlyAccess>false</ReadOnlyAccess>
        <SchoolCode>994</SchoolCode>
      </SchoolAccessPermission>
      …
      …
    </SchoolAccessPermissions>
    <Sex>F</Sex>
    <StateEducatorID></StateEducatorID>
    <Title></Title>
    <UserName>teacher</UserName>
  </Staff>
  …
  …
</ArrayOfStaff>


Field Documentation:

Name
Aeries Table.Column
Description
AlternateEmailAddress
STF.AEM
An alternate email address.
BirthDate
STF.BD
Date of Birth
BirthYear
STF.BY
(obsolete) Year of birth
CellPhone
STF.CP
Mobile phone number
EmailAddress
UGN.EM
The staff member’s email address. (Will pull from STF.EM is UGN.EM is blank)
FirstName
STF.FN
The staff member’s first name
FullTimePercentage
STF.TP
The staff member’s full-time employment percentage
HireDate
STF.HD
The staff member’s hire date
HumanResourcesSystemID
STF.HRID
An identifier for the staff member in an external Human Resources management system. While Aeries staff IDs are numeric, this field accepts all text characters.
ID
STF.ID
The Aeries District Staff ID
InactiveStatusCode
STF.TG
Any value other than blank indicates the staff member is inactive.
LastName
STF.LN
The staff member’s last name
LeaveDate
STF.LD
The date the staff member’s employment terminated.
MiddleName
STF.MN
The staff member’s middle name
NetworkLoginID
STF.NID
The staff member’s network login ID. This may be used by the district for any purpose they choose, such as an Active Directory account.
NotificationPreferenceCode
STF.NP
The staff member’s Aeries Comunications notification preference.
PrimaryAeriesSchool
STF.PSC
The Aeries school code of the school where the staff member is primarily employed.
CommunicationGroup
USR.CG
Indicates whether the user should be included in school-wide communications for this school in the Aeries Communications system.
ReadOnlyAccess
USR.RO
Indicates whether this user has read-only access to the Aeries system for this school code. If True, the user is not permitted to make ANY changes to data when logged-in to this school code.
SchoolCode
USR.SC
The Aeries school code to which this user has access.
Sex
STF.SX
The staff member’s sex (M or F)
StateEducatorID
STF.SID
For certificated employees, the Statewide Educator ID issued by the state authority.
Title
STF.TI
The staff member’s title.
UserName
UGN.UN
The staff member’s username for the Aeries SIS.

Extended Properties:

  • CommunicationDistrictAdmin
  • AllowPostingToGeneralDistrictLevelCommunicationGroups
  • AllowPostingToGeneralSchoolLevelCommunicationGroups
  • AllowPostingToStaffSpecificDistrictLevelCommunicationGroups
  • AllowPostingToStaffSpecificSchoolLevelCommunicationGroups


Staff Data Changes

Security Area:

  • "Staff Data"

URL(s):

  • /api/v2/StaffDataChanges/{year}/{month}/{day}/{hour}/{minute}
    • year, month, day, hour, minute – required – The parts of the Date/Time from which you want to system to return staff with data changes. All parameters are required although 0 is valid for hour and minute. Valid values for "hour" are 0-23. "AM" and "PM" values are invalid

Notes:

  • This should be used for advanced interfaces with Aeries where you may be pulling data hourly or daily and want to only get the changes since the last time you pulled data from the Aeries API. After you get the list of staff with changes, you will have to loop through the dataset and call the Staff Information API one record at a time.

Example Staff Data Changes Results:

https://demo.aeries.net/aeries/api/v2/StaffDataChanges/2016/7/1/0/0

<ArrayOfStaffKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v2.Models.Scheduling">
  <StaffKey>
    <ID>19785</ID>
  </StaffKey>
  <StaffKey>
    <ID>990001</ID>
  </StaffKey>
  <StaffKey>
    <ID>990002</ID>
  </StaffKey>
  <StaffKey>
    <ID>990003</ID>
  </StaffKey>
  …
  …
</ArrayOfStaffKey>


Teacher Information

Security Area:

  • "Teacher Data"

URL(s):

  • /api/schools/{SchoolCode}/teachers/{TeacherNumber}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • TeacherNumber (optional) – the School-Based Aeries Teacher Number.

Notes:

  • If Teacher Number is not passed, all teacher records in the given school will be returned.

Example Multiple Teacher Information Results:

https://demo.aeries.net/aeries/api/schools/994/teachers

<ArrayOfTeacher xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.Models.Scheduling">
  <Teacher>
    <DisplayName>Aldrich</DisplayName>
    <EmailAddress>Teacher601@example.com</EmailAddress>
    <FirstName>Heidi</FirstName>
    <HighlyQualifiedStatusCode1></HighlyQualifiedStatusCode1>
    <HighlyQualifiedStatusCode2></HighlyQualifiedStatusCode2>
    <HighlyQualifiedStatusCode3></HighlyQualifiedStatusCode3>
    <InactiveStatusCode>I</InactiveStatusCode>
    <LastName></LastName>
    <Room></Room>
    <SchoolCode>994</SchoolCode>
    <StaffID1>994601</StaffID1>
    <StaffID2>0</StaffID2>
    <StaffID3>0</StaffID3>
    <StateCourseCode></StateCourseCode>
    <TeacherNumber>601</TeacherNumber>
  </Teacher>
  …
  …
</ArrayOfTeacher>


Example Single Teacher Information Results:

https://demo.aeries.net/aeries/api/schools/994/teachers/605

<Teacher xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.Models.Scheduling">
  <DisplayName>Acosta</DisplayName>
  <EmailAddress>Teacher605@example.com</EmailAddress>
  <FirstName>Heather</FirstName>
  <HighlyQualifiedStatusCode1></HighlyQualifiedStatusCode1>
  <HighlyQualifiedStatusCode2></HighlyQualifiedStatusCode2>
  <HighlyQualifiedStatusCode3></HighlyQualifiedStatusCode3>
  <InactiveStatusCode></InactiveStatusCode>
  <LastName></LastName>
  <Room>12</Room>
  <SchoolCode>994</SchoolCode>
  <StaffID1>994605</StaffID1>
  <StaffID2>0</StaffID2>
  <StaffID3>0</StaffID3>
  <StateCourseCode></StateCourseCode>
  <TeacherNumber>605</TeacherNumber>
</Teacher>


Field Documentation:

Name
Aeries Table.Column
Description
DisplayName
TCH.TE
The display name for the teacher that is used throughout the Aeries system. This may be different from the teacher’s actual first and last name.
EmailAddress
TCH.EM
The teacher’s email address.
FirstName
TCH.TF
The teacher’s first name
HighlyQualifiedStatusCode1
TCH.HQT
For self-contained elementary classroom teachers, the method by which the teacher associated with Staff ID 1 became Highly Qualified
HighlyQualifiedStatusCode2
TCH.HQ2
For self-contained elementary classroom teachers, the method by which the teacher associated with Staff ID 2 became Highly Qualified
HighlyQualifiedStatusCode3
TCH.HQ3
For self-contained elementary classroom teachers, the method by which the teacher associated with Staff ID 3 became Highly Qualified
InactiveStatusCode
TCH.TG
Any value other than blank indicates that this teacher is inactive. Inactive teachers should have no active class sections and no students.
LastName
TCH.TLN
The teacher’s last name
Room
TCH.RM
The teacher’s room number
SchoolCode
TCH.SC
The Aeries school code
StaffID1
TCH.ID
The teacher’s staff ID
StaffID2
TCH.ID2
For team teaching, the 2nd teacher’s staff ID
StaffID3
TCH.ID3
For team teaching, the 3rd teacher’s staff ID
StateCourseCode
TCH.CB
For elementary schools without a master schedule, this value will be used when reporting course section enrollment to the state. If the school has a master schedule, the value will be taken from the Courses table instead.
TeacherNumber
TCH.TN
The school-based Aeries teacher number

For descriptions of the “HighlyQualifiedStatus” codes, use our “Code Sets” API:

https://demo.aeries.net/aeries/api/v3/codes/Teachers/HighlyQualifiedStatusCode1


Staff-Teacher Information

Security Area:

  • "Teacher Data"

URL(s):

  • /api/v2/staff/{StaffID}/teachers
    • StaffID (required) – The Aeries District Staff ID (numeric).

Notes:

  • This end point will return a list of teacher records associated with the given Staff ID.

Example Staff-Teacher Information Results:

https://demo.aeries.net/aeries/api/v2/staff/994605/teachers

<ArrayOfTeacher xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.Models.Scheduling">
  <Teacher>
    <DisplayName>Acosta</DisplayName>
    <EmailAddress>Teacher605@example.com</EmailAddress>
    <FirstName>Heather</FirstName>
    <HighlyQualifiedStatusCode1></HighlyQualifiedStatusCode1>
    <HighlyQualifiedStatusCode2></HighlyQualifiedStatusCode2>
    <HighlyQualifiedStatusCode3></HighlyQualifiedStatusCode3>
    <InactiveStatusCode></InactiveStatusCode>
    <LastName></LastName>
    <Room>12</Room>
    <SchoolCode>994</SchoolCode>
    <StaffID1>994605</StaffID1>
    <StaffID2>0</StaffID2>
    <StaffID3>0</StaffID3>
    <StateCourseCode></StateCourseCode>
    <TeacherNumber>605</TeacherNumber>
  </Teacher>
  …
  …
</ArrayOfTeacher>


Field Documentation:

(Same as Teacher Information field documentation above)


Section (from Master Schedule)

Security Area:

  • "Master Schedule"

URL(s):

  • /api/v3/schools/{SchoolCode}/sections/{SectionNumber}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • SectionNumber (optional) – The school-based Aeries section number.

Notes:

  • If Section Number is not passed, all section records in the master schedule of the given school will be returned.

Example Multiple Section (from Master Schedule) Results:

https://demo.aeries.net/aeries/api/v3/schools/994/sections

<ArrayOfMasterScheduleSection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Scheduling">
  <MasterScheduleSection>
    <CareerTechnicalEducationProviderCode></CareerTechnicalEducationProviderCode>
    <ClassID>0</ClassID>
    <CountsForADA></CountsForADA>
    <CourseID>0304</CourseID>
    <Credit>5.0000</Credit>
    <Days>MTWTF</Days>
    <DistanceLearningIndicator></DistanceLearningIndicator>
    <EducationServiceCode>4</EducationServiceCode>
    <ExclusionCode></ExclusionCode>
    <FundingSourceCode></FundingSourceCode>
    <GenderRestriction></GenderRestriction>
    <HighGrade>12</HighGrade>
    <HighlyQualifiedStatusCode1>H</HighlyQualifiedStatusCode1>
    <HighlyQualifiedStatusCode2></HighlyQualifiedStatusCode2>
    <HighlyQualifiedStatusCode3></HighlyQualifiedStatusCode3>
    <HourlyAttendanceProgramCode></HourlyAttendanceProgramCode>
    <InactiveStatusCode></InactiveStatusCode>
    <IndependentStudyIndicator></IndependentStudyIndicator>
    <InstructionalStrategyCode>500</InstructionalStrategyCode>
    <LanguageOfInstructionCode>00</LanguageOfInstructionCode>
    <LowGrade>11</LowGrade>
    <MaxStudents>38</MaxStudents>
    <MultiTeacherCode></MultiTeacherCode>
    <Period>0</Period>
    <PeriodBlock>1</PeriodBlock>
    <ProgramCode></ProgramCode>
    <Room>CD3</Room>
    <SchedulingGroup></SchedulingGroup>
    <SchoolCode>994</SchoolCode>
    <SectionNumber>43</SectionNumber>
    <Semester>Y</Semester>
    <SemesterGroup></SemesterGroup>
    <TeacherNumber1>816</TeacherNumber1>
    <TeacherNumber2>0</TeacherNumber2>
    <TeacherNumber3>0</TeacherNumber3>
    <TeamCourseGroup></TeamCourseGroup>
    <TeamNumber>0</TeamNumber>
    <TotalBoys>21</TotalBoys>
    <TotalGirls>17</TotalGirls>
    <TotalStudents>38</TotalStudents>
    <Track></Track>
    <UserCode1></UserCode1>
    <UserCode2></UserCode2>
    <UserCode3></UserCode3>
    <UserCode4></UserCode4>
    <UserCode5></UserCode5>
    <UserCode6></UserCode6>
    <UserCode7></UserCode7>
    <UserCode8></UserCode8>
  </MasterScheduleSection>
  …
  …
</ArrayOfMasterScheduleSection>


Example Single Section (from Master Schedule) Results:

https://demo.aeries.net/aeries/api/v3/schools/994/sections/1038

<MasterScheduleSection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Models.Scheduling">
  <CareerTechnicalEducationProviderCode></CareerTechnicalEducationProviderCode>
  …
  <UserCode8></UserCode8>
</MasterScheduleSection>


Field Documentation:

Name
Aeries Table.Column
Description
CareerTechnicalEducationProviderCode
MST.TEP
Indicates what entity is providing the Career Technical Education class (e.g., “ROP” or “District”)
ClassID
MST.CID
This field is used to identify separate sections as an individual "Class". The Class Size Reduction Reports use the Class ID field.
CountsForADA
MST.ADA
Sections tagged with “N” will not affect the running of the Mass Change All Day Code process when requiring an absence in every period.
CourseID
MST.CN
The Aeries District Course ID
Credit
MST.CR
The number of credits a student will receive for taking this section.
Days
MST.DY
The days of the week this class meets
DistanceLearningIndicator
MST.DLI
Indicates whether this section is offered through distance learning (e.g., online course).
EducationServiceCode
MST.ESR
The type of education service provided to English Learners in this class
ExclusionCode
MST.ST
Whether this section should be excluded from grades and/or attendance reporting
FundingSourceCode
MST.FS
The funding source for this section (e.g., California Partnership Academy)
GenderRestriction
MST.SX
This section is restricted to students of a particular gender
HighGrade
MST.HI
The highest grade level of students who would normally take this section.
HighlyQualifiedStatusCode1
MST.HQT
The method by which the primary teacher became Highly Qualified to teach this subject
HighlyQualifiedStatusCode2
MST.HQ2
For team teaching/job sharing, the method by which Teacher 2 became Highly Qualified to teach this subject
HighlyQualifiedStatusCode3
MST.HQ3
For team teaching/job sharing, the method by which Teacher 3 became Highly Qualified to teach this subject
HourlyAttendanceProgramCode
MST.HP
(no longer used) Was used in summer schools for funding purposes.
InactiveStatusCode
MST.STG
Any value other than blank indicates this section is inactive. Inactive sections should not have any students enrolled.
IndependentStudyIndicator
MST.ISI
Indicates whether this is an independent study class
InstructionalStrategyCode
MST.INS
The instructional strategy used in this class for specific student groups such English Learners or special education students
LanguageOfInstructionCode
MST.LI
The language in which this class is taught.
LowGrade
MST.LO
The lowest grade level of students who would normally take this section.
MaxStudents
MST.MX
The maximum number of students who can enroll in this section (i.e., class capacity).
MultiTeacherCode
MST.MTS
The type of multi-teacher configuration for this section (such as team teaching or job sharing)
Period
MST.PD
The period (0 – 9) this class meets
PeriodBlock
MST.BL
If the class spans multiple consecutive periods, this value will be greater than 1. E.g., if Period is 3 and PeriodBlock is 2, then the class spans period 3 – 4.
ProgramCode
MST.PR
Special program related to this section. Certain reports in Aeries can be limited by special program.
Room
MST.RM
The room number in which this class meets
SchedulingGroup
MST.SG
The Scheduling Group for this section. This is used to create scheduling restrictions and is used in conjunction with the student’s Scheduling Group (see Student Information Extended). Students with a blank scheduling group cannot be scheduled into sections with a non-blank scheduling group, and students with a non-blank scheduling group can only be scheduled into sections with the same or blank scheduling group.
SchoolCode
MST.SC
The Aeries school code
SectionNumber
MST.SE
The school-based Aeries section number
Semester
MST.SM
The term during which this section meets
SemesterGroup
MST.GP
The Semester Group for this section. Semester Groups are used to ensure that certain classes are scheduled for a student in different semesters and not at the same time.
TeacherNumber1
MST.TN
The school-based Aeries teacher number of the teacher primarily responsible for this section.
TeacherNumber2
MST.TN2
The teacher number of the second teacher teaching this section
TeacherNumber3
MST.TN3
The teacher number of the third teacher teaching this section
TeamCourseGroup
MST.CG
The team course group is used to create groups of sections to be further divided into teams.
TeamNumber
MST.TM
In conjunction with the team course group, the team number is used to group sections of different courses into teams. For instance, team scheduling can be used to ensure that students are scheduled into English, Math, Social Studies, and Science courses together while allowing PE and elective courses to have a mixture of students.
TotalBoys
MST.TB
The total number of boys (males) currently enrolled in the section
TotalGirls
MST.TG
The total number of girls (females) currently enrolled in the section
TotalStudents
MST.TS
The total number of students currently enrolled in the sections
Track
MST.TR
This section is restricted to students in a specific attendance track.
UserCode1
MST.U1
User-defined code 1
UserCode2
MST.U2
User-defined code 2
UserCode3
MST.U3
User-defined code 3
UserCode4
MST.U4
User-defined code 4
UserCode5
MST.U5
User-defined code 5
UserCode6
MST.U6
User-defined code 6
UserCode7
MST.U7
User-defined code 7
UserCode8
MST.U8
User-defined code 8

For descriptions of the various coded fields, use our "Code Sets" API:

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/CareerTechnicalEducationProvider

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/EducationService

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/Exclusion

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/FundingSource

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/HourlyAttendanceProgram

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/InactiveStatus

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/InstructionalStrategy

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/LanguageOfInstruction

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/MultiTeacher

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/ProgramCode

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/SchedulingGroup

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/SemesterGroup

https://demo.aeries.net/aeries/api/v3/codes/MasterSchedule/TeamCourseGroup


Section (from Master Schedule) Data Changes

Security Area:

  • "Master Schedule"

URL(s):

  • /api/v2/SectionDataChanges/{year}/{month}/{day}/{hour}/{minute}
    • year, month, day, hour, minute – required – The parts of the Date/Time from which you want to system to return sections with data changes. All parameters are required although 0 is valid for hour and minute. Valid values for "hour" are 0-23. "AM" and "PM" values are invalid

Notes:

  • This should be used for advanced interfaces with Aeries where you may be pulling data hourly or daily and want to only get the changes since the last time you pulled data from the Aeries API. After you get the list of sections with changes, you will have to loop through the dataset and call the Section (from Master Schedule) API one record at a time.

Example Section (from Master Schedule) Data Changes Results:

https://demo.aeries.net/aeries/api/v2/SectionDataChanges/2017/1/1/0/0

<ArrayOfMasterScheduleSectionKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v2.Models.Scheduling">
  <MasterScheduleSectionKey>
    <SchoolCode>994</SchoolCode>
    <SectionNumber>43</SectionNumber>
  </MasterScheduleSectionKey>
  <MasterScheduleSectionKey>
    <SchoolCode>994</SchoolCode>
    <SectionNumber>1038</SectionNumber>
  </MasterScheduleSectionKey>
  …
  …
</ArrayOfMasterScheduleSectionKey>


Staff Classes/Sections

Security Area:

  • "Master Schedule"

URL(s):

  • /api/v3/staff/{StaffID}/classes
    • StaffID (required) – The Aeries District Staff ID (numeric).

Notes:

  • This end point will return a list of classes associated with the given Staff ID.

Example Staff Classes/Sections Results:

https://demo.aeries.net/aeries/api/v3/staff/994605/classes


Note: The results for this end point follow the exact same structure as the Section (from Master Schedule) end point documented above.


Section Class Roster

Security Area:

  • "Class Schedules/History"

URL(s):

  • /api/v1/schools/{SchoolCode}/sections/{SectionNumber}/students
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • SectionNumber (required) – The school-based Aeries section number.

Notes:

  • This information can also be requested on a student by student basis. See Student Class Schedule End Point.
  • When this information is requested before the beginning of the school year the SequenceNumber and SectionNumber values will match.
  • Be aware that Class Schedules are highly prone to large scale adjustments before the start of school through the first 2 weeks of the school year.

Example Section Class Roster Results:

https://demo.aeries.net/aeries/api/v1/schools/994/sections/1038/students

<ArrayOfStudentClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.Models.Scheduling">
  <StudentClass>
    <CourseID>0726</CourseID>
    <DateEnded>2017-08-04T00:00:00</DateEnded>
    <DateStarted>2016-07-11T00:00:00</DateStarted>
    <Period>1</Period>
    <PeriodBlock>1</PeriodBlock>
    <PermanentID>99400723</PermanentID>
    <SchoolCode>994</SchoolCode>
    <SectionNumber>1038</SectionNumber>
    <SequenceNumber>11</SequenceNumber>
    <TeacherNumber>605</TeacherNumber>
  </StudentClass>
  …
  …
</ArrayOfStudentClass>


Field Documentation:

(Same as Student Class Schedule field documentation)


Section Class Roster Data Changes

Security Area:

  • "Class Schedules/History"

URL(s):

  • /api/v2/SectionRosterDataChanges/{year}/{month}/{day}/{hour}/{minute}
    • year, month, day, hour, minute – required – The parts of the Date/Time from which you want to system to return sections with roster changes. All parameters are required although 0 is valid for hour and minute. Valid values for "hour" are 0-23. "AM" and "PM" values are invalid

Notes:

  • This should be used for advanced interfaces with Aeries where you may be pulling data hourly or daily and want to only get the changes since the last time you pulled data from the Aeries API. After you get the list of sections with roster changes, you will have to loop through the dataset and call the Section Class Roster API one record at a time.

Example Section Class Roster Data Changes Results:

https://demo.aeries.net/aeries/api/v2/SectionRosterDataChanges/2017/1/1/0/0

<ArrayOfMasterScheduleSectionKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v2.Models.Scheduling">
  <MasterScheduleSectionKey>
    <SchoolCode>994</SchoolCode>
    <SectionNumber>43</SectionNumber>
  </MasterScheduleSectionKey>
  <MasterScheduleSectionKey>
    <SchoolCode>994</SchoolCode>
    <SectionNumber>1038</SectionNumber>
  </MasterScheduleSectionKey>
  …
  …
</ArrayOfMasterScheduleSectionKey>


Gradebook

 

Gradebook Information

Security Area:

  • "Gradebook Data"

URL(s):

  • /api/v3/staff/{StaffID}/gradebooks
    • StaffID (required) – the Aeries District Staff ID (numeric)
  • /api/v3/schools/{SchoolCode}/sections/{SectionNumber}/gradebooks
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • SectionNumber (required) – the school-based Aeries section number.
  • /api/v3/gradebooks/{GradebookNumber}
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • Note: This can be used if you already have pulled a list of gradebooks for a teacher or section and want to refresh a specific gradebook's information. Returns a single “Gradebook” object rather than an “ArrayOfGradebook”.

Notes:

  • A method of retrieving ALL gradebooks for a school or district is not possible. It is recommended that this API be called on the fly when needed by your system to generate a user interface.
  • Documentation on the Aeries Gradebook can be found here

Example Gradebook Information Results:

https://demo.aeries.net/aeries/api/v3/staff/994605/gradebooks

<ArrayOfGradebook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Public.Models.Gradebook">
  <Gradebook>
    <AssignmentCategories>
      <AssignmentCategory>
        <Code>0</Code>
        <Color>6666ff</Color>
        <Description>Homework</Description>
        <GradebookNumber>4366926</GradebookNumber>
        <PercentageOfGrade>10</PercentageOfGrade>
      </AssignmentCategory>
      <AssignmentCategory>
        <Code>2</Code>
        <Color>33ffff</Color>
        <Description>Test</Description>
        <GradebookNumber>4366926</GradebookNumber>
        <PercentageOfGrade>25</PercentageOfGrade>
      </AssignmentCategory>
      <AssignmentCategory>
        <Code>3</Code>
        <Color>336699</Color>
        <Description>Quiz</Description>
        <GradebookNumber>4366926</GradebookNumber>
        <PercentageOfGrade>20</PercentageOfGrade>
      </AssignmentCategory>
      <AssignmentCategory>
        <Code>4</Code>
        <Color>00ff66</Color>
        <Description>Presentations</Description>
        <GradebookNumber>4366926</GradebookNumber>
        <PercentageOfGrade>25</PercentageOfGrade>
      </AssignmentCategory>
      <AssignmentCategory>
        <Code>5</Code>
        <Color>000000</Color>
        <Description>Reports</Description>
        <GradebookNumber>4366926</GradebookNumber>
        <PercentageOfGrade>20</PercentageOfGrade>
      </AssignmentCategory>
    </AssignmentCategories>
    <Comment></Comment>
    <EndDate>2017-08-28T00:00:00</EndDate>
    <GradebookNumber>4366926</GradebookNumber>
    <GradebookType></GradebookType>
    <LinkedGroup>1</LinkedGroup>
    <Name>IBHstAm2/HEcCv</Name>
    <Period>1</Period>
    <SchoolCode>994</SchoolCode>
    <Sections>
      <GradebookSection>
        <GradebookNumber>4366926</GradebookNumber>
        <SchoolCode>994</SchoolCode>
        <SectionNumber>1038</SectionNumber>
      </GradebookSection>
    </Sections>
    <Settings>
      <AddDropStudentsAutomatically>false</AddDropStudentsAutomatically>
      <ApplyRangeToStudent>false</ApplyRangeToStudent>
      <CountCompletedNow>true</CountCompletedNow>
      <CountHi>999</CountHi>
      <CountLo>1</CountLo>
      <CountMaxDate>2016-08-28T00:00:00</CountMaxDate>
      <CountMinDate>2015-08-04T00:00:00</CountMinDate>
      <DoingFormativeSummativeWeight>false</DoingFormativeSummativeWeight>
      <DoingMinMaxAssignmentValues>false</DoingMinMaxAssignmentValues>
      <DoingRubric>false</DoingRubric>
      <DoingWeight>true</DoingWeight>
      <FilterAssignmentsBy>AssignmentDueDate</FilterAssignmentsBy>
      <FormativePercentage>0</FormativePercentage>
      <GradebookNumber>4366926</GradebookNumber>
      <HideDroppedStudents>false</HideDroppedStudents>
      <HideOverallScore>false</HideOverallScore>
      <HideOverallScoreFromParentStudent>true</HideOverallScoreFromParentStudent>
      <MaxAssignmentValue>0</MaxAssignmentValue>
      <MinAssignmentValue>0</MinAssignmentValue>
      <ShowFinalMark>true</ShowFinalMark>
      <ShowFinalMarkToParentStudent>true</ShowFinalMarkToParentStudent>
      <ShowHi>999</ShowHi>
      <ShowLo>1</ShowLo>
      <ShowMaxDate>2016-08-28T00:00:00</ShowMaxDate>
      <ShowMinDate>2015-08-04T00:00:00</ShowMinDate>
      <ShowPointRatio>false</ShowPointRatio>
      <SingleTermGradebook>false</SingleTermGradebook>
      <SummativePercentage>0</SummativePercentage>
    </Settings>
    <StartDate>2016-08-04T00:00:00</StartDate>
    <TeacherEmailAddress>Teacher605@example.com</TeacherEmailAddress>
    <TeacherName>Acosta</TeacherName>
    <TeacherNumber>605</TeacherNumber>
    <Terms>
      <Term>
        <Code>F</Code>
        <EndDate>2016-12-23T00:00:00</EndDate>
        <GradebookNumber>4366926</GradebookNumber>
        <Name>Fall</Name>
        <StartDate>2016-07-11T00:00:00</StartDate>
      </Term>
      <Term>
        <Code>S</Code>
        <EndDate>2017-08-04T00:00:00</EndDate>
        <GradebookNumber>4366926</GradebookNumber>
        <Name>Spring</Name>
        <StartDate>2017-01-02T00:00:00</StartDate>
      </Term>
    </Terms>
  </Gradebook>
  …
  …
</ArrayOfGradebook>


Field Documentation:

Gradebook

Name
Aeries Table.Column
Description
Comment
GBK.CO
A comment associated with the gradebook for reference by the teacher.
EndDate
GBK.D2
The ending date of the gradebook. Usually the last day of the term associated with the gradebook.
GradebookNumber
GBK.GN
The specific Aeries Gradebook Number. This is a unique number that is assigned at the time the gradebook is created and should not change.
GradebookType
GBK.TY
(not currently used)
LinkedGroup
GBK.AG
Linked Gradebooks group number. Gradebooks with the same number are considered linked together. A value of 0 is considered Ungrouped.
Name
GBK.NM
The name of the gradebook as displayed throughout the system. This is typically the Course name; however, the teacher can modify the name.
Period
GBK.PD
The period associated with this gradebook.
SchoolCode
GBK.SC
The Aeries school code
StartDate
GBK.D1
The starting date of the gradebook. Usually the first day of the term associated with the gradebook.
TeacherEmailAddress
TCH.EM
The teacher’s email address
TeacherName
TCH.TE
The display name of the teacher. It may be different than teacher’s actual first and last name.
TeacherNumber
GBK.TN
The school-based Aeries teacher number


Assignment Category

Name
Aeries Table.Column
Description
Code
GBT.AT
Assignment Category Type. A code representing the gradebook assignment category. This is an internal code not normally displayed to our users.
Color
GBT.CL
A hexadecimal color value. The teacher can choose to color-code each assignment category. The colors display in Aeries on the Scores By Class page.
Description
GBT.TD
Assignment Category description (ex. Homework, Classwork, Class Participation, etc.). Category descriptions can be changed by teachers.
GradebookNumber
GBT.GN
The specific Aeries Gradebook Number
PercentageOfGrade
GBT.PG
This is used to weight categories. Valid values are 0-100. For example, Homework category may be worth 10% of the overall grade.


Gradebook Section

Name
Aeries Table.Column
Description
GradebookNumber
GBE.GN
The specific Aeries Gradebook Number
SchoolCode
GBE.SC
The Aeries school code
SectionNumber
GBE.SE
The school-based Master Schedule section number of the section associated with this gradebook. In an elementary school without a master schedule, this will match the Teacher Number instead.


Settings

Name
Aeries Table.Column
Description
AddDropStudentsAutomatically

All come from the GBO table. GBO.OPN is the name, and GBO.OV is the value

Students will be automatically added to and dropped from the gradebook based on changes to the section class roster
ApplyRangeToStudent
(no longer used, but may be populated on older gradebooks)
CountCompletedNow
Scores entered into the gradebook apply immediately to the overall grade (essentially overrides the “Grading Completed” property of individual assignments).
CountHi
(no longer used, but may be populated on older gradebooks)
CountLo
(no longer used, but may be populated on older gradebooks)
CountMaxDate
(no longer used, but may be populated on older gradebooks)
CountMinDate
(no longer used, but may be populated on older gradebooks)
DoingFormativeSummativeWeight
Allows the teacher to assign a percentage to summative assignments and a percentage to formative assignments.
DoingMinMaxAssignmentValues
When calculating the total grade, each assignment's score will be scaled to be within the defined min/max range.
DoingRubric
This gradebook is doing Rubric grading, meaning the total grade will be calculated by using trend analysis.
DoingWeight
This gradebook has percentages assigned to each assignment category.
FilterAssignmentsBy
(no longer used, but may be populated on older gradebooks)
FormativePercentage
If DoingFormativeSummativeWeight is turned on, this is the percentage to weight Formative assignments.
GradebookNumber
GBO.ID
The specific Aeries Gradebook Number
HideDroppedStudents

All come from the GBO table. GBO.OPN is the name, and GBO.OV is the value

If True, students who have been dropped from the gradebook will be hidden on the various “Scores By” pages. If False, dropped students instead display on a colored background at the bottom of the list.
HideOverallScore
Do not show the student’s overall score/percentage when a teacher or other staff is viewing the gradebook
HideOverallScoreFromParentStudent
Do not show the student’s overall score/percentage when a parent or student is viewing the gradebook
MaxAssignmentValue
If DoingMinMaxAssignmentValues is turned on, this is the max value.
MinAssignmentValue
If DoingMinMaxAssignmentValues is turned on, this is the min value.
ShowFinalMark
Display the student’s overall mark (e.g., A, B, F) when a teacher or other staff is viewing the gradebook
ShowFinalMarkToParentStudent
Display the student’s overall mark (e.g., A, B, F) when a parent or student is viewing the gradebook
ShowHi
(no longer used, but may be populated on older gradebooks)
ShowLo
(no longer used, but may be populated on older gradebooks)
ShowMaxDate
(no longer used, but may be populated on older gradebooks)
ShowMinDate
(no longer used, but may be populated on older gradebooks)
ShowPointRatio
Shows the overall point ratio to the teacher on the scores by class page. Example 300/1000.
SingleTermGradebook
Allows a teacher to associate the gradebook to a single year-long term, instead of being restricted to the school defined Terms.
SummativePercentage
If DoingFormativeSummativeWeight is turned on, this is the percentage to weight Summative assignments.

 

Term

Name
Aeries Table.Column
Description
Code
GBR.CD
The code of the term; e.g., S = Spring, 1 = Trimester 1, etc. For Single Term Gradebooks, this value will be Y.
EndDate
GBR.ED
The end date of the specified term.
GradebookNumber
GBR.GN
The specific Aeries Gradebook Number
Name
GBR.NM
The Term Description of the term; e.g., Spring, Fall, Trimester 1, etc. This value can be specified by the teacher if they are using a single term gradebook.
StartDate
GBR.SD
The start date of the specified term.


Assignment Information

Security Area:

  • "Gradebook Data"

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • AssignmentNumber (optional) – the specific Assignment Number
  • /api/v3/gradebooks/Assignments/{UniqueID}
    • UniqueID (required) – The District-wide Unique ID for this assignment. The teacher has the ability to change the Assignment Number, but the Unique ID for an assignment will never change. Once the Unique ID is known, it can be used to guarantee that future API calls refer to the same assignment.

Notes:

  • A method of retrieving assignments for ALL gradebooks for a school or district is not possible. It is recommended that this API be called on the fly when needed by your system to generate a user interface.
  • If AssignmentNumber or UniqueID is passed, a single “Assignment” object is returned rather than an “ArrayOfAssignment”.

Example Assignment Information Results:

https://demo.aeries.net/aeries/api/v3/gradebooks/4366926/assignments

<ArrayOfAssignment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Public.Models.Gradebook">
  <Assignment>
    <AeriesAnalyticsExamID>0</AeriesAnalyticsExamID>
    <AeriesAnalyticsExamTestAdmin>0</AeriesAnalyticsExamTestAdmin>
    <AllowStudentDropBox>false</AllowStudentDropBox>
    <AssignmentCategory>
      <Code>0</Code>
      <Color>6666ff</Color>
      <Description>Homework</Description>
      <GradebookNumber>4366926</GradebookNumber>
      <PercentageOfGrade>10</PercentageOfGrade>
    </AssignmentCategory>
    <AssignmentNumber>2</AssignmentNumber>
    <Comment>Read Chapter 1, Section 1.</Comment>
    <DateAssigned>2016-08-04T00:00:00</DateAssigned>
    <DateDue>2016-08-06T00:00:00</DateDue>
    <Description>Ch 1-1</Description>
    <DueTime>0001-01-01T00:00:00</DueTime>
    <ExternalID></ExternalID>
    <FormativeSummativeIndicator>F</FormativeSummativeIndicator>
    <GradebookNumber>4366926</GradebookNumber>
    <GradingCompleted>true</GradingCompleted>
    <InputScoresByStandard>true</InputScoresByStandard>
    <NarrativeGradeSet>
      <NarrativeGrade>
        <Mark>AD</Mark>
        <NarrativeGradeSetID>1640411</NarrativeGradeSetID>
        <PercentValue>95.0000</PercentValue>
      </NarrativeGrade>
      <NarrativeGrade>
        <Mark>BA</Mark>
        <NarrativeGradeSetID>1640411</NarrativeGradeSetID>
        <PercentValue>75.0000</PercentValue>
      </NarrativeGrade>
      …
      …
    </NarrativeGradeSet>
    <NarrativeGradeSetID>1640411</NarrativeGradeSetID>
    <NumberCorrectPossible>10</NumberCorrectPossible>
    <PointsPossible>10</PointsPossible>
    <RubricAssignment>false</RubricAssignment>
    <ScoresVisibleToParents>true</ScoresVisibleToParents>
    <Standards>
      <AssignmentStandard>
        <AcademicBenchmarkId>F74BB748-3CFF-11D9-8407-9AE6FB2C8371</AcademicBenchmarkId>
        <AssignmentNumber>2</AssignmentNumber>
        <GradebookNumber>4366926</GradebookNumber>
        <NumberCorrectPossible>10</NumberCorrectPossible>
        <StandardDescription>Students distinguish valid arguments from fallacious….</StandardDescription>
        <StandardId>SHA.H.1</StandardId>
      </AssignmentStandard>
    </Standards>
    <UniqueID>76289310-6ACF-4124-9A42-057684DCE9F2</UniqueID>
    <VisibleToParents>true</VisibleToParents>
  </Assignment>
  …
  …
</ArrayOfAssignment>


Field Documentation:

Assignment

Name
Aeries Table.Column
Description
AeriesAnalyticsExamID
GBA.EID
(no longer used)
AeriesAnalyticsExamTestAdmin
GBA.ETA
(no longer used)
AllowStudentDropBox
GBA.ADB
If turned on, this allows students to upload a document to this particular assignment via the Aeries Student Portal.
AssignmentNumber
GBA.AN
The specific Assignment Number
Comment
GBA.COM
This is a longer description of the assignment
DateAssigned
GBA.DA
The date the assignment was assigned
DateDue
GBA.DD
The date the assignment is due.
Description
GBA.AD
The name of the assignment as displayed throughout the system
DueTime
GBA.DUT
Used in conjunction with the AllowStudentDropBox option. The document can only be uploaded until this time.
ExternalID
GBA.EI
This is used to identify an assignment in third party systems such as Google Classroom.
FormativeSummativeIndicator
GBA.TY
Defines an assignment as either Formative or Summative.
GradebookNumber
GBA.GN
The specific Aeries Gradebook Number
GradingCompleted
GBA.GC
This is a flag that notes whether the teacher is finished grading this assignment. Once the flag is turned on, the scores count toward students’ overall grade and will be considered “missing” if not yet scored.
InputScoresByStandard
GBA.IBS
This denotes that the assignment is Input by Standard. Teachers will enter multiple scores per assignment, one for each standard.
NarrativeGradeSetID
GBA.CID
If a narrative grading scale is in use on this assignment, this denotes which one is being used. A narrative grade set allows the teacher to choose from a list of marks rather than enter a numeric score for each student. Each narrative grade mark then corresponds to a certain percentage correct.
NumberCorrectPossible
GBA.NP
The number of questions (or points) possible for this assignment.
PointsPossible
GBA.MX
The maximum number of points that can be earned on this assignment.
RubricAssignment
GBA.RA
Indicates whether this assignment is using Rubric Grading
ScoresVisibleToParents
GBA.SVP
The score is visible to parents and students in the Aeries Parent/Student Portal. Parents may see the assignment but not the score.
UniqueID
GBA.UI
The District-wide Unique ID for this assignment. The teacher has the ability to change the Assignment Number, but the Unique ID for an assignment will never change. Once the Unique ID is known, it can be used to guarantee that future API calls refer to the same assignment.
VisibleToParents
GBA.VP
The assignment is visible to parents and students in the Aeries Parent/Student Portal. Neither the score nor the assignment will be shown if this is False.

 

Assignment Category documentation is the same as that provided above.


Narrative Grade

Name
Aeries Table.Column
Description
Mark
GBM.MK
The mark for the narrative grading scale. A teacher can use any number of letters, numbers, or symbols here.
NarrativeGradeSetID
GBM.CID
An ID assigned to the narrative grade set by Aeries. Not typically displayed to the user.
PercentValue
GBM.PM
The percentage associated with the mark.

 

Assignment Standard

Name
Aeries Table.Column
Description
AcademicBenchmarkId
STN.BID
A specific ID used to relate Aeries standards to specific standards third party systems.
AssignmentNumber
GBN.AN
The specific Assignment Number
GradebookNumber
GBN.GN
The specific Aeries Gradebook Number
NumberCorrectPossible
GBN.NP
The maximum number of points attributed to this particular standard that can be earned on this assignment.
StandardDescription
STN.TI
The specific description of the Aeries Standard.
StandardId
GBN.SD
The specific ID of the Aeries Standard.


Updating Assignment Information

Security Area:

  • "Gradebook Data" - Update

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • AssignmentNumber (required) – the specific Assignment Number
  • /api/v3/gradebooks/Assignments/{UniqueID}
    • UniqueID (required) – The District-wide Unique ID for this assignment. The teacher has the ability to change the Assignment Number, but the Unique ID for an assignment will never change. Once the Unique ID is known, it can be used to guarantee that future API calls refer to the same assignment.

Notes:

  • This end point returns an “ArrayOfAssignment” container of “Assignment” objects similar to the regular Assignment Information end point; however, it contains only those records which were updated by the current Update request. The result is an array because the Assignment with the same Assignment Number will be updated in all Linked Gradebooks if the UpdateLinkedGradebooksToo option is set to “true” or omitted (defaults to “true”). Linked Gradebooks are all a teacher’s Gradebooks in the same school code with equal, nonzero values for “LinkedGroup” (see the Gradebook Information end point)

POST Payload Object:

  • “AssignmentUpdate” object

“AssignmentUpdate” Object Definition:

Name
Data Type
Notes
Description
String
Max length: 255. The title/description of the assignment.
AssignmentCategoryCode
String
Max length: 1. Must match an existing Assignment Category Code in the current Gradebook
DateAssigned
Date
The date the assignment is assigned to students
DateDue
Date
The date the assignment is due
NumberCorrectPossible
Decimal
The number of questions (or points) possible for this assignment. If omitted or the value is 0, then the value of PointsPossible will be used.
PointsPossible
Decimal
REQUIRED The maximum number of points that can be earned on this assignment.
GradingCompleted
Boolean
(true or false. DEFAULT false if omitted) Indicates whether the teacher has finished grading this assignment and it should therefore count towards students’ overall grades
Comment
String
A comment or note to provide additional information about the assignment. Though this field is optional, if it is omitted or blank, then any existing Comment will be overwritten with an empty string.
FormativeSummativeIndicator
String
Valid values are “F” or “S”. Indicates whether this assignment is Formative or Summative.
RubricAssignment
Boolean
(true or false. DEFAULT false if omitted) Indicates whether this assignment uses Rubric grading. Note: If this is true, then both NumberCorrectPossible and PointsPossible will automatically be set to 0 regardless of what values are passed. This option only works if the overall Gradebook is set to allow Rubric grading. If not, this field will automatically be interpreted as “false”
ExternalID
String
An identifier for this assignment in an external system such as a Learning Management System (LMS).
UpdateLinkedGradebooksToo
Boolean
(true or false. DEFAULT true if omitted) Option to update the same assignment in any of the teacher’s Linked Gradebooks.


Example Payload:

{
  "Description":"Test the Aeries API",
  "AssignmentCategoryCode":"T",
  "DateAssigned":"2017-01-27",
  "DateDue":"2017-02-17",
  "NumberCorrectPossible":50,
  "PointsPossible":50,
  "GradingCompleted":false,
  "Comment":"Make sure the Gradebook end points work",
  "FormativeSummativeIndicator":"S",
  "RubricAssignment":false,
  "ExternalID":null,
  "UpdateLinkedGradebooksToo":true
}


Inserting a New Assignment

Security Area:

  • "Gradebook Data" - Update

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/InsertAssignment
    • GradebookNumber (required) – the specific Aeries Gradebook Number

Notes:

  • This end point returns an “ArrayOfAssignment” container of “Assignment” objects similar to the regular Assignment Information end point; however, it contains only those records which were added by the current Insert request. The result is an array because the new Assignment will be added in all Linked Gradebooks if the CreateInLinkedGradebooksToo option is set to “true” or omitted (defaults to “true”). Linked Gradebooks are all a teacher’s Gradebooks in the same school code with equal, nonzero values for “LinkedGroup” (see the Gradebook Information end point)

POST Payload Object:

  • “AssignmentInsert” object

“AssignmentInsert” Object Definition:

Name
Data Type
Notes
Description
String
REQUIRED Max length: 255. The title/description of the assignment. Empty string is allowed (though not encouraged), but field cannot be omitted or null.
AssignmentCategoryCode
String
Max length: 1. Must match an existing Assignment Category Code in the current Gradebook. If invalid or omitted, the first Assignment Category Code in the Gradebook will be used by default.
DateAssigned
Date
The date the assignment is assigned to students. If omitted or null, the DateDue will be used. If both are omitted or null, today’s date will be used.
DateDue
Date
The date the assignment is due. If omitted or null, the DateAssigned will be used. If both are omitted or null, today’s date will be used.
NumberCorrectPossible
Decimal
The number of questions (or points) possible for this assignment. If omitted or the value is 0, then the value of PointsPossible will be used.
PointsPossible
Decimal
The maximum number of points that can be earned on this assignment.
Comment
String
A comment or note to provide additional information about the assignment.
FormativeSummativeIndicator
String
Valid values are “F” or “S”. Indicates whether this assignment is Formative or Summative. If omitted or invalid, “S” will be used by default.
RubricAssignment
Boolean
(true or false. DEFAULT false if omitted) Indicates whether this assignment uses Rubric grading. Note: If this is true, then both NumberCorrectPossible and PointsPossible will automatically be set to 0 regardless of what values are passed. This option only works if the overall Gradebook is set to allow Rubric grading. If not, this field will automatically be interpreted as “false”
ExternalID
String
An identifier for this assignment in an external system such as a Learning Management System (LMS).
CreateInLinkedGradebooksToo
Boolean
(true or false. DEFAULT true if omitted) Option to create the same assignment in the teacher’s Linked Gradebooks.


Example Payload:

{
  "Description":"Test the Aeries API",
  "AssignmentCategoryCode":"T",
  "DateAssigned":"2017-01-27",
  "DateDue":"2017-02-17",
  "NumberCorrectPossible":50,
  "PointsPossible":50,
  "Comment":"Make sure the Gradebook end points work",
  "FormativeSummativeIndicator":"S",
  "RubricAssignment":false,
  "ExternalID":"",
  "CreateInLinkedGradebooksToo":true
}


Final Mark Ranges

Security Area:

  • "Gradebook Data"

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/FinalMarks
    • GradebookNumber (required) – the specific Aeries Gradebook Number

Notes:

  • A method of retrieving final marks for ALL gradebooks for a school or district is not possible. It is recommended that this API be called on the fly when needed by your system.
  • In Aeries, the "Low Value" is used as a threshold. The "High Value" is informational only, except that if the High Value is 0 (zero), then the Final Mark is not being used.

Example Final Mark Ranges Results:

https://demo.aeries.net/aeries/api/v3/gradebooks/4366926/FinalMarks

<ArrayOfFinalMark xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Public.Models.Gradebook">
  <FinalMark>
    <HighValue>110.0000</HighValue>
    <LowValue>98.0000</LowValue>
    <Mark>A+</Mark>
  </FinalMark>
  <FinalMark>
    <HighValue>97.9900</HighValue>
    <LowValue>93.0000</LowValue>
    <Mark>A</Mark>
  </FinalMark>
  <FinalMark>
    <HighValue>92.9900</HighValue>
    <LowValue>90.0000</LowValue>
    <Mark>A-</Mark>
  </FinalMark>
  …
  …
</ArrayOfFinalMark>


Field Documentation:

Name
Aeries Table.Column
Description
HighValue
GTG.HI
High Value (informational only see note above)
LowValue
GTG.LO
The Low Value for this range.
Mark
GTG.MK
The Mark assigned to this range ex. A, B+, etc.


Gradebook Student Information

Security Area:

  • "Gradebook Data"

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/{GradebookTerm}/students/{StudentID}
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • GradebookTerm (required) – the Term Code from the Gradebook object (Gradebook à Terms à Term à Code)
    • StudentID (optional) - the Aeries Student District Permanent ID Number.
      • Note: This can be used if you already have pulled a list of students for a gradebook and want to refresh a specific student's information. Returns a single “Student” object rather than an “ArrayOfStudent”.

Notes:

  • A method of retrieving students for ALL gradebooks for a school or district is not possible. It is recommended that this API be called on the fly when needed by your system.
  • Also not available at this time is the ability to request a set of gradebooks for a specific student. This will be available in a future enhancement.

Example Gradebook Student Information Results:

https://demo.aeries.net/aeries/api/v3/gradebooks/4366926/F/students

<ArrayOfStudent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Public.Models.Gradebook">
  <Student>
    <CurrentMark>A-</CurrentMark>
    <CurrentPercentage>91.5384</CurrentPercentage>
    <CurrentTerm>F</CurrentTerm>
    <CustomSortOrder>1</CustomSortOrder>
    <EndDate>2017-08-04T00:00:00</EndDate>
    <HighAssignmentNumber>0</HighAssignmentNumber>
    <InactiveTag></InactiveTag>
    <LowAssignmentNumber>0</LowAssignmentNumber>
    <PermanentID>99400001</PermanentID>
    <SchoolCode>994</SchoolCode>
    <StartDate>2016-07-11T00:00:00</StartDate>
    <StudentFirstName>Allan</StudentFirstName>
    <StudentGradeLevel>12</StudentGradeLevel>
    <StudentLastName>Abbott</StudentLastName>
    <StudentMiddleName>James</StudentMiddleName>
    <StudentNumber>1</StudentNumber>
    <StudentSex>M</StudentSex>
  </Student>
  …
  …
</ArrayOfStudent>


Field Documentation:

Name
Aeries Table.Column
Description
CurrentMark
GBV.MK
The student’s overall current mark for this gradebook.
CurrentPercentage
GBV.PC
The student’s overall current percentage for this gradebook.
CurrentTerm
GBV.CD
The term that this mark applies to. Usually F, S, Y, 1, 2, 3, or 4.
CustomSortOrder
GBU.SRT
A custom sort order that a teacher can assign to sort students in their gradebook.
EndDate
GBU.D2
The student’s end date for this gradebook. Normally the last day of the term unless the student dropped the class at an earlier date.
HighAssignmentNumber
GBU.HI
(no longer used)
InactiveTag
GBU.TG
Is the student inactive in this gradebook
LowAssignmentNumber
GBU.LO
(no longer used)
PermanentID
STU.ID
The Permanent ID of this student
SchoolCode
GBU.SC
The Aeries school code
StartDate
GBU.D1
The student’s beginning date for this gradebook. Normally the first day of the term unless the student enrolled in the class at a later date.
StudentFirstName
STU.FN
The student’s first name
StudentGradeLevel
STU.GR
The student’s grade level
StudentLastName
STU.LN
The student’s last name
StudentMiddleName
STU.MN
The student’s middle name
StudentNumber
GBU.SN
The school-based Student Number for this student
StudentSex
STU.SX
The student’s sex


Assignment Scores

Security Area:

  • "Gradebook Scores"

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}/scores/{StudentID}
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • AssignmentNumber (required) – the specific Assignment Number
    • StudentID (optional) – the Aeries Student District Permanent ID Number
      • Note: This can be used if you already have pulled a list of scores for an assignment and want to refresh a specific student’s information. Returns a single “AssignmentScore” object rather than an “ArrayOfAssignmentScore”.
  • /api/v3/gradebooks/assignments/{UniqueID}/scores/{StudentID}
    • UniqueID (required) – The District-wide Unique ID for this assignment. The teacher has the ability to change the Assignment Number, but the Unique ID for an assignment will never change. Once the Unique ID is known, it can be used to guarantee that future API calls refer to the same assignment.
    • StudentID (optional) – the Aeries Student District Permanent ID Number
      • Note: This can be used if you already have pulled a list of scores for an assignment and want to refresh a specific student’s information. Returns a single “AssignmentScore” object rather than an “ArrayOfAssignmentScore”.

Notes:

  • A method of retrieving scores for ALL assignments in a gradebook is not possible. It is recommended that this API be called on the fly when needed by your system.
  • For Standards-based grades, the list of standards and the "Academic Benchmark Id" is available through the Assignment Information API.
  • Also for Standards-based grades, the Number Correct and Points Earned fields will always match.
  • For Rubric-based grades, the Number Correct Possible and Points Possible fields will be 0 (zero). Also, the Number Correct and Points Earned fields will match.

Example Assignment Scores Results:

https://demo.aeries.net/aeries/api/v3/gradebooks/4454703/assignments/80/scores

<ArrayOfAssignmentScore xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Public.Models.Gradebook">
  <AssignmentScore>
    <AssignmentNumber>80</AssignmentNumber>
    <DateCompleted>2017-02-06T00:00:00</DateCompleted>
    <GradebookNumber>4454703</GradebookNumber>
    <IsMissing>false</IsMissing>
    <IsRuleReplacingScore>false</IsRuleReplacingScore>
    <Mark>4.0000</Mark>
    <NumberCorrect>4</NumberCorrect>
    <NumberCorrectPossible>0</NumberCorrectPossible>
    <PercentCorrect>0</PercentCorrect>
    <PermanentID>99000007</PermanentID>
    <PointsEarned>4</PointsEarned>
    <PointsPossible>0</PointsPossible>
    <RuleNumberApplied>0</RuleNumberApplied>
    <RuleReplacedScore>0</RuleReplacedScore>
    <StandardScores>
      <AssignmentStandardScore>
        <Mark>4</Mark>
        <NumberCorrect>4.0000</NumberCorrect>
        <NumberCorrectPossible>0.0000</NumberCorrectPossible>
        <PercentCorrect>0.0000</PercentCorrect>
        <PointsEarned>4.0000</PointsEarned>
        <PointsPossible>0.0000</PointsPossible>
        <StandardId>CEL.4.L.5</StandardId>
      </AssignmentStandardScore>
      <AssignmentStandardScore>
        <Mark>4</Mark>
        <NumberCorrect>4.0000</NumberCorrect>
        <NumberCorrectPossible>0.0000</NumberCorrectPossible>
        <PercentCorrect>0.0000</PercentCorrect>
        <PointsEarned>4.0000</PointsEarned>
        <PointsPossible>0.0000</PointsPossible>
        <StandardId>CEL.4.RI.9</StandardId>
      </AssignmentStandardScore>
    </StandardScores>
  </AssignmentScore>
  …
  …
</ArrayOfAssignmentScore>


Field Documentation:

Assignment Score

Name
Aeries Table.Column
Description
AssignmentNumber
GBS.AN
The specific Assignment Number
DateCompleted
GBS.DC
The date the student completed/submitted the assignment
GradebookNumber
GBS.GN
The specific Aeries Gradebook Number
IsMissing

Indicates whether this counts as a missing assignment for the student. Typically, this will be true under the following conditions:
  • The student is not permanently excused from the assignment
  • The student has no mark entered on the assignment
  • The Grading Completed flag for the assignment is set to true
IsRuleReplacingScore

Indicates whether a Gradebook Rule will replace this student’s actual score in the overall grade calculation.
Gradebook Rules can be set by the teacher for each Gradebook. For example: drop the lowest score in the Quiz category and replace it with the average of remaining scores in the Quiz category.
Mark
GBS.MK
The mark entered for the student on this assignment. Usually numeric, but there are special marks such as “NA” (not applicable; i.e., excused) and “TX” (temporarily excused). Also, if a Narrative Grade set is used, the mark from the Narrative Grade set will display here. Also, marks can be expressed as a percentage such as 95%.
NumberCorrect
GBS.NC
The number of questions (or points) the student answered correctly.
NumberCorrectPossible
GBS.NP
The number of questions (or points) possible for this assignment for this student.
PercentCorrect
GBS.PC
The percentage of possible points earned by the student.
PermanentID
STU.ID
The Permanent ID of the student
PointsEarned
GBS.SCR
The number of points earned by the student
PointsPossible
GBS.MX
The maximum number of points the student could have earned
RuleNumberApplied

If a Gradebook Rule was applied to this score, this is the rule number. Note: There is currently no API end point that provides detailed information on Gradebook Rules
RuleReplacedScore

The percent score that will replace this student’s actual score due to a Gradebook Rule being applied. Expressed as a decimal (e.g., 0.9 = 90%)


Assignment Standard Score

Name
Aeries Table.Column
Description
Mark
GBD.MK
The mark attributed to this particular standard entered for this student on this assignment
NumberCorrect
GBD.NC
The number of points attributed to this particular standard earned by the student
NumberCorrectPossible
GBD.NP
The maximum number of points attributed to this particular standard that the student could have earned
PercentCorrect
GBD.PC
The percentage of possible points attributed to this particular standard earned by the student
PointsEarned
GBD.SCR
The number of points attributed to this particular standard earned by the student
PointsPossible
GBD.MX
The maximum number of points attributed to this particular standard that the student could have earned
StandardId
GBD.SD
The specific Standard ID


Updating Assignment Scores

Security Area:

  • "Gradebook Scores" - Update

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}/UpdateScores
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • AssignmentNumber (required) – the specific Assignment Number
  • /api/v3/gradebooks/assignments/{UniqueID}/UpdateScores
    • UniqueID (required) – The District-wide Unique ID for this assignment. The teacher has the ability to change the Assignment Number, but the Unique ID for an assignment will never change. Once the Unique ID is known, it can be used to guarantee that future API calls refer to the same assignment.

Notes:

  • This end point returns an “ArrayOfAssignmentScore” container of “AssignmentScore” objects similar to the regular Assignment Scores end point. Regardless of how many scores are updated, all scores for the selected assignment will be returned after the update is completed.
  • For Standards-based grades, the list of standards and the "Academic Benchmark Id" are available through the Assignment Information API.
  • For Rubric-based grades, send the numeric Rubric value for Number Correct.

POST Payload Object:

  • Array of “AssignmentScoreUpdate” object

“AssignmentScoreUpdate” Object Definition:

Name
Data Type
Notes
PermanentID
Int32
Student District Permanent ID number
NumberCorrect
Decimal
The number of questions (or points) earned on this assignment. Handles up to 4 decimal places. Do not populate if StandardScores are being sent.
DateCompleted
Date
Only populate if you really want to put in a specific value. Otherwise, Aeries will automatically use the Due Date of the assignment.
StandardScores
Array of AssignmentStandardScoreUpdate
This is an array of custom objects. See below for details.


“AssignmentStandardScoreUpdate” Object Definition:

Name
Data Type
Notes
AeriesStandardID
String
Either this field or the AcademicBenchmarkID field must be populated. This needs to match information originally found in the "Assignment" object.
AcademicBenchmarkID
String
Either this field or the AeriesStandardID field must be populated. This needs to match information originally found in the "Assignment" object.
NumberCorrect
Decimal
The number of questions (or points) earned on this standard, within the given assignment. Handles up to 4 decimal places.


Example Payload (for an assignment NOT using Input Scores By Standard):

[
  {
     "PermanentID":99400001,
     "NumberCorrect":20,
  },
  {
     "PermanentID":99400318,
     "NumberCorrect":42,
     "DateCompleted":"2017/02/17",
  }
]


Example Payload (for an assignment using Input Scores By Standard):

[
  {
     "PermanentID":99000007,
     "StandardScores":
     [
       {
         "AcademicBenchmarkID":"1C799626-9892-11E0-8388-5F489DFF4B22",
         "NumberCorrect":2
       },
       {
         "AeriesStandardID":"CEL.4.RI.9",
         "NumberCorrect":4
       }
     ]
  },
  {
     "PermanentID":99000018,
     "DateCompleted":"2017/02/17",
     "StandardScores":
     [
       {
         "AcademicBenchmarkID":"1C799626-9892-11E0-8388-5F489DFF4B22",
         "NumberCorrect":4
       },
       {
         "AeriesStandardID":"CEL.4.RI.9",
         "NumberCorrect":4
       }
     ]
  }
]