TABLE OF CONTENTS

Student Information

Update Address

Student Information Extended

Student Data Changes

Contacts

Programs

Authorizations

Test Scores

College Entrance Test Scores

Assertive Discipline

District Supplemental Student Data

School Supplemental Student Data

Fees and Fines

Student Picture

Student Groups

Student Information

Security Area:

  • "Student Data"

URL(s):

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

Query String Filters:

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

Notes:

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

Example Student Information Results:

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


[
    {
        "StudentID": 99400001,
        "OldStudentID": 0,
        "CorrespondenceLanguageCode": "00",
        "SchoolCode": 994,
        "StudentNumber": 1,
        "StateStudentID": "1234567890",
        "LastName": "Abbott",
        "FirstName": "Allan",
        "MiddleName": "James",
        "LastNameAlias": "",
        "FirstNameAlias": "AJ",
        "MiddleNameAlias": "",
        "Gender": "M",
        "Grade": 12,
        "GradeLevelShortDescription": "12",
        "GradeLevelLongDescription": "Twelfth Grade",
        "Birthdate": "2002-11-11T00:00:00",
        "ParentGuardianName": "M/M A Abbott",
        "HomePhone": "7775559448",
        "StudentMobilePhone": "",
        "MailingAddress": "1118 Glenview Lane",
        "MailingAddressCity": "Eagle Rock",
        "MailingAddressState": "CA",
        "MailingAddressZipCode": "99999",
        "MailingAddressZipExt": "",
        "ResidenceAddress": "1118 Glenview Lane",
        "ResidenceAddressCity": "Eagle Rock",
        "ResidenceAddressState": "CA",
        "ResidenceAddressZipCode": "99999",
        "ResidenceAddressZipExt": "",
        "AddressVerified": false,
        "EthnicityCode": "N",
        "RaceCode1": "700",
        "RaceCode2": "",
        "RaceCode3": "",
        "RaceCode4": "",
        "RaceCode5": "",
        "UserCode1": "",
        "UserCode2": "",
        "UserCode3": "",
        "UserCode4": "N",
        "UserCode5": "",
        "UserCode6": "G",
        "UserCode7": "C",
        "UserCode8": "",
        "UserCode9": "Y",
        "UserCode10": "",
        "UserCode11": "",
        "UserCode12": "",
        "UserCode13": "",
        "SchoolEnterDate": "2017-09-05T00:00:00",
        "SchoolLeaveDate": null,
        "DistrictEnterDate": "2014-09-05T00:00:00",
        "CounselorNumber": 708,
        "Track": "",
        "AttendanceProgramCodePrimary": "",
        "AttendanceProgramCodeAdditional1": "",
        "AttendanceProgramCodeAdditional2": "",
        "LockerNumber": "",
        "LowSchedulingPeriod": 0,
        "HighSchedulingPeriod": 9,
        "InactiveStatusCode": "",
        "FamilyKey": 1480,
        "LanguageFluencyCode": "L",
        "HomeLanguageCode": "01",
        "ParentEdLevelCode": "12",
        "ParentEmailAddress": "",
        "StudentEmailAddress": "charles.norris@gedu-demo-aeries.com",
        "NetworkLoginID": "",
        "AtRiskPoints": "41.0000",
        "HomeRoomTeacherNumber": "0",
        "NotificationPreferenceCode": "",
        "NextSchoolCode": 0,
        "NextGrade": 13,
        "NextGradeLevelShortDescription": "13",
        "NextGradeLevelLongDescription": "Reserved for Graduating Seniors",
        "RecordsReleaseCode": ""
    }
]


Field Documentation:

NameAeries Table.ColumnDescription
AddressVerifiedSTU.AVIndicates whether the student’s residence address has been verified
AtRiskPointsSTU.RPThe total number of “at-risk” points. Used by the Aeries Analytics Early Warning System
AttendanceProgramCodeAdditional1STU.AP1An additional specialized attendance program to which this student belongs
AttendanceProgramCodeAdditional2STU.AP2An additional specialized attendance program to which this student belongs
AttendanceProgramCodePrimarySTU.SPThe primary specialized attendance program to which this student currently belongs. Attendance programs are used to separate certain students’ attendance data in the monthly apportionment (ADA) calculations.
BirthdateSTU.BDDate of Birth
CorrespondanceLanguageCodeSTU.CLThe preferred language for correspondence sent regarding this student
CounselorNumberSTU.CUA school-based Aeries teacher number (0-999). Represents the student’s counselor (secondary schools) or classroom teacher (elementary schools).
DistrictEnterDateSTU.DDDate student entered the district
EthnicityCodeSTU.ETH“Y” or “N” Hispanic indicator
FamilyKeySTU.FKNumeric. Students with the same nonzero Family Key are considered “siblings” in Aeries.
FirstNameSTU.FNStudent’s legal first name
FirstNameAliasSTU.FNAStudent’s first name alias
GradeSTU.GR0-18 Student’s grade level
HighSchedulingPeriodSTU.HI0-9 Highest scheduling period
HomeLanguageCodeSTU.HLThe student’s primary language for purposes of English Learner classification
HomePhoneSTU.TLStudent’s home phone number
HomeRoomTeacherNumber(calculated value)A school-based Aeries teacher number. The student’s homeroom teacher based on the class period the school designates as homeroom.
InactiveStatusCodeSTU.TGStudent’s status (blank is active)
LanguageFluencyCodeSTU.LFLanguage fluency code
LastNameSTU.LNStudent’s legal last name
LastNameAliasSTU.LNAStudent’s last name alias
LockerNumberSTU.LKLocker number
LowSchedulingPeriodSTU.LO0-9 Lowest scheduling period
MailingAddressSTU.ADStudent’s mailing address
MailingAddressCitySTU.CYStudent’s mailing address city
MailingAddressStateSTU.STStudent’s mailing address state
MailingAddressZipCodeSTU.ZCStudent’s mailing address zip code
MailingAddressZipExtSTU.ZXStudent’s mailing address zip code extension
MiddleNameSTU.MNStudent’s legal middle name
MiddleNameAliasSTU.MNAStudent’s middle name alias
NetworkLoginIDSTU.NIDStudent’s Network Login ID. Districts may use this for various purposes, but most commonly for a directory services (e.g., Active Directory) username
NotificationPreferenceCodeSTU.NPIndicates the Aeries Communications notification preference of this student
ParentEdLevelCodeSTU.PEDHighest level of education completed by either of the student’s parents (for socioeconomically disadvantaged classification purposes)
ParentEmailAddressSTU.PEM(deprecated, but still in use by some customers) The primary parent/guardian email address
ParentGuardianNameSTU.PGParent/Guardian name
StudentIDSTU.IDStudent ID
RaceCode1STU.RC1Student’s first reported race
RaceCode2STU.RC2Student’s second reported race
RaceCode3STU.RC3Student’s third reported race
RaceCode4STU.RC4Student’s fourth reported race
RaceCode5STU.RC5Student’s fifth reported race
ResidenceAddressSTU.RADResidence address
ResidenceAddressCitySTU.RCYResidence address city
ResidenceAddressStateSTU.RSTResidence address state
ResidenceAddressZipCodeSTU.RZCResidence address zip code
ResidenceAddressZipExtSTU.RZXResidence address zip code extension
SchoolCodeSTU.SCAeries school code
SchoolEnterDateSTU.EDDate student first entered this school
SchoolLeaveDateSTU.LDDate student left this school
GenderSTU.GNStudent'sg ender (May be M or F or another coded value for non-binary gender identifications)
StateStudentIDSTU.CIDStatewide Student ID
StudentEmailAddressSTU.SEMStudent’s email address
StudentMobilePhoneSTU.MPHMobile phone number
StudentNumberSTU.SNSchool-based Student Number
TrackSTU.TRStudent’s attendance track
UserCode1STU.U1User-defined code 1
UserCode10STU.U10User-defined code 10
UserCode11STU.U11User-defined code 11
UserCode12STU.U12User-defined code 12
UserCode13STU.U13User-defined code 13
UserCode2STU.U2User-defined code 2
UserCode3STU.U3User-defined code 3
UserCode4STU.U4User-defined code 4
UserCode5STU.U5User-defined code 5
UserCode6STU.U6User-defined code 6
UserCode7STU.U7User-defined code 7
UserCode8STU.U8User-defined code 8
UserCode9STU.U9User-defined code 9


Student Information - Create

Security Area:

  • "Student Data" – Read & Insert
  • “Student Demographics” – Field-level Insert permission is required for each field; otherwise, the value will be ignored.

URL:

  • POST /api/v5/schools/{SchoolCode}/InsertStudent
    • SchoolCode (required) – the Aeries School Code. This is normally 1 – 999.

Notes:

  • This end point returns a single “Student” object representing the student record that was just added. 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 record for a student who has never been enrolled in the district. It cannot not be used to add or transfer an existing student to a different school.
  • Any field that is omitted will be assigned the Aeries default value for that field.

POST Payload Object:

  • “StudentInsert” object


“StudentInsert” Object Definition:

Name

Data Type

Max Length

Notes

LastName

String

100

Student’s legal last name

FirstName

String

100

Student’s legal first name

MiddleName

String

100

Student’s legal middle name

NameSuffix

String

10

Student’s legal name suffix (e.g., “JR” or “IV”)

Gender

String

1

Student's gender identification.  May be M or F or another coded value for non-binary gender identifications. 

Grade

Integer


Student’s grade level. Valid range is (-2) – 18.

NextGrade

Integer


Student’s grade level for next school year. Valid range is (-2) – 18.

NextSchool

Integer


The Aeries school code of the next school the student will attend

Birthdate

Date


Student’s date of birth

InactiveStatusCode

String

1

Student’s status (blank is active)

HomeLanguageCode

String

2

The student’s primary language for purposes of English Learner classification

CorrespondanceLanguageCode

String

2

The preferred language for correspondence sent regarding this student

LanguageFluencyCode

String

1

Language fluency code

HomePhone

String


Student’s home phone number. Formatting may be included, and the input will be parsed for the first 10 digits (0-9) encountered.

LastSchool

Integer


The Aeries school code of the last school the student attended

ResidenceSchool

Integer


The Aeries school code of the student’s assigned school of residence, usually based on address boundaries

NextResidenceSchool

Integer


The Aeries school code of the student’s assigned school of residence for next year

EthnicityCode

String

1

“Y” or “N” Hispanic indicator

Race1Code

String

3

Student’s first reported race

Race2Code

String

3

Student’s second reported race

Race3Code

String

3

Student’s third reported race

Race4Code

String

3

Student’s fourth reported race

Race5Code

String

3

Student’s fifth reported race

SchoolEnterDate

Date


Date student entered this school

DistrictEnterDate

Date


Date student entered the district

BirthCity

String

30

The city name where the student was born

BirthStateCode

String

3

The state or province in the US, Canada, or Mexico where the student was born

BirthCountryCode

String

2

The country code where the student was born

ParentEdLevelCode

String

2

Highest level of education completed by either of the student’s parents (for socioeconomically disadvantaged classification purposes)

ParentGuardianName

String

50

Parent/Guardian name

MailingAddress

String

55

Student’s mailing address

MailingAddressCity

String

30

Student’s mailing address city

MailingAddressState

String

2

Student’s mailing address state

MailingAddressZipCode

String

5

Student’s mailing address zip code

MailingAddressZipExt

String

4

Student’s mailing address zip code extension

ResidenceAddress

String

55

Residence address

ResidenceAddressCity

String

30

Residence address city

ResidenceAddressState

String

2

Residence address state

ResidenceAddressZipCode

String

5

Residence address zip code

ResidenceAddressZipExt

String

4

Residence address zip code extension

HomeLanguageSurveyFirstLanguageCode

String

2

From the Home Language Survey (HLS) – The language first spoken by the student growing up

HomeLanguageSurveyPrimaryLanguageCode

String

2

From the Home Language Survey (HLS) – The language primarily spoken by the student

HomeLanguageSurveyHomeLanguageCode

String

2

From the Home Language Survey (HLS) – The language spoken most frequently at home by the student

HomeLanguageSurveyAdultLanguageCode

String

2

From the Home Language Survey (HLS) – The language spoken most frequently by adults at home

USEnterDate

Date


The Date the Student first entered the US

USSchoolEnterDate

Date


The Date the Student first entered a US school to receive instruction

HomeLanguageSurveyDateDate
The Date the Parent completed the Home Language Survey

UserCode1

String

1

User-Defined Code

UserCode2

String

1

User-Defined Code

UserCode3

String

1

User-Defined Code

UserCode4

String

1

User-Defined Code

UserCode5

String

1

User-Defined Code

UserCode6

String

1

User-Defined Code

UserCode7

String

1

User-Defined Code

UserCode8

String

1

User-Defined Code

UserCode9

String

2

User-Defined Code

UserCode10

String

2

User-Defined Code

UserCode11

String

2

User-Defined Code

UserCode12

String

2

User-Defined Code

UserCode13

String

2

User-Defined Code

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

Example POST Payload:

{
  "LastName":"AA Test LN",
  "FirstName":"AA Test FN",
  "MiddleName":"AA Test MN",
  "NameSuffix":"JR",
  "Gender":"M",
  "Grade":11,
  "NextGrade":12,
  "NextSchool":994,
  "BirthDate":"2000-11-24",
  "InactiveStatusCode":"*",
  "HomePhone":"(888) 777-5555",
  "HomeLanguageCode":"01",
  "CorrespondanceLanguageCode":"02",
  "LanguageFluencyCode":"T",
  "EthnicityCode":"Y",
  "Race1Code":"700",
  "Race2Code":"400",
  "Race3Code":"",
  "Race4Code":"",
  "Race5Code":"",
  "LastSchool":993,
  "ResidenceSchool":994,
  "NextResidenceSchool":994,
  "SchoolEnterDate":"2017-05-01",
  "DistrictEnterDate":"2017-05-01",
  "BirthCity":"Santa Maria",
  "BirthStateCode":"CA",
  "BirthCountryCode":"US",
  "ParentEdLevelCode":"11",
  "ParentGuardianName":"Mrs Momma",
  "MailingAddress":"123 Main ST",
  "MailingAddressCity":"Anaheim",
  "MailingAddressState":"CA",
  "MailingAddressZipCode":"99999",
  "MailingAddressZipExt":"1234",
  "ResidenceAddress":"789 Broadway",
  "ResidenceAddressCity":"Fullerton",
  "ResidenceAddressState":"CA",
  "ResidenceAddressZipCode":"88888",
  "ResidenceAddressZipExt":"4321",
  "HomeLanguageSurveyFirstLanguageCode":"03",
  "HomeLanguageSurveyPrimaryLanguageCode":"04",
  "HomeLanguageSurveyHomeLanguageCode":"05",
  "HomeLanguageSurveyAdultLanguageCode":"06",
  "USEnterDate":"2000-01-01",
  "USSchoolEnterDate":"2000-02-02",
  "UserCode1": "A",
  "UserCode2": "B",
  "UserCode3": "C",
  "UserCode4": "D",
  "UserCode5": "E",
  "UserCode6": "F",
  "UserCode7": "G",
  "UserCode8": "H",
  "UserCode9": "I",
  "UserCode10": "J",
  "UserCode11": "K",
  "UserCode12": "L",
  "UserCode13": "M"
}


Student Information - Update 

Security Area:

  • "Student Data" – Read & Update
  • “Student Demographics” – Field-level Update permission is required for each field; otherwise, the value will be ignored.

URL:

  • POST /api/v5/UpdateStudent/{StudentID}
    • StudentID (required) – the Aeries Student District Student ID Number.

Notes:

  • This end point returns an array of “Student” objects representing the student record(s) that were updated. The result is an array because the same student ID may have a record at multiple schools, and all will be updated. For the specification of the “Student” object, see the Student Information section of the main Aeries API documentation.
  • Any field that is omitted will NOT be updated in the Aeries database.

POST Payload Object:

  • “StudentUpdate” object


“StudentUpdate” Object Definition:

Name

Data Type

Max Length

Notes

LastName

See “StudentInsert” object definition above

 

FirstName

MiddleName

NameSuffix

Birthdate

Gender

Grade

NextGrade

NextSchool

LastSchool

ResidenceSchool

NextResidenceSchool

CorrespondanceLanguageCode

HomePhone

SchoolEnterDate

DistrictEnterDate

ParentEdLevelCode

ParentGuardianName

EthnicityCode

Race1Code

Race2Code

Race3Code

Race4Code

Race5Code

USEnterDate

USSchoolEnterDate

UserCode1

UserCode2

UserCode3

UserCode4

UserCode5

UserCode6

UserCode7

UserCode8

UserCode9

UserCode10

UserCode11

UserCode12

UserCode13


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


Example POST Payload:

{ 
"NextGrade":11,  
"NextSchool":994,  
"HomePhone":"(888) 777-5555",  
"CorrespondanceLanguageCode":"02",  
"SchoolEnterDate":"2017-06-01",  
"ParentEdLevelCode":"13",  
"ParentGuardianName":"New Momma",  
"LastName":"AA Test LN",  
"FirstName":"AA Test FN",  
"MiddleName":"AA Test MN",  
"NameSuffix":"JR",  "BirthDate":"2000-11-24",  
"Gender":"F",  "Grade":12,  
"LastSchool":993,  
"ResidenceSchool":994,  
"NextResidenceSchool":994,  
"EthnicityCode":"Y",  
"Race1Code":"400",  
"Race2Code":"700",  
"Race3Code":"",  
"Race4Code":"",  
"Race5Code":"", 
"DistrictEnterDate":"2017-05-02",   
"USEnterDate":"2000-01-01",   
"USSchoolEnterDate":"2000-02-02",  
"UserCode1": "A",  
"UserCode2": "B",  
"UserCode3": "C",  
"UserCode4": "D",  
"UserCode5": "E",  
"UserCode6": "F",  
"UserCode7": "G",  
"UserCode8": "H",  
"UserCode9": "I",  
"UserCode10": "J",  
"UserCode11": "K",  
"UserCode12": "L",  
"UserCode13": "M"
}


Update Address 

Security Area:

  • "Student Data" – Read & Update
  • “Student Demographics” – Field-level Update permission is required for each field; otherwise, the value will be ignored.

URL:

  • POST /api/v5/UpdateStudentAddress/{StudentID}
    • StudentID (required) – the Aeries Student District Student ID Number.

Notes:

  • This end point returns an array of “Student” objects representing the student record(s) that were updated. The result is an array because the same student ID may have a record at multiple schools, and all will be updated. For the specification of the “Student” object, see the Student Information section of the main Aeries API documentation.
  • Any field that is omitted will NOT be updated in the Aeries database.

POST Payload Object:

  • “StudentAddressUpdate” object


“StudentAddressUpdate” Object Definition:

Name

Data Type

Max Length

Notes

MailingAddress

String

55

Student’s mailing address

MailingAddressCity

String

30

Student’s mailing address city

MailingAddressState

String

2

Student’s mailing address state

MailingAddressZipCode

String

5

Student’s mailing address zip code

MailingAddressZipExt

String

4

Student’s mailing  address zip code extension

ResidenceAddress

String

55

Residence address

ResidenceAddressCity

String

30

Residence address city

ResidenceAddressState

String

2

Residence address state

ResidenceAddressZipCode

String

5

Residence address zip code

ResidenceAddressZipExt

String

4

Residence address zip code extension

CorrectionOrChange

String


Indicates whether this is an address change or correcting bad data. Valid values are “Correction” or “Change”.

EffectiveStartDate

Date


Required only if CorrectionOrChange = “Change”. The effective date for the address change.


Example POST Payload:


{  
"MailingAddress":"123412 Main ST",  
"MailingAddressCity":"Anaheim",  
"MailingAddressState":"CA",  
"MailingAddressZipCode":"99999",  
"MailingAddressZipExt":"1234",  
"ResidenceAddress":"789 Broadway",  
"ResidenceAddressCity":"Fullerton",  
"ResidenceAddressState":"CA",  
"ResidenceAddressZipCode":"88888",  
"ResidenceAddressZipExt":"4321",  
"CorrectionOrChange":"Change",  "EffectiveStartDate":"2017-05-02"
}


Student Information Extended 

Security Area:

  • "Student Data"

URL(s):

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

Query String Filters:

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

Notes:

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

Example Student Information Extended Results:

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


[
    {
        "StudentID": 99400001,
        "CountInCensusIndicator": "",
        "NextInterIntraDistrictTransferCode": "",
        "NextInterIntraDistrictStateCode": "",
        "SummerWithdrawalLeaveDate": null,
        "SummerWithdrawalNextSchool": 0,
        "EndOfYearNextSchool": 0,
        "ReportingSchoolCode": 0,
        "NextAttendanceProgramCodePrimary": "",
        "NextAttendanceProgramCodeAdditional1": "",
        "NextAttendanceProgramCodeAdditional2": "",
        "HomeLanguageSurveyDate": null,
        "SchoolCode": 994,
        "StudentNumber": 1,
        "StateStudentID": "1234567890",
        "SchoolCompletionDate": null,
        "SchoolCompletionStatusCode": "",
        "QualifiedUC": "Y",
        "QualifiedCSU": "Y",
        "CourseCompletionUC": "Y",
        "CourseCompletionCSU": "Y",
        "InterIntraDistrictTransferCode": "",
        "InterIntraDistrictStateCode": "",
        "GraduationRequirementsTrack": "",
        "SafeSchoolsActViolationDate": "2021-02-28T00:00:00",
        "SchedulingGroup": "",
        "ExpectedGraduationDate": null,
        "SummerWithdrawalReasonCode": "",
        "EndOfYearStatusCode": "",
        "RecordAddedDateTime": null,
        "RecordAddedSystem": "",
        "SchoolMobility": 9,
        "DistrictMobility": 1,
        "USSchoolsLessThan3Years": "",
        "USEnterDate": "2010-01-01T00:00:00",
        "USSchoolEnterDate": "2010-01-01T00:00:00",
        "StateSchoolEnterDate": "2010-01-01T00:00:00",
        "DateRedesignatedFluentEnglishProficient": null,
        "HomeLanguageSurveyFirstLanguageCode": "01",
        "HomeLanguageSurveyPrimaryLanguageCode": "01",
        "HomeLanguageSurveyHomeLanguageCode": "00",
        "HomeLanguageSurveyAdultLanguageCode": "01",
        "EnglishLearnerProgramCode": "",
        "EnglishLearnerServiceCode": "330",
        "EnglishLearnerStartDate": "2014-09-05T00:00:00",
        "EnglishLearnerEndDate": null,
        "LongTermEnglishLearnerCode": "",
        "YearsAsEnglishLearner": 0,
        "BirthCity": "Hermosillo",
        "BirthStateCode": "SO",
        "BirthCountryCode": "MX",
        "LastSchool": 0,
        "ResidenceSchool": 994,
        "NextResidenceSchool": 994,
        "NextGrade": 13,
        "NextSchool": 0
    }
]



Field Documentation:

NameAeries Table.ColumnDescription
BirthCitySTU.BCYThe city name where the student was born
BirthCountryCodeSTU.BCUThe country code where the student was born
BirthStateCodeSTU.BSTThe state or province in the US, Canada, or Mexico where the student was born
CourseCompletionCSUSTU.CCSThe indicator for if this student has completed the course sequence for entrance into the CA State University (CSU) system
CourseCompletionUCSTU.CUCThe indicator for if this student has completed the course sequence for entrance into the University of CA (UC) system
DateRedesignatedFluentEnglishProficientLAC.RD1The Date the Student was redesignated/reclassified as Fluent English Proficient from an English Learner
DistrictMobilitySTU.DMThe "District Mobility" - the grade level the student entered this District during the most recent span of contiguous enrollment.
EndOfYearStatusCodeSTU.EOYThe End of Year Status Code for a student. This is populated at the end of the year when a student is going to be active through the last day of school but will leave the school over the summer and not be returning next school year.
EnglishLearnerEndDateLAC.EDThe date the student was reclassified to no longer be an English Learner
EnglishLearnerProgramCodeLAC.PREnglish Learner Program Code
EnglishLearnerServiceCodeLAC.SREnglish Learner Services Received Code
EnglishLearnerStartDateLAC.SDThe date the student began receiving English Learner services
ExpectedGraduationDateSTU.EGDThe Expected Graduation Date for this Student. This field is normally inconsistently populated as it is no longer required by CALPADS.
GraduationRequirementsTrackSTU.GRTThe Graduation Requirements Track for a student
HomeLanguageSurveyAdultLanguageCodeLAC.L4From the Home Language Survey (HLS) - The language spoken most frequently by adults at home
HomeLanguageSurveyFirstLanguageCodeLAC.L1From the Home Language Survey (HLS) - The language first spoken by the student growing up
HomeLanguageSurveyHomeLanguageCodeLAC.L3From the Home Language Survey (HLS) - The language spoken most frequently at home by the student
HomeLanguageSurveyPrimaryLanguageCodeLAC.L2From the Home Language Survey (HLS) - The language primarily spoken by the student
InterIntraDistrictStateCodeSTU.ITDThe Inter/Intra-District Transfer State Code for a student
InterIntraDistrictTransferCodeSTU.ITThe Inter/Intra-District Transfer Code for a student
LongTermEnglishLearnerCodeLAC.LTStudent Identified as a Long Term English Learner
StudentIDSTU.IDThe Student ID
QualifiedCSUSTU.QCSThe indicator for if this student has qualified for entrance into the CA State University (CSU) system
QualifiedUCSTU.QUCThe indicator for if this student has qualified for entrance into the University of CA (UC) system
RecordAddedDateTimeSTU.RDTThe Date/Time the student record was added to the system.
RecordAddedSystemSTU.RSYThe system used to add this student record.
SafeSchoolsActViolationDateSTU.SDThe Safe Schools Act Violation Date for this Student. I.e., the date the student violated a "Violent" 48900 Ed Code.
SchedulingGroupSTU.SGThe Scheduling Group for a student
SchoolCodeSTU.SCThe Aeries school code for this student
SchoolCompletionDateSTU.DGThe School Completion Date for this Student. For High Schools, this is the Graduation Date.
SchoolCompletionStatusCodeSTU.HSGThe Completion Status Code for this student from the current school. For High Schools, this is the Graduation Status Code.
SchoolMobilitySTU.SMThe "School Mobility" - the grade level the student entered this school during the most recent span of contiguous enrollment.
StateSchoolEnterDateLAC.STSThe Date the Student first entered a school in the current state
StateStudentIDSTU.CIDThe State Student ID (SSID) for this Student
StudentNumberSTU.SNThe school-level Aeries Student Number for this student
SummerWithdrawalReasonCodeSTU.SWRThe Summer Withdrawal Reason Code for a student. This is populated at the beginning of the year when a student is found to have left the school during the summer and is not attending the first day of school.
USEnterDateLAC.USEThe Date the Student first entered the US
USSchoolEnterDateLAC.USSThe Date the Student first entered a US school to receive instruction
USSchoolsLessThan3YearsSSD.SUSThe indicator for when a student has been enrolled in US Schools for less than 3 years. This is normally the definition of an "Eligible Immigrant" for SNOR reporting.
YearsAsEnglishLearnerLAC.YELThe Number of Years the student has been or was identified as an English Learner
CountInCensusIndicatorSTU.CIC
NextInterIntraDistrictTransferCodeSTU.NITThe Students' Inter/Intra District Transfer Code for Next Year
NextInterIntraDistrictStateCodeSTU.NTD
SummerWithdrawalLeaveDateSTU.SLDThe Date the Student withdrew from the District before the start of the School Year
SummerWithdrawalNextSchoolSTU.SNSExpected School of attendance after withdrawal
EndOfYearNextSchoolSTU.ENSNext School
ReportingSchoolCodeSTU.HSThe Students Reporting School
NextAttendanceProgramCodePrimarySTU.NPSThe Students Primary Enrollment Program for Next Year
NextAttendanceProgramCodeAdditional1STU.NP1The Students' first Additional Enrollment Program for Next Year
NextAttendanceProgramCodeAdditional2STU.NP2The Students' second Additional Enrollment Program for Next Year
HomeLanguageSurveyDateLAC.HLDThe Date the Parent filled out the Home Language Survey


Student Data Changes 

Security Area:

  • "Student Data"

URL(s):

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

Notes:

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

Example Student Data Changes Results:

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


{
        "StudentID": 89401949,
        "SchoolCode": 894,
        "StudentNumber": 1949
    },
    {
        "StudentID": 99401589,
        "SchoolCode": 994,
        "StudentNumber": 1589
    },
    {
        "StudentID": 99401671,
        "SchoolCode": 994,
        "StudentNumber": 1671
    },
    {
        "StudentID": 99401753,
        "SchoolCode": 994,
        "StudentNumber": 1753
    }



Contacts 

Security Area:

  • "Contacts"

URL(s):

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

Notes:

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

Example Contact Results:

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

{
        "StudentID": 99400001,
        "AdministrativeLockCode": "",
        "EnrolledTheStudentIndicator": "",
        "Birthdate": null,
        "Occupation": "",
        "TuberculosisTestStatusCode": "",
        "TuberculosisTestExpirationDate": null,
        "FingerprintStatusCode": "",
        "FingerprintDate": null,
        "UserCode1": "",
        "UserCode2": "",
        "UserCode3": "",
        "UserCode4": "",
        "UserCode5": "",
        "UserCode6": "",
        "UserCode7": "",
        "UserCode8": "",
        "MiscCode": "",
        "MailTagCode": "A",
        "AddressTypeCode": "4",
        "AdditionalCommunicationTypeCode1": "",
        "AdditionalCommunicationTypeCode2": "",
        "AdditionalCommunicationTypeCode3": "",
        "AdditionalCommunicationTypeCode4": "",
        "AdditionalCommunicationDetail1": "",
        "AdditionalCommunicationDetail2": "",
        "AdditionalCommunicationDetail3": "",
        "AdditionalCommunicationDetail4": "",
        "AddressVerificationDate": null,
        "RecordAddedDate": "2020-11-13T00:00:00",
        "MilitaryUserFieldCode1": "",
        "MilitaryUserFieldCode2": "",
        "MilitaryUserFieldCode3": "",
        "MilitaryUserFieldCode4": "",
        "MilitaryUserFieldCode5": "",
        "PrimaryContact1Field": "WorkPhone",
        "PrimaryContact2Field": "",
        "PrimaryContact1Description": "Father Work - Adam A",
        "PrimaryContact2Description": "",
        "EducationalRightsHolder": "",
        "AttendanceNotification": "Y",
        "PrimaryContact": "",
        "SchoolCode": 994,
        "SequenceNumber": 1,
        "MailingName": "Adam Abbott",
        "NamePrefix": "",
        "FirstName": "Adam",
        "LastName": "Abbott",
        "MiddleName": "",
        "NameSuffix": "",
        "Address": "5647 Elm St",
        "AddressCity": "Eagle rock",
        "AddressState": "CA",
        "AddressZipCode": "99998",
        "AddressZipExt": "",
        "RelationshipToStudentCode": "11",
        "LivesWithStudentIndicator": "",
        "RedFlag": false,
        "HomePhone": "",
        "WorkPhone": "7775557537",
        "WorkPhoneExt": "",
        "CellPhone": "",
        "Pager": "",
        "EmailAddress": "parent@aeries.com",
        "AccessToPortal": "",
        "ContactOrder": 1,
        "CorrespondanceLanguageCode": "",
        "EmployerName": "",
        "EmployerLocation": "",
        "MilitaryBranchCode": "AR",
        "MilitaryRankCode": "SGT",
        "MilitarySupervisorName": "John Brown",
        "MilitarySupervisorPhone": "9995551234",
        "MilitaryStatusCode": "X",
        "NotificationPreferenceCode": "1",
        "Comments": ""
    }


Field Documentation:

NameAeries Table.ColumnDescription
AccessToPortalCON.APIndicates whether the contact can access the Aeries Parent Portal
AddressCON.ADThe street address of this contact
AddressCityCON.CYThe city
AddressStateCON.STThe state abbreviation
AddressZipCodeCON.ZCThe zip code
AddressZipExtCON.ZXThe zip code extension
CellPhoneCON.CPThe contact’s mobile phone number
CommentsCON.MEA free-text comment for this contact
ContactOrderCON.ORThe order in which this contact displays in Aeries
CorrespondanceLanguageCodeCON.CLThe language in which this contact prefers to receive correspondence
EmailAddressCON.EMThe email address of this contact
EmployerLocationCON.ELCThe location of this contact’s employer
EmployerNameCON.ENMThe name of this contact’s employer
FirstNameCON.FNThe contact’s first name
HomePhoneCON.TLThe contact’s home phone number
LastNameCON.LNThe contact’s last name
LivesWithStudentIndicatorCON.LWIndicates whether the student lives with this contact
MailingNameCON.NMThe name for this contact that should appear on mailing labels
MiddleNameCON.MNThe contact’s middle name
MilitaryBranchCodeCON.MBRIf this contact is in the military, the code indicates the branch of service
MilitaryRankCodeCON.MRAIf this contact is in the military, the code indicates the rank
MilitaryStatusCodeCON.MTGIf this contact is/was in the military, the code indicates this contact’s military service status
MilitarySupervisorNameCON.MSNIf this contact is/was in the military, the name of the military supervisor
MilitarySupervisorPhoneCON.MSPIf this contact is/was in the military, the phone number of the military supervisor
NamePrefixCON.PFThe name prefix for this contact
NameSuffixCON.SFThe name suffix for this contact
NotificationPreferenceCodeCON.NPIndicates the Aeries Communications notification preference of this contact
PagerCON.PAThe contact’s pager number
StudentIDSTU.IDThe Student ID
RedFlagCON.RFIndicates whether the contact has been red-flagged
RelationshipToStudentCodeCON.RLA code indicating the contact’s relationship to the student
SchoolCodeSTU.SCThe Aeries school code
SequenceNumberCON.SQThe sequence number makes up the primary key of the Contacts table and has no independent meaning.
WorkPhoneCON.WPThe contact’s work phone number
WorkPhoneExtCON.WXThe contact’s work phone extension
AdministrativeLockCodeCON.LKContact record is locked for editing
EnrolledTheStudentIndicatorCON.ESIf this is the Contact who Enrolled the Student in School
BirthdateCON.BDContact Birth Date
OccupationCON.OCContacts' Occupation
TuberculosisTestStatusCodeCON.TBStatus of the Contacts' TB test - Pass/Fail/Pending
TuberculosisTestExpirationDateCON.TBETB Test Expiration Date
FingerprintStatusCodeCON.FPWhether a Fingerprint has been obtained or not
FingerprintDateCON.FPDDate Fingerprint submitted
UserCode1CON.U1User Code 1
UserCode2CON.U2User Code 2
UserCode3CON.U3User Code 3
UserCode4CON.U4User Code 4
UserCode5CON.U5User Code 5
UserCode6CON.U6User Code 6
UserCode7CON.U7User Code 7
UserCode8CON.U8User Code 8


For descriptions of the various coded fields, use our "Code Sets" API: ~api/v5/codes/Contacts/{ElementName}

example:

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


Contacts - Create 

Security Area:

  • "Contacts" – Read & Insert
  • “Contacts” – Field-level Insert permission is required for each field; otherwise, the value will be ignored.

URL:

  • POST /api/v5/InsertContact/{StudentID}
    • StudentID (required) – the Aeries Student District Student ID Number.

Notes:

  • This end point returns a single “Contact” object representing the contact record that was just added. For the specification of the “Contact” object, see the Contacts section of the main Aeries API documentation.
  • Any field that is omitted will be assigned the Aeries default value for that field.

POST Payload Object:

  • “ContactInsert” object


“ContactInsert” Object Definition:

Name

Data Type

Max Length

Notes

MailingName

String

50

The name for this contact that should appear on mailing labels

NamePrefix

String

5

The name prefix for this contact

FirstName

String

20

The contact’s first name

LastName

String

50

The contact’s last name

MiddleName

String

20

The contact’s middle name

NameSuffix

String

10

The name suffix for this contact

Address

String

50

The street address of this contact

AddressCity

String

24

The city

AddressState

String

2

The state abbreviation

AddressZip

String

5

The zip code

AddressZipExt

String

4

The zip code extension

RelationshipToStudentCode

String

2

A code indicating the contact’s relationship to the student

HomePhone

String


The contact’s home phone number. Formatting may be included, and the input will be parsed for the first 10 digits (0-9) encountered.

WorkPhone

String


The contact’s work phone number. Formatting may be included, and the input will be parsed for the first 10 digits (0-9) encountered.

WorkPhoneExt

String

5

The contact’s work phone extension

CellPhone

String


The contact’s mobile phone number. Formatting may be included, and the input will be parsed for the first 10 digits (0-9) encountered.

EmailAddress

String

50

The email address of this contact

ContactOrder

Integer


The order in which this contact displays in Aeries

MisCodeString2Contact Code
PrimaryContactString1Y/N - Is this the Primary Contact for the Student
MailTagCodeString1Send a Copy of mail/report cards?
AccessToPortalString1Y/N - Should this Contact have access to the Parent Portal? Requires an email address for access
LivesWithStudentIndicatorString1Y/N - does this Contact Live With the Student


Note: For descriptions of the various coded values, use our Code Sets API : ~/api/v5/codes/Contacts/{ElementName}


Example POST Payload:

{
  "MailingName":"To: Mother",
  "NamePrefix":"Dr.",
  "LastName":"AA Test LN",
  "FirstName":"AA Test FN",
  "MiddleName":"AA Test MN",
  "NameSuffix":"JR",
  "Address":"1234 Main St",
  "AddressCity":"Anaheim",
  "AddressState":"CA",
  "AddressZip":"99999",
  "AddressZipExt":"1234",
  "RelationshiptoStudentCode":"10",
  "HomePhone":"(888) 777-5555",
  "WorkPhone":"(800) 555-5555",
  "WorkPhoneExt":"1234",
  "CellPhone":"(999) 444-4455",
  "EmailAddress":"noone@aeries.com",
  "ContactOrder":10
}


Contacts - Update 

Security Area:

  • "Contacts" – Read & Update
  • “Contacts” – Field-level Update permission is required for each field; otherwise, the value will be ignored.

URL:

  • POST /api/v5/UpdateContact/{StudentID}/{SequenceNumber}
    • StudentID (required) – the Aeries Student District Student ID Number.
    • SequenceNumber (required) – the sequence number that makes up part of the primary key

Notes:

  • This end point returns a single “Contact” object representing the contact record that was just updated. For the specification of the “Contact” object, see the Contacts section of the main Aeries API documentation.
  • To obtain the sequence number, make a request to the Contacts end point to retrieve a list of all contacts for the selected student. Each “Contact” object will include the SequenceNumber field.
  • Any field that is omitted will NOT be updated in the Aeries database.

POST Payload Object:

  • “ContactUpdate” object


“ContactUpdate” Object Definition:

Name

Data Type

Max Length

Notes

MailingName

See “ContactInsert” object definition above

NamePrefix

FirstName

LastName

MiddleName

NameSuffix

Address

AddressCity

AddressState

AddressZip

AddressZipExt

RelationshipToStudentCode

HomePhone

WorkPhone

WorkPhoneExt

CellPhone

EmailAddress

ContactOrder

MiscCode
PrimaryContact
MailTagCode
AccessToPortal
LivesWithStudentIndicator


Note: For descriptions of the various coded values, use our Code Sets API: ~api/v5/codes/Contacts/{ElementName}


Example POST Payload:

{
  "MailingName":"To: New Mother",
  "NamePrefix":"Mrs",
  "LastName":"new AA Test LN",
  "Address":"12 Main St",
  "AddressCity":"Anaheim",
  "AddressState":"CA",
  "AddressZip":"99999",
  "AddressZipExt":"1234",
  "RelationshiptoStudentCode":"11",
  "HomePhone":"(888) 777-5555",
  "WorkPhone":"(800) 555-5555",
  "WorkPhoneExt":"1234",
  "CellPhone":"(999) 414-4455",
  "EmailAddress":"noone@aeries.com",
  "ContactOrder":11
}


Contacts - Delete 

Security Area:

  • "Contacts" – Delete

URL:

  • /api/v5/DeleteContact/{StudentID}/{SequenceNumber}
    • StudentID (required) – the Aeries Student District Student ID Number.
    • SequenceNumber (required) – the sequence number that makes up part of the primary key

Notes:

  • This end point supports both the DELETE and GET HTTP verbs. The DELETE verb is preferred, but GET is supported in the unlikely case the customer’s web server is configured to block DELETE requests.
  • After a successful request, this end point returns an array of “Contact” objects representing the student’s contact records that remain after the selected record was deleted. For example, if there were three contact records before, the response body will be an array containing the remaining two contact records. If there was only one contact record before, the response body will be an empty array of contact records. For the specification of the “Contact” object, see the Contacts section of the main Aeries API documentation.
  • To obtain the sequence number, make a request to the Contacts end point to retrieve a list of all contacts for the selected student. Each “Contact” object will include the SequenceNumber field.

URL:

  • DELETE api/v4/DeleteContact/{id}/{sq}
Delete an existing CON record
Also supports HTTP GET verb instead of DELETE, same as v3


Programs 

Security Area:

  • "Student Programs"

URL(s):

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

Query String Filters:

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

Notes:

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

Example Student Program Results:

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

[
    {
        "ExtendedProperties": [],
        "StudentID": 99400001,
        "ProgramCode": "127",
        "ProgramDescription": "Gifted and Talented Education (GATE)",
        "EligibilityStartDate": "2017-01-11T00:00:00",
        "EligibilityEndDate": null,
        "ParticipationStartDate": "2017-03-15T00:00:00",
        "ParticipationEndDate": null
    },
    {
        "ExtendedProperties": [],
        "StudentID": 99400001,
        "ProgramCode": "101",
        "ProgramDescription": "504 Accommodation Plan",
        "EligibilityStartDate": "2020-07-15T00:00:00",
        "EligibilityEndDate": "2020-08-05T00:00:00",
        "ParticipationStartDate": "2020-07-15T00:00:00",
        "ParticipationEndDate": "2020-08-05T00:00:00"
    },
    {
        "ExtendedProperties": [
            {
                "Name": "DisabilityCode",
                "Value": "240"
            },
            {
                "Name": "DisabilityCodeDescription",
                "Value": "Speech or Language Impairment (SLI)"
            },
            {
                "Name": "DisabilityCode2",
                "Value": "260"
            },
            {
                "Name": "DisabilityCode2Description",
                "Value": "Emotional Disturbance (ED)"
            },
            {
                "Name": "ParentalConsentDate",
                "Value": "2012-11-21T00:00:00"
            }
        ],



Field Documentation:

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


NameAeries Table.ColumnDescription
EligibilityEndDate
ProgramCodeTable.Column
127GTE.EED
101FOF.ED
144CSE.XD
181FRE.EED
182FRE.EED
All OthersPGM.EED
The last date the student is/was eligible for the program
EligibilityStartDate
ProgramCodeTable.Column
127GTE.ESD
101FOF.SD
144CSE.ED
181FRE.ESD
182FRE.ESD
All OthersPGM.ESD
The first date the student was eligible for the program
ParticipationEndDate
ProgramCodeTable.Column
127GTE.PED
101FOF.ED
144N/A
181FRE.PED
182FRE.PED
All OthersPGM.PED
The last date the student participated in the program
ParticipationStartDate
ProgramCodeTable.Column
127GTE.PSD
101FOF.SD
144N/A
181FRE.PSD
182FRE.PSD
All OthersPGM.PSD
The first date the student participated in the program
ProgramCode
ProgramTableProgramCode
GATEGTE127
504FOF101
Special EducationCSE144
NSLP FreeFRE.CD = “F”181
NSLP ReducedFRE.CD = “R”182
All OthersPGMPGM.CD
The code identifying the program. This is usually a 3-character numeric string.

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

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

Extended Properties:

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


Authorizations 

Security Area:

  • "Authorizations" – Read

URL:

  • /api/v5/schools/{sc}/authorizations/
    • Returns list of authorizations (AUT) for the entire school
    • More information about the use of Authorizations can be found here.
  • api/v5/schools/{sc}/students/{id}/authorizations/{sq?} 
    • Returns list of authorizations for a single Student
    • Sequence Number (optional) - Authorization Sequence Number


Example Authorizations Result for a single Student:

https://demo.aeries.net/aeries/api/v5/Schools/994/students/99400001/authorizations

{
        "StudentID": 348581,
        "SchoolCode": 302,
        "SequenceNumber": 2,
        "DateEntered": "2014-08-25T00:00:00",
        "TypeCode": "3",
        "MiscCode": "",
        "Status": "1",
        "StatusDate": "2013-10-03T00:00:00",
        "EffectiveEndDate": "2014-09-30T00:00:00",
        "Comment": "Obfuscated",
        "TestAdministration": "",
        "Source": ""
    },
    {
        "StudentID": 348581,
        "SchoolCode": 302,
        "SequenceNumber": 12,
        "DateEntered": "2015-08-24T00:00:00",
        "TypeCode": "3",
        "MiscCode": "",
        "Status": "1",
        "StatusDate": "2013-10-03T00:00:00",
        "EffectiveEndDate": "2014-09-30T00:00:00",
        "Comment": "Obfuscated",
        "TestAdministration": "",
        "Source": ""
    }




Name

Data TypeMax LengthNotes
SequenceNumbersmallint32,767Auto-assigned on Insert
DateEntereddatetime8Date of Authorization
TypeCodevarchar1Type of Authorization
MiscCodevarchar3Authorization Code
StatusCodevarchar1Approval Status of Authorization
StatusDatedatetime8Date of Approval  Status
EffectiveEndDatedatetime8Authorization End Date
Commentnvarcharmax
TestAdministrationvarchar6Testing period
Sourcevarchar255Source of Authorization


Authorizations - Create 

Security Area:

  • "Authorizations" – Read & Insert

URL:

  • POST api/v5/schools/{sc}/students/{id}/authorizations 
    • StudentID (required) – the Aeries Student District Student ID Number.

Notes:

  • This end point returns a single “Authorization” object representing the authorization record that was just added.
  • Any field that is omitted will be assigned the Aeries default value for that field.

POST Payload Object:

  • “AuthorizationtInsert” object


Example POST payload:

{
"DateEntered":"2020-07-07 09:59:39.397",
"TypeCode":"3",
"MiscCode":"",
"StatusCode":"2",
"StatusDate":"2020-07-07 09:59:39.397",
"EffectiveEndDate":"",
"Comment":"New Comment",
"TestAdministration":"",
"Source":""
}


Authorizations - Update 

Security Area:

  • "Authorizations" - Read & Update

URL:

  • PUT api/v5/schools/{sc}/students/{id}/authorizations/{sq} 
    • Updates an existing AUT record
    • If SQ does not yet exist, and the vendor has permission to insert AUT, then a new record will be created
    • Only works if AUT table is PID-based; otherwise, gives an error

Example PUT Payload:

{

"StatusCode":"1"
"StatusDate": "2020-07-07T09:59:39.397"

}



Authorizations - Delete 

Security Area:

  • "Authorizations" - Read & Delete

URL:

  • DELETE api/v5/schools/{sc}/students/{id}/authorizations/{sq} 
    • Deletes an existing AUT record
    • Only works if AUT table is PID-based; otherwise, gives an error


Test Scores

Security Area:

  • "Test Scores"

URL(s):

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

Notes:

  • This end point will return a full history of all State and locally administered Standardized Tests in Aeries. Examples include SBAC (CAASPP) and ELPAC. College Entrance Test Scores such as SAT I, SAT II, ACT, IB, and AP are available in a separate area detailed elsewhere in this documentation.

Example Student Test Score Results:

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

[
    {
        "StudentID": 99400001,
        "Scores": [
            {
                "Type": "ScaleScore",
                "Score": 491.0
            },
            {
                "Type": "Other",
                "Score": 3.0
            }
        ],
        "SequenceNumber": 1,
        "TestID": "CELDT",
        "TestPart": "0",
        "TestDescription": "CA Eng.Lang.Dev. Test",
        "GradeLevel": 4.0,
        "TestingAdministration": "",
        "TestDate": "2012-11-17T00:00:00",
        "TestTypeCode": "",
        "TestSourceCode": ""
    },
    {
        "StudentID": 99400001,
        "Scores": [
            {
                "Type": "ScaleScore",
                "Score": 562.0
            },
            {
                "Type": "Other",
                "Score": 4.0
            }
        ],
        "SequenceNumber": 2,
        "TestID": "CELDT",
        "TestPart": "1",
        "TestDescription": "List & Speaking",
        "GradeLevel": 4.0,
        "TestingAdministration": "",
        "TestDate": "2012-11-17T00:00:00",
        "TestTypeCode": "",
        "TestSourceCode": ""
    },
    {
        "StudentID": 99400001,
        "Scores": [
            {
                "Type": "ScaleScore",
                "Score": 440.0
            },
            {
                "Type": "Other",
                "Score": 1.0
            }
        ],
        "SequenceNumber": 3,
        "TestID": "CELDT",
        "TestPart": "2",
        "TestDescription": "Reading",
        "GradeLevel": 4.0,
        "TestingAdministration": "",
        "TestDate": "2012-11-17T00:00:00",
        "TestTypeCode": "",
        "TestSourceCode": ""
    },
    {
        "StudentID": 99400001,
        "Scores": [
            {
                "Type": "ScaleScore",
                "Score": 402.0
            },
            {
                "Type": "Other",
                "Score": 1.0
            }
        ],
...
...
]



Field Documentation:

Test

NameAeries Table.ColumnDescription
GradeLevelTST.GR / 10The student’s grade level when the test was taken
StudentIDSTU.ID / TST.PIDThe Student ID
TestScore* See separate table belowDepending on the test, a single result can have multiple score types. For each nonzero value, a TestScore element will be included in the Scores container.
SequenceNumberTST.SQThe sequence number makes up the primary key of the Test Scores table and has no independent meaning
TestDateTST.TDThe date the test was taken
TestDescriptionCTL.NMThe description of the Test Part
TestIDTST.IDThe ID of the test. Ex: SBAC, ELPAC
TestPartTST.PTA numeric value to indicate which part of the test this Test Score result represents. Many standardized tests have multiple parts, such as Math and English/Language Arts.
TestSourceTST.SRCThe source of this test result in Aeries. This may be blank. Other valid values include:
LOC = Local Administration
RT = Records Transfer
VND = Testing Vendor
TestTypeTST.TYThe type of test. Codes are set by the District.
TestingAdministrationTST.TAThe testing administration during which this test was taken. Depending on the test, this value may be in one of several formats. The most common are as follows:
SPRG16 = Spring 2016. This format is used for tests that are typically administered only once per year in the spring term.
0916 = September 2016. This format is used for tests that are administered several times throughout the school year.


Test Score

TypeScore
RawScoreTST.RS
ScaleScoreTST.SS
PerformanceLevelTST.PL
OtherTST.OT
GradeEquivalencyTST.GE
PercentileTST.PC
PercentCorrectTST.PR
StanineTST.ST
CurveEquivalentTST.CE
RubricTST.RU


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

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


Update Test Scores 

Security Area:

  • "Test Scores" - Update

URL(s):

  • /api/v5/testing/UpdateScores

Notes:

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

POST Payload Object:

  • Array of “TestScoreUpdate” objects

“TestScoreUpdate” Object Definition:

NameData TypeNotes
StudentIDInt32REQUIRED The Student ID
TestIDStringREQUIRED Max length: 6. The ID of the test
TestPartInt16REQUIRED A numeric value to indicate which part of the test this Test Score result represents. Many standardized tests have multiple parts, such as Math and English/Language Arts.
TestingAdministrationStringREQUIRED Max length: 6. The testing administration during which this test was taken
TestDateDateREQUIRED The date the test was taken
RawScoreInt16The Raw Score achieved on the test
PercentCorrectInt32The Percent Correct achieved on the test
PerformanceLevelInt32The Performance Level achieved on the test
TestTypeCodeStringMax Length: 3
TestSourceCodeStringMax Length: 3
ScaleScoresmallintThe Scale Score achieved on the test
Othersmallint
GradeEquivalencysmallintThe Grade Level Equivalent Score
PercentilesmallintPercentile Ranking 
StaninesmallintStanine Score
CurveEquivalentsmallintNormal Curve Equivalent Score
RubricsmallintRubric

Example Payload:


College Entrance Test Scores 

Security Area:

  • "College Entrance Tests"

URL(s):

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

Notes:

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

Example Student College Test Score Results:

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

 {
        "StudentID": 99400001,
        "TestScores": [
            {
                "SubTests": [
                    {
                        "Code": "EN",
                        "Score": 24.0
                    },
                    {
                        "Code": "MT",
                        "Score": 22.0
                    },
                    {
                        "Code": "RD",
                        "Score": 31.0
                    },
                    {
                        "Code": "SC",
                        "Score": 24.0
                    },
                    {
                        "Code": "CP",
                        "Score": 25.0
                    },
                    {
                        "Code": "EW",
                        "Score": 24.0
                    },
                    {
                        "Code": "WR",
                        "Score": 9.0
                    }
                ],
                "TestSourceCode": "",
                "TestTypeCode": "",
                "CollegeAndCareerReadinessEnglishBenchmarkIndicator": "",
                "CollegeAndCareerReadinessMathBenchmarkIndicator": "",
                "GradeLevel": "",
                "TestDate": "2019-06-09T00:00:00",
                "TestName": "ACT",
                "OverallScore": 101.0
            },



Field Documentation:

NameAeries Table.ColumnDescription
StudentIDCTS.PID / STU.IDThe Student ID
SchoolCodeSTU.SCThe Aeries school code
OverallScoreCTS.TTLThe overall score achieved on the test
CodeCTS.ST1 – ST13The code representing this subtest. See note below*
ScoreCTS.SC1 – SC13The score achieved on this subtest
TestDateCTS.DTThe date the test was taken
TestNameCTS.NMThe name of the test. Ex: ACT, SAT I, SAT II, AP
TestSourceCodeCTS.SRCTest Source
TestTypeCodeCTS.TYTest Type
CollegeAndCareerReadinessEnglishBenchmarkIndicatorCTS.BECollege And Career Readiness English Benchmark Indicator - PSAT
CollegeAndCareerReadinessMathBenchmarkIndicatorCTS.BMCollege And Career Readiness Math Benchmark Indicator - PSAT
GradeLevelCTS.TGRGrade Level - IB

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

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


Assertive Discipline 

Security Area:

  • "Assertive Discipline"

URL(s):

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

Notes:

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

Example Student Assertive Discipline Results:

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

{
        "StudentID": 99400001,
        "AssertiveDisciplines": [
            {
                "AdministrativeDecisions": [
                    {
                        "StudentID": 99400001,
                        "AssignedDays": 0.0000,
                        "AssignedHours": 0.0000,
                        "AssignedStartDate": null,
                        "AssignedEndDate": null,
                        "AssignedReturnDate": null,
                        "ReasonForDifferenceCode": " ",
                        "DisciplinaryAssignmentSchoolCode": 0,
                        "ActionDecisionDate": null,
                        "SequenceNumber": 1,
                        "DispositionCode": "SUS",
                        "Days": 5.0000,
                        "Hours": 0.0000,
                        "StartDate": "2021-03-03T00:00:00",
                        "EndDate": "2021-03-08T00:00:00",
                        "ReturnDate": "2021-03-11T00:00:00",
                        "ReturnStatusCode": "2",
                        "ReturnLocationCode": "",
                        "ActionAuthorityCode": "10",
                        "PlacementCode": "",
                        "ResultCode": "",
                        "SuspensionTagCode": ""
                    }
                ],
                "ShortDescription": "",
                "SequenceNumber": 16,
                "IncidentDate": "2021-03-02T00:00:00",
                "IncidentID": 16382,
                "ExactTime": "1906-01-01T12:30:00",
                "ApproximateTimeCode": "L",
                "StaffReferral": "Alvarado",
                "SchoolOfIncidentCode": 994,
                "LocationCode": "S",
                "PossibleMotivationCode": "HC",
                "WeaponTypeCode": "",
                "Demerits": 8.0000,
                "Initials": "",
                "InstructionalSupportIndicator": "",
                "Comment": "Student was part of an attack on another student.",
                "IsSubstituteTeacherReferral": false,
                "ViolationCode1": "04",
                "ViolationCode2": "",
                "ViolationCode3": "",
                "ViolationCode4": "",
                "ViolationCode5": "",
                "PreReferralInterventionCode1": "",
                "PreReferralInterventionCode2": "",
                "PreReferralInterventionCode3": "",
                "UserCode1": "",
                "UserCode2": "",
                "UserCode3": "",
                "UserCode4": "",
                "UserCode5": "",
                "UserCode6": "",
                "UserCode7": "",
                "UserCode8": ""
            },


Field Documentation:

Assertive Discipline

NameAeries Table.ColumnDescription
ApproximateTimeCodeADS.AXTThe approximate time the incidnt occurred
CommentADS.COA comment describing the incident
DemeritsADS.DMThe number of demerits the student received for the incident
ExactTimeADS.ETThe exact time the incident occurred
IncidentDateADS.DTThe date the incident occurred
IncidentIDADS.IIDThe Incident ID. This ID is used to link student Assertive Discipline records pertaining to the same incident (i.e., if two or more students were involved in the same incident, the Incident ID will be the same on those records).
InitialsADS.INIThe initials of the staff member entering the record
InstructionalSupportIndicatorADS.ISIFor special education students, indicates whether instructional support was provided during a suspension or expulsion resulting from this incident
IsSubstituteTeacherReferralADS.SRIndicates whether the incident was referred by a substitute teacher
LocationCodeADS.LCNThe location where the incident occurred
PossibleMotivationCodeADS.PMThe student’s possible motivation for the incident
PreReferralInterventionCode1ADS.PI1A first intervention that was attempted prior to making the disciplinary referral
PreReferralInterventionCode2ADS.PI2A second intervention that was attempted prior to making the disciplinary referral
PreReferralInterventionCode3ADS.PI3A third intervention that was attempted prior to making the disciplinary referral
SchoolOfIncidentCodeADS.SCLThe Aeries school code where the incident occurred
SequenceNumberADS.SQThe sequence number is part of the primary key. It has no independent meaning.
StaffReferralADS.RFThe staff member who made the referral
UserCode1ADS.U1User-defined code 1
UserCode2ADS.U2User-defined code 2
UserCode3ADS.U3User-defined code 3
UserCode4ADS.U4User-defined code 4
UserCode5ADS.U5User-defined code 5
UserCode6ADS.U6User-defined code 6
UserCode7ADS.U7User-defined code 7
UserCode8ADS.U8User-defined code 8
ViolationCode1ADS.CDThe first violation committed in this incident (the first should be the most severe)
ViolationCode2ADS.CD2The second violation committed in this incident
ViolationCode3ADS.CD3The third violation committed in this incident
ViolationCode4ADS.CD4The fourth violation committed in this incident
ViolationCode5ADS.CD5The fifth violation committed in this incident
WeaponTypeCodeADS.WTThe type of weapon used in this incident
ShortDescriptionADS.DEShort Description of the Incident
AssignedDaysDSP.IDYDays assigned to the Disciplinary Action, ie Days of Suspension
AssignedHoursDSP.IHRHours assigned to the Disciplinary Action
AssignedStartDateDSP.IDDAssigned Start Date of Disciplinary Action
AssignedEndDateDSP.IEDAssigned End Date of Disciplinary Action
AssignedReturnDateDPS.IRDStudent Assigned Return Date
ReasonForDifferenceCodeDPS.RDDCode for the reason the Assigned date/time to serve a Disciplinary Action differs from the actual date/time served
DisciplinaryAssignmentSchoolcodeDSP.SASchool that Assigned the Disciplinary Action


Disposition

NameAeries Table.ColumnDescription
ActionAuthorityCodeDSP.AAThe authority under which the disposition was administered
DaysDSP.DYThe number of days of disposition (e.g., days of suspension if this is a suspension)
DispositionCodeDSP.DSThe disposition taken
EndDateDSP.EDThe end date of the disposition
HoursDSP.HRThe number of hours of disposition
StudentIDDSP.PIDThe Student ID
PlacementCodeDSP.PLThe student’s placement for this disposition
ResultCodeDSP.RSThe result of the disposition
ReturnDateDSP.RDThe date the student returned from this disposition
ReturnLocationCodeDSP.RLThe return location for this disposition
ReturnStatusCodeDSP.RSTThe return status for this disposition
SequenceNumberDSP.SQ1The sequence number is part of the primary key. It has no independent meaning.
StartDateDSP.DDThe start date of the disposition
SuspensionTagCodeDSP.STThe suspension tag for this disposition

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

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



District Supplemental Student Data 

Security Area:

  • "District Supplemental Data"

URL(s):

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

Notes:

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

Example District Supplemental Student Data Results:

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

[
    {
        "StudentID": 99400001,
        "Columns": [
            {
                "ColumnCode": "CD",
                "ColumnDescription": "Type of Permit",
                "Value": "P",
                "ColumnType": "varchar"
            },
            {
                "ColumnCode": "DT",
                "ColumnDescription": "Issue Date",
                "Value": "8/3/2020 12:00:00 AM",
                "ColumnType": "datetime"
            },
            {
                "ColumnCode": "CO",
                "ColumnDescription": "Comment",
                "Value": "Honda Civid 7x89098",
                "ColumnType": "varchar"
            },
            {
                "ColumnCode": "IN",
                "ColumnDescription": "Issue #",
                "Value": "745896    ",
                "ColumnType": "nchar"
            }
        ]
    }
]


School Supplemental Student Data 

Security Area:

  • "Supplemental Data"

URL(s):

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

Notes:

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

Example School Supplemental Student Data Results:

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

[
    {
        "StudentID": 99400001,
        "Columns": [
            {
                "ColumnCode": "CD",
                "ColumnDescription": "Type of Permit",
                "Value": "P",
                "ColumnType": "varchar"
            },
            {
                "ColumnCode": "DT",
                "ColumnDescription": "Issue Date",
                "Value": "8/3/2020 12:00:00 AM",
                "ColumnType": "datetime"
            },
            {
                "ColumnCode": "CO",
                "ColumnDescription": "Comment",
                "Value": "Honda Civid 7x89098",
                "ColumnType": "varchar"
            },
            {
                "ColumnCode": "IN",
                "ColumnDescription": "Issue #",
                "Value": "745896    ",
                "ColumnType": "nchar"
            }
        ]
    }
]


Update Supplemental Table  

  • POST ~ api/v5/UpdateSchoolSupplemental/{sc}/{sn}


Fees and Fines 

Security Area:

  • "Fees and Fines"

URL(s):

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

Notes:

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

Example Student Fees and Fines Results:

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

[
    {
        "StudentID": 99400001,
        "Fees": [
            {
                "FeeCode": "ASB-02",
                "SequenceNumber": 1,
                "AmountCharged": 20.0000,
                "DateCharged": "2021-05-17T00:00:00",
                "AmountPaid": 0.0000,
                "DatePaid": null,
                "LetterCount": 0,
                "Comment": "",
                "ReceiptNumber": "",
                "SchoolCode": 994
            },
            {
                "FeeCode": "LIB-06",
                "SequenceNumber": 2,
                "AmountCharged": 25.0000,
                "DateCharged": "2020-11-20T00:00:00",
                "AmountPaid": 15.0000,
                "DatePaid": null,
                "LetterCount": 0,
                "Comment": "",
                "ReceiptNumber": "0",
                "SchoolCode": 993
            }
        ]
    }
]


Field Documentation:

NameAeries Table.ColumnDescription
AmountChargedFEE.AMThe dollar amount of the Fee
AmountPaidFEE.PDThe dollar amount that has been paid toward the Fee
CommentFEE.COA comment or note that the school has entered about this Fee
DateChargedFEE.DTThe date the Fee was charged
DatePaidFEE.DPThe date the Fee was paid
FeeCodeFEE.CDA code representing the reason for the Fee
LetterCountFEE.LTThe school can send Fee Letters to remind/warn students and parents about unpaid Fees. This is the number of such letters that have been sent pertaining to this Fee.
ReceiptNumberFEE.RNWhen a Fee is paid, the school can store the receipt number for the payment
SchoolCodeFEE.SCLThe Aeries school code of the school where the Fee was charged
SequenceNumberFEE.SQThe sequence number is part of the primary key. It has no independent meaning.
StudentIDFEE.PID / STU.IDThe Student ID

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

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


Student Picture 

Security Area:

  • "Student Pictures"

URL(s):

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

Query String Filters:

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

Notes:

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

Example Student Pictures Results:

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

{
        "StudentID": 99400001,
        "Pictures": [
            {
                "SchoolYear": 2020,
                "RawBinary": [Not shown for document readability]
                "FileExtension": "jpg",
                "FileSize": 13768
            }
        ],
        "SchoolCode": 994
    }
]


Field Documentation:

NameAeries Table.ColumnDescription
StudentIDPIC.IDThe Student ID
FileExtensionPIC.XTThe original file extension of the photo (e.g., “jpg”)
FileSizePIC.SZThe size in bytes of the photo
RawBinaryPIC.RBA serialized byte array containing the student photo
SchoolYearPIC.YRThe school year the photo was taken (e.g., 2016 for the 2016-2017 school year)
SchoolCodeSTU.SCThe Aeries school code


Student Groups

Security Area:

  • "Student Groups"

URL(s):

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

Notes:

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

Example Student Groups Results:

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

   {
        "Students": [
            {
                "StudentId": 99400001
            },
            {
                "StudentId": 99400003
            }
        ],
        "Staff": [

            {
                "StaffId": 994947
            },
            {
                "StaffId": 994956
            },
            {
                "StaffId": 994958
            }
        ],
        "GroupId": 3,
        "Name": "Detention",
        "Description": "Detention",
        "ExpirationDate": null,
        "SchoolCode": 994,
        "IsCommunicationGroup": false
    },


Field Documentation:

NameAeries Table.ColumnDescription
DescriptionSGD.GDThe description of the group
ExpirationDateSGD.DXThe date the group expires. If the expiration date is populated and has passed, the group should be considered inactive.
GroupIdSGD.GIThe unique identifier for the group
IsCommunicationGroupSGD.CMIndicates whether the group is synced with the Aeries Communication platform
NameSGD.GNThe name of the group
StaffIdSGS.IDThe staff ID of a staff member associated with the group
StudentIdSGM.IDThe Student ID of a student who is a member of the group