Introduction

This article describes enhancements to the Aeries API that were developed for Always Be Learning, Inc for their Abl product to interact with the Aeries scheduling tables.  These enhancements are technically available to any vendor with appropriate permissions, though great caution must be exercised when adding, updating, or deleting information using the Aeries API.


Main API Documentation

Please refer to the Aeries API Full Documentation for more information about the Aeries API.  Version 4 (V4) of the Aeries API has not yet been fully released. Once a complete set of V4 endpoints is ready for publication, the main API documentation will be updated. In the meantime, separate documentation is being provided to appropriate vendors as V4 endpoints are added and updated.


Error Messages

As much as possible, human-readable errors will be returned by the endpoints described below. If the HTTP status code in the response indicates an error (code 400 or above), the response body should be parsed for the detailed error message.


Errors may occur for several reasons. Attempting to retrieve a single object that does not exist will result in a 404 Not Found error. Omitting a required field in a POST request payload will result in a 400 Bad Request error. A violation of other business rules in a POST or PUT request will also result in a 400 Bad Request error. For example, attempting to create a section using an inactive Course ID will generate an error.


Error Example (JSON):


{
    "Message": "Course ID is required."
}


Error Example (XML):


<Error>
    <Message>Course ID is required.</Message>
</Error>


Teacher Information

Revision:

  • Updated to V4 and added a new field.

Security Area:

  • "Teacher Data"

URL(s):

  • /api/v4/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.v4.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>
    <NextYearInactiveStatusCode></NextYearInactiveStatusCode>
    <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.v4.Models.Scheduling">
  <DisplayName>Acosta</DisplayName>
  <EmailAddress>Teacher605@example.com</EmailAddress>
  <FirstName>Heather</FirstName>
  <HighlyQualifiedStatusCode1></HighlyQualifiedStatusCode1>
  <HighlyQualifiedStatusCode2></HighlyQualifiedStatusCode2>
  <HighlyQualifiedStatusCode3></HighlyQualifiedStatusCode3>
  <InactiveStatusCode></InactiveStatusCode>
  <LastName></LastName>
  <NextYearInactiveStatusCode></NextYearInactiveStatusCode>
  <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
NextYearInactiveStatusCode
TCH.NTG
The inactive status code that will be effective as of the next school year. Any value other than blank indicates that this teacher should not be scheduled for next year.
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


Staff-Teacher Information

Revision:

  • Updated to V4.

Security Area:

  • "Teacher Data"

URL(s):

  • /api/v4/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:


<ArrayOfTeacher xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v4.Models.Scheduling">
  <Teacher>
    <DisplayName>Acosta</DisplayName>
    <EmailAddress>Teacher605@example.com</EmailAddress>
    <FirstName>Heather</FirstName>
    <HighlyQualifiedStatusCode1></HighlyQualifiedStatusCode1>
    <HighlyQualifiedStatusCode2></HighlyQualifiedStatusCode2>
    <HighlyQualifiedStatusCode3></HighlyQualifiedStatusCode3>
    <InactiveStatusCode></InactiveStatusCode>
    <LastName></LastName>
    <NextYearInactiveStatusCode></NextYearInactiveStatusCode>
    <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)


Course Information

Revision:

  • Updated to V4 and added new fields.

Security Area:

  • "Course Data"

URL(s):

  • /api/v4/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:


<ArrayOfCourse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v4.Models.Scheduling">
  <Course>
    <AlternateCourse></AlternateCourse>
    <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>
    <DefaultMaxStudents>0</DefaultMaxStudents>
    <DepartmentCode>M</DepartmentCode>
    <HighGrade>12</HighGrade>
    <ID>0618</ID>
    <InactiveStatusCode></InactiveStatusCode>
    <LongDescription>PreCalculus</LongDescription>
    <LowGrade>10</LowGrade>
    <NextYearInactiveStatusCode>X</NextYearInactiveStatusCode>
    <NonAcademicOrHonorsCode></NonAcademicOrHonorsCode>
    <Notes></Notes>
    <PhysicalEducationIndicator>false</PhysicalEducationIndicator>
    <PrerequisiteCourse></PrerequisiteCourse>
    <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:


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


Field Documentation:

Name
Aeries Table.Column
Description
AlternateCourse
CRS.AC
The Alternate Course is used as a reference for an optional course that a student can take if all classes of the primary course request are full.
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.
DefaultMaxStudents
CRS.MX
The default maximum seats available for this course.
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.
NextYearInactiveStatusCode
CRS.NTG
The inactive status code that will be effective as of the next school year. Any non-blank value indicates that the course should not be scheduled for next year.
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.
PrerequisiteCourse
CRS.PR
The Prerequisite Course is used as a reference for a required course that a student must take and pass prior to being enrolled in this course.
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.


Student Information

Revision:

  • Updated to V4 and added new fields.

Security Area:

  • "Student Data"

URL(s):

  • /api/v4/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/v4/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/v4/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:


<ArrayOfStudent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v4.Models.Student">
  <Student>
    <AddressVerified>false</AddressVerified>
    <AtRiskPoints>44.0000</AtRiskPoints>
    <AttendanceProgramCodeAdditional1></AttendanceProgramCodeAdditional1>
    <AttendanceProgramCodeAdditional2></AttendanceProgramCodeAdditional2>
    <AttendanceProgramCodePrimary></AttendanceProgramCodePrimary>
    <Birthdate>2000-11-11T00:00:00</Birthdate>
    <CorrespondanceLanguageCode>00</CorrespondanceLanguageCode>
    <CounselorNumber>708</CounselorNumber>
    <DistrictEnterDate>2006-11-11T00:00:00</DistrictEnterDate>
    <EthnicityCode>N</EthnicityCode>
    <FamilyKey>1480</FamilyKey>
    <FirstName>Allan</FirstName>
    <FirstNameAlias>AJ</FirstNameAlias>
    <Gender>M</Gender>
    <Grade>12</Grade>
    <GradeLevelLongDescription>Twelfth Grade</GradeLevelLongDescription>
    <GradeLevelShortDescription>12</GradeLevelShortDescription>
    <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>
    <NextGrade>13</NextGrade>
    <NextGradeLevelLongDescription>Reserved for Graduating Seniors</NextGradeLevelLongDescription>
    <NextGradeLevelShortDescription>13</NextGradeLevelShortDescription>
    <NextSchoolCode>0</NextSchoolCode>
    <NotificationPreferenceCode></NotificationPreferenceCode>
    <OldPermanentID>0</OldPermanentID>
    <ParentEdLevelCode>12</ParentEdLevelCode>
    <ParentEmailAddress></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>2013-09-05T00:00:00</SchoolEnterDate>
    <SchoolLeaveDate i:nil="true" />
    <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
Gender
STU.GN
Student's gender identification.  May be M or F or another coded value for non-binary gender identifications.
Grade
STU.GR
Student’s grade level. Valid range is (-2) – 18.
GradeLevelLongDescription
COD.DE
Long description of the student's grade level.
GradeLevelShortDescription
COD.CD
Short description of the student's grade level.  For most grade levels, this will be the same as Grade. There are some special grade levels such as -2, -1, 0, and 14-18 which may have different short descriptions (e.g., -1 = TK).
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
NextGrade
STU.NG
Student’s grade level for next school year. Valid range is (-2) – 18.
NextGradeLevelLongDescription
COD.DE
Long description of the student's next year grade level.
NextGradeLevelShortDescription
COD.CD
Short description of the student's next year grade level.
NextSchoolCode
STU.NS
The Aeries school code of the school the student will attend next year.
NotificationPreferenceCode
STU.NP
Indicates the Aeries Communications notification preference of this student
OldPermanentID
STU.OID
The student's old permanent ID. If this is populated with a value other than 0, this usually indicates that the student was copied from a feeder district, and this value is the student's permanent ID from the previous district. It could also indicate that the student's permanent ID was previously changed for some reason. It is also possible that a district is using this field for a different purpose than what is intended.
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
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


Section (from Scheduling Master Schedule)

Revision:

  • New set of endpoints for full CRUD access to Scheduling Master Schedule.

Security Area:

  • "Scheduling Master Schedule"

URL(s):

  • /api/v4/schools/{SchoolCode}/scheduling/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 scheduling master schedule of the given school will be returned.

Example Multiple Section (from Scheduling Master Schedule) Results:


<ArrayOfSchedulingMasterScheduleSection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v4.Models.Scheduling">
  <SchedulingMasterScheduleSection>
    <CareerTechnicalEducationProviderCode></CareerTechnicalEducationProviderCode>
    <ClassID>0</ClassID>
    <ClassTypeCode></ClassTypeCode>
    <CountsForADA></CountsForADA>
    <CourseID>0917</CourseID>
    <Credit>5.0000</Credit>
    <DistanceLearningIndicator></DistanceLearningIndicator>
    <EducationServiceCode>4</EducationServiceCode>
    <ExclusionCode></ExclusionCode>
    <FundingSourceCode></FundingSourceCode>
    <GenderRestriction></GenderRestriction>
    <HighGrade>12</HighGrade>
    <HighlyQualifiedStatusCode1></HighlyQualifiedStatusCode1>
    <HighlyQualifiedStatusCode2></HighlyQualifiedStatusCode2>
    <HighlyQualifiedStatusCode3></HighlyQualifiedStatusCode3>
    <HourlyAttendanceProgramCode></HourlyAttendanceProgramCode>
    <InactiveStatusCode></InactiveStatusCode>
    <IndependentStudyIndicator></IndependentStudyIndicator>
    <InstructionalStrategyCode>500</InstructionalStrategyCode>
    <ItinerantTeacherIndicator>0</ItinerantTeacherIndicator>
    <LanguageOfInstructionCode>00</LanguageOfInstructionCode>
    <LowGrade>9</LowGrade>
    <MaxStudents>20</MaxStudents>
    <MonthlyMinutes>0</MonthlyMinutes>
    <MultiTeacherCode></MultiTeacherCode>
    <Period>1</Period>
    <PeriodBlock>1</PeriodBlock>
    <PopulationServedCode></PopulationServedCode>
    <ProgramCode></ProgramCode>
    <Room>F8</Room>
    <SchedulingGroup></SchedulingGroup>
    <SchoolCode>994</SchoolCode>
    <SectionNumber>1109</SectionNumber>
    <Semester>Y</Semester>
    <SemesterGroup></SemesterGroup>
    <SplitTerm>MTWTF</SplitTerm>
    <TeacherNumber1>808</TeacherNumber1>
    <TeacherNumber2>0</TeacherNumber2>
    <TeacherNumber3>0</TeacherNumber3>
    <TeamCourseGroup></TeamCourseGroup>
    <TeamNumber>0</TeamNumber>
    <TotalBoys>12</TotalBoys>
    <TotalGirls>4</TotalGirls>
    <TotalPrescheduled>0</TotalPrescheduled>
    <TotalStudents>16</TotalStudents>
    <Track></Track>
    <UseSupplementalAttendance>false</UseSupplementalAttendance>
    <UserCode1></UserCode1>
    <UserCode2></UserCode2>
    <UserCode3></UserCode3>
    <UserCode4></UserCode4>
    <UserCode5></UserCode5>
    <UserCode6></UserCode6>
    <UserCode7></UserCode7>
    <UserCode8></UserCode8>
  </SchedulingMasterScheduleSection>
  …
  …
</ArrayOfSchedulingMasterScheduleSection>


Example Single Section (from Scheduling Master Schedule) Results:


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


Field Documentation:


Name
Aeries Table.Column
Description
CareerTechnicalEducationProviderCode
SMS.TEP
Indicates what entity is providing the Career Technical Education class (e.g., “ROP” or “District”)
ClassID
SMS.CID
This field is used to identify separate sections as an individual "Class". The Class Size Reduction Reports use the Class ID field.
ClassTypeCode
SMS.CTY
For Texas state reporting, this field indicates the type of class.
CountsForADA
SMS.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
SMS.CN
The Aeries District Course ID
Credit
SMS.CR
The number of credits a student will receive for taking this section.
Days
SMS.DY
The days of the week this class meets
DistanceLearningIndicator
SMS.DLI
Indicates whether this section is offered through distance learning (e.g., online course).
EducationServiceCode
SMS.ESR
The type of education service provided to English Learners in this class
ExclusionCode
SMS.ST
Whether this section should be excluded from grades and/or attendance reporting
FundingSourceCode
SMS.FS
The funding source for this section (e.g., California Partnership Academy)
GenderRestriction
SMS.SX
This section is restricted to students of a particular gender
HighGrade
SMS.HI
The highest grade level of students who would normally take this section.
HighlyQualifiedStatusCode1
SMS.HQT
The method by which the primary teacher became Highly Qualified to teach this subject
HighlyQualifiedStatusCode2
SMS.HQ2
For team teaching/job sharing, the method by which Teacher 2 became Highly Qualified to teach this subject
HighlyQualifiedStatusCode3
SMS.HQ3
For team teaching/job sharing, the method by which Teacher 3 became Highly Qualified to teach this subject
HourlyAttendanceProgramCode
SMS.HP
(no longer used) Was used in summer schools for funding purposes.
InactiveStatusCode
SMS.STG
Any value other than blank indicates this section is inactive. Inactive sections should not have any students enrolled.
IndependentStudyIndicator
SMS.ISI
Indicates whether this is an independent study class
InstructionalStrategyCode
SMS.INS
The instructional strategy used in this class for specific student groups such English Learners or special education students
ItinerantTeacherIndicator
SMS.IT
Indicates whether this section is taught by an itinerant teacher
LanguageOfInstructionCode
SMS.LI
The language in which this class is taught.
LowGrade
SMS.LO
The lowest grade level of students who would normally take this section.
MaxStudents
SMS.MX
The maximum number of students who can enroll in this section (i.e., class capacity).
MonthlyMinutes
SMS.MMN
For Texas state reporting, this field represents the total number of minutes this class is taught in a month (typically a four-week period).
MultiTeacherCode
SMS.MTS
The type of multi-teacher configuration for this section (such as team teaching or job sharing)
Period
SMS.PD
The period (0 – 9) this class meets
PeriodBlock
SMS.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.
PopulationServedCode
SMS.PSV
For Texas state reporting, this field indicates the type of student population served by this section.
ProgramCode
SMS.PR
Special program related to this section. Certain reports in Aeries can be limited by special program.
Room
SMS.RM
The room number in which this class meets
SchedulingGroup
SMS.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
SMS.SC
The Aeries school code
SectionNumber
SMS.SE
The school-based Aeries section number
Semester
SMS.SM
The term during which this section meets
SemesterGroup
SMS.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
SMS.TN
The school-based Aeries teacher number of the teacher primarily responsible for this section.
TeacherNumber2
SMS.TN2
The teacher number of the second teacher teaching this section
TeacherNumber3
SMS.TN3
The teacher number of the third teacher teaching this section
TeamCourseGroup
SMS.CG
The team course group is used to create groups of sections to be further divided into teams.
TeamNumber
SMS.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
SMS.TB
The total number of boys (males) currently enrolled in the section
TotalGirls
SMS.TG
The total number of girls (females) currently enrolled in the section
TotalPrescheduled
SMS.PS
The total number of students currently pre-scheduled in the section
TotalStudents
SMS.TS
The total number of students currently enrolled in the sections
Track
SMS.TR
This section is restricted to students in a specific attendance track.
UseSupplementalAttendance
SMS.USA
Indicates whether attendance for the section is based on Supplemental Attendance.
UserCode1
SMS.U1
User-defined code 1
UserCode2
SMS.U2
User-defined code 2
UserCode3
SMS.U3
User-defined code 3
UserCode4
SMS.U4
User-defined code 4
UserCode5
SMS.U5
User-defined code 5
UserCode6
SMS.U6
User-defined code 6
UserCode7
SMS.U7
User-defined code 7
UserCode8
SMS.U8
User-defined code 8



Section (from Scheduling Master Schedule) - Create


Security Area:

  • "Scheduling Master Schedule" - Insert

URL(s):

  • POST /api/v4/schools/{SchoolCode}/scheduling/sections
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.

Notes:

  • After a successful request, this end point returns HTTP status code 201, and the response body contains the "SchedulingMasterScheduleSection" object that was just created.

POST Payload Object:

  • “SchedulingMasterScheduleSectionUpdate” object


“SchedulingMasterScheduleSectionUpdate” Object Definition:

Name
Data Type
Notes
SectionNumber
Int16
The section number that forms part of the primary key. If omitted, the section number will automatically be generated for the new record.
Period
Int16
REQUIRED: Valid values are 0-9.
PeriodBlock
Int16
REQUIRED: Valid values are 1-10. Also, the sum of Period + PeriodBlock must be less than or equal to 10.
Semester
String
REQUIRED Max length: 1. Must be a valid Term for the school.
SplitTerm
String
Max length: 6. Indicates when the class meets. Valid values include "A-DAYS", "B-DAYS", "FIRST", "SECOND", "DAILY", or a list of days of the week with dashes as placeholders for days the class does not meet. E.g., MTWTF or M-W-F or -T-T- .
CourseID
String
REQUIRED Max length: 6: The District Course ID for this section
TeacherNumber1
Int16
REQUIRED: The school-based teacher number of the primary teacher of this section
TeacherNumber2
Int16

TeacherNumber3
Int16

HighlyQualifiedStatusCode1
String
Max length: 1
HighlyQualifiedStatusCode2
String
Max length: 1
HighlyQualifiedStatusCode3
String
Max length: 1
Room
String
Max length: 6
Credit
Decimal

GenderRestriction
String
Max length: 1
LowGrade
Int16

HighGrade
Int16

MaxStudents
Int16

InactiveStatusCode
String
Max length: 1
ProgramCode
String
Max length: 3
HourlyAttendanceProgramCode
String
Max length: 2
ExclusionCode
String
Max length: 1
CountsForADA
String
Max length: 1
MultiTeacherCode
String
Max length: 2
SchedulingGroup
String
Max length: 2
TeamCourseGroup
String
Max length: 2
TeamNumber
Int16

SemesterGroup
String
Max length: 1
Track
String
Max length: 1
ClassID
Int32

EducationServiceCode
String
Max length: 1
LanguageOfInstructionCode
String
Max length: 2
InstructionalStrategyCode
String
Max length: 3
FundingSourceCode
String
Max length: 3
CareerTechnicalEducationProviderCode
String
Max length: 1
IndependentStudyIndicator
String
Max length: 1
DistanceLearningIndicator
String
Max length: 1
ItinerantTeacherIndicator
String
Max length: 1
UseSupplementalAttendance
Boolean
true or false
PopulationServedCode
String
Max length: 2
ClassTypeCode
String
Max length: 2
MonthlyMinutes
Int16

UserCode1
String
Max length: 3
UserCode2
String
Max length: 3
UserCode3
String
Max length: 3
UserCode4
String
Max length: 3
UserCode5
String
Max length: 3
UserCode6
String
Max length: 3
UserCode7
String
Max length: 3
UserCode8
String
Max length: 3


Example POST Payload:

{
    "Period": 8,
    "PeriodBlock": 2,
    "Semester": "Y",
    "SplitTerm": "MTWTF",
    "CourseID": "0917",
    "TeacherNumber1": 808,
    "TeacherNumber2": 0,
    "TeacherNumber3": 0,
    "HighlyQualifiedStatusCode1": "",
    "HighlyQualifiedStatusCode2": "",
    "HighlyQualifiedStatusCode3": "",
    "Room": "F8",
    "Credit": 5,
    "GenderRestriction": "",
    "LowGrade": 9,
    "HighGrade": 12,
    "MaxStudents": 20,
    "InactiveStatusCode": "",
    "ProgramCode": "",
    "HourlyAttendanceProgramCode": "",
    "ExclusionCode": "",
    "CountsForADA": "",
    "MultiTeacherCode": "",
    "SchedulingGroup": "",
    "TeamCourseGroup": "",
    "TeamNumber": 0,
    "SemesterGroup": "",
    "Track": "",
    "ClassID": 0,
    "EducationServiceCode": "4",
    "LanguageOfInstructionCode": "00",
    "InstructionalStrategyCode": "500",
    "FundingSourceCode": "",
    "CareerTechnicalEducationProviderCode": "",
    "IndependentStudyIndicator": "",
    "DistanceLearningIndicator": "",
    "ItinerantTeacherIndicator": "0",
    "UseSupplementalAttendance": false,
    "PopulationServedCode": "",
    "ClassTypeCode": "",
    "MonthlyMinutes": 0,
    "UserCode1": "",
    "UserCode2": "",
    "UserCode3": "",
    "UserCode4": "",
    "UserCode5": "",
    "UserCode6": "",
    "UserCode7": "",
    "UserCode8": ""
}


Section (from Scheduling Master Schedule) - Update


Security Area:

  • "Scheduling Master Schedule" - Update

URL(s):

  • PUT /api/v4/schools/{SchoolCode}/scheduling/sections/{SectionNumber}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • SectionNumber (required) - the school-based section number for a single record

Notes:

  • If the section number does not exist, a new record will be created.
  • After a successful request, this end point returns the "SchedulingMasterScheduleSection" object that was just updated or created. If an existing record was updated, the status code will be 200. If a new record was created, the status code will be 201.

PUT Payload Object:

  • “SchedulingMasterScheduleSectionUpdate” object


“SchedulingMasterScheduleSectionUpdate” Object Definition:


The definition is the same that is given with the Section (from Scheduling Master Schedule) - Create documentation, with the following exceptions:


  • SectionNumber is ignored in the body. The SectionNumber from the URL is used instead.
  • There are no required elements when updating an existing record. Elements that are omitted from the request will be unchanged on the existing record.
  • IMPORTANT: When changing the CourseID, the following additional element is required in the object passed in the request body:


Name
Data Type
Notes
StudentScheduleOptions
String
Valid values are "LockedStudents", "AllStudents", and "DropStudents". This element determines what action to take with Student Course Requests that are already assigned to this section.  If there are no Student Course Requests assigned to this section, this element will be ignored.

LockedStudents: Update the Course Request Course ID only for students whose section assignment is Locked (either the PermanentLockCode is populated, or the RejectCode is populated with '*'). All other students will have their Course Request unassigned from this section.
AllStudents: Update the Course Request Course ID for all students currently assigned to this section.
DropStudents: Unassign all students from this section. The actual Student Course Requests will be kept, but the section assignment will be cleared.


Example PUT Payload:

{
    "CourseID": "0917",
    "StudentScheduleOptions": "LockedStudents"
}


Section (from Scheduling Master Schedule) - Delete


Security Area:

  • "Scheduling Master Schedule" - Delete

URL(s):

  • DELETE /api/v4/schools/{SchoolCode}/scheduling/sections/{SectionNumber}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • SectionNumber (required) - the school-based section number for a single record

Notes:

  • After a successful request, an empty response with HTTP status code 204 will be returned.
  • If there are Student Course Requests assigned to the section, they will automatically be unassigned from the section. The actual Student Course Requests will be kept, but the section assignment will be cleared.


Student Course Requests

Revision:

  • New set of endpoints for full CRUD access to Student Course Requests.

Security Area:

  • "Student Scheduling Schedules (Course Requests)"

URL(s):

  • /api/v4/schools/{SchoolCode}/scheduling/courserequests
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
  • /api/v4/schools/{SchoolCode}/students/{StudentID}/courserequests/{SequenceNumber}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (required) - The Aeries Student District Permanent ID Number.
    • SequenceNumber (optional) - The sequence number for a single record for the given student.

Notes:

  • If the student is not passed, all student course request records for the school will be returned.
  • If Sequence Number is not passed, all student course request records for the given student will be returned.

Example Multiple Student Course Requests Results:


<ArrayOfStudentCourseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v4.Models.Scheduling">
  <StudentCourseRequest>
    <AlternateCourseID>311</AlternateCourseID>
    <AlternateTag></AlternateTag>
    <CourseID>0726</CourseID>
    <PermanentID>99400001</PermanentID>
    <PermanentLockCode></PermanentLockCode>
    <PreferredTeacherNumber>605</PreferredTeacherNumber>
    <RejectCode>*</RejectCode>
    <SchoolCode>994</SchoolCode>
    <SectionNumber>1038</SectionNumber>
    <SequenceNumber>1</SequenceNumber>
  </StudentCourseRequest>
  …
</ArrayOfStudentCourseRequest>


Example Single Student Course Request Results:


<StudentCourseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
   xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v4.Models.Scheduling">
    <AlternateCourseID>311</AlternateCourseID>
    <AlternateTag></AlternateTag>
    <CourseID>0726</CourseID>
    <PermanentID>99400001</PermanentID>
    <PermanentLockCode></PermanentLockCode>
    <PreferredTeacherNumber>605</PreferredTeacherNumber>
    <RejectCode>*</RejectCode>
    <SchoolCode>994</SchoolCode>
    <SectionNumber>1038</SectionNumber>
    <SequenceNumber>1</SequenceNumber>
</StudentCourseRequest>


Field Documentation:

Name
Aeries Table.Column
Description
AlternateCourseID
SSS.AC
The District course ID of the alternate course that has been requested.
AlternateTag
SSS.AT
Valid values are blank and 'X'. An 'X' indicates that the Scheduler has swapped the alternate course and the primary course because the primary course could not be scheduled.
CourseID
SSS.CN
The District course ID of the primary course that has been requested.
PermanentID
STU.ID
The Permanent ID for the student
PermanentLockCode
SSS.PL
A non-blank value indicates that the assigned section is locked and should not be changed on subsequent runs of the Scheduler.
PreferredTeacherNumber
SSS.TN
The school-specific teacher number for the preferred teacher for this student course request. If a section number is assigned, this is NOT necessarily the same as the teacher of that section.
RejectCode
SSS.RT
See Codes API for valid values and descriptions. A value of '*' indicates that the assigned section is locked and should not be changed on subsequent runs of the Scheduler. Any other non-blank value indicates a reason that the requested course could not be scheduled for the student.
SchoolCode
SSS.SC
The Aeries school code
SectionNumber
SSS.SE
The section number assigned to this student course request from the Scheduling Master Schedule
SequenceNumber
SSS.SQ
The sequence number is part of the primary key. It has no independent meaning.


Student Course Requests - Create


Security Area:

  • "Student Scheduling Schedules (Course Requests)" - Insert

URL(s):

  • POST /api/v4/schools/{SchoolCode}/students/{StudentID}/courserequests
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (required) - The Aeries Student District Permanent ID Number.ven student.

Notes:

  • After a successful request, this end point returns HTTP status code 201, and the response body contains the "StudentCourseRequest" object that was just created.

POST Payload Object:

  • “StudentCourseRequestUpdate” object


“StudentCourseRequestUpdate” Object Definition:

Name
Data Type
Notes
SequenceNumber
Int16
The sequence number that forms part of the primary key. If omitted, the sequence number will automatically be generated for the new record. Aeries recommends allowing the system to automatically assign the sequence number.
SectionNumber
Int16
If populated, must be a valid Section Number from the Scheduling Master Schedule. This indicates that the student has been assigned to this section during the scheduling process. Also, the Course ID for this course request must match the Course ID of the Scheduling Master Schedule section.
CourseID
String
REQUIRED Max length: 6: The District Course ID for this course request.
PreferredTeacherNumber
Int16
The school-based teacher number of the preferred teacher for this course request.
RejectCode
String
Max length: 2. Must be a valid code. Use the Codes API for valid codes and descriptions.
AlternateCourseID
String
Max length: 6. If populated, must be a valid District Course ID. The Alternate Course ID may not be the same as the primary Course ID.
AlternateTag
String
Max length: 1. Valid values are blank and 'X'. An 'X' indicates that the Scheduler has swapped the alternate course and the primary course because the primary course could not be scheduled.
PermanentLockCode
String
Max length: 2


Example POST Payload:

{
    "SectionNumber": 1109,
    "CourseID": "0917",
    "PreferredTeacherNumber": 808,
    "RejectCode": "*",
    "AlternateCourseID": "0095",
    "AlternateTag": "",
    "PermanentLockCode": ""
}


Student Course Requests - Update


Security Area:

  • "Student Scheduling Schedules (Course Requests)" - Update

URL(s):

  • PUT /api/v4/schools/{SchoolCode}/students/{StudentID}/courserequests/{SequenceNumber}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (required) - The Aeries Student District Permanent ID Number.
    • SequenceNumber (required) - The sequence number for a single record for the given student. Must be greater than 0.

Notes:

  • If the sequence number does not exist, a new record will be created.
  • After a successful request, this end point returns the "StudentCourseRequest" object that was just updated or created. If an existing record was updated, the status code will be 200. If a new record was created, the status code will be 201.

PUT Payload Object:

  • “StudentCourseRequestUpdate” object


“StudentCourseRequestUpdate” Object Definition:


The definition is the same that is given with the Student Course Requests - Create documentation, with the following exceptions:


  • SequenceNumber is ignored in the body. The SequenceNumber from the URL is used instead.
  • There are no required elements when updating an existing record. Elements that are omitted from the request will be unchanged on the existing record.


Example PUT Payload:

{     "SectionNumber": 1038,
      "PermanentLockCode": "A"
}


Student Course Requests - Delete


Security Area:

  • "Student Scheduling Schedules (Course Requests)" - Delete

URL(s):

  • DELETE /api/v4/schools/{SchoolCode}/students/{StudentID}/courserequests/{SequenceNumber}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • StudentID (required) - The Aeries Student District Permanent ID Number.
    • SequenceNumber (required) - The sequence number for a single record for the given student.

Notes:

  • After a successful request, an empty response with HTTP status code 204 will be returned.