Pre-Enroll Student
The Pre-Enroll Student endpoint allows a student to be transferred as a pre-enrolled student to their approved school for the next school year.
Security Area:
- "Trigger Student Pre-Enrollment" - Insert
URL:
- GET /api/v5/commands/preenrollstudent/{StudentID}
- StudentID (required) – the Aeries Student District Student ID Number.
Notes:
- The NextSchool field of the active record determines where the student will be pre-enrolled.
- A student record must be active to be pre-enrolled to another school. The system will automatically determine the most recent active record if the student has more than one.
- Any existing pre-enrolled records for the student at schools other than the Next School are removed: they are deleted if Aeries allows the student record to be deleted; otherwise their inactive status is set to “R”. This happens even if the new pre-enrolled record can’t be created. There should only ever be one pre-enrolled record for a student at a given time.
- There are several reasons the creation of the pre-enrolled student record could fail. The most common is that the Next Grade is invalid for the Next School. If the student already has an active or pre-enrolled record at the Next School, no new record is created. If the student has an inactive record there, that record is changed to pre-enrolled (with Grade and Next Grade updated) instead; LogDetails then shows Copied = “No” and Exception = “Existing Inactive to Pre-Enrolled”. If the pre-enrollment fails, check the LogDetails object for more information.
- This endpoint will return a complex PreEnrollStudentResult object. This object includes LogDetails with information about the status of the request. It also includes an array of student objects representing the active and pre-enrolled student records for the given Student ID, including the newly created pre-enrolled record (if successful). For the full list of Student fields, see the Student Information section of the Student-related end points article.
- Possible Exception values in LogDetails: “Already pre-enrolled”, “Already active”, “Existing Inactive to Pre-Enrolled”, “Add Where Exist”, and “NG not in NS range” (the Next Grade is not valid for the Next School).
- If the Student ID is 0 or less, the end point returns HTTP 204. If none of the student’s active records has a Next School, it returns HTTP 204 with the message “Student matriculation data not set.” If the student doesn’t qualify for pre-enrollment (for example, the Next School is the same as the current school), LogDetails is empty.
Example Pre-Enroll Student Results:
{
"LogDetails": [
{
"StudentID": 99300014,
"SchoolCode": 993,
"StudentNumber": 14,
"Grade": 8,
"NextGrade": 9,
"NextSchool": 994,
"NewStudentNumber": 2786,
"Copied": "Yes",
"Exception": ""
}
],
"Students": [
{
"StudentID": 99300014,
"OldStudentID": 0,
"CorrespondenceLanguageCode": "00",
"SchoolCode": 993,
"StudentNumber": 14,
"StateStudentID": "0099300014",
"LastName": "Albert",
"FirstName": "Alison",
"MiddleName": "A",
"LastNameAlias": "",
"FirstNameAlias": "",
"MiddleNameAlias": "",
"Gender": "F",
"Grade": 8,
"GradeLevelShortDescription": "8",
"GradeLevelLongDescription": "Eighth Grade",
"Birthdate": "2006-11-07T00:00:00",
"ParentGuardianName": "M/M A Albert",
"HomePhone": "9996334125",
"StudentMobilePhone": "",
"MailingAddress": "10922 Pembroke Dr",
"MailingAddressCity": "Eagle Point",
"MailingAddressState": "CA",
"MailingAddressZipCode": "99999",
"MailingAddressZipExt": "",
"ResidenceAddress": "10922 Pembroke Dr",
"ResidenceAddressCity": "Eagle Point",
"ResidenceAddressState": "CA",
"ResidenceAddressZipCode": "99999",
"ResidenceAddressZipExt": "",
"AddressVerified": false,
"EthnicityCode": "N",
"RaceCode1": "700",
"RaceCode2": "",
"RaceCode3": "",
"RaceCode4": "",
"RaceCode5": "",
"UserCode1": "",
"UserCode2": "",
"UserCode3": "",
"UserCode4": "Y",
"UserCode5": "",
"UserCode6": "",
"UserCode7": "",
"UserCode8": "",
"UserCode9": "Y",
"UserCode10": "",
"UserCode11": "",
"UserCode12": "",
"UserCode13": "",
"SchoolEnterDate": "2017-09-04T00:00:00",
"SchoolLeaveDate": null,
"DistrictEnterDate": "2006-11-07T00:00:00",
"CounselorNumber": 0,
"Track": "",
"AttendanceProgramCodePrimary": "",
"AttendanceProgramCodeAdditional1": "",
"AttendanceProgramCodeAdditional2": "",
"LockerNumber": "",
"LowSchedulingPeriod": 0,
"HighSchedulingPeriod": 9,
"InactiveStatusCode": "",
"FamilyKey": 216,
"LanguageFluencyCode": "",
"HomeLanguageCode": "",
"ParentEdLevelCode": "",
"ParentEmailAddress": "",
"StudentEmailAddress": "Alison.Albert@example.com",
"NetworkLoginID": "",
"EarlyWarningPoints": "9.0000",
"HomeRoomTeacherNumber": "0",
"NotificationPreferenceCode": "",
"NextSchoolCode": 994,
"NextGrade": 9,
"NextGradeLevelShortDescription": "9",
"NextGradeLevelLongDescription": "Ninth Grade",
"RecordsReleaseCode": ""
},
{
"StudentID": 99300014,
"OldStudentID": 0,
"CorrespondenceLanguageCode": "00",
"SchoolCode": 994,
"StudentNumber": 2786,
"StateStudentID": "0099300014",
"LastName": "Albert",
"FirstName": "Alison",
"MiddleName": "A",
"LastNameAlias": "",
"FirstNameAlias": "",
"MiddleNameAlias": "",
"Gender": "F",
"Grade": 8,
"GradeLevelShortDescription": "8",
"GradeLevelLongDescription": "Eighth Grade",
"Birthdate": "2006-11-07T00:00:00",
"ParentGuardianName": "M/M A Albert",
"HomePhone": "9996334125",
"StudentMobilePhone": "",
"MailingAddress": "10922 Pembroke Dr",
"MailingAddressCity": "Eagle Point",
"MailingAddressState": "CA",
"MailingAddressZipCode": "99999",
"MailingAddressZipExt": "",
"ResidenceAddress": "10922 Pembroke Dr",
"ResidenceAddressCity": "Eagle Point",
"ResidenceAddressState": "CA",
"ResidenceAddressZipCode": "99999",
"ResidenceAddressZipExt": "",
"AddressVerified": false,
"EthnicityCode": "N",
"RaceCode1": "700",
"RaceCode2": "",
"RaceCode3": "",
"RaceCode4": "",
"RaceCode5": "",
"UserCode1": "",
"UserCode2": "",
"UserCode3": "",
"UserCode4": "Y",
"UserCode5": "",
"UserCode6": "",
"UserCode7": "",
"UserCode8": "",
"UserCode9": "Y",
"UserCode10": "",
"UserCode11": "",
"UserCode12": "",
"UserCode13": "",
"SchoolEnterDate": "2017-09-04T00:00:00",
"SchoolLeaveDate": null,
"DistrictEnterDate": "2006-11-07T00:00:00",
"CounselorNumber": 0,
"Track": "",
"AttendanceProgramCodePrimary": "",
"AttendanceProgramCodeAdditional1": "",
"AttendanceProgramCodeAdditional2": "",
"LockerNumber": "",
"LowSchedulingPeriod": 0,
"HighSchedulingPeriod": 9,
"InactiveStatusCode": "*",
"FamilyKey": 216,
"LanguageFluencyCode": "",
"HomeLanguageCode": "",
"ParentEdLevelCode": "",
"ParentEmailAddress": "",
"StudentEmailAddress": "Alison.Albert@example.com",
"NetworkLoginID": "",
"EarlyWarningPoints": "9.0000",
"HomeRoomTeacherNumber": "0",
"NotificationPreferenceCode": "",
"NextSchoolCode": 994,
"NextGrade": 9,
"NextGradeLevelShortDescription": "9",
"NextGradeLevelLongDescription": "Ninth Grade",
"RecordsReleaseCode": ""
}
]
}Pre-Enroll Student to a Chosen School
The Pre-Enroll Student to a Chosen School endpoint pre-enrolls a student into a school you specify, instead of the Next School already on the student’s record.
Security Area:
- "Trigger Student Pre-Enrollment" - Insert
URL:
- GET /api/v5/commands/preenrollstudent/{StudentID}/{NextSchool}
- StudentID (required) – the Aeries Student District Student ID Number.
- NextSchool (required) – the Aeries School Code where the student should be pre-enrolled.
Notes:
- Important: This end point uses the HTTP GET verb, but it changes data in Aeries.
- The end point handles the student based on the records they already have, in this order:
- If the student already has a record at NextSchool, no new record is created. An inactive record there is changed to pre-enrolled; an active or pre-enrolled record is left as is. Pre-enrolled records at other schools are removed.
- Otherwise, if the student has one or more active records, the Next School on all of the student’s active records is changed to NextSchool, and then the standard Pre-Enroll Student process runs (see above).
- Otherwise, if the student has a pre-enrolled record at another school, the most recently changed pre-enrolled record is copied to NextSchool as a pre-enrolled record, and the student’s other pre-enrolled records are removed.
- Otherwise, the student’s most recent inactive record is copied to NextSchool as a pre-enrolled record. If that record is already at NextSchool, it is marked as pre-enrolled instead.
- Removed pre-enrolled records are deleted if Aeries allows the student record to be deleted; otherwise their inactive status is set to “R”.
- This end point returns the same PreEnrollStudentResult object as the Pre-Enroll Student end point. LogDetails is filled in only when the standard Pre-Enroll Student process runs (step 2); otherwise the Students array contains the resulting student record(s).
Errors:
- 401 Unauthorized
- The district has not granted Insert permission for "Trigger Student Pre-Enrollment"
- 500 Invalid Student ID
- The Student ID is 0 or less, or does not exist in the database
- 500 Invalid Next School Code
- NextSchool is not a valid school code in Aeries
- 500 Student could not be transferred!
- Aeries could not copy the student’s record to NextSchool
Pre-Enroll Inactive Student
The Pre-Enroll Inactive Student endpoint provides the ability to create a Pre-Enroll student record from an inactive STU record and place the resulting new pre-enrolled record in a desired school.
Security Area:
- "Trigger Student Pre-Enrollment" - Update
URL:
- GET /api/v5/PreEnrollInactiveStudent/{StudentID}/{NextSchoolCode}
- StudentID (required) – the Aeries Student District Student ID Number.
- NextSchoolCode (required) – the destination Aeries School Number for the new pre-enrolled record.
Notes:
- The {StudentID} value determines which student will be pre-enrolled.
- The {NextSchoolCode} value determines where the student will be pre-enrolled.
- A student record must be inactive to be pre-enrolled to another school utilizing this endpoint.
- The system checks only the student’s most recent record (the current-year enrollment record, or otherwise the record with the latest school enter date). If that record is active, the request fails; if it is inactive, it is used. If that record is already at NextSchoolCode, it is marked as pre-enrolled instead of being copied.
- If the student’s most recent record is already pre-enrolled, the request returns a "500 Student is already pre-enrolled" message. Older pre-enrolled records at other schools are not checked, so make sure the student has no other pre-enrolled record before calling this end point. There should only be one pre-enrolled record for a student at a given time.
- This end point returns an array of student objects representing all student records for the given Student ID, including the newly created pre-enrolled record (if successful). For the specification of the “Student” object, see the Student Information section of the main Aeries API documentation.
- This end point should only be used to create a pre-enrolled record for a student who has no active record in the district.
Errors:
- 401 Unauthorized
- The district has not granted Update permission for "Trigger Student Pre-Enrollment"
- 500 Invalid Student ID
- A Student ID was sent that does not exist in the database
- 500 Invalid Next School Code
- The Next School Code sent is not a valid school code in Aeries
- 500 Student has an active record.
- There is already an active record in Aeries for the Student ID. The Pre-Enrollment Trigger should be used instead.
- 500 Student is already pre-enrolled.
- The student’s most recent record is already pre-enrolled
- 500 Student could not be transferred!
- Aeries could not copy the inactive record to the new school