Aeries API Documentation (Application Programming Interface) September 9, 2015

Transcription

1 Aeries API Documentation (Application Programming Interface) September 9, 2015 The Aeries API is a web-based, REST API system. Currently, only 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 contruct the HTTP GET and POST Requests. 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: interfacing-with-aeries+subscribe@googlegroups.com Every customer using Aeries.net will have an independent website with an independent URL. This includes BOTH, districts hosted by Eagle Software (Aeries ASP Environment) and those who host their own installations of Aeries.net. Not every customer has a public-facing instance of Aeries.net 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.net somewhere in their environment, but not EVERY. We encourage every district to use Aeries.net and at least have the Aeries.net Parent/Student Portal accessible to the outside, but many still use our old "ABI Parent/Student Portal." Some districts will only have an instance of Aeries.net available to you through a windows-authenticated URL. This happens when a district is not using the Aeries.net Parent/Student Portal and only has an instance of Aeries.net 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. Eagle 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. The Certificate and Security Permissions: Unless you are an "Eagle Software Elite Partner" (1) and have a certificate issued directly from Eagle Software, each district will issue you a certificate that is unique for that district. A "certficate" 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.net server. The Aeries.net demo website can be used to test your code: The certificate for the demo website that you can use is "477abe9e7d d62f4e0de1f5e1". You can also log into the demo website using the username "admin" and password "admin". Your certificate is case-sensitive! (1) "Eagle Software Elite Partners" are companies that have formal business relationships with Eagle Software that can involve co-marketing and sales campaigns as well as financial relationships. Aeries API Documentation Page 1

2 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 o Accept: text/xml, text/html, application/xhtml+xml, */* JSON o Accept: application/json, text/html, application/xhtml+xml, */* To give the system your certificate with each request: o AERIES-CERT: 477abe9e7d d62f4e0de1f5e1 The certificate is case sensitive! Other 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 > T00:00:00</ FieldName> Aeries API Documentation Page 2

3 Data Available / Table of Contents: Revision History Page 4 School Information Page 5 School Term Information Page 6 Student Information Page 8 Student Information Extended Page 11 Student Data Changes Page 14 Student Enrollment History Page 15 Student GPAs Page 17 Student Contacts Page 18 Student Programs Page 19 Student Test Scores Page 20 Student Class Schedule Page 21 Course Information Page 22 Course Data Changes Page 23 Staff Information Page 24 Staff Data Changes Page 25 Teacher Information Page 26 Staff-Teacher Information Page 27 Section (from Master Schedule) Page 28 Section (from Master Schedule) Data Changes Page 29 Section Class Roster Page 30 Section Class Roster Data Changes Page 31 Code Sets Page 32 Gradebook Information Page 33 Gradebook Assignment Information Page 36 Gradebook Final Mark Ranges Page 38 Gradebook Student Information Page 39 Gradebook Assignment Scores Page 40 Updating Gradebook Assignment Scores Page 42 Aeries API Documentation Page 3

4 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 Address, Username and Primary School Gradebooks for a section can now be retrieved o Documented in the Gradebook Information End Point Gradebook API End Points upgraded to V2 o Gradebook Information object changed to include multiple Terms o 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. Aeries API Documentation Page 4

5 School Information End Points: None Required /api/v2/schools/{schoolcode} SchoolCode optional the Aeries School Code. This is normally If School Code is not passed, all schools for the current district will be returned. Compared to the v1 of this end point, the School object now contains a list of Terms. Example Multiple School Information Results: <ArrayOfSchool xmlns:i=" xmlns=" <School> <Address>9950 Comet Street</Address> <AddressCity>Eagle Point</AddressCity> <AddressState>CA</AddressState> <AddressZipCode>95990</AddressZipCode> <AddressZipExt/> <DoNotReport>false</DoNotReport> <HighGradeLevel>6</HighGradeLevel> <InactiveStatusCode/> <LowGradeLevel>0</LowGradeLevel> <Name>Golden Eagle Elementary School</Name> <SchoolCode>990</SchoolCode> <StateCountyID>65</StateCountyID> <StateDistrictID>99999</StateDistrictID> <StateSchoolID> </StateSchoolID> <Terms> <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>1</TermCode> <TermDescription>First Quarter</TermDescription> </Term> <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>2</TermCode> <TermDescription>Second Quarter</TermDescription> </Term> </Terms> </School> </ArrayOfSchool> Aeries API Documentation Page 5

6 Example Single School Information Results: <School xmlns:i=" xmlns=" <Address>9950 Comet Street</Address> <AddressCity>Eagle Point</AddressCity> <AddressState>CA</AddressState> <AddressZipCode>95990</AddressZipCode> <AddressZipExt/> <DoNotReport>false</DoNotReport> <HighGradeLevel>6</HighGradeLevel> <InactiveStatusCode/> <LowGradeLevel>0</LowGradeLevel> <Name>Golden Eagle Elementary School</Name> <SchoolCode>990</SchoolCode> <StateCountyID>65</StateCountyID> <StateDistrictID>99999</StateDistrictID> <StateSchoolID> </StateSchoolID> <Terms> <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>1</TermCode> <TermDescription>First Quarter</TermDescription> </Term> <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>2</TermCode> <TermDescription>Second Quarter</TermDescription> </Term> </Terms> </School> Aeries API Documentation Page 6

7 School Term Information End Points: None Required /api/v2/schools/{schoolcode}/terms SchoolCode required the Aeries School Code. This is normally This information is already available on each school returned from the "School Information" end point. Example Multiple School Term Results: <ArrayOfTerm xmlns:i=" xmlns=" <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>1</TermCode> <TermDescription>First Quarter</TermDescription> </Term> <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>2</TermCode> <TermDescription>Second Quarter</TermDescription> </Term> <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>3</TermCode> <TermDescription>Third Quarter</TermDescription> </Term> <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>4</TermCode> <TermDescription>Fourth Quarter</TermDescription> </Term> <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>F</TermCode> <TermDescription>Fall</TermDescription> </Term> <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>S</TermCode> <TermDescription>Spring</TermDescription> </Term> <Term> <EndDate> T00:00:00</EndDate> <StartDate> T00:00:00</StartDate> <TermCode>Y</TermCode> <TermDescription>Year</TermDescription> </Term> </ArrayOfTerm> Aeries API Documentation Page 7

8 Student Information End Points: "Student Data" /api/schools/{schoolcode}/students/{studentid} SchoolCode required the Aeries School Code. This is normally StudentID optional the Aeries District Permanent ID Number. 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. Alternate End Point /api/schools/{schoolcode}/students/grade/{gradelevel} SchoolCode required the Aeries School Code. This is normally GradeLevel required the academic grade level of the set of students to return. This can be used against large districts if pulling all students in the district takes too long. Use this method to "chunk" the sets of students by looping from -2 to 18. Alternate End Point /api/schools/{schoolcode}/students/sn/{studentnumber} SchoolCode required the Aeries School Code. This is normally StudentNumber required the School-Based Student Number of the student to return. This can be used to pull a specific student record for a specific school. Students often have multiple student records in a district if they are concurrently enrolled or if they have changed schools some time this school year. Aeries API Documentation Page 8

9 Example Single and Multiple Student Information Results: <ArrayOfStudent xmlns:i=" xmlns=" <Student> <AddressVerified>false</AddressVerified> <AtRiskPoints> </AtRiskPoints> <AttendanceProgramCodeAdditional1/> <AttendanceProgramCodeAdditional2/> <AttendanceProgramCodePrimary/> <Birthdate> T00:00:00</Birthdate> <CorrespondanceLanguageCode>00</CorrespondanceLanguageCode> <DistrictEnterDate> T00: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> </HomePhone> <InactiveStatusCode/> <LanguageFluencyCode>L</LanguageFluencyCode> <LastName>Abbott</LastName> <LastNameAlias/> <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/> <NetworkLoginID/> <ParentEdLevelCode>12</ParentEdLevelCode> <ParentGuardianName>M/M A Abbott</ParentGuardianName> <PermanentID> </PermanentID> <RaceCode1>700</RaceCode1> <RaceCode2/> <RaceCode3/> <RaceCode4/> <RaceCode5/> <ResidenceAddress>1118 Glenview Lane</ResidenceAddress> <ResidenceAddressCity>Eagle Rock</ResidenceAddressCity> <ResidenceAddressState>CA</ResidenceAddressState> <ResidenceAddressZipCode>99999</ResidenceAddressZipCode> <ResidenceAddressZipExt>1234</ResidenceAddressZipExt> <SchoolCode>994</SchoolCode> <SchoolEnterDate> T00:00:00</SchoolEnterDate> <SchoolLeaveDate> T00:00:00</SchoolLeaveDate> <Sex>M</Sex> <StateStudentID> </StateStudentID> <Student Address>Allan.Abbott@example.com</Student Address> <StudentMobilePhone/> <StudentNumber>1</StudentNumber> <TeacherNumber>708</TeacherNumber> <Track/> <UserCode1/> <UserCode10/> Aeries API Documentation Page 9

10 <UserCode11/> <UserCode12/> <UserCode13/> <UserCode2/> <UserCode3/> <UserCode4>N</UserCode4> <UserCode5/> <UserCode6>G</UserCode6> <UserCode7>C</UserCode7> <UserCode8/> <UserCode9/> </Student> </ArrayOfStudent> Aeries API Documentation Page 10

11 Student Information Extended End Points: "Student Data" /api/v2/schools/{schoolcode}/students/{studentid}/extended SchoolCode required the Aeries School Code. This is normally StudentID optional the Aeries District Permanent ID Number. For all students, pass a 0 in this field. If Student ID passed is 0, 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. Alternate End Point /api/v2/schools/{schoolcode}/students/grade/{gradelevel}/extended SchoolCode required the Aeries School Code. This is normally GradeLevel required the academic grade level of the set of students to return. This can be used against large districts if pulling all students in the district takes too long. Use this method to "chunk" the sets of students by looping from -2 to 18. Alternate End Point /api/v2/schools/{schoolcode}/students/sn/{studentnumber}/extended SchoolCode required the Aeries School Code. This is normally StudentNumber required the School-Based Student Number of the student to return. This can be used to pull a specific student record for a specific school. Students often have multiple student records in a district if they are concurrently enrolled or if they have changed schools some time this school year. Aeries API Documentation Page 11

12 Example Single and Multiple Student Extended Information Results: <ArrayOfStudentExtended xmlns:i=" xmlns=" <StudentExtended> <CourseCompletionCSU>Y</CourseCompletionCSU> <CourseCompletionUC>Y</CourseCompletionUC> <DateRedesignatedFluentEnglishProficient i:nil="true"/> <DistrictMobility>1</DistrictMobility> <EndOfYearStatusCode/> <ExpectedGraduationDate i:nil="true"/> <GraduationRequirementsTrack/> <HomeLanguageSurveyAdultLanguageCode>00</HomeLanguageSurveyAdultLanguageCode> <HomeLanguageSurveyFirstLanguageCode>00</HomeLanguageSurveyFirstLanguageCode> <HomeLanguageSurveyHomeLanguageCode>00</HomeLanguageSurveyHomeLanguageCode> <HomeLanguageSurveyPrimaryLanguageCode>00</HomeLanguageSurveyPrimaryLanguageCode> <InterIntraDistrictTransferCode/> <PermanentID> </PermanentID> <QualifiedCSU>Y</QualifiedCSU> <QualifiedUC>Y</QualifiedUC> <RecordAddedDateTime i:nil="true"/> <RecordAddedSystem/> <SafeSchoolsActViolationDate> T00:00:00</SafeSchoolsActViolationDate> <SchedulingGroup/> <SchoolCode>994</SchoolCode> <SchoolCompletionDate i:nil="true"/> <SchoolCompletionStatusCode/> <SchoolMobility>9</SchoolMobility> <StateSchoolEnterDate> T00:00:00</StateSchoolEnterDate> <StateStudentID> </StateStudentID> <StudentNumber>1</StudentNumber> <SummerWithdrawalReasonCode/> <USEnterDate> T00:00:00</USEnterDate> <USSchoolEnterDate> T00:00:00</USSchoolEnterDate> <USSchoolsLessThan3Years/> </StudentExtended> </ArrayOfStudentExtended> Field Documentation: CourseCompletionCSU o (STU.CCS) The indicator for if this student has completed the course sequence for entrance into the CA State University (CSU) system CourseCompletionUC o (STU.CUC) The indicator for if this student has completed the course sequence for entrance into the University of CA (UC) system DateRedesignatedFluentEnglishProficient o (LAC.RD1) The Date the Student was redesignated/reclassified as Fluent English Proficient from an English Learner DistrictMobility o (STU.DM) The "District Mobility" - the grade level the student entered this District during the most recent span of contiguous enrollment. EndOfYearStatusCode o (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. ExpectedGraduationDate o (STU.EGD) The Expected Graduation Date for this Student. This field is normally inconsistently populated as it is no longer required by CALPADS. Aeries API Documentation Page 12

13 GraduationRequirementsTrack o (STU.GRT) The Graduation Requirements Track for a student HomeLanguageSurveyAdultLanguageCode o (LAC.L4) From the Home Language Survey - The language spoken most frequently by adults at home HomeLanguageSurveyFirstLanguageCode o (LAC.L1) From the Home Language Survey - The language first spoken by the student HomeLanguageSurveyHomeLanguageCode o (LAC.L3) From the Home Language Survey - The language spoken most frequently at home by the student HomeLanguageSurveyPrimaryLanguageCode o (LAC.L2) From the Home Language Survey - The language primarily spoken by the student InterIntraDistrictTransferCode o (STU.IT) The Inter/Intra-District Transfer Code for a student PermanentID o (STU.ID) The District Assigned Permanent ID for this Student QualifiedCSU o (STU.QCS) The indicator for if this student has qualified for entrance into the CA State University (CSU) system QualifiedUC o (STU.QUC) The indicator for if this student has qualified for entrance into the University of CA (UC) system RecordAddedDateTime o (STU.RDT) The Date/Time the student record was added to the system. RecordAddedSystem o (STU.RSY) The system used to add this student record. SafeSchoolsActViolationDate o (STU.SD) The Safe Schools Act Violation Date for this Student. AKA, the date the student violated a "Violent" Ed Code. SchedulingGroup o (STU.SG) The Scheduling Group for a student SchoolCode o (STU.SC) The Aeries School Code for this Student SchoolCompletionDate o (STU.DG) The School Completion Date. For High Schools this is the Graduation Date. SchoolCompletionStatusCode o (STU.HSG) The Completion Status Code for this student from the current school. For High Schools, this is the Graduation Status Code. SchoolMobility o (STU.SM) The "School Mobility" - the grade level the student entered this school during the most recent span of contiguous enrollment. StateSchoolEnterDate o (LAC.STS) The Date the Student first entered a school in the current state StateStudentID o (STU.CID) The State Student ID (SSID) for this Student StudentNumber o (STU.SN) The School-Level Aeries Student Number for this Student SummerWithdrawalReasonCode o (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 o (LAC.USE) The Date the Student first entered the US USSchoolEnterDate o (LAC.USS) The Date the Student first entered a US school to receive instruction USSchoolsLessThan3Years o (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. Aeries API Documentation Page 13

14 Student Data Changes End Point: "Student Data" api/v2/studentdatachanges/{dataarea}/{year}/{month}/{day}/{hour}/{minute} DataArea required the Aeries Student Data Area to be evaluated: o 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 "AM" and "PM" values are invalid. 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: <ArrayOfStudentKeys xmlns:i=" xmlns=" <StudentKeys> <PermanentID> </PermanentID> <SchoolCode>990</SchoolCode> <StudentNumber>400</StudentNumber> </StudentKeys> <StudentKeys> <PermanentID> </PermanentID> <SchoolCode>994</SchoolCode> <StudentNumber>1</StudentNumber> </StudentKeys> </ArrayOfStudentKeys> Aeries API Documentation Page 14

15 Student Enrollment History End Points: "Enrollment History" /api/v1/enrollment/{studentid} StudentID optional the Aeries District Permanent ID Number. For all students, pass a 0 in this field. If Student ID is not passed and 0 is sent instead, all students in the district will be returned with all years of enrollment history. Alternate End Point /api/v1/enrollment/{studentid}/year/{academicyear} StudentID optional the Aeries District Permanent ID Number. Pass a 0 for all students. SchoolYear required The full 4-digit year that corresponds to the year the school year started: "2015" for the school year. This can be used to pull just the current year's enrollment for all students in the district. Alternate End Point api/v1/schools/{schoolcode}/enrollment/{studentid} SchoolCode required the Aeries School Code. This is normally StudentID optional the Aeries District Permanent ID Number. Pass a 0 for all students. This can be used to pull the enrollment for a specific school for 1 or all students. All school years will be included. Alternate End Point api/v1/schools/{schoolcode}/enrollment/{studentid}}/year/{academicyear} SchoolCode required the Aeries School Code. This is normally StudentID optional the Aeries District Permanent ID Number. Pass a 0 for all students. SchoolYear required The full 4-digit year that corresponds to the year the school year started: "2015" for the school year. This can be used to pull the enrollment for a specific school for 1 or all students for a specific year. Aeries API Documentation Page 15

16 Example Student Enrollment History Results: <ArrayOfEnrollmentHistory xmlns:i=" xmlns=" <EnrollmentHistory> <AcademicYear>2015</AcademicYear> <AttendanceProgramCode/> <AttendanceProgramCodeAdditional1/> <AttendanceProgramCodeAdditional2/> <ElementaryTeacherName>Unassigned</ElementaryTeacherName> <ElementaryTeacherNumber>0</ElementaryTeacherNumber> <EnterDate> T00:00:00</EnterDate> <ExitReasonCode/> <Grade>12</Grade> <InterIntraDistrictTransferCode/> <LeaveDate i:nil="true"/> <PermanentID> </PermanentID> <SchoolCode>994</SchoolCode> <StudentNumber>1</StudentNumber> <Track/> </EnrollmentHistory > </ArrayOfEnrollmentHistory > Field Documentation: AcademicYear o (ENR.YR) The full 4-digit year the school year started with: "2015" for the school year. AttendanceProgramCode o (ENR.PR) The Attendance Program of the student during this enrollment period AttendanceProgramCodeAdditional1 o (ENR.AP1) The First Additional Attendance Program of the student during this enrollment period AttendanceProgramCodeAdditional2 o (ENR.AP2) The Second Additional Attendance Program of the student ElementaryTeacherName o (ENR.TE) The name of the elementary teacher associated with this enrollment period ElementaryTeacherNumber o (ENR.TN) The record number (school-specific) of the elementary teacher associated with this enrollment period. This value for prior year record may not match up to the Teacher Numbers in the current school year's Teacher table. EnterDate o (ENR.ED) The First day of this enrollment period ExitReasonCode o (ENR.ER) The Exit Reason Code for this enrollment. Codes used are current CALPADS codes. "440" is used to indicate a mid-year program, grade, or other enrollment change. Grade o (ENR.GR) The student grade level during this enrollment period InterIntraDistrictTransferCode o (ENR.IT) The Inter/Intra-District Transfer Code for this enrollmennt period LeaveDate o (ENR.LD) The last day of this enrollment period. This value will be NULL for students who finished the school year active and who will return the following year. PermanentID o (ENR.ID) The District Assigned Permanent ID for this Student SchoolCode o (ENR.SC) The Aeries School Code for this Student StudentNumber o (ENR.SN) The School-Level Aeries Student Number for this Student Track o (ENR.TR) The Attendance Calendar Track for this student Aeries API Documentation Page 16

17 Student GPA End Points: "Student Data" /api/schools/{schoolcode}/gpas/{studentid} SchoolCode required the Aeries School Code. This is normally StudentID optional the Aeries District Permanent ID Number. 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 Single and Multiple Student GPA Results: <ArrayOfStudentGPAs xmlns:i=" xmlns=" <StudentGPAs> <ClassRank>18</ClassRank> <ClassRank1012>16</ClassRank1012> <ClassSize>522</ClassSize> <CreditsAttempted> </CreditsAttempted> <CreditsCompleted> </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> </GradePointsCumulative> <GradeReportingClassRank>1</GradeReportingClassRank> <GradeReportingClassSize>467</GradeReportingClassSize> <GradeReportingCreditsAttempted>0.0000</GradeReportingCreditsAttempted> <GradeReportingCreditsCompleted>0.0000</GradeReportingCreditsCompleted> <PermanentID> </PermanentID> <SchoolCode>994</SchoolCode> </StudentGPAs> </ArrayOfStudentGPAs> Aeries API Documentation Page 17

18 Student Contacts End Points: "Contacts" /api/schools/{schoolcode}/contacts/{studentid} SchoolCode required the Aeries School Code. This is normally StudentID optional the Aeries District Permanent ID Number. If Student ID is not passed, all contacts for all students for the given school will be returned. Example Student Contact Results: <ArrayOfContact xmlns:i=" xmlns=" <Contact> <AccessToPortal/> <Address>5647 Elm St</Address> <AddressCity>Eagle rock</addresscity> <AddressState>CA</AddressState> <AddressZipCode>99998</AddressZipCode> <AddressZipExt/> <CellPhone/> <ContactOrder>1</ContactOrder> <CorrespondanceLanguageCode/> < Address/> <EmployerLocation/> <EmployerName/> <FirstName>Adam</FirstName> <HomePhone/> <LastName>Abbott</LastName> <LivesWithStudentIndicator/> <MailingName>Adam Abbott</MailingName> <MiddleName/> <MilitaryBranchCode>AR</MilitaryBranchCode> <MilitaryRankCode>SGT</MilitaryRankCode> <MilitaryStatusCode>X</MilitaryStatusCode> <MilitarySupervisorName>John Brown</MilitarySupervisorName> <MilitarySupervisorPhone> </MilitarySupervisorPhone> <NamePrefix/> <NameSuffix/> <Pager/> <PermanentID> </PermanentID> <RedFlag>true</RedFlag> <RelationshipToStudentCode>11</RelationshipToStudentCode> <SchoolCode>994</SchoolCode> <SequenceNumber>1</SequenceNumber> <WorkPhone> </WorkPhone> <WorkPhoneExt/> </Contact> </ArrayOfContact> Aeries API Documentation Page 18

19 Student Programs End Points: "Student Programs" /api/v2/schools/{schoolcode}/students/{studentid}/programs SchoolCode required the Aeries School Code. This is normally StudentID optional (pass "0" for all students) the Aeries District Permanent ID Number. If Student ID is not passed and you pass a 0 (zero) instead, all progams for all students for the given school will be returned. Example Student Programs Results: <ArrayOfStudentProgram xmlns:i=" xmlns=" <StudentProgram> <EligibilityEndDate i:nil="true" /> <EligibilityStartDate> T00:00:00</EligibilityStartDate> <ExtendedProperties> <ExtendedProperty> <Name>DisabilityCode</Name> <Value>240</Value> </ExtendedProperty> <ExtendedProperty> <Name>DisabilityCodeDescription</Name> <Value>Speech or Language Impairment (SLI)</Value> </ExtendedProperty> </ExtendedProperties> <ParticipationEndDate i:nil="true" /> <ParticipationStartDate i:nil="true" /> <ProgramCode>144</ProgramCode> <ProgramDescription>Special Education</ProgramDescription> <StudentID> </StudentID> </StudentProgram> </ArrayOfStudentProgram> Extended Properties: Program Code 144 Special Education o DisabilityCode o DisabilityCodeDescription o DisabilityCode2 o DisabilityCode2Description Program Code 190 Foster Program o FosterID Program Code 191 Homess Program o DwellingTypeCode o DwellingTypeCodeDescription Aeries API Documentation Page 19

20 Student Test Scores End Points: "Test Scores" /api/v2/students/{studentid}/tests StudentID required the Aeries District Permanent ID Number. 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 Scores Results: <ArrayOfTest xmlns:i=" xmlns=" <Test> <GradeLevel>10</GradeLevel> <PermanentID> </PermanentID> <Scores> <TestScore> <Score>431</Score> <Type>ScaleScore</Type> </TestScore> <TestScore> <Score>5.0000</Score> <Type>PerformanceLevel</Type> </TestScore> </Scores> <SequenceNumber>49</SequenceNumber> <TestDate> T00:00:00</TestDate> <TestDescription>Life Science</TestDescription> <TestID>CAHSEE</TestID> <TestPart>8</TestPart> <TestSource/> <TestType/> <TestingAdministration>SPRG14</TestingAdministration> </Test> </ArrayOfTest> Aeries API Documentation Page 20

21 Student Class Schedule End Points: "Class Schedules/History" /api/schools/{schoolcode}/classes/{studentid} SchoolCode required the Aeries School Code. This is normally StudentID optional the Aeries District Permanent ID Number. 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 Single and Multiple Student Class Schedule Results: <ArrayOfStudentClass xmlns:i=" xmlns=" <StudentClass> <CourseID>0317</CourseID> <DateEnded> T00:00:00</DateEnded> <DateStarted> T00:00:00</DateStarted> <Period>1</Period> <PeriodBlock>1</PeriodBlock> <PermanentID> </PermanentID> <SchoolCode>994</SchoolCode> <SectionNumber>1118</SectionNumber> <SequenceNumber>9</SequenceNumber> <TeacherNumber>804</TeacherNumber> </StudentClass> </ArrayOfStudentClass> Aeries API Documentation Page 21

22 Course Information End Points: "Course Data" /api/courses/{courseid} CourseID optional the Aeries Course ID (alpha-numeric). If Course ID is not passed, all courses in the district will be returned. Example Multiple Course Information Results: <ArrayOfCourse xmlns:i=" xmlns=" <Course> <CSFCourseList>A</CSFCourseList> <CSU_Rule_CanBeAnElective/> <CSU_Rule_HonorsCode/> <CSU_Rule_ValidationLevelCode/> <CSU_SubjectAreaCode>B</CSU_SubjectAreaCode> <CollegePrepIndicatorCode>P</CollegePrepIndicatorCode> <ContentDescription/> <CreditDefault>5.0000</CreditDefault> <CreditMax> </CreditMax> <DepartmentCode>E</DepartmentCode> <HighGrade>12</HighGrade> <ID>0301</ID> <InactiveStatusCode/> <LongDescription></LongDescription> <LowGrade>9</LowGrade> <NonAcademicOrHonorsCode></NonAcademicOrHonorsCode> <Notes/> <PhysicalEducationIndicator>false</PhysicalEducationIndicator> <StateCourseCode>2101</StateCourseCode> <SubjectArea1Code>A</SubjectArea1Code> <SubjectArea2Code></SubjectArea2Code> <SubjectArea3Code></SubjectArea3Code> <TeacherAideIndicator>false</TeacherAideIndicator> <TermTypeCode>Y</TermTypeCode> <Title>English 9 Cp</Title> <UC_Rule_CanBeAnElective>G</UC_Rule_CanBeAnElective> <UC_Rule_HonorsCode></UC_Rule_HonorsCode> <UC_Rule_ValidationLevelCode>0</UC_Rule_ValidationLevelCode> <UC_SubjectAreaCode>B</UC_SubjectAreaCode> </Course> </ArrayOfCourse> Example Single Course Information Results: <Course xmlns:i=" xmlns=" <CSFCourseList>A</CSFCourseList> <UC_SubjectAreaCode>B</UC_SubjectAreaCode> </Course> Aeries API Documentation Page 22

23 Course Data Changes End Point: "Course Data" 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 "AM" and "PM" values are invalid. 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 Data API one record at a time. Example Course Data Changes Results: <ArrayOfCourseKey xmlns:i=" xmlns=" <CourseKey> <ID>0004</ID> </CourseKey> <CourseKey> <ID>ENG001</ID> </CourseKey> </ArrayOfCourseKey> Aeries API Documentation Page 23

24 Staff Information End Points: "Staff Data" /api/v2/staff/{staffid} StaffID optional the Aeries District Staff ID (numeric). If Staff ID is not passed, all staff records in the district will be returned. Compared to the v1 of this end point, the Staff object now contains " Address", "PrimaryAeriesSchool" and "UserName". " Address" and "UserName" come from the security tables in Aeries.net. Example Multiple Staff Information Results: <ArrayOfStaff xmlns:i=" xmlns=" <Staff> <BirthDate> T00:00:00</BirthDate> <BirthYear>1950</BirthYear> <FirstName>Anthony</FirstName> <FullTimePercentage>38</FullTimePercentage> <HireDate> T00:00:00</HireDate> <ID>994601</ID> <InactiveStatusCode></InactiveStatusCode> <LastName>Aldrich</LastName> <LeaveDate i:nil="true" /> <MiddleName/> <PrimaryAeriesSchool>990</PrimaryAeriesSchool> <Sex>F</Sex> <StateEducatorID/> <UserName>a.aldrich</UserName> </Staff> </ArrayOfStaff> Example Single Staff Information Results: <Staff xmlns:i=" xmlns=" <BirthDate> T00:00:00</BirthDate> <BirthYear>1950</BirthYear> <FirstName>Anthony</FirstName> <FullTimePercentage>38</FullTimePercentage> <HireDate> T00:00:00</HireDate> <ID>994601</ID> <InactiveStatusCode></InactiveStatusCode> <LastName>Aldrich</LastName> <LeaveDate i:nil="true" /> <MiddleName/> <PrimaryAeriesSchool>990</PrimaryAeriesSchool> <Sex>F</Sex> <StateEducatorID/> <UserName>a.aldrich</UserName> </Staff> Aeries API Documentation Page 24

25 Staff Data Changes End Point: "Staff Data" 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 "AM" and "PM" values are invalid. 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 Data API one record at a time. Example Course Data Changes Results: <ArrayOfStaffKey xmlns:i=" xmlns=" <StaffKey> <ID>374892</ID> </StaffKey> <StaffKey> <ID> </ID> </StaffKey> </ArrayOfStaffKey> Aeries API Documentation Page 25

26 Teacher Information End Points: "Teacher Data" /api/schools/{schoolcode}/teachers/{teachernumber} SchoolCode required the Aeries School Code. This is normally TeacherNumber optional the School-Based Aeries Teacher Number. If Teacher Number is not passed, all teacher records in the given school will be returned. Example Multiple Teacher Information Results: <ArrayOfTeacher xmlns:i=" xmlns=" <Teacher> <DisplayName>Acosta, M</DisplayName> <FirstName>Maria</FirstName> <HighlyQualifiedStatusCode1/> <HighlyQualifiedStatusCode2/> <HighlyQualifiedStatusCode3/> <InactiveStatusCode/> <LastName>Acosta</LastName> <Room>12</Room> <SchoolCode>994</SchoolCode> <StaffID1>994605</StaffID1> <StaffID2>0</StaffID2> <StaffID3>0</StaffID3> <StateCourseCode/> <TeacherNumber>605</TeacherNumber> </Teacher> </ArrayOfTeacher> Example Single Teacher Information Results: <Teacher xmlns:i=" xmlns=" <DisplayName>Acosta, M</DisplayName> <FirstName>Maria</FirstName> <HighlyQualifiedStatusCode1/> <HighlyQualifiedStatusCode2/> <HighlyQualifiedStatusCode3/> <InactiveStatusCode/> <LastName>Acosta</LastName> <Room>12</Room> <SchoolCode>994</SchoolCode> <StaffID1>994605</StaffID1> <StaffID2>0</StaffID2> <StaffID3>0</StaffID3> <StateCourseCode/> <TeacherNumber>605</TeacherNumber> </Teacher> Aeries API Documentation Page 26

27 Staff-Teacher Information End Points: "Teacher Data" /api/v2/staff/{staffid}/teachers StaffID required the Aeries District Staff ID (numeric). This end point will return a list of teacher records associated with the given Staff ID. Example Multiple Teacher Information Results: <ArrayOfTeacher xmlns:i=" xmlns=" <Teacher> <DisplayName>Acosta, M</DisplayName> < Address>Teacher605@example.com</ Address> <FirstName>Maria</FirstName> <HighlyQualifiedStatusCode1/> <HighlyQualifiedStatusCode2/> <HighlyQualifiedStatusCode3/> <InactiveStatusCode/> <LastName>Acosta</LastName> <Room>12</Room> <SchoolCode>994</SchoolCode> <StaffID1>994605</StaffID1> <StaffID2>0</StaffID2> <StaffID3>0</StaffID3> <StateCourseCode/> <TeacherNumber>605</TeacherNumber> </Teacher> </ArrayOfTeacher> Aeries API Documentation Page 27

28 Section (from Master Schedule) Information End Points: "Master Schedule" /api/schools/{schoolcode}/sections/{sectionnumber} SchoolCode required the Aeries School Code. This is normally SectionNumber optional the School-Based Aeries Section Number. If Section Number is not passed, all section records in the master schedule of the given school will be returned. Example Multiple Section Information Results: <ArrayOfMasterScheduleSection xmlns:i=" xmlns=" <MasterScheduleSection> <CourseID>0353</CourseID> <Credit>5.0000</Credit> <Days>MTWTF</Days> <HighGrade>12</HighGrade> <HighlyQualifiedStatusCode1/> <HighlyQualifiedStatusCode2/> <HighlyQualifiedStatusCode3/> <InactiveStatusCode/> <LowGrade>10</LowGrade> <MaxStudents>2</MaxStudents> <Period>1</Period> <PeriodBlock>1</PeriodBlock> <Room>LIB</Room> <SchoolCode>994</SchoolCode> <SectionNumber>1005</SectionNumber> <Semester>Y</Semester> <SexRestriction/> <TeacherNumber1>635</TeacherNumber1> <TeacherNumber2>0</TeacherNumber2> <TeacherNumber3>0</TeacherNumber3> <TotalBoys>1</TotalBoys> <TotalGirls>1</TotalGirls> <TotalStudents>2</TotalStudents> </MasterScheduleSection> </ArrayOfMasterScheduleSection> Example Single Section Information Results: <MasterScheduleSection xmlns:i=" xmlns=" <CourseID>0353</CourseID> <SectionNumber>1005</SectionNumber> <TotalStudents>2</TotalStudents> </MasterScheduleSection> Aeries API Documentation Page 28

29 Section (from Master Schedule) Data Changes End Point: "Master Schedule" 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 "AM" and "PM" values are invalid. 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 Data API one record at a time. Example Course Data Changes Results: <ArrayOfMasterScheduleSectionKey xmlns:i=" xmlns=" <MasterScheduleSectionKey> <SchoolCode>994</SchoolCode> <SectionNumber>2034</SectionNumber> </MasterScheduleSectionKey> <MasterScheduleSectionKey> <SchoolCode>994</SchoolCode> <SectionNumber>1134</SectionNumber> </MasterScheduleSectionKey> </ArrayOfMasterScheduleSectionKey> Aeries API Documentation Page 29

30 Section Class Roster End Points: "Class Schedules/History" /api/v1/schools/{schoolcode}/sections/{sectionnumber}/students SchoolCode required the Aeries School Code. This is normally SectionNumber required the School-Based Aeries Section Number. 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: <ArrayOfStudentClass xmlns:i=" xmlns=" <StudentClass> <CourseID>0425</CourseID> <DateEnded> T00:00:00</DateEnded> <DateStarted> T00:00:00</DateStarted> <Period>3</Period><PeriodBlock>1</PeriodBlock> <PermanentID> </PermanentID> <SchoolCode>994</SchoolCode> <SectionNumber>3093</SectionNumber> <SequenceNumber>10</SequenceNumber> <TeacherNumber>610</TeacherNumber> </StudentClass> </ArrayOfStudentClass> Aeries API Documentation Page 30

31 Section Class Roster Data Changes End Point: "Class Schedules/History" 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 "AM" and "PM" values are invalid. 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 Course Data Changes Results: <ArrayOfMasterScheduleSectionKey xmlns:i=" xmlns=" <MasterScheduleSectionKey> <SchoolCode>994</SchoolCode> <SectionNumber>2034</SectionNumber> </MasterScheduleSectionKey> <MasterScheduleSectionKey> <SchoolCode>994</SchoolCode> <SectionNumber>1134</SectionNumber> </MasterScheduleSectionKey> </ArrayOfMasterScheduleSectionKey> Aeries API Documentation Page 31