Home

AeriesApi Module

Add-AeriesActivity

Synopsis

Add an Activity/Award to Aeries

Syntax

Add-AeriesActivity [-SchoolCode] <Int16> [-StudentID] <Int32> [[-DateEntered] <DateTime>] [[-TypeCode] <String>] [[-ActivityOrAwardCode] <String>] [[-Name] <String>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [[-Hours] <Decimal>] [[-ReasonCode] <String>] [[-SeasonCode] <String>] [[-StatusCode] <String>] [[-TransportationDate] <DateTime>] [[-TransportationStatusCode] <String>] [[-CareerPathwayCode] <String>] [[-Comment] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
DateEntered			false	false
TypeCode			false	false
ActivityOrAwardCode			false	false
Name			false	false
StartDate			false	false
EndDate			false	false
Hours			false	false	-1
ReasonCode			false	false
SeasonCode			false	false
StatusCode			false	false
TransportationDate			false	false
TransportationStatusCode			false	false
CareerPathwayCode			false	false
Comment			false	false

Examples

EXAMPLE 1

Add-AeriesActivity -SchoolCode 994 -StudentID 99400001 -TypeCode "1" -DateEntered "2021-10-26" -Comment "This was added via PowerShell!"
This will create an Activity in Aeries for StudentID 99400001 at SchoolCode 994

Add-AeriesAlternateCourseRequest

Synopsis

Add an Alternate Course Request to Aeries

Syntax

Add-AeriesAlternateCourseRequest [-SchoolCode] <Int16> [-StudentID] <Int32> [-CourseNumber] <String> [[-RelativePrioritySortOrder] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
CourseNumber			true	false
RelativePrioritySortOrder			false	false	-1

Examples

EXAMPLE 1

Add-AeriesAlternateCourseRequest -SchoolCode 994 -StudentID 99400001 -CourseNumber "123456"
This will create an Alternate Course Request in Aeries for StudentID 99400001 at SchoolCode 994 with Course Number 123456

Add-AeriesAuthorization

Synopsis

Add a new Authorization in Aeries

Syntax

Add-AeriesAuthorization [-SchoolCode] <Int16> [-StudentID] <Int32> [[-DateEntered] <DateTime>] [[-TypeCode] <String>] [[-MiscCode] <String>] [[-StatusCode] <String>] [[-StatusDate] <DateTime>] [[-EffectiveEndDate] <DateTime>] [[-Comment] <String>] [[-TestAdministration] <String>] [[-Source] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
DateEntered			false	false
TypeCode			false	false
MiscCode			false	false
StatusCode			false	false
StatusDate			false	false
EffectiveEndDate			false	false
Comment			false	false
TestAdministration			false	false
Source			false	false

Examples

EXAMPLE 1

Add-AeriesAuthorization -SchoolCode 994 -StudentID 99400001 -Comment "This was added with PowerShell"
This will add an Authorization to Aeries

Add-AeriesContact

Synopsis

Add a Contact to Aeries

Syntax

Add-AeriesContact [-StudentID] <Int32> [[-MailingName] <String>] [[-NamePrefix] <String>] [[-FirstName] <String>] [[-LastName] <String>] [[-MiddleName] <String>] [[-NameSuffix] <String>] [[-Address] <String>] [[-AddressCity] <String>] [[-AddressState] <String>] [[-AddressZip] <String>] [[-AddressZipExt] <String>] [[-RelationshipToStudentCode] <String>] [[-HomePhone] <String>] [[-WorkPhone] <String>] [[-WorkPhoneExt] <String>] [[-CellPhone] <String>] [[-EmailAddress] <String>] [[-ContactOrder] <Int32>] [[-MiscCode] <String>] [[-PrimaryContact] <Boolean>] [[-MailTagCode] <String>] [[-AccessToPortal] <Boolean>] [[-LivesWithStudentIndicator] <Boolean>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StudentID			true	false	0
MailingName			false	false
NamePrefix			false	false
FirstName			false	false
LastName			false	false
MiddleName			false	false
NameSuffix			false	false
Address			false	false
AddressCity			false	false
AddressState			false	false
AddressZip			false	false
AddressZipExt			false	false
RelationshipToStudentCode			false	false
HomePhone			false	false
WorkPhone			false	false
WorkPhoneExt			false	false
CellPhone			false	false
EmailAddress			false	false
ContactOrder			false	false	-1
MiscCode			false	false
PrimaryContact			false	false	False
MailTagCode			false	false
AccessToPortal			false	false	False
LivesWithStudentIndicator			false	false	False

Examples

EXAMPLE 1

Add-AeriesContact -StudentID 99400001 -FirstName "Aeries" -LastName "Software"
This will create a Contact in Aeries for StudentID 99400001

Add-AeriesCourseRequest

Synopsis

Add a Course Request to Aeries

Syntax

Add-AeriesCourseRequest [-SchoolCode] <Int16> [-StudentID] <Int32> [[-SectionNumber] <Int16>] [-CourseNumber] <String> [[-PreferredTeacherNumber] <Int16>] [[-PreferredStaffID] <Int32>] [[-RejectCode] <String>] [[-AlternateTag] <String>] [[-ActualPrimaryCourseID] <String>] [[-PermanentLockCode] <String>] [[-AlternateCourseRequestReferences] <Int16[]>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
SectionNumber			false	false	-1
CourseNumber			true	false
PreferredTeacherNumber			false	false	-1
PreferredStaffID			false	false	-1
RejectCode			false	false
AlternateTag			false	false
ActualPrimaryCourseID			false	false
PermanentLockCode			false	false
AlternateCourseRequestReferences			false	false

Examples

EXAMPLE 1

Add-AeriesCourseRequest -SchoolCode 994 -StudentID 99400001 -CourseNumber "123456"
This will create a Course Request in Aeries for StudentID 99400001 at SchoolCode 994 with Course Number 123456

Add-AeriesGradebookAssignment

Synopsis

Add a new Gradbook Assignment in Aeries

Syntax

Add-AeriesGradebookAssignment [-GradebookNumber] <Int32> [-Description] <String> [[-AssignmentCategoryCode] <String>] [[-DateAssigned] <DateTime>] [[-DateDue] <DateTime>] [[-NumberCorrectPossible] <Decimal>] [[-PointsPossible] <Decimal>] [[-Comment] <String>] [[-FormativeSummativeIndicator] <String>] [[-RubricAssignment] <Boolean>] [[-ExternalID] <String>] [[-CreateInLinkedGradebooksToo] <Boolean>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
GradebookNumber			true	false	0
Description			true	false
AssignmentCategoryCode			false	false
DateAssigned			false	false
DateDue			false	false
NumberCorrectPossible			false	false	-1
PointsPossible			false	false	-1
Comment			false	false
FormativeSummativeIndicator			false	false
RubricAssignment			false	false	False
ExternalID			false	false
CreateInLinkedGradebooksToo			false	false	True

Examples

EXAMPLE 1

Add-AeriesGradebookAssignment -GradebookNumber 123456 -Description "Assignment created from PowerShell"
This will add a Gradebook Assignment to Aeries

Add-AeriesSchedulingSection

Synopsis

Add a Scheduling Section to Aeries

Syntax

Add-AeriesSchedulingSection [-SchoolCode] <Int16> [[-SectionNumber] <Int16>] [[-Period] <Int16>] [[-FlexPeriodSequenceNumber] <Int32>] [[-PeriodBlock] <Int16>] [-Semester] <String> [[-SplitTerm] <String>] [[-ClassCalendarSequenceNumber] <Int32>] [-CourseID] <String> [[-TeacherNumber1] <Int16>] [[-TeacherNumber2] <Int16>] [[-TeacherNumber3] <Int16>] [[-HighlyQualifiedStatusCode1] <String>] [[-HighlyQualifiedStatusCode2] <String>] [[-HighlyQualifiedStatusCode3] <String>] [[-Room] <String>] [[-Credit] <Decimal>] [[-GenderRestriction] <String>] [[-LowGrade] <Int16>] [[-HighGrade] <Int16>] [[-MaxStudents] <Int16>] [[-InactiveStatusCode] <String>] [[-ProgramCode] <String>] [[-HourlyAttendanceProgramCode] <String>] [[-ExclusionCode] <String>] [[-CountsForADA] <String>] [[-MultiTeacherCode] <String>] [[-SchedulingGroup] <String>] [[-TeamCourseGroup] <String>] [[-TeamNumber] <Int32>] [[-SemesterGroup] <String>] [[-Track] <String>] [[-ClassID] <Int32>] [[-EducationServiceCode] <String>] [[-LanguageOfInstructionCode] <String>] [[-InstructionalStrategyCode] <String>] [[-FundingSourceCode] <String>] [[-CareerTechnicalEducationProviderCode] <String>] [[-IndependentStudyIndicator] <String>] [[-DistanceLearningIndicator] <String>] [[-ItinerantTeacherIndicator] <String>] [-UseSupplementalAttendance] [[-PopulationServedCode] <String>] [[-ClassTypeCode] <String>] [[-MonthlyMinutes] <Int16>] [[-UserCode1] <String>] [[-UserCode2] <String>] [[-UserCode3] <String>] [[-UserCode4] <String>] [[-UserCode5] <String>] [[-UserCode6] <String>] [[-UserCode7] <String>] [[-UserCode8] <String>] [[-ArticulatedCourseIndicator] <String>] [[-NonCampusBasedInstructionCode] <String>] [[-PreKSchoolTypeCode] <String>] [[-PreKCurriculaCode] <String>] [-IsHighQualityPreKProgram] [[-InstructionTypeCode] <String>] [[-ProgramEvaluationTypeCode] <String>] [[-EducationalEnvironmentCode] <String>] [[-CareerTechnicalEducationHours] <Int16>] [[-ContentSubcategoryCode] <String>] [[-CharterNonCoreIndicator] <String>] [[-AdvancedCourseStateCode] <String>] [[-OnlineInstructionTypeCode] <String>] [[-MiddleSchoolCoreIndicator] <String>] [[-NonCredentialedAuthorizationCode] <String>] [[-HighQualityCareerTechnicalEducationIndicator] <String>] [[-ArenaSchedulingIndicator] <String>] [-ExcludeFromScheduler] [[-SectionStaffMembers] <SectionStaffMember[]>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
SectionNumber			false	false	0
Period			false	false	-1
FlexPeriodSequenceNumber			false	false	0
PeriodBlock			false	false	0
Semester			true	false
SplitTerm		If the value is blank, accept it. Might be section staff If is in valid set, accept it If value is 6 or less characters, accept it	false	false
ClassCalendarSequenceNumber			false	false	0
CourseID			true	false
TeacherNumber1			false	false	0
TeacherNumber2			false	false	-1
TeacherNumber3			false	false	-1
HighlyQualifiedStatusCode1			false	false
HighlyQualifiedStatusCode2			false	false
HighlyQualifiedStatusCode3			false	false
Room			false	false
Credit			false	false	0
GenderRestriction			false	false
LowGrade			false	false	-99
HighGrade		-99 because technically -1 that I usually use is a valid grade	false	false	-99
MaxStudents		-99 because technically -1 that I usually use is a valid grade	false	false	0
InactiveStatusCode			false	false
ProgramCode			false	false
HourlyAttendanceProgramCode			false	false
ExclusionCode			false	false
CountsForADA			false	false
MultiTeacherCode			false	false
SchedulingGroup			false	false
TeamCourseGroup			false	false
TeamNumber			false	false	0
SemesterGroup			false	false
Track			false	false
ClassID			false	false	0
EducationServiceCode			false	false
LanguageOfInstructionCode			false	false
InstructionalStrategyCode			false	false
FundingSourceCode			false	false
CareerTechnicalEducationProviderCode			false	false
IndependentStudyIndicator			false	false
DistanceLearningIndicator			false	false
ItinerantTeacherIndicator			false	false
UseSupplementalAttendance			false	false	False
PopulationServedCode			false	false
ClassTypeCode			false	false
MonthlyMinutes			false	false	0
UserCode1			false	false
UserCode2			false	false
UserCode3			false	false
UserCode4			false	false
UserCode5			false	false
UserCode6			false	false
UserCode7			false	false
UserCode8			false	false
ArticulatedCourseIndicator			false	false
NonCampusBasedInstructionCode			false	false
PreKSchoolTypeCode			false	false
PreKCurriculaCode			false	false
IsHighQualityPreKProgram			false	false	False
InstructionTypeCode			false	false
ProgramEvaluationTypeCode			false	false
EducationalEnvironmentCode			false	false
CareerTechnicalEducationHours			false	false	0
ContentSubcategoryCode			false	false
CharterNonCoreIndicator			false	false
AdvancedCourseStateCode			false	false
OnlineInstructionTypeCode			false	false
MiddleSchoolCoreIndicator			false	false
NonCredentialedAuthorizationCode			false	false
HighQualityCareerTechnicalEducationIndicator			false	false
ArenaSchedulingIndicator			false	false
ExcludeFromScheduler			false	false	False
SectionStaffMembers			false	false

Examples

EXAMPLE 1

Add-AeriesSchedulingSection -SchoolCode 884
This will create a Schedule Section in Aeries for SchoolCode 884

Add-AeriesStaff

Synopsis

Add a new Staff in Aeries

Syntax

Add-AeriesStaff [[-StaffID] <Int32>] [[-FirstName] <String>] [[-LastName] <String>] [[-MiddleName] <String>] [[-BirthYear] <Int16>] [[-BirthDate] <DateTime>] [[-FullTimePercentage] <Int16>] [[-HireDate] <DateTime>] [[-LeaveDate] <DateTime>] [[-InactiveStatusCode] <String>] [[-StateEducatorID] <String>] [[-EmailAddress] <String>] [[-PrimaryAeriesSchool] <Int16>] [[-NetworkLoginID] <String>] [[-AlternateEmailAddress] <String>] [[-HumanResourcesSystemID] <String>] [[-CellPhone] <String>] [[-Title] <String>] [[-Gender] <String>] [[-EducationLevelCode] <String>] [[-EthnicityCode] <String>] [[-RaceCode1] <String>] [[-RaceCode2] <String>] [[-RaceCode3] <String>] [[-RaceCode4] <String>] [[-RaceCode5] <String>] [[-PositionStatusCode] <String>] [[-TotalYearsOfEduService] <Int16>] [[-TotalYearsInThisDistrict] <Int16>] [[-PreviousLastName] <String>] [[-PreviousFirstName] <String>] [[-PreviousMiddleName] <String>] [[-NameSuffix] <String>] [[-Address] <String>] [[-AddressCity] <String>] [[-AddressState] <String>] [[-AddressZipCode] <String>] [[-AddressZipExt] <String>] [[-HomePhone] <String>] [[-EmergencyContactName] <String>] [[-EmergencyContactPhone] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StaffID			false	false	-1
FirstName			false	false
LastName			false	false
MiddleName			false	false
BirthYear			false	false	-1
BirthDate			false	false
FullTimePercentage			false	false	-1
HireDate			false	false
LeaveDate			false	false
InactiveStatusCode			false	false
StateEducatorID			false	false
EmailAddress			false	false
PrimaryAeriesSchool			false	false	-1
NetworkLoginID			false	false
AlternateEmailAddress			false	false
HumanResourcesSystemID			false	false
CellPhone			false	false
Title			false	false
Gender			false	false
EducationLevelCode			false	false
EthnicityCode			false	false
RaceCode1			false	false
RaceCode2			false	false
RaceCode3			false	false
RaceCode4			false	false
RaceCode5			false	false
PositionStatusCode			false	false
TotalYearsOfEduService			false	false	-1
TotalYearsInThisDistrict			false	false	-1
PreviousLastName			false	false
PreviousFirstName			false	false
PreviousMiddleName			false	false
NameSuffix			false	false
Address			false	false
AddressCity			false	false
AddressState			false	false
AddressZipCode			false	false
AddressZipExt			false	false
HomePhone			false	false
EmergencyContactName			false	false
EmergencyContactPhone			false	false

Examples

EXAMPLE 1

Add-AeriesStaff -StaffID 1 -FirstName "Aeries" -LastName "Software"
This will add a Staff to Aeries

Add-AeriesStaffAssignment

Synopsis

Add a Staff Assignment in Aeries

Syntax

Add-AeriesStaffAssignment [-StaffID] <Int32> [-AssignmentType] <String> [[-JobClassification] <String>] [[-FullTimePercentage] <Double>] [[-NonClassroomBasedJobAssignment1] <String>] [[-NonClassroomBasedJobAssignment2] <String>] [[-NonClassroomBasedJobAssignment3] <String>] [[-NonClassroomBasedJobAssignment4] <String>] [[-NonClassroomBasedJobAssignment5] <String>] [[-NonClassroomBasedJobAssignment6] <String>] [[-NonClassroomBasedJobAssignment7] <String>] [[-SchoolCode] <Int16>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StaffID			true	false	0
AssignmentType			true	false
JobClassification		If the passed in value is blank or null, accept it Classified can have up to 3 character codes Certificated can have up to 2 character codes	false	false
FullTimePercentage			false	false	-1
NonClassroomBasedJobAssignment1			false	false
NonClassroomBasedJobAssignment2			false	false
NonClassroomBasedJobAssignment3			false	false
NonClassroomBasedJobAssignment4			false	false
NonClassroomBasedJobAssignment5			false	false
NonClassroomBasedJobAssignment6			false	false
NonClassroomBasedJobAssignment7			false	false
SchoolCode			false	false	-1
StartDate			false	false
EndDate			false	false

Examples

EXAMPLE 1

Add-AeriesStaffAssignment -StaffID 1 -AssignmentType "classified"
This will create a Staff Assignment for Staff ID 1 with an Assignment Type of "classified" in Aeries

Add-AeriesStudent

Synopsis

Add a new Student in Aeries

Syntax

Add-AeriesStudent [-SchoolCode] <Int16> [[-LastName] <String>] [[-FirstName] <String>] [[-MiddleName] <String>] [[-NameSuffix] <String>] [[-Gender] <String>] [[-Grade] <String>] [[-NextGrade] <String>] [[-NextSchool] <Int16>] [[-BirthDate] <DateTime>] [[-InactiveStatusCode] <String>] [[-HomePhone] <String>] [[-HomeLanguageCode] <String>] [[-CorrespondanceLanguageCode] <String>] [[-LanguageFluencyCode] <String>] [[-EthnicityCode] <String>] [[-Race1Code] <String>] [[-Race2Code] <String>] [[-Race3Code] <String>] [[-Race4Code] <String>] [[-Race5Code] <String>] [[-LastSchool] <Int16>] [[-ResidenceSchool] <Int16>] [[-NextResidenceSchool] <Int16>] [[-SchoolEnterDate] <DateTime>] [[-DistrictEnterDate] <DateTime>] [[-BirthCity] <String>] [[-BirthStateCode] <String>] [[-BirthCountryCode] <String>] [[-ParentEdLevelCode] <String>] [[-ParentGuardianName] <String>] [[-MailingAddress] <String>] [[-MailingAddressCity] <String>] [[-MailingAddressState] <String>] [[-MailingAddressZipCode] <String>] [[-MailingAddressZipExt] <String>] [[-ResidenceAddress] <String>] [[-ResidenceAddressCity] <String>] [[-ResidenceAddressState] <String>] [[-ResidenceAddressZipCode] <String>] [[-ResidenceAddressZipExt] <String>] [[-HomeLanguageSurveyFirstLanguageCode] <String>] [[-HomeLanguageSurveyPrimaryLanguageCode] <String>] [[-HomeLanguageSurveyHomeLanguageCode] <String>] [[-HomeLanguageSurveyAdultLanguageCode] <String>] [[-USEnterDate] <DateTime>] [[-USSchoolEnterDate] <DateTime>] [[-UserCode1] <String>] [[-UserCode2] <String>] [[-UserCode3] <String>] [[-UserCode4] <String>] [[-UserCode5] <String>] [[-UserCode6] <String>] [[-UserCode7] <String>] [[-UserCode8] <String>] [[-UserCode9] <String>] [[-UserCode10] <String>] [[-UserCode11] <String>] [[-UserCode12] <String>] [[-UserCode13] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
LastName			false	false
FirstName			false	false
MiddleName			false	false
NameSuffix			false	false
Gender			false	false
Grade			false	false
NextGrade			false	false
NextSchool			false	false	-1
BirthDate			false	false
InactiveStatusCode			false	false
HomePhone			false	false
HomeLanguageCode			false	false
CorrespondanceLanguageCode			false	false
LanguageFluencyCode			false	false
EthnicityCode			false	false
Race1Code			false	false
Race2Code			false	false
Race3Code			false	false
Race4Code			false	false
Race5Code			false	false
LastSchool			false	false	-1
ResidenceSchool			false	false	-1
NextResidenceSchool			false	false	-1
SchoolEnterDate			false	false
DistrictEnterDate			false	false
BirthCity			false	false
BirthStateCode			false	false
BirthCountryCode			false	false
ParentEdLevelCode			false	false
ParentGuardianName			false	false
MailingAddress			false	false
MailingAddressCity			false	false
MailingAddressState			false	false
MailingAddressZipCode			false	false
MailingAddressZipExt			false	false
ResidenceAddress			false	false
ResidenceAddressCity			false	false
ResidenceAddressState			false	false
ResidenceAddressZipCode			false	false
ResidenceAddressZipExt			false	false
HomeLanguageSurveyFirstLanguageCode			false	false
HomeLanguageSurveyPrimaryLanguageCode			false	false
HomeLanguageSurveyHomeLanguageCode			false	false
HomeLanguageSurveyAdultLanguageCode			false	false
USEnterDate			false	false
USSchoolEnterDate			false	false
UserCode1			false	false
UserCode2			false	false
UserCode3			false	false
UserCode4			false	false
UserCode5			false	false
UserCode6			false	false
UserCode7			false	false
UserCode8			false	false
UserCode9			false	false
UserCode10			false	false
UserCode11			false	false
UserCode12			false	false
UserCode13			false	false

Examples

EXAMPLE 1

Add-AeriesStudent -SchoolCode 994 -FirstName "Aeries" -LastName "Software"
This will add a student to the specific School Code in Aeries

Edit-AeriesActivity

Synopsis

Edit an Activity/Award to Aeries

Syntax

Edit-AeriesActivity [-SchoolCode] <Int16> [-StudentID] <Int32> [[-Sequence] <Int16>] [[-DateEntered] <DateTime>] [[-TypeCode] <String>] [[-ActivityOrAwardCode] <String>] [[-Name] <String>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [[-Hours] <Decimal>] [[-ReasonCode] <String>] [[-SeasonCode] <String>] [[-StatusCode] <String>] [[-TransportationDate] <DateTime>] [[-TransportationStatusCode] <String>] [[-CareerPathwayCode] <String>] [[-Comment] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
Sequence			false	false	0
DateEntered			false	false
TypeCode			false	false
ActivityOrAwardCode			false	false
Name			false	false
StartDate			false	false
EndDate			false	false
Hours			false	false	-1
ReasonCode			false	false
SeasonCode			false	false
StatusCode			false	false
TransportationDate			false	false
TransportationStatusCode			false	false
CareerPathwayCode			false	false
Comment			false	false

Examples

EXAMPLE 1

Edit-AeriesActivity -SchoolCode 994 -StudentID 99400001 -Sequence 1 -TypeCode "1" -DateEntered "2021-10-26" -Comment "This was added via PowerShell!"
This will edit or create an Activity in Aeries for StudentID 99400001 at SchoolCode 994 with Sequence 1

Edit-AeriesAddress

Synopsis

Edit a Students Address in Aeries

Syntax

Edit-AeriesAddress [-StudentID] <Int32> [-UpdateType] <String> [[-EffectiveStartDate] <DateTime>] [[-MailingAddress] <String>] [[-MailingAddressCity] <String>] [[-MailingAddressState] <String>] [[-MailingAddressZipCode] <String>] [[-MailingAddressZipExt] <String>] [[-ResidenceAddress] <String>] [[-ResidenceAddressCity] <String>] [[-ResidenceAddressState] <String>] [[-ResidenceAddressZipCode] <String>] [[-ResidenceAddressZipExt] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StudentID			true	false	0
UpdateType			true	false
EffectiveStartDate			false	false	\(Get-Date\)
MailingAddress			false	false
MailingAddressCity			false	false
MailingAddressState			false	false
MailingAddressZipCode			false	false
MailingAddressZipExt			false	false
ResidenceAddress			false	false
ResidenceAddressCity			false	false
ResidenceAddressState			false	false
ResidenceAddressZipCode			false	false
ResidenceAddressZipExt			false	false

Examples

EXAMPLE 1

Edit-AeriesAddress -StudentID 99400001 -UpdateType "Change" -MailingAddress "770 The City Dr S #6500" -MailingAddressCity "Orange" -MailingAddressState "CA" -MailingAddressZipCode "92868"
This will update Student ID 99400001 to have the Address of "770 The City Dr S #6500, Orange, CA 92868"

Edit-AeriesAlternateCourseRequest

Synopsis

Edit an Alternate Course Request to Aeries

Syntax

Edit-AeriesAlternateCourseRequest [-SchoolCode] <Int16> [-StudentID] <Int32> [-Sequence] <Int16> [[-CourseNumber] <String>] [[-RelativePrioritySortOrder] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
Sequence			true	false	0
CourseNumber			false	false
RelativePrioritySortOrder			false	false	-1

Examples

EXAMPLE 1

Edit-AeriesAlternateCourseRequest -SchoolCode 994 -StudentID 99400001 -Sequence 1 -CourseNumber "123456"
This will edit an Alternate Course Request in Aeries for StudentID 99400001 at SchoolCode 994 with Sequence 1

Edit-AeriesAuthorization

Synopsis

Edit an Authorization in Aeries

Syntax

Edit-AeriesAuthorization [-SchoolCode] <Int16> [-StudentID] <Int32> [[-Sequence] <Int16>] [[-DateEntered] <DateTime>] [[-TypeCode] <String>] [[-MiscCode] <String>] [[-StatusCode] <String>] [[-StatusDate] <DateTime>] [[-EffectiveEndDate] <DateTime>] [[-Comment] <String>] [[-TestAdministration] <String>] [[-Source] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
Sequence			false	false	0
DateEntered			false	false
TypeCode			false	false
MiscCode			false	false
StatusCode			false	false
StatusDate			false	false
EffectiveEndDate			false	false
Comment			false	false
TestAdministration			false	false
Source			false	false

Examples

EXAMPLE 1

Edit-AeriesAuthorization -SchoolCode 994 -StudentID 99400001 -Sequence 1 -Comment "This was edited with PowerShell"
This will edit an Authorization in Aeries

Edit-AeriesContact

Synopsis

Edit a Contact in Aeries

Syntax

Edit-AeriesContact [-StudentID] <Int32> [-Sequence] <Int16> [[-MailingName] <String>] [[-NamePrefix] <String>] [[-FirstName] <String>] [[-LastName] <String>] [[-MiddleName] <String>] [[-NameSuffix] <String>] [[-Address] <String>] [[-AddressCity] <String>] [[-AddressState] <String>] [[-AddressZip] <String>] [[-AddressZipExt] <String>] [[-RelationshipToStudentCode] <String>] [[-HomePhone] <String>] [[-WorkPhone] <String>] [[-WorkPhoneExt] <String>] [[-CellPhone] <String>] [[-EmailAddress] <String>] [[-ContactOrder] <Int32>] [[-MiscCode] <String>] [[-PrimaryContact] <Boolean>] [[-MailTagCode] <String>] [[-AccessToPortal] <Boolean>] [[-LivesWithStudentIndicator] <Boolean>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StudentID			true	false	0
Sequence			true	false	0
MailingName			false	false
NamePrefix			false	false
FirstName			false	false
LastName			false	false
MiddleName			false	false
NameSuffix			false	false
Address			false	false
AddressCity			false	false
AddressState			false	false
AddressZip			false	false
AddressZipExt			false	false
RelationshipToStudentCode			false	false
HomePhone			false	false
WorkPhone			false	false
WorkPhoneExt			false	false
CellPhone			false	false
EmailAddress			false	false
ContactOrder			false	false	-1
MiscCode			false	false
PrimaryContact			false	false	False
MailTagCode			false	false
AccessToPortal			false	false	False
LivesWithStudentIndicator			false	false	False

Examples

EXAMPLE 1

Edit-AeriesContact -StudentID 99400001 -Sequence 1 -FirstName "Aeries" -LastName "Software"
This will edit a Contact in Aeries for StudentID 99400001

Edit-AeriesCourseRequest

Synopsis

Edit a Course Request to Aeries

Syntax

Edit-AeriesCourseRequest [-SchoolCode] <Int16> [-StudentID] <Int32> [-Sequence] <Int16> [[-SectionNumber] <Int16>] [-CourseNumber] <String> [[-PreferredTeacherNumber] <Int16>] [[-PreferredStaffID] <Int32>] [[-RejectCode] <String>] [[-AlternateTag] <String>] [[-ActualPrimaryCourseID] <String>] [[-PermanentLockCode] <String>] [[-AlternateCourseRequestReferences] <Int16[]>] [[-AlternateCourseRequestUpdateOptions] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
Sequence			true	false	0
SectionNumber			false	false	-1
CourseNumber			true	false
PreferredTeacherNumber			false	false	-1
PreferredStaffID			false	false	-1
RejectCode			false	false
AlternateTag			false	false
ActualPrimaryCourseID			false	false
PermanentLockCode			false	false
AlternateCourseRequestReferences			false	false
AlternateCourseRequestUpdateOptions		Must provide either append or replace if providing AlternateCourseRequestReferences	false	false

Examples

EXAMPLE 1

Edit-AeriesCourseRequest -SchoolCode 994 -StudentID 99400001 -Sequence 1 -CourseNumber "123456"
This will edit a Course Request in Aeries for StudentID 99400001 at SchoolCode 994 with Sequence 1

Edit-AeriesGradebookAssignment

Synopsis

Edit a Gradbook Assignment in Aeries

Syntax

Edit-AeriesGradebookAssignment -GradebookNumber <Int32> -AssignmentNumber <Int32> [-Description <String>] [-AssignmentCategoryCode <String>] [-DateAssigned <DateTime>] [-DateDue <DateTime>] [-NumberCorrectPossible <Decimal>] [-PointsPossible <Decimal>] [-GradingCompleted <Boolean>] [-Comment <String>] [-FormativeSummativeIndicator <String>] [-RubricAssignment <Boolean>] [-ExternalID <String>] [-UpdateLinkedGradebooksToo <Boolean>] [<CommonParameters>]

Edit-AeriesGradebookAssignment -UniqueID <String> [-Description <String>] [-AssignmentCategoryCode <String>] [-DateAssigned <DateTime>] [-DateDue <DateTime>] [-NumberCorrectPossible <Decimal>] [-PointsPossible <Decimal>] [-GradingCompleted <Boolean>] [-Comment <String>] [-FormativeSummativeIndicator <String>] [-RubricAssignment <Boolean>] [-ExternalID <String>] [-UpdateLinkedGradebooksToo <Boolean>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
GradebookNumber			true	false	0
AssignmentNumber			true	false	0
UniqueID			true	false
Description			false	false
AssignmentCategoryCode			false	false
DateAssigned			false	false
DateDue			false	false
NumberCorrectPossible			false	false	-1
PointsPossible			false	false	-1
GradingCompleted			false	false	-1
Comment			false	false
FormativeSummativeIndicator			false	false
RubricAssignment			false	false	False
ExternalID			false	false
UpdateLinkedGradebooksToo			false	false	True

Examples

EXAMPLE 1

Edit-AeriesGradebookAssignment -GradebookNumber 123456 -AssignmentNumber 1 -Description "Assignment edited from PowerShell"
This will edit a Gradebook Assignment in Aeries

Edit-AeriesGradebookAssignmentScore

Synopsis

Edit a Gradbook Assignment in Aeries

Syntax

Edit-AeriesGradebookAssignmentScore -GradebookNumber <Int32> -AssignmentNumber <Int32> -StudentID <Int32> [-NumberCorrect <Decimal>] [-DateCompleted <DateTime>] [-AeriesStandardID <String>] [-AcademicBenchmarkID <String>] [<CommonParameters>]

Edit-AeriesGradebookAssignmentScore -UniqueID <String> -StudentID <Int32> [-NumberCorrect <Decimal>] [-DateCompleted <DateTime>] [-AeriesStandardID <String>] [-AcademicBenchmarkID <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
GradebookNumber			true	false	0
AssignmentNumber			true	false	0
UniqueID			true	false
StudentID			true	false	0
NumberCorrect			false	false	-1
DateCompleted			false	false
AeriesStandardID			false	false
AcademicBenchmarkID			false	false

Examples

EXAMPLE 1

Edit-AeriesGradebookAssignmentScore -GradebookNumber 4366926 -AssignmentNumber 122 -StudentID 99400156 -NumberCorrect 5
This will edit a Gradebook Assignment Score for Student ID 99400156 in Gradebook 4366926 on Assignment 122 in Aeries

Edit-AeriesSchedulingSection

Synopsis

Edit a Scheduling Section in Aeries

Syntax

Edit-AeriesSchedulingSection [-SchoolCode] <Int16> [-SectionNumber] <Int16> [[-Period] <Int16>] [[-FlexPeriodSequenceNumber] <Int32>] [[-PeriodBlock] <Int16>] [[-Semester] <String>] [[-SplitTerm] <String>] [[-ClassCalendarSequenceNumber] <Int32>] [[-CourseID] <String>] [[-TeacherNumber1] <Int16>] [[-TeacherNumber2] <Int16>] [[-TeacherNumber3] <Int16>] [[-HighlyQualifiedStatusCode1] <String>] [[-HighlyQualifiedStatusCode2] <String>] [[-HighlyQualifiedStatusCode3] <String>] [[-Room] <String>] [[-Credit] <Decimal>] [[-GenderRestriction] <String>] [[-LowGrade] <Int16>] [[-HighGrade] <Int16>] [[-MaxStudents] <Int16>] [[-InactiveStatusCode] <String>] [[-ProgramCode] <String>] [[-HourlyAttendanceProgramCode] <String>] [[-ExclusionCode] <String>] [[-CountsForADA] <String>] [[-MultiTeacherCode] <String>] [[-SchedulingGroup] <String>] [[-TeamCourseGroup] <String>] [[-TeamNumber] <Int32>] [[-SemesterGroup] <String>] [[-Track] <String>] [[-ClassID] <Int32>] [[-EducationServiceCode] <String>] [[-LanguageOfInstructionCode] <String>] [[-InstructionalStrategyCode] <String>] [[-FundingSourceCode] <String>] [[-CareerTechnicalEducationProviderCode] <String>] [[-IndependentStudyIndicator] <String>] [[-DistanceLearningIndicator] <String>] [[-ItinerantTeacherIndicator] <String>] [-UseSupplementalAttendance] [[-PopulationServedCode] <String>] [[-ClassTypeCode] <String>] [[-MonthlyMinutes] <Int16>] [[-UserCode1] <String>] [[-UserCode2] <String>] [[-UserCode3] <String>] [[-UserCode4] <String>] [[-UserCode5] <String>] [[-UserCode6] <String>] [[-UserCode7] <String>] [[-UserCode8] <String>] [[-ArticulatedCourseIndicator] <String>] [[-NonCampusBasedInstructionCode] <String>] [[-PreKSchoolTypeCode] <String>] [[-PreKCurriculaCode] <String>] [-IsHighQualityPreKProgram] [[-InstructionTypeCode] <String>] [[-ProgramEvaluationTypeCode] <String>] [[-EducationalEnvironmentCode] <String>] [[-CareerTechnicalEducationHours] <Int16>] [[-ContentSubcategoryCode] <String>] [[-CharterNonCoreIndicator] <String>] [[-AdvancedCourseStateCode] <String>] [[-OnlineInstructionTypeCode] <String>] [[-MiddleSchoolCoreIndicator] <String>] [[-NonCredentialedAuthorizationCode] <String>] [[-HighQualityCareerTechnicalEducationIndicator] <String>] [[-ArenaSchedulingIndicator] <String>] [-ExcludeFromScheduler] [[-SectionStaffMembers] <SectionStaffMember[]>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
SectionNumber			true	false	0
Period			false	false	-1
FlexPeriodSequenceNumber			false	false	0
PeriodBlock			false	false	0
Semester			false	false
SplitTerm		If the value is blank, accept it. Might be section staff If is in valid set, accept it If value is 6 or less characters, accept it	false	false
ClassCalendarSequenceNumber			false	false	0
CourseID			false	false
TeacherNumber1			false	false	-1
TeacherNumber2			false	false	-1
TeacherNumber3			false	false	-1
HighlyQualifiedStatusCode1			false	false
HighlyQualifiedStatusCode2			false	false
HighlyQualifiedStatusCode3			false	false
Room			false	false
Credit			false	false	0
GenderRestriction			false	false
LowGrade			false	false	-99
HighGrade		-99 because technically -1 that I usually use is a valid grade	false	false	-99
MaxStudents		-99 because technically -1 that I usually use is a valid grade	false	false	0
InactiveStatusCode			false	false
ProgramCode			false	false
HourlyAttendanceProgramCode			false	false
ExclusionCode			false	false
CountsForADA			false	false
MultiTeacherCode			false	false
SchedulingGroup			false	false
TeamCourseGroup			false	false
TeamNumber			false	false	0
SemesterGroup			false	false
Track			false	false
ClassID			false	false	0
EducationServiceCode			false	false
LanguageOfInstructionCode			false	false
InstructionalStrategyCode			false	false
FundingSourceCode			false	false
CareerTechnicalEducationProviderCode			false	false
IndependentStudyIndicator			false	false
DistanceLearningIndicator			false	false
ItinerantTeacherIndicator			false	false
UseSupplementalAttendance			false	false	False
PopulationServedCode			false	false
ClassTypeCode			false	false
MonthlyMinutes			false	false	0
UserCode1			false	false
UserCode2			false	false
UserCode3			false	false
UserCode4			false	false
UserCode5			false	false
UserCode6			false	false
UserCode7			false	false
UserCode8			false	false
ArticulatedCourseIndicator			false	false
NonCampusBasedInstructionCode			false	false
PreKSchoolTypeCode			false	false
PreKCurriculaCode			false	false
IsHighQualityPreKProgram			false	false	False
InstructionTypeCode			false	false
ProgramEvaluationTypeCode			false	false
EducationalEnvironmentCode			false	false
CareerTechnicalEducationHours			false	false	0
ContentSubcategoryCode			false	false
CharterNonCoreIndicator			false	false
AdvancedCourseStateCode			false	false
OnlineInstructionTypeCode			false	false
MiddleSchoolCoreIndicator			false	false
NonCredentialedAuthorizationCode			false	false
HighQualityCareerTechnicalEducationIndicator			false	false
ArenaSchedulingIndicator			false	false
ExcludeFromScheduler			false	false	False
SectionStaffMembers			false	false

Examples

EXAMPLE 1

Edit-AeriesSchedulingSection -SchoolCode 884 -SectionNumber 1
This will edit a Schedule Section in Aeries for SchoolCode 884

Edit-AeriesSchoolSupplemental

Synopsis

Edit a School Supplemental record for a Student in Aeries

Syntax

Edit-AeriesSchoolSupplemental [-SchoolCode] <Int16> [-StudentNumber] <Int16> [[-ColumnCode] <String>] [[-NewValue] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentNumber			true	false	0
ColumnCode			false	false
NewValue			false	false

Examples

EXAMPLE 1

Edit-AeriesSchoolSupplemental -SchoolCode 994 -StudentNumber 1 -ColumnCode "PI" -NewValue "XZ"
This will create an Activity in Aeries for StudentID 99400001 at SchoolCode 994

Edit-AeriesStaff

Synopsis

Edit a Staff in Aeries

Syntax

Edit-AeriesStaff [-StaffID] <Int32> [[-FirstName] <String>] [[-LastName] <String>] [[-MiddleName] <String>] [[-BirthYear] <Int16>] [[-BirthDate] <DateTime>] [[-FullTimePercentage] <Int16>] [[-HireDate] <DateTime>] [[-LeaveDate] <DateTime>] [[-InactiveStatusCode] <String>] [[-StateEducatorID] <String>] [[-EmailAddress] <String>] [[-PrimaryAeriesSchool] <Int16>] [[-NetworkLoginID] <String>] [[-AlternateEmailAddress] <String>] [[-HumanResourcesSystemID] <String>] [[-CellPhone] <String>] [[-Title] <String>] [[-Gender] <String>] [[-EducationLevelCode] <String>] [[-EthnicityCode] <String>] [[-RaceCode1] <String>] [[-RaceCode2] <String>] [[-RaceCode3] <String>] [[-RaceCode4] <String>] [[-RaceCode5] <String>] [[-PositionStatusCode] <String>] [[-TotalYearsOfEduService] <Int16>] [[-TotalYearsInThisDistrict] <Int16>] [[-PreviousLastName] <String>] [[-PreviousFirstName] <String>] [[-PreviousMiddleName] <String>] [[-NameSuffix] <String>] [[-Address] <String>] [[-AddressCity] <String>] [[-AddressState] <String>] [[-AddressZipCode] <String>] [[-AddressZipExt] <String>] [[-HomePhone] <String>] [[-EmergencyContactName] <String>] [[-EmergencyContactPhone] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StaffID			true	false	0
FirstName			false	false
LastName			false	false
MiddleName			false	false
BirthYear			false	false	-1
BirthDate			false	false
FullTimePercentage			false	false	-1
HireDate			false	false
LeaveDate			false	false
InactiveStatusCode			false	false
StateEducatorID			false	false
EmailAddress			false	false
PrimaryAeriesSchool			false	false	-1
NetworkLoginID			false	false
AlternateEmailAddress			false	false
HumanResourcesSystemID			false	false
CellPhone			false	false
Title			false	false
Gender			false	false
EducationLevelCode			false	false
EthnicityCode			false	false
RaceCode1			false	false
RaceCode2			false	false
RaceCode3			false	false
RaceCode4			false	false
RaceCode5			false	false
PositionStatusCode			false	false
TotalYearsOfEduService			false	false	-1
TotalYearsInThisDistrict			false	false	-1
PreviousLastName			false	false
PreviousFirstName			false	false
PreviousMiddleName			false	false
NameSuffix			false	false
Address			false	false
AddressCity			false	false
AddressState			false	false
AddressZipCode			false	false
AddressZipExt			false	false
HomePhone			false	false
EmergencyContactName			false	false
EmergencyContactPhone			false	false

Examples

EXAMPLE 1

Edit-AeriesStaff -StaffID 1 -FirstName "Aeries" -LastName "Software"
This will edit a Staff in Aeries

Edit-AeriesStaffAssignment

Synopsis

Edit a Staff Assignment in Aeries

Syntax

Edit-AeriesStaffAssignment [-StaffID] <Int32> [-AssignmentType] <String> [-Sequence] <Int16> [[-JobClassification] <String>] [[-FullTimePercentage] <Double>] [[-NonClassroomBasedJobAssignment1] <String>] [[-NonClassroomBasedJobAssignment2] <String>] [[-NonClassroomBasedJobAssignment3] <String>] [[-NonClassroomBasedJobAssignment4] <String>] [[-NonClassroomBasedJobAssignment5] <String>] [[-NonClassroomBasedJobAssignment6] <String>] [[-NonClassroomBasedJobAssignment7] <String>] [[-SchoolCode] <Int16>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StaffID			true	false	0
AssignmentType			true	false
Sequence			true	false	0
JobClassification		If the passed in value is blank or null, accept it Classified can have up to 3 character codes Certificated can have up to 2 character codes	false	false
FullTimePercentage			false	false	-1
NonClassroomBasedJobAssignment1			false	false
NonClassroomBasedJobAssignment2			false	false
NonClassroomBasedJobAssignment3			false	false
NonClassroomBasedJobAssignment4			false	false
NonClassroomBasedJobAssignment5			false	false
NonClassroomBasedJobAssignment6			false	false
NonClassroomBasedJobAssignment7			false	false
SchoolCode			false	false	-1
StartDate			false	false
EndDate			false	false

Examples

EXAMPLE 1

Edit-AeriesStaffAssignment -StaffID 1 -AssignmentType "classified" -Sequence 1
This will edit a Staff Assignment for Staff ID 1 with an Assignment Type of "classified" and Sequence of 1 in Aeries

Edit-AeriesStudent

Synopsis

Edit a Student in Aeries

Syntax

Edit-AeriesStudent [-StudentID] <Int32> [[-LastName] <String>] [[-FirstName] <String>] [[-MiddleName] <String>] [[-NameSuffix] <String>] [[-Gender] <String>] [[-Grade] <String>] [[-NextGrade] <String>] [[-NextSchool] <Int16>] [[-BirthDate] <DateTime>] [[-InactiveStatusCode] <String>] [[-HomePhone] <String>] [[-HomeLanguageCode] <String>] [[-CorrespondanceLanguageCode] <String>] [[-LanguageFluencyCode] <String>] [[-EthnicityCode] <String>] [[-Race1Code] <String>] [[-Race2Code] <String>] [[-Race3Code] <String>] [[-Race4Code] <String>] [[-Race5Code] <String>] [[-LastSchool] <Int16>] [[-ResidenceSchool] <Int16>] [[-NextResidenceSchool] <Int16>] [[-SchoolEnterDate] <DateTime>] [[-DistrictEnterDate] <DateTime>] [[-BirthCity] <String>] [[-BirthStateCode] <String>] [[-BirthCountryCode] <String>] [[-ParentEdLevelCode] <String>] [[-ParentGuardianName] <String>] [[-MailingAddress] <String>] [[-MailingAddressCity] <String>] [[-MailingAddressState] <String>] [[-MailingAddressZipCode] <String>] [[-MailingAddressZipExt] <String>] [[-ResidenceAddress] <String>] [[-ResidenceAddressCity] <String>] [[-ResidenceAddressState] <String>] [[-ResidenceAddressZipCode] <String>] [[-ResidenceAddressZipExt] <String>] [[-HomeLanguageSurveyFirstLanguageCode] <String>] [[-HomeLanguageSurveyPrimaryLanguageCode] <String>] [[-HomeLanguageSurveyHomeLanguageCode] <String>] [[-HomeLanguageSurveyAdultLanguageCode] <String>] [[-USEnterDate] <DateTime>] [[-USSchoolEnterDate] <DateTime>] [[-UserCode1] <String>] [[-UserCode2] <String>] [[-UserCode3] <String>] [[-UserCode4] <String>] [[-UserCode5] <String>] [[-UserCode6] <String>] [[-UserCode7] <String>] [[-UserCode8] <String>] [[-UserCode9] <String>] [[-UserCode10] <String>] [[-UserCode11] <String>] [[-UserCode12] <String>] [[-UserCode13] <String>] [[-WellbeingDate] <DateTime>] [[-WellbeingScore] <String>] [[-WellbeingAttentionCode] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StudentID			true	false	0
LastName			false	false
FirstName			false	false
MiddleName			false	false
NameSuffix			false	false
Gender			false	false
Grade			false	false
NextGrade			false	false
NextSchool			false	false	-1
BirthDate			false	false
InactiveStatusCode			false	false
HomePhone			false	false
HomeLanguageCode			false	false
CorrespondanceLanguageCode			false	false
LanguageFluencyCode			false	false
EthnicityCode			false	false
Race1Code			false	false
Race2Code			false	false
Race3Code			false	false
Race4Code			false	false
Race5Code			false	false
LastSchool			false	false	-1
ResidenceSchool			false	false	-1
NextResidenceSchool			false	false	-1
SchoolEnterDate			false	false
DistrictEnterDate			false	false
BirthCity			false	false
BirthStateCode			false	false
BirthCountryCode			false	false
ParentEdLevelCode			false	false
ParentGuardianName			false	false
MailingAddress			false	false
MailingAddressCity			false	false
MailingAddressState			false	false
MailingAddressZipCode			false	false
MailingAddressZipExt			false	false
ResidenceAddress			false	false
ResidenceAddressCity			false	false
ResidenceAddressState			false	false
ResidenceAddressZipCode			false	false
ResidenceAddressZipExt			false	false
HomeLanguageSurveyFirstLanguageCode			false	false
HomeLanguageSurveyPrimaryLanguageCode			false	false
HomeLanguageSurveyHomeLanguageCode			false	false
HomeLanguageSurveyAdultLanguageCode			false	false
USEnterDate			false	false
USSchoolEnterDate			false	false
UserCode1			false	false
UserCode2			false	false
UserCode3			false	false
UserCode4			false	false
UserCode5			false	false
UserCode6			false	false
UserCode7			false	false
UserCode8			false	false
UserCode9			false	false
UserCode10			false	false
UserCode11			false	false
UserCode12			false	false
UserCode13			false	false
WellbeingDate			false	false
WellbeingScore			false	false
WellbeingAttentionCode			false	false

Examples

EXAMPLE 1

Edit-AeriesStudent -StudentID 99400001 -FirstName "Aeries" -LastName "Software"
This will update Student ID 99400001 to have the First Name of "Aeries" and the Last Name of "Software"

Edit-AeriesStudentTest

Synopsis

Update Test Score in Aeries

Syntax

Edit-AeriesStudentTest [-StudentID] <Int32> [-TestID] <String> [-TestPart] <Int16> [[-TestingAdministration] <String>] [-TestDate] <DateTime> [[-RawScore] <Int16>] [[-PercentCorrect] <Decimal>] [[-PerformanceLevel] <Int32>] [[-TestTypeCode] <String>] [[-TestSourceCode] <String>] [[-ScaleScore] <Int16>] [[-Other] <Int16>] [[-GradeEquivalency] <Int16>] [[-Percentile] <Int16>] [[-Stanine] <Int16>] [[-CurveEquivalent] <Int16>] [[-Rubric] <Int16>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StudentID			true	false	0
TestID			true	false
TestPart			true	false	0
TestingAdministration			false	false
TestDate			true	false
RawScore			false	false	-1
PercentCorrect			false	false	-1
PerformanceLevel			false	false	-1
TestTypeCode			false	false
TestSourceCode			false	false
ScaleScore			false	false	-1
Other			false	false	-1
GradeEquivalency			false	false	-1
Percentile			false	false	-1
Stanine			false	false	-1
CurveEquivalent			false	false	-1
Rubric			false	false	-1

Examples

EXAMPLE 1

Edit-AeriesStudentTest -StudentID 99400001 -TestID "ELPAC" -TestPart 0 -TestingAdministration "0322" -TestDate "2022-03-12" -Other 5
This will edit the Test for the specific Student ID in Aeries with the given TestID, TestPart, TestingAdministration and TestDate

Get-AeriesAbsenceCode

Synopsis

Get one or all Absence Codes from Aeries for a specific School

Syntax

Get-AeriesAbsenceCode [-SchoolCode] <Int16> [[-AbsenceCode] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
AbsenceCode		Specific Absence Code to pull	false	false

Examples

EXAMPLE 1

Get-AeriesAbsenceCode -SchoolCode 994
This will return all Absence Codes for School 994 from Aeries

EXAMPLE 2

Get-AeriesAbsenceCode -SchoolCode 994 -AbsenceCode "A"
This will return the Absence Code "A" for School 994 from Aeries

Get-AeriesActivity

Synopsis

Get Activities and Awards from Aeries

Syntax

Get-AeriesActivity [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-Code] <String>] [[-Sequence] <Int16>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
Code		Used to get Activity with a specific code	false	false
Sequence		Used to get a specific Activity	false	false	0

Examples

EXAMPLE 1

Get-AeriesActivity -SchoolCode 994
This will return all Activities and Awards for all Students at the given School Code from Aeries

EXAMPLE 2

Get-AeriesActivity -SchoolCode 994 -Code "600"
This will return all Activities and Awards for all Students at the given School Code from Aeries

EXAMPLE 3

Get-AeriesActivity -SchoolCode 994 -StudentID 99400001
This will return all Activities and Awards for the given Student ID at the given School Code from Aeries

EXAMPLE 4

Get-AeriesActivity -SchoolCode 994 -StudentID 99400001 -Code "600"
This will return all Activities and Awards for the given Student ID at the given School Code from Aeries

EXAMPLE 5

Get-AeriesActivity -SchoolCode 994 -StudentID 99400001 -Sequence 7
This will return an Activity or Award for the given Sequence Number, Student ID and School Code from Aeries

Get-AeriesAlternateCourseRequest

Synopsis

Get Alternate Course Requests from Aeries

Syntax

Get-AeriesAlternateCourseRequest [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-Sequence] <Int16>] [[-StudentNumber] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
Sequence			false	false	0
StudentNumber			false	false	0

Examples

EXAMPLE 1

Get-AeriesAlternateCourseRequest -SchoolCode 994
This will return all Alternate Course Requests for School Code 994 from Aeries

EXAMPLE 2

Get-AeriesAlternateCourseRequest -SchoolCode 994 -StudentID 99400002
This will return the Alternate Course Requests for Student ID 99400002 from School Code 994 from Aeries

EXAMPLE 3

Get-AeriesAlternateCourseRequest -SchoolCode 994 -StudentID 99400002 -Sequence 2
This will return the Alternate Course Request Sequence 2 for Student ID 99400002 from School Code 994 from Aeries

EXAMPLE 4

Get-AeriesAlternateCourseRequest -SchoolCode 994 -StudentNumber 2
This will return the Alternate Course Requests for Student Number 2 from School Code 994 from Aeries

EXAMPLE 5

Get-AeriesAlternateCourseRequest -SchoolCode 994 -StudentNumber 2 -Sequence 2
This will return the Alternate Course Request Sequence 2 for Student Number 2 from School Code 994 from Aeries

Get-AeriesAssertiveDiscipline

Synopsis

Get Assertive Discipline from Aeries

Syntax

Get-AeriesAssertiveDiscipline [-SchoolCode] <Int16> [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0

Examples

EXAMPLE 1

Get-AeriesAssertiveDiscipline -SchoolCode 994
This will return all Assertive Disciplines for all Students at the specified School Code from Aeries

EXAMPLE 2

Get-AeriesAssertiveDiscipline -SchoolCode 994 -StudentID 99400001
This will return all Assertive Disciplines for the specific Student ID at the specified School Code from Aeries

Get-AeriesAttendanceHistoryCodes

Synopsis

Get Attendace History Codes from Aeries

Syntax

Get-AeriesAttendanceHistoryCodes [-SchoolCode] <Int16> [[-StartYear] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StartYear		Start Year \(Will format to be Academic Year of YYYY-YYYY\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesAttendanceHistoryCodes -SchoolCode 994
This will return all Attendace History Codes from Aeries for School Code 994

EXAMPLE 2

Get-AeriesAttendanceHistoryCodes -SchoolCode 994 -StartYear 2020
This will return all Attendace History Codes from Aeries for Academic Year 2020-2021 at School Code 994

Get-AeriesAttendanceHistoryDetail

Synopsis

Get Attendace History Detail from Aeries

Syntax

Get-AeriesAttendanceHistoryDetail [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-StartYear] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
StartYear		Start Year \(Will format to be Academic Year of YYYY-YYYY\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesAttendanceHistoryDetail -SchoolCode 994
This will return all Attendace History Details from Aeries for School Code 994

EXAMPLE 2

Get-AeriesAttendanceHistoryDetail -SchoolCode 994 -StudentID 99400001
This will return all Attendace History Details from Aeries for Student ID 99400001

EXAMPLE 3

Get-AeriesAttendanceHistoryDetail -SchoolCode 994 -StartYear 2020
This will return all Attendace History Details from Aeries for Academic Year 2020-2021 at School Code 994

Get-AeriesAttendanceHistorySummary

Synopsis

Get Attendace History Summary from Aeries

Syntax

Get-AeriesAttendanceHistorySummary [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-StartYear] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
StartYear		Start Year \(Will format to be Academic Year of YYYY-YYYY\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesAttendanceHistorySummary -SchoolCode 994
This will return all Attendace History Summaries from Aeries for School Code 994

EXAMPLE 2

Get-AeriesAttendanceHistorySummary -SchoolCode 994 -StudentID 99400001
This will return all Attendance History Summaries from Aeries for Student ID 99400001

EXAMPLE 3

Get-AeriesAttendanceHistorySummary -SchoolCode 994 -StartYear 2020
This will return all Attendance History Summaries from Aeries for Academic Year 2020-2021 at School Code 994

Get-AeriesAuthorization

Synopsis

Get Authorizations from Aeries

Syntax

Get-AeriesAuthorization [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-Sequence] <Int16>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
Sequence			false	false	0

Examples

EXAMPLE 1

Get-AeriesAuthorization -SchoolCode 994
This will return all Authorizations for all Students at the given School Code from Aeries

EXAMPLE 2

Get-AeriesAuthorization -SchoolCode 994 -StudentID 99400001
This will return all Authorizations for the given Student ID at the given School Code from Aeries

EXAMPLE 3

Get-AeriesAuthorization -SchoolCode 994 -StudentID 99400001 -Sequence 5
This will return specific Authorization for the given Student ID at the given School Code from Aeries

Get-AeriesBellSchedule

Synopsis

Get Bell Schedules from Aeries for a specific School

Syntax

Get-AeriesBellSchedule [-SchoolCode] <Int16> [[-Date] <DateTime>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
Date		Specific date to pull Bell Schedule for	false	false

Examples

EXAMPLE 1

Get-AeriesBellSchedule -SchoolCode 994
This will return Bell Schedules for School 994 from Aeries

EXAMPLE 2

Get-AeriesBellSchedule -SchoolCode 994 -Date (Get-Date "2021-04-08")
This will return Bell Schedules for School 994 from Aeries on the specified Date

Get-AeriesClassCalendar

Synopsis

Get Class Calendars from Aeries

Syntax

Get-AeriesClassCalendar [-SchoolCode] <Int16> [[-Sequence] <Int16>] [-GetDates] [[-StartYear] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
Sequence			false	false	0
GetDates		Switch for pulling Dates for a Class Calendar	false	false	False
StartYear		Start Year \(Will format to be Academic Year of YYYY-YYYY\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesClassCalendar -SchoolCode 894
This will return all Class Calendars for School Code 894 from Aeries

EXAMPLE 2

Get-AeriesClassCalendar -SchoolCode 894 -StartYear 2020
This will return all Class Calendars for School Code 894 that apply to Academic Year 2020-2021 from Aeries

EXAMPLE 3

Get-AeriesClassCalendar -SchoolCode 894 -Sequence 14
This will return the Class Calendar with Sequence 14 from School Code 894 from Aeries

EXAMPLE 4

Get-AeriesClassCalendar -SchoolCode 894 -Sequence 14 -GetDates
This will return the Dates for Class Calendar with Sequence 14 from School Code 894 from Aeries

Get-AeriesCodeSet

Synopsis

Get a Code Set from Aeries

Syntax

Get-AeriesCodeSet [-Table] <String> [-Field] <String> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
Table		Table Code	true	false
Field		Field Code	true	false

Examples

EXAMPLE 1

Get-AeriesCodeSet -Table "STU" -Field "TG"
This will return the Code Set from Aeries for STU.TG (Student Tag)

Get-AeriesContact

Synopsis

Get Contacts from Aeries

Syntax

Get-AeriesContact [-SchoolCode] <Int16> [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0

Examples

EXAMPLE 1

Get-AeriesContact -SchoolCode 994
This will return all Contacts for all Students at the given School Code from Aeries

EXAMPLE 2

Get-AeriesContact -SchoolCode 994 -StudentID 99400001
This will return all Contacts for the given Student ID at the given School Code from Aeries

Get-AeriesCourseDataChanges

Synopsis

Get Course Data Changes from Aeries

Syntax

Get-AeriesCourseDataChanges [-DateTime] <DateTime> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
DateTime		Date Object to use for filters	true	false

Examples

EXAMPLE 1

Get-AeriesCourseDataChanges -DateTime (Get-Date "2021-04-09 9:00AM")
This will return the requested Course Data Changes from Aeries

Get-AeriesCourseInformation

Synopsis

Get Course Information from Aeries

Syntax

Get-AeriesCourseInformation [[-CourseID] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
CourseID			false	false

Examples

EXAMPLE 1

Get-AeriesCourseInformation
This will return all Course Information for School Code 994 from Aeries

EXAMPLE 2

Get-AeriesCourseInformation -CourseID "100"
This will return the Course Information for Student ID 99400001 from School Code 994 from Aeries

Get-AeriesCourseRequest

Synopsis

Get Course Requests from Aeries

Syntax

Get-AeriesCourseRequest [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-Sequence] <Int16>] [[-StudentNumber] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
Sequence			false	false	0
StudentNumber			false	false	0

Examples

EXAMPLE 1

Get-AeriesCourseRequest -SchoolCode 994
This will return all Course Requests for School Code 994 from Aeries

EXAMPLE 2

Get-AeriesCourseRequest -SchoolCode 994 -StudentID 99400002
This will return the Course Requests for Student ID 99400002 from School Code 994 from Aeries

EXAMPLE 3

Get-AeriesCourseRequest -SchoolCode 994 -StudentID 99400002 -Sequence 5
This will return the Course Request Sequence 5 for Student ID 99400002 from School Code 994 from Aeries

EXAMPLE 4

Get-AeriesCourseRequest -SchoolCode 994 -StudentNumber 2
This will return the Course Requests for Student Number 2 from School Code 994 from Aeries

EXAMPLE 5

Get-AeriesCourseRequest -SchoolCode 994 -StudentNumber 2 -Sequence 5
This will return the Course Request Sequence 5 for Student Number 2 from School Code 994 from Aeries

Get-AeriesDistrictSupplemental

Synopsis

Get District Supplemental from Aeries

Syntax

Get-AeriesDistrictSupplemental [-SchoolCode] <Int16> [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0

Examples

EXAMPLE 1

Get-AeriesDistrictSupplemental -SchoolCode 994
This will return all District Supplemental for all Students at the specified School Code from Aeries

EXAMPLE 2

Get-AeriesDistrictSupplemental -SchoolCode 994 -StudentID 99400001
This will return all District Supplemental for the specific Student ID at the specified School Code from Aeries

Get-AeriesFee

Synopsis

Get Fees and Fines from Aeries

Syntax

Get-AeriesFee [-SchoolCode] <Int16> [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0

Examples

EXAMPLE 1

Get-AeriesFee -SchoolCode 994
This will return all Fees and Fines for all Students at the specified School Code from Aeries

EXAMPLE 2

Get-AeriesFee -SchoolCode 994 -StudentID 99400001
This will return all Fees and Fines for the specific Student ID at the specified School Code from Aeries

Get-AeriesFlexPeriod

Synopsis

Get Flex Periods from Aeries

Syntax

Get-AeriesFlexPeriod [-SchoolCode] <Int16> [[-Sequence] <Int16>] [[-StartYear] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
Sequence			false	false	0
StartYear		Start Year \(Will format to be Academic Year of YYYY-YYYY\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesFlexPeriod -SchoolCode 894
This will return all Flex Periods for School Code 894 from Aeries

EXAMPLE 2

Get-AeriesFlexPeriod -SchoolCode 894 -StartYear 2020
This will return all Flex Periods for School Code 894 that apply to Academic Year 2020-2021 from Aeries

EXAMPLE 3

Get-AeriesFlexPeriod -SchoolCode 894 -Sequence 2
This will return the Flex Period with Sequence 2 from School Code 894 from Aeries

Get-AeriesGradebook

Synopsis

Get Gradebook from Aeries

Syntax

Get-AeriesGradebook [[-GradebookNumber] <Int32>] [[-StaffID] <Int32>] [[-SchoolCode] <Int16>] [[-SectionNumber] <Int16>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
GradebookNumber			false	false	0
StaffID			false	false	0
SchoolCode			false	false	0
SectionNumber			false	false	0

Examples

EXAMPLE 1

Get-AeriesGradebook -GradebookNumber 4487750
This will return the Gradebook with Number 4487750 from Aeries

EXAMPLE 2

Get-AeriesGradebook -StaffID 994605
This will return all Gradebooks associated to Staff ID 994605 from Aeries

EXAMPLE 3

Get-AeriesGradebook -SchoolCode 994 -SectionNumber 43
This will return the Gradebooks associated to School Code 994 and Section Number 43 from Aeries

Get-AeriesGradebookAssignment

Synopsis

Get Gradebook Assignments from Aeries

Syntax

Get-AeriesGradebookAssignment [[-GradebookNumber] <Int32>] [[-AssignmentNumber] <Int32>] [[-AssignmentUniqueID] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
GradebookNumber			false	false	0
AssignmentNumber			false	false	0
AssignmentUniqueID			false	false

Examples

EXAMPLE 1

Get-AeriesGradebookAssignment -GradebookNumber 4487750
This will return the Gradebook Assignments for Gradebook Number 4487750 from Aeries

EXAMPLE 2

Get-AeriesGradebookAssignment -GradebookNumber 4487750 -AssignmentNumber 1
This will return all Gradebooks associated to Staff ID 994605 from Aeries

EXAMPLE 3

Get-AeriesGradebookAssignment -AssignmentUniqueID "059FE76C-05C1-40DD-8B95-1FFA961DE488"
This will return the Gradebooks associated to School Code 994 and Section Number 43 from Aeries

Get-AeriesGradebookAssignmentScore

Synopsis

Get Gradebook Assignment Scores from Aeries

Syntax

Get-AeriesGradebookAssignmentScore [[-GradebookNumber] <Int32>] [[-AssignmentNumber] <Int32>] [[-AssignmentUniqueID] <String>] [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
GradebookNumber			false	false	0
AssignmentNumber			false	false	0
AssignmentUniqueID			false	false
StudentID			false	false	0

Examples

EXAMPLE 1

Get-AeriesGradebookAssignmentScore -GradebookNumber 4487750 -AssignmentNumber 1
This will return the Gradebook Assignment Scores for Gradebook Number 4487750 and Assignment 1 from Aeries

EXAMPLE 2

Get-AeriesGradebookAssignmentScore -GradebookNumber 4487750 -AssignmentNumber 1 -StudentID 99400015
This will return all Gradebook Assignemtn Scores for Student ID 99400015 on Assignment 1 in Gradebook Number 4487750 from Aeries

EXAMPLE 3

Get-AeriesGradebookAssignmentScore -AssignmentUniqueID "059FE76C-05C1-40DD-8B95-1FFA961DE488"
This will return the Gradebook Assignment Scores for Gradebook Assignment "059FE76C-05C1-40DD-8B95-1FFA961DE488" from Aeries

EXAMPLE 4

Get-AeriesGradebookAssignmentScore -AssignmentUniqueID "059FE76C-05C1-40DD-8B95-1FFA961DE488" -StudentID 99400015
This will return the Gradebook Assignment Scores for Gradebook Assignment "059FE76C-05C1-40DD-8B95-1FFA961DE488" and Student ID 99400015 from Aeries

Get-AeriesGradebookFinalMarks

Synopsis

Get Gradebook Final Marks from Aeries

Syntax

Get-AeriesGradebookFinalMarks [-GradebookNumber] <Int32> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
GradebookNumber			true	false	0

Examples

EXAMPLE 1

Get-AeriesGradebookFinalMarks -GradebookNumber 4487750
This will return the Final Marks for Gradebook Number 4487750 from Aeries

Get-AeriesGradebookStudent

Synopsis

Get Gradebook Students from Aeries

Syntax

Get-AeriesGradebookStudent [-GradebookNumber] <Int32> [-Term] <String> [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
GradebookNumber			true	false	0
Term			true	false
StudentID			false	false	0

Examples

EXAMPLE 1

Get-AeriesGradebookStudent -GradebookNumber 4487750 -Term "Y"
This will return the Gradebook Students for Gradebook Number 4487750 and Term "Y" from Aeries

EXAMPLE 2

Get-AeriesGradebookStudent -GradebookNumber 4487750 -Term "Y" -StudentID 99400015
This will return the Gradebook Student for Gradebook Number 4487750, Term "Y" and Student ID 99400015 from Aeries

Get-AeriesGraduationRequirement

Synopsis

Get Graduation Requirements from Aeries

Syntax

Get-AeriesGraduationRequirement [-SchoolCode] <Int16> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0

Examples

EXAMPLE 1

Get-AeriesGraduationRequirement -SchoolCode 994
This will return Graduation Requirements from Aeries at School 994

Get-AeriesReportCardMarkingPeriod

Synopsis

Get Report Card Marking Periods from Aeries

Syntax

Get-AeriesReportCardMarkingPeriod [-SchoolCode] <Int16> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0

Examples

EXAMPLE 1

Get-AeriesReportCardMarkingPeriod -SchoolCode 994
This will return all Report Card Marking Periods from Aeries at School 994

Get-AeriesSchedulingSection

Synopsis

Get Scheduling Sections from Aeries

Syntax

Get-AeriesSchedulingSection [-SchoolCode] <Int16> [[-SectionNumber] <Int16>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
SectionNumber			false	false	0

Examples

EXAMPLE 1

Get-AeriesSchedulingSection -SchoolCode 994
This will return all Scheduling Sections for School Code 994 from Aeries

EXAMPLE 2

Get-AeriesSchedulingSection -SchoolCode 994 -SectionNumber 43
This will return the Scheduling Sections for Section 43 from School Code 994 from Aeries

Get-AeriesSchool

Synopsis

Get a specific school or all schools from Aeries

Syntax

Get-AeriesSchool [[-SchoolCode] <Int16>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			false	false	0

Examples

EXAMPLE 1

Get-AeriesSchoolInformation
This will return all schools from Aeries

EXAMPLE 2

Get-AeriesSchoolInformation -SchoolCode 994
This will return the requested school from Aeries

Get-AeriesSchoolCalendar

Synopsis

Get Terms from Aeries for a specific School

Syntax

Get-AeriesSchoolCalendar [[-SchoolCode] <Int16>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			false	false	0

Examples

EXAMPLE 1

Get-AeriesSchoolCalendar -SchoolCode 994
This will return Terms for School 994 from Aeries

Get-AeriesSchoolSupplemental

Synopsis

Get School Supplemental from Aeries

Syntax

Get-AeriesSchoolSupplemental [-SchoolCode] <Int16> [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0

Examples

EXAMPLE 1

Get-AeriesSchoolSupplemental -SchoolCode 994
This will return all School Supplemental for all Students at the specified School Code from Aeries

EXAMPLE 2

Get-AeriesSchoolSupplemental -SchoolCode 994 -StudentID 99400001
This will return all School Supplemental for the specific Student ID at the specified School Code from Aeries

Get-AeriesSchoolTerms

Synopsis

Get Terms from Aeries for a specific School

Syntax

Get-AeriesSchoolTerms [-SchoolCode] <Int16> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0

Examples

EXAMPLE 1

Get-AeriesSchoolTerms -SchoolCode 994
This will return Terms for School 994 from Aeries

Get-AeriesSection

Synopsis

Get Sections from Aeries

Syntax

Get-AeriesSection [-SchoolCode] <Int16> [[-SectionNumber] <Int16>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
SectionNumber			false	false	0

Examples

EXAMPLE 1

Get-AeriesSection -SchoolCode 994
This will return all Sections for School Code 994 from Aeries

EXAMPLE 2

Get-AeriesSection -SchoolCode 994 -SectionNumber 43
This will return the Sections for Section 43 from School Code 994 from Aeries

Get-AeriesSectionDataChanges

Synopsis

Get Course Data Changes from Aeries

Syntax

Get-AeriesSectionDataChanges [-DateTime] <DateTime> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
DateTime		Date Object to use for filters	true	false

Examples

EXAMPLE 1

Get-AeriesSectionDataChanges -DateTime (Get-Date "2021-04-09 9:00AM")
This will return the requested Section Data Changes from Aeries

Get-AeriesSectionRoster

Synopsis

Get Section Class Roster from Aeries

Syntax

Get-AeriesSectionRoster [-SchoolCode] <Int16> [-SectionNumber] <Int16> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
SectionNumber			true	false	0

Examples

EXAMPLE 1

Get-AeriesSectionRoster -SchoolCode 994 -SectionNumber 43
This will return the Section Class Roster for Section 43 from School Code 994 from Aeries

Get-AeriesSectionRosterDataChanges

Synopsis

Get Section Roster Data Changes from Aeries

Syntax

Get-AeriesSectionRosterDataChanges [-DateTime] <DateTime> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
DateTime		Date Object to use for filters	true	false

Examples

EXAMPLE 1

Get-AeriesSectionRosterDataChanges -DateTime (Get-Date "2021-04-09 9:00AM")
This will return the requested Section Roster Data Changes from Aeries

Get-AeriesStaff

Synopsis

Get Staff records from Aeries

Syntax

Get-AeriesStaff [[-StaffID] <Int32>] [[-HRID] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StaffID			false	false	0
HRID			false	false

Examples

EXAMPLE 1

Get-AeriesStaff
This will return all Staff records from Aeries

EXAMPLE 2

Get-AeriesStaff -StaffID 994605
This will return the Staff record for Staff ID 994605 from Aeries

EXAMPLE 3

Get-AeriesStaff -HRID "SomeOtherID"
This will return the Staff record for HR ID "SomeOtherID" from Aeries

Get-AeriesStaffAssignment

Synopsis

Get Staff Assignments from Aeries

Syntax

Get-AeriesStaffAssignment [-StaffID] <Int32> [[-AssignmentType] <Object>] [[-Sequence] <Int16>] [[-Date] <DateTime>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StaffID			true	false	0
AssignmentType			false	false
Sequence			false	false	0
Date			false	false

Examples

EXAMPLE 1

Get-AeriesStaffAssignment -StaffID 1
This will return all Staff Assignments for Staff ID 1 from Aeries

EXAMPLE 2

Get-AeriesStaffAssignment -StaffID 1 -AssignmentType "classified"
This will return all Staff Assignments for Staff ID 1 that match Assignment Type of "classified" from Aeries

EXAMPLE 3

Get-AeriesStaffAssignment -StaffID 1 -AssignmentType "classified" -Sequence 1
This will return all Staff Assignments for Staff ID 1 that match Assignment Type of "classified" and Sequence Number 1 from Aeries

EXAMPLE 4

Get-AeriesStaffAssignment -StaffID 1 -AssignmentType "classified" -Date (Get-Date "2021-04-13")
This will return all Staff Assignments for Staff ID 1 that match Assignment Type of "classified" and were effective on 04/13/2021 from Aeries

Get-AeriesStaffClass

Synopsis

Get Staff Classes/Sections from Aeries

Syntax

Get-AeriesStaffClass [-StaffID] <Int32> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StaffID			true	false	0

Examples

EXAMPLE 1

Get-AeriesStaffClass -StaffID 994605
This will return all Classes/Sections for Staff ID 994605 from Aeries

Get-AeriesStaffDataChanges

Synopsis

Get Staff Data Changes from Aeries

Syntax

Get-AeriesStaffDataChanges [-DateTime] <DateTime> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
DateTime		Date Object to use for filters	true	false

Examples

EXAMPLE 1

Get-AeriesStaffDataChanges -DateTime (Get-Date "2021-04-09 9:00AM")
This will return Staff Data Changes as of the given Date Time from Aeries

Get-AeriesStudent

Synopsis

Get one or more Students from Aeries

Syntax

Get-AeriesStudent [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-StudentNumber] <Int32>] [[-Grade] <String>] [[-StartingRecord] <Int32>] [[-EndingRecord] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
StudentNumber			false	false	0
Grade			false	false
StartingRecord		The Record-Count value of the first record to return \(inclusive\)	false	false	0
EndingRecord		The Record-Count value of the last record to return \(inclusive\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesStudent -SchoolCode 994
This will return all Students from Aeries at School 994

EXAMPLE 2

Get-AeriesStudent -SchoolCode 994 -Grade 9
This will return all Stduents from Aeries at School 994 and Grade 9

Get-AeriesStudentAttendance

Synopsis

Get Attendace from Aeries

Syntax

Get-AeriesStudentAttendance [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
StartDate		The earliest date of attendance to include \(inclusive\)	false	false
EndDate		The latest date of attendance to include \(inclusive\)	false	false

Examples

EXAMPLE 1

Get-AeriesStudentAttendance
This will return all Student Attendace from Aeries

EXAMPLE 2

Get-AeriesStudentAttendance -SchoolCode 994
This will return the requested Attendace from Aeries for School Code 994

EXAMPLE 3

Get-AeriesStudentAttendance -SchoolCode 994 -StudentID 99400001 -StartDate (Get-Date "2020-08-01") -EndDate (Get-Date "2021-07-31")
This will return the requested Attendance from Aeries for Student ID 99400001, School Code 994, Start Date of 08/01/2020 and End Date 07/31/2021

Get-AeriesStudentClassSchedule

Synopsis

Get Student Class Schedules from Aeries

Syntax

Get-AeriesStudentClassSchedule [-SchoolCode] <Int16> [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0

Examples

EXAMPLE 1

Get-AeriesStudentClassSchedule -SchoolCode 994
This will return all Student Class Schedules for School Code 994 from Aeries

EXAMPLE 2

Get-AeriesStudentClassSchedule -SchoolCode 994 -StudentID 99400001
This will return the Student Class Schedules for Student ID 99400001 from School Code 994 from Aeries

Get-AeriesStudentCollegeTest

Synopsis

Get College Tests from Aeries

Syntax

Get-AeriesStudentCollegeTest [-SchoolCode] <Int16> [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0

Examples

EXAMPLE 1

Get-AeriesStudentCollegeTest -SchoolCode 994 -StudentID 99400001
This will return all College Tests for the specific Student ID at the specified School Code from Aeries

Get-AeriesStudentDataChanges

Synopsis

Get Student Data Changes from Aeries

Syntax

Get-AeriesStudentDataChanges [-DataArea] <String> [-DateTime] <DateTime> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
DataArea			true	false
DateTime		Date Object to use for filters	true	false

Examples

EXAMPLE 1

Get-AeriesStudentDataChanges -DataArea "student" -DateTime (Get-Date "2021-04-09 9:00AM")
This will return the requested something from Aeries

Get-AeriesStudentEnrollmentHistory

Synopsis

Get Enrollment History from Aeries

Syntax

Get-AeriesStudentEnrollmentHistory [[-SchoolCode] <Int16>] [[-StudentID] <Int32>] [[-AcademicYear] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			false	false	0
StudentID			false	false	0
AcademicYear		Academic year \(2017 for 2017-2018\)	false	false

Examples

EXAMPLE 1

Get-AeriesStudentEnrollmentHistory
This will return all Student Enrollment Histories from Aeries

EXAMPLE 2

Get-AeriesStudentEnrollmentHistory -StudentID 99400001
This will return all Enrollment Histories from Aeries for Student ID 99400001

EXAMPLE 3

Get-AeriesStudentEnrollmentHistory -StudentID 99400001 -AcademicYear 2020
This will return all Enrollment Histories from Aeries for Student ID 99400001 and Academic Year 2020-2021

EXAMPLE 4

Get-AeriesStudentEnrollmentHistory -SchoolCode 994
This will return all Enrollment Histories from Aeries for School Code 994

EXAMPLE 5

Get-AeriesStudentEnrollmentHistory -SchoolCode 994 -AcademicYear 2020
This will return all Enrollment Histories from Aeries for School Code 994 and Academic Year 2020-2021

EXAMPLE 6

Get-AeriesStudentEnrollmentHistory -SchoolCode 994 -StudentID 99400001 -AcademicYear 2020
This will return all Enrollment Histories from Aeries for Student ID 99400001 at School Code 994 for Academic Year 2020

Get-AeriesStudentExtended

Synopsis

Get one or more Students Extended Information from Aeries

Syntax

Get-AeriesStudentExtended [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-StudentNumber] <Int32>] [[-Grade] <String>] [[-StartingRecord] <Int32>] [[-EndingRecord] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
StudentNumber			false	false	0
Grade			false	false
StartingRecord		The Record-Count value of the first record to return \(inclusive\)	false	false	0
EndingRecord		The Record-Count value of the last record to return \(inclusive\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesStudentExtended -SchoolCode 994
This will return all Students Extended Information from Aeries at School 994

EXAMPLE 2

Get-AeriesStudentExtended -SchoolCode 994 -Grade 9
This will return all Stduents Extended Information from Aeries at School 994 and Grade 9

Get-AeriesStudentGPA

Synopsis

Get one or more Students GPAs from Aeries

Syntax

Get-AeriesStudentGPA [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-StartingRecord] <Int32>] [[-EndingRecord] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
StartingRecord		The Record-Count value of the first record to return \(inclusive\)	false	false	0
EndingRecord		The Record-Count value of the last record to return \(inclusive\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesStudentGPA -SchoolCode 994
This will return all Student GPAs from Aeries at School 994

EXAMPLE 2

Get-AeriesStudentGPA -SchoolCode 994 -StudentID 99400001
This will return the GPAs for School 994 and Student ID 99400001

Get-AeriesStudentGraduationStatus

Synopsis

Get one or more Students Graduation Status from Aeries

Syntax

Get-AeriesStudentGraduationStatus [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-Grade] <String>] [[-StartingRecord] <Int32>] [[-EndingRecord] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
Grade			false	false
StartingRecord		The Record-Count value of the first record to return \(inclusive\)	false	false	0
EndingRecord		The Record-Count value of the last record to return \(inclusive\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesStudentGraduationStatus -SchoolCode 994
This will return all Student Graduation Status from Aeries at School 994

EXAMPLE 2

Get-AeriesStudentGraduationStatus -SchoolCode 994 -StudentID 99400001
This will return the Graduation Status for School 994 and Student ID 99400001

Get-AeriesStudentGroup

Synopsis

Get Student Groups from Aeries

Syntax

Get-AeriesStudentGroup [-SchoolCode] <Int16> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0

Examples

EXAMPLE 1

Get-AeriesStudentGroup -SchoolCode 994
This will return all Student Groups for all Students at the specified School Code from Aeries

Get-AeriesStudentPicture

Synopsis

Get Student Picture from Aeries

Syntax

Get-AeriesStudentPicture [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-StartingRecord] <Int32>] [[-EndingRecord] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
StartingRecord		The Record-Count value of the first record to return \(inclusive\)	false	false	0
EndingRecord		The Record-Count value of the last record to return \(inclusive\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesStudentPicture -SchoolCode 994
This will return all Student Picture for all Students at the specified School Code from Aeries

EXAMPLE 2

Get-AeriesStudentPicture -SchoolCode 994 -StudentID 99400001
This will return all Student Picture for the specific Student ID at the specified School Code from Aeries

Get-AeriesStudentProgram

Synopsis

Get Programs from Aeries

Syntax

Get-AeriesStudentProgram [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-Code] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
Code		Program to limit results to	false	false

Examples

EXAMPLE 1

Get-AeriesStudentProgram -SchoolCode 994
This will return all Programs for all Students at the given School Code from Aeries

EXAMPLE 2

Get-AeriesStudentProgram -SchoolCode 994 -StudentID 99400001
This will return all Programs for the given Student ID at the given School Code from Aeries

Get-AeriesStudentReportCard

Synopsis

Get one or more Students Report Cards from Aeries

Syntax

Get-AeriesStudentReportCard [-SchoolCode] <Int16> [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0

Examples

EXAMPLE 1

Get-AeriesStudentReportCard -SchoolCode 994
This will return all Student Report Cards from Aeries at School 994

EXAMPLE 2

Get-AeriesStudentReportCard -SchoolCode 994 -StudentID 99400001
This will return the Report Cards for School 994 and Student ID 99400001

Get-AeriesStudentTest

Synopsis

Get Tests from Aeries

Syntax

Get-AeriesStudentTest [-StudentID] <Int32> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StudentID			true	false	0

Examples

EXAMPLE 1

Get-AeriesStudentTest -StudentID 99400001
This will return all Tests for the specific Student ID from Aeries

Get-AeriesStudentTranscript

Synopsis

Get one or more Students Transcript from Aeries

Syntax

Get-AeriesStudentTranscript [-SchoolCode] <Int16> [[-StudentID] <Int32>] [[-StartingRecord] <Int32>] [[-EndingRecord] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0
StartingRecord		The Record-Count value of the first record to return \(inclusive\)	false	false	0
EndingRecord		The Record-Count value of the last record to return \(inclusive\)	false	false	0

Examples

EXAMPLE 1

Get-AeriesStudentTranscript -SchoolCode 994
This will return all Student Transcript from Aeries at School 994

EXAMPLE 2

Get-AeriesStudentTranscript -SchoolCode 994 -StudentID 99400001
This will return the Transcript for School 994 and Student ID 99400001

Get-AeriesSystemInfo

Synopsis

Get the System Info for Aeries

Syntax

Get-AeriesSystemInfo [<CommonParameters>]

Examples

EXAMPLE 1

Get-AeriesSystemInfo
This will return the System Info for Aeries

Get-AeriesTeacher

Synopsis

Get Teacher record from Aeries

Syntax

Get-AeriesTeacher [[-SchoolCode] <Int16>] [[-TeacherNumber] <Int16>] [[-StaffID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			false	false	0
TeacherNumber			false	false	-1
StaffID			false	false	0

Examples

EXAMPLE 1

Get-AeriesTeacher -SchoolCode 994
This will return all Teacher records for School Code 994 from Aeries

EXAMPLE 2

Get-AeriesTeacher -SchoolCode 994 -TeacherNumber 605
This will return the Teacher record for School Code 994 and Teacher Number 605 from Aeries

EXAMPLE 3

Get-AeriesTeacher -StaffID 994605
This will return the Teacher records for Staff ID 994605 from Aeries

Initialize-AeriesApi

Synopsis

Initialize and prepare for Aeries API calls

Syntax

Initialize-AeriesApi [-URL] <String> [-Certificate] <String> [[-DatabaseYear] <String>] [[-UserAgent] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
URL		Base URL for Aeries API	true	false
Certificate		The certificate to perform the requests	true	true \(ByValue\)
DatabaseYear		The DatabaseYear to utilize If provided, must be 4 characters	false	false
UserAgent		User Agent to use for Requests	false	false	PowerShell AeriesApi Module

Examples

EXAMPLE 1

Initialize-AeriesApi -URL "https://demo.aeries.net/aeries" -Certificate "abcdefghijklmnopqrstuvwxyz0123456789"
This will initialize the link to an Aeries Instance for API calls

Initialize-AeriesPreEnrollActive

Synopsis

Initialize a Pre-Enrollment for an Active Student

Syntax

Initialize-AeriesPreEnrollActive [-StudentID] <Int32> [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StudentID			true	false	0

Examples

EXAMPLE 1

Initialize-AeriesPreEnrollActive -StudentID 99400001
This will initialize a Pre Enrollment for the given Student ID in Aeries

Initialize-AeriesPreEnrollInactive

Synopsis

Initialize a Pre-Enrollment for an Inactive Student

Syntax

Initialize-AeriesPreEnrollInactive [-SchoolCode] <Int16> [[-StudentID] <Int32>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			false	false	0

Examples

EXAMPLE 1

Initialize-AeriesPreEnrollInactive -SchoolCode 994 -StudentID 99400001
This will initialize a Pre Enrollment for the given Student ID in Aeries

Remove-AeriesActivity

Synopsis

Remove an Activity/Award to Aeries

Syntax

Remove-AeriesActivity [-SchoolCode] <Int16> [-StudentID] <Int32> [[-Sequence] <Int16>] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
Sequence			false	false	0
WhatIf	wi		false	false
Confirm	cf		false	false

Examples

EXAMPLE 1

Remove-AeriesActivity -SchoolCode 994 -StudentID 99400001 -Sequence 1
This will delete an Activity/Award in Aeries for StudentID 99400001 at SchoolCode 994 with Sequence 1

Remove-AeriesAlternateCourseRequest

Synopsis

Remove an Alternate Course Request from Aeries

Syntax

Remove-AeriesAlternateCourseRequest [-SchoolCode] <Int16> [-StudentID] <Int32> [-Sequence] <Int16> [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
Sequence			true	false	0
WhatIf	wi		false	false
Confirm	cf		false	false

Examples

EXAMPLE 1

Remove-AeriesAlternateCourseRequest -SchoolCode 994 -StudentID 99400001 -Sequence 1
This will delete an Alternate Course Request in Aeries for StudentID 99400001 at SchoolCode 994 with Sequence 1

Remove-AeriesAuthorization

Synopsis

Remove an Authorization in Aeries

Syntax

Remove-AeriesAuthorization [-SchoolCode] <Int16> [-StudentID] <Int32> [[-Sequence] <Int16>] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
Sequence			false	false	0
WhatIf	wi		false	false
Confirm	cf		false	false

Examples

EXAMPLE 1

Remove-AeriesAuthorization -SchoolCode 994 -StudentID 99400001 -Sequence 1
This will remove an Authorization in Aeries

Remove-AeriesContact

Synopsis

Removes a Contact in Aeries

Syntax

Remove-AeriesContact [-StudentID] <Int32> [-Sequence] <Int16> [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StudentID			true	false	0
Sequence			true	false	0
WhatIf	wi		false	false
Confirm	cf		false	false

Examples

EXAMPLE 1

Remove-AeriesContact -StudentID 99400001 -Sequence 1
This will remove a Contact in Aeries for StudentID 99400001 with a Sequence Number of 1

Remove-AeriesCourseRequest

Synopsis

Remove a Course Request from Aeries

Syntax

Remove-AeriesCourseRequest [-SchoolCode] <Int16> [-StudentID] <Int32> [-Sequence] <Int16> [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
StudentID			true	false	0
Sequence			true	false	0
WhatIf	wi		false	false
Confirm	cf		false	false

Examples

EXAMPLE 1

Remove-AeriesCourseRequest -SchoolCode 994 -StudentID 99400001 -Sequence 1
This will delete a Course Request in Aeries for StudentID 99400001 at SchoolCode 994 with Sequence 1

Remove-AeriesSchedulingSection

Synopsis

Removes a Scheduling Section in Aeries

Syntax

Remove-AeriesSchedulingSection [-SchoolCode] <Int16> [-SectionNumber] <Int16> [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
SectionNumber			true	false	0
WhatIf	wi		false	false
Confirm	cf		false	false

Examples

EXAMPLE 1

Remove-AeriesSchedulingSection -SchoolCode 884 -SectionNumber 1
This will remove a Scheduling Section in Aeries for SchoolCode 884 with a SectionNumber 1

Remove-AeriesStaffAssignment

Synopsis

Removes a Staff Assignment in Aeries

Syntax

Remove-AeriesStaffAssignment -StaffID <Int32> -AssignmentType <String> -StartDate <DateTime> [-WhatIf] [-Confirm] [<CommonParameters>]

Remove-AeriesStaffAssignment -StaffID <Int32> -AssignmentType <String> -Sequence <Int16> [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
StaffID			true	false	0
AssignmentType			true	false
Sequence			true	false	0
StartDate			true	false
WhatIf	wi		false	false
Confirm	cf		false	false

Examples

EXAMPLE 1

Remove-AeriesStaffAssignment -StaffID 1 AssignmentType "classified" -Sequence 1
This will remove a classified Staff Assignment in Aeries for StaffID 1 with a Sequence Number of 1

Send-AeriesAlert

Synopsis

Send an alert to a User/Teacher/Parent/Student in Aeries

Syntax

Send-AeriesAlert [-SchoolCode] <Int16> [-RecipientID] <Int32> [-RecipientType] <String> [-Comment] <String> [[-StudentNumber] <Int32>] [[-StudentID] <Int32>] [[-OtherID] <String>] [[-PageID] <String>] [[-AlertType] <String>] [<CommonParameters>]

Parameters

Name	Alias	Description	Required?	Pipeline Input	Default Value
SchoolCode			true	false	0
RecipientID			true	false	0
RecipientType			true	false
Comment			true	false
StudentNumber			false	false	-1
StudentID			false	false	-1
OtherID			false	false
PageID			false	false	0
AlertType			false	false	Alert

Examples

EXAMPLE 1

Send-AeriesAlert -SchoolCode 994 -RecipientID 1 -RecipientType "User" -Comment "This is an amazing Alert!"
This will send an Alert to the User with UID 1 to Aeries

Test-AeriesApiConnection

Synopsis

Test the connection for Aeries API calls

Syntax

Test-AeriesApiConnection [<CommonParameters>]

Outputs

• System.Boolean

Examples

EXAMPLE 1

Test-AeriesApiConnection
This will perform a web request against the configured Aeries Instance