TABLE OF CONTENTS

Staff Information

Staff Assignments

Staff Data Changes

Teacher Information

Staff-Teacher Information


Staff Information

Security Area:

  • "Staff Data"

URL(s):

  • /api/v5/staff/{StaffID}
    • StaffID (optional) – The Aeries District Staff ID (numeric).
  • api/v5/staff/hrid/{hrid}
    • HRID (optional) - The Human Resources ID (alphanumeric)

Query String Filters:

  • Most fields below can be passed as query string filters to limit the records returned.
    • Example: ?primaryaeriesschool=994&fulltimepercentage=100
    • Example: ?username=JohnSmith
    • The date fields will accept “null” as a comparison; e.g., ?leavedate=null

Notes:

  • If Staff ID is not passed, all staff records in the district will be returned.

Example Staff Information Results:

https://demo.aeries.net/aeries/api/v5/staff/994065

{
    "SchoolAccessPermissions": [
        {
            "SchoolCode": 994,
            "ReadOnlyAccess": false,
            "CommunicationGroup": true
        }
    ],
    "ExtendedProperties": [],
    "EarlyChildhoodCertificationCode": "",
    "Gender": "F",
    "EducationLevelCode": "4",
    "EthnicityCode": "",
    "RaceCode1": "",
    "RaceCode2": "",
    "RaceCode3": "",
    "RaceCode4": "",
    "RaceCode5": "",
    "PositionStatusCode": "1",
    "TotalYearsOfEduService": 12,
    "TotalYearsInThisDistrict": 12,
    "PreviousLastName": "",
    "PreviousFirstName": "Julia",
    "PreviousMiddleName": "",
    "NameSuffix": "",
    "Address": "1234 Teacher lane",
    "AddressCity": "Eagle Rock",
    "AddressState": "CA",
    "AddressZipCode": "98765",
    "AddressZipExt": "1234",
    "HomePhone": "7779983475",
    "EmergencyContactName": "Edward Acosta",
    "EmergencyContactPhone": "7779983475",
    "ID": 994605,
    "FirstName": "Michele",
    "LastName": "Acosta",
    "MiddleName": "",
    "BirthYear": 1963,
    "BirthDate": null,
    "FullTimePercentage": 100,
    "HireDate": "2011-08-31T00:00:00",
    "LeaveDate": null,
    "InactiveStatusCode": "",
    "StateEducatorID": "",
    "UserName": "Acosta",
    "EmailAddress": "nowhere@aeries.com",
    "PrimaryAeriesSchool": 994,
    "NetworkLoginID": "",
    "AlternateEmailAddress": "",
    "HumanResourcesSystemID": "",
    "CellPhone": "",
    "NotificationPreferenceCode": "1",
    "Title": ""
}


Field Documentation:

NameAeries Table.ColumnDescription
AlternateEmailAddressSTF.AEMAn alternate email address.
BirthDateSTF.BDDate of Birth
BirthYearSTF.BY(obsolete) Year of birth
CellPhoneSTF.CPMobile phone number
EmailAddressUGN.EMThe staff member’s email address. (Will pull from STF.EM if UGN.EM is blank)
FirstNameSTF.FNThe staff member’s first name
FullTimePercentageSTF.TPThe staff member’s full-time employment percentage
HireDateSTF.HDThe staff member’s hire date
HumanResourcesSystemIDSTF.HRIDAn identifier for the staff member in an external Human Resources management system. While Aeries staff IDs are numeric, this field accepts all text characters.
IDSTF.IDThe Aeries District Staff ID
InactiveStatusCodeSTF.TGAny value other than blank indicates the staff member is inactive.
LastNameSTF.LNThe staff member’s last name
LeaveDateSTF.LDThe date the staff member’s employment terminated.
MiddleNameSTF.MNThe staff member’s middle name
NetworkLoginIDSTF.NIDThe staff member’s network login ID. This may be used by the district for any purpose they choose, such as an Active Directory account.
NotificationPreferenceCodeSTF.NPThe staff member’s Aeries Comunications notification preference.
PrimaryAeriesSchoolSTF.PSCThe Aeries school code of the school where the staff member is primarily employed.
CommunicationGroupUSR.CGIndicates whether the user should be included in school-wide communications for this school in the Aeries Communications system.
ReadOnlyAccessUSR.ROIndicates whether this user has read-only access to the Aeries system for this school code. If True, the user is not permitted to make ANY changes to data when logged-in to this school code.
SchoolCodeUSR.SCThe Aeries school code to which this user has access.
GenderSTF.SXThe staff member’s sex (M or F)
StateEducatorIDSTF.SIDFor certificated employees, the Statewide Educator ID issued by the state authority.
TitleSTF.TIThe staff member’s title.
UserNameUGN.UNThe staff member’s username for the Aeries SIS.
EarlyChildhoodCertificationCodeSTF.ECCEarly Childhood Certification Code
MonthlyMinutesSTJ.MMNMonthly Minutes
PopulationServedCodeSTJ.PSVPopulation Served Code
ServiceIdCodeSTJ.SVCService ID Code

For descriptions of the codes, use our “Code Sets” API: ~api/v5/codes/Staff/{ElementName}

Example:

https://demo.aeries.net/aeries/api/v5/codes/Staff/ECC


Extended Properties:

  • CommunicationDistrictAdmin
  • AllowPostingToGeneralDistrictLevelCommunicationGroups
  • AllowPostingToGeneralSchoolLevelCommunicationGroups
  • AllowPostingToStaffSpecificDistrictLevelCommunicationGroups
  • AllowPostingToStaffSpecificSchoolLevelCommunicationGroups


Staff Information - Create

Security Area:

  • "Staff Data" - Insert

URL(s):

  • POST /api/v5/staff

Notes:

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

POST Payload Object:

  • “StaffUpdate” object


“StaffUpdate” Object Definition:

NameData TypeNotes
IDInt32The Aeries district staff ID. Some customers enable an option to auto-generate new staff IDs.  In this case, ID will be ignored.  Otherwise, it is REQUIRED.
FirstNameStringMax length: 20
LastNameStringMax length: 50
MiddleNameStringMax length: 20
BirthYearInt16
BirthDateDate
FullTimePercentageInt16
HireDateDate
LeaveDateDate
InactiveStatusCodeStringMax length: 1
StateEducatorIDStringMax length: 10
EmailAddressStringMax length: 255
PrimaryAeriesSchoolInt16
NetworkLoginIDStringMax length: 255
AlternateEmailAddressStringMax length: 255
HumanResourcesSystemIDStringMax length: 255
CellPhoneStringMax length: 10 numbers.  If other characters are passed, only numbers will be kept.
TitleStringMax length: 100
GenderStringMax length: 1
EducationLevelCodeStringMax length: 2
EthnicityCodeStringMax length: 1
RaceCode1StringMax length: 3
RaceCode2StringMax length: 3
RaceCode3StringMax length: 3
RaceCode4StringMax length: 3
RaceCode5StringMax length: 3
PositionStatusCodeStringMax length: 2
TotalYearsOfEduServiceInt16
TotalYearsInThisDistrictInt16
PreviousLastNameStringMax length: 50
PreviousFirstNameStringMax length: 50
PreviousMiddleNameStringMax length: 50
NameSuffixStringMax length: 10
AddressStringMax length: 55
AddressCityStringMax length: 30
AddressStateStringMax length: 2
AddressZipCodeStringMax length: 5
AddressZipExtStringMax length: 4
HomePhoneStringMax length: 10 numbers.  If other characters are passed, only numbers will be kept.
EmergencyContactNameStringMax length: 50
EmergencyContactPhoneStringMax length: 10 numbers.  If other characters are passed, only numbers will be kept.


Example POST Payload:

{
    "ID": 994902,
    "FirstName": "Somebody",
    "LastName": "Know",
    "MiddleName": "I",
    "BirthYear": 1985,
    "BirthDate": "1985-01-01",
    "FullTimePercentage": 100,
    "HireDate": "2017-07-01",
    "LeaveDate": null,
    "InactiveStatusCode": "",
    "StateEducatorID": "9949990000",
    "EmailAddress": "teacher994999@aeries.com",
    "PrimaryAeriesSchool": 994,
    "NetworkLoginID": "",
    "AlternateEmailAddress": "",
    "HumanResourcesSystemID": "994999",
    "CellPhone": "",
    "Title": "Mr.",
    "Gender": "M",
    "EducationLevelCode": "4",
    "EthnicityCode": "N",
    "RaceCode1": "700",
    "RaceCode2": "",
    "RaceCode3": "",
    "RaceCode4": "",
    "RaceCode5": "",
    "PositionStatusCode": "1",
    "TotalYearsOfEduService": 12,
    "TotalYearsInThisDistrict": 1,
    "PreviousLastName": "",
    "PreviousFirstName": "",
    "PreviousMiddleName": "",
    "NameSuffix": "",
    "Address": "123 Fake St",
    "AddressCity": "Eagle Rock",
    "AddressState": "CA",
    "AddressZipCode": "99999",
    "AddressZipExt": "1234",
    "HomePhone": "8883245363",
    "EmergencyContactName": "Aeries Software",
    "EmergencyContactPhone": "8883245363"
}


Staff Information - Update 

Security Area:

  • "Staff Data" - Update

URL(s):

  • PUT /api/v5/staff/{StaffID}
    • StaffID (required) - the Aeries district Staff ID

Notes:

  • If the Staff ID does not exist, a new record will be created unless the customer has enabled the option to auto-generate new staff IDs.  In this case, an error will be generated if the given Staff ID does not already exist.
  • After a successful request, this end point returns the "Staff" object that was just updated or created. If an existing record was updated, the status code will be 200. If a new record was created, the status code will be 201.
  • If a property is omitted or null, it will be ignored. An empty string is different from a null value. An empty string willoverwrite an existing value for string type properties.
    • Exception: If LeaveDate is omitted or null, it will be set to null. (It's important to be able to nullify this field, so we need to assume that the intent is to nullify if it's missing.

PUT Payload Object:

  • “StaffUpdate” object
{
    "ID": 994902,
    "FirstName": "Somebody",
    "LastName": "Know",
    "MiddleName": "I",
    "BirthYear": 1985,
    "BirthDate": "1985-01-01",
    "FullTimePercentage": 100,
    "HireDate": "2017-07-01",
    "LeaveDate": null,
    "InactiveStatusCode": "",
    "StateEducatorID": "9949990000",
    "EmailAddress": "teacher994999@aeries.com",
    "PrimaryAeriesSchool": 994,
    "NetworkLoginID": "",
    "AlternateEmailAddress": "",
    "HumanResourcesSystemID": "994999",
    "CellPhone": "",
    "Title": "Mr.",
    "Gender": "M",
    "EducationLevelCode": "4",
    "EthnicityCode": "N",
    "RaceCode1": "700",
    "RaceCode2": "",
    "RaceCode3": "",
    "RaceCode4": "",
    "RaceCode5": "",
    "PositionStatusCode": "1",
    "TotalYearsOfEduService": 12,
    "TotalYearsInThisDistrict": 1,
    "PreviousLastName": "",
    "PreviousFirstName": "",
    "PreviousMiddleName": "",
    "NameSuffix": "",
    "Address": "123 Fake St",
    "AddressCity": "Eagle Rock",
    "AddressState": "CA",
    "AddressZipCode": "99999",
    "AddressZipExt": "1234",
    "HomePhone": "8883245363",
    "EmergencyContactName": "Aeries Software",
    "EmergencyContactPhone": "8883245363"
}



“StaffUpdate” Object Definition:


The definition is the same that is given with the Staff Information - Create documentation, with the following exception:

  • ID is ignored in the body. The StaffID from the URL is used instead.


Example PUT Payload:

{    
"LeaveDate": "2019-01-31",    
"InactiveStatusCode": "I"
}


Staff Assignments 

Security Area:

  • "Staff Job Assignments"
  • "Staff Assignments (Classified)"

URL(s):

  • /api/v5/staff/{StaffID}/assignments/{AssignmentType}/{SequenceNumber}
    • StaffID (required) - the Aeries district Staff ID
    • AssignmentType (optional) - the type of assignment ("certificated" or "classified").
    • SequenceNumber (optional) - part of the primary key, along with StaffID and AssignmentType.  Uniquely identifies an assignment given a staff ID and assignment type.  If SequenceNumber is passed, then AssignmentType is required.
  • /api/v5/staff/{StaffID}/assignments/date/{year}/{month}/{day}/{AssignmentType}
    • Collection of assignments for a staff ID effective on a specific date
    • StaffID (required) - the Aeries district Staff ID
    • year, month, day (required) - the date parts for the effective date
    • AssignmentType (optional) - the type of assignment ("certificated" or "classified")

Notes:

  • Assignments for certificated and classified staff are stored in two separate Aeries tables.  For the greatest flexibility, these are separate security areas. However, they are both referred to as "assignments" in the API. There is an AssignmentType property of "certificated" or "classified" to distinguish them.  Not all fields are applicable to classified assignments.  These can be identified by the Aeries Table.Column in the field documentation.  If there is no mapping to STA, the field does not apply to classified assignments.

Example Staff Assignments Results:

[
    {
        "AssignmentType": "certificated",
        "ID": 994999,
        "SequenceNumber": 1,
        "JobClassificationCode": "12",
        "FullTimePercentage": 100,
        "NonClassroomBasedJobAssignmentCode1": "",
        "NonClassroomBasedJobAssignmentCode2": "",
        "NonClassroomBasedJobAssignmentCode3": "",
        "NonClassroomBasedJobAssignmentCode4": "",
        "NonClassroomBasedJobAssignmentCode5": "",
        "NonClassroomBasedJobAssignmentCode6": "",
        "NonClassroomBasedJobAssignmentCode7": "",
        "SchoolCode": 994,
        "StartDate": "2018-07-01T00:00:00",
        "EndDate": "2019-06-30T00:00:00"
    }
]

Field Documentation:

NameAeries Table.ColumnDescription
AssignmentTypeN/A"certificated" or "classified".  This is used to distinguish between the two distinct Aeries tables where these data are stored.
EndDateSTJ.ED, STA.EDThe end date of the assignment
FullTimePercentageSTJ.FTE, STA.PTThe full-time employment percentage attributed to this assignment
IDSTJ.ID, STA.IDThe Aeries District Staff ID
JobClassificationCodeSTJ.JC, STA.JCThe job classification code for this assignment.
NonClassroomBasedJobAssignmentCode1STJ.NC1The first non classroom based job assignment code.  This is used for certificated, non-teaching assignments.
NonClassroomBasedJobAssignmentCode2STJ.NC2The second non classroom based job assignment code.  This is used for certificated, non-teaching assignments.
NonClassroomBasedJobAssignmentCode3STJ.NC3The third non classroom based job assignment code.  This is used for certificated, non-teaching assignments.
NonClassroomBasedJobAssignmentCode4STJ.NC4The fourth non classroom based job assignment code.  This is used for certificated, non-teaching assignments.
NonClassroomBasedJobAssignmentCode5STJ.NC5The fifth non classroom based job assignment code.  This is used for certificated, non-teaching assignments.
NonClassroomBasedJobAssignmentCode6STJ.NC6The sixth non classroom based job assignment code.  This is used for certificated, non-teaching assignments.
NonClassroomBasedJobAssignmentCode7STJ.NC7The seventh non classroom based job assignment code.  This is used for certificated, non-teaching assignments.
SchoolCodeSTJ.SCL, STA.SCLThe Aeries school code associated with this assignment
SequenceNumberSTJ.SQ, STA.SQThe Sequence Number forms part of the primary key.  It has no independent meaning.
StartDateSTJ.SD, STA.SDThe start date of the assignment.


Staff Assignments - Create 

Security Area:

  • "Staff Job Assignments" - Insert
  • "Staff Assignments (Classified)" - Insert

URL(s):

  • POST /api/v5/staff/{StaffID}/assignments
    • StaffID (required) – the Aeries district Staff ID

Notes:

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

POST Payload Object:

  • “StaffJobAssignmentUpdate” object


“StaffJobAssignmentUpdate” Object Definition:

NameData TypeNotes
AssignmentTypeStringREQUIRED The only valid values are "certificated" and "classified".
JobClassificationStringMax length (certificated): 3. Max length (classified): 2
FullTimePercentageDoubleFor CA state reporting purposes, should be rounded to the nearest tenth (e.g., 87.5).
NonClassroomBasedJobAssignment1StringMax length: 4. Does not apply to classified assignments.
NonClassroomBasedJobAssignment2StringMax length: 4. Does not apply to classified assignments.
NonClassroomBasedJobAssignment3StringMax length: 4. Does not apply to classified assignments.
NonClassroomBasedJobAssignment4StringMax length: 4. Does not apply to classified assignments.
NonClassroomBasedJobAssignment5StringMax length: 4. Does not apply to classified assignments.
NonClassroomBasedJobAssignment6StringMax length: 4. Does not apply to classified assignments.
NonClassroomBasedJobAssignment7StringMax length: 4. Does not apply to classified assignments.
SchoolCodeInt16
StartDateDate
EndDateDate


Example POST Payload:

{
    "AssignmentType": "certificated",
    "JobClassificationCode": "12",
    "FullTimePercentage": 100,
    "NonClassroomBasedJobAssignmentCode1": "",
    "NonClassroomBasedJobAssignmentCode2": "",
    "NonClassroomBasedJobAssignmentCode3": "",
    "NonClassroomBasedJobAssignmentCode4": "",
    "NonClassroomBasedJobAssignmentCode5": "",
    "NonClassroomBasedJobAssignmentCode6": "",
    "NonClassroomBasedJobAssignmentCode7": "",
    "SchoolCode": 994,
    "StartDate": "2018-07-01",
    "EndDate": null
}


Staff Assignments - Update 

Security Area:

  • "Staff Job Assignments" - Update
  • "Staff Assignments (Classified)" - Update

URL(s):

  • PUT /api/v5/staff/{StaffID}/assignments/{AssignmentType}/{SequenceNumber}
    • StaffID (required) - the Aeries district Staff ID
    • AssignmentType (required) - the type of assignment ("certificated" or "classified").
    • SequenceNumber (required) - part of the primary key, along with StaffID and AssignmentType.  Uniquely identifies an assignment given a staff ID and assignment type.

Notes:

  • If the sequence number does not exist, a new record will be created.
  • After a successful request, this end point returns the "StaffJobAssignment" object that was just updated or created. If an existing record was updated, the status code will be 200. If a new record was created, the status code will be 201.
  • If a property is omitted or null, it will be ignored. An empty string is different from a null value. An empty string willoverwrite an existing value for string type properties.
    • Exception: If EndDate is omitted or null, it will be set to null. (It's important to be able to nullify this field, so we need to assume that the intent is to nullify if it's missing.


PUT Payload Object:

  • “StaffJobAssignmentUpdate” object


“StaffJobAssignmentUpdate” Object Definition:


The definition is the same that is given with the Staff Assignments - Create documentation, with the following exception:

  • AssignmentType is ignored in the body. The AssignmentType from the URL is used instead.


Example PUT Payload:

{   
    "JobClassificationCode": "12",   
    "FullTimePercentage": 100,    
    "EndDate": null
}


Staff Assignments - Delete 

Security Area:

  • "Staff Job Assignments" - Delete
  • "Staff Assignments (Classified)" - Delete

URL(s):

  • DELETE /api/v5/staff/{StaffID}/assignments/{AssignmentType}/{SequenceNumber}
    • StaffID (required) - the Aeries district Staff ID
    • AssignmentType (required) - the type of assignment ("certificated" or "classified").
    • SequenceNumber (required) - part of the primary key, along with StaffID and AssignmentType.  Uniquely identifies an assignment given a staff ID and assignment type.
  • DELETE /api/v5/staff/{StaffID}/assignments/startdate/{year}/{month}/{day}/{AssignmentType}
    • Delete all assignments for a staff ID with a Start Date on or after a specific date.  For example, delete all assignments for the current academic year (2018/07/01).
    • StaffID (required) - the Aeries district Staff ID
    • year, month, day (required) - the date parts for the start date
    • AssignmentType (optional) - limit by the type of assignment ("certificated" or "classified")

Notes:

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


Staff Data Changes 

Security Area:

  • "Staff Data"

URL(s):

  • /api/v5/StaffDataChanges/{year}/{month}/{day}/{hour}/{minute}
    • year, month, day, hour, minute – required – The parts of the Date/Time from which you want to system to return staff with data changes. All parameters are required although 0 is valid for hour and minute. Valid values for "hour" are 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 staff with changes, you will have to loop through the dataset and call the Staff Information API one record at a time.

Example Staff Data Changes Results:

https://demo.aeries.net/aeries/api/v5/StaffDataChanges/2016/7/1/0/0

{
        "ID": 884797
    },
    {
        "ID": 884877
    },
    {
        "ID": 884915
    },
    {
        "ID": 884918
    },
    {
        "ID": 884948
    },
    {
        "ID": 990900
    },
    {
        "ID": 990901
    },
    {
        "ID": 990902
    },


Teacher Information 

Security Area:

  • "Teacher Data"

URL(s):

  • /api/v5/schools/{SchoolCode}/teachers/
  • /api/v5/schools/{SchoolCode}/teachers/{TeacherNumber}
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • TeacherNumber (optional) – the School-Based Aeries Teacher Number.

Notes:

  • If Teacher Number is not passed, all teacher records in the given school will be returned.


Example Single Teacher Information Results:

https://demo.aeries.net/aeries/api/schools/994/teachers/605

{
    "UserCode1": "",
    "UserCode2": "",
    "UserCode3": "",
    "UserCode4": "",
    "UserCode5": "",
    "UserCode6": "",
    "UserCode7": "",
    "UserCode8": "",
    "SchoolCode": 994,
    "TeacherNumber": 605,
    "DisplayName": "Acosta",
    "FirstName": "Heather",
    "LastName": "",
    "Room": "12",
    "EmailAddress": "Teacher605@example.com",
    "StaffID1": 994605,
    "StaffID2": 0,
    "StaffID3": 0,
    "StateCourseCode": "",
    "InactiveStatusCode": "",
    "HighlyQualifiedStatusCode1": "",
    "HighlyQualifiedStatusCode2": "",
    "HighlyQualifiedStatusCode3": "",
    "NextYearInactiveStatusCode": ""
}


Field Documentation:

NameAeries Table.ColumnDescription
DisplayNameTCH.TEThe display name for the teacher that is used throughout the Aeries system. This may be different from the teacher’s actual first and last name.
EmailAddressTCH.EMThe teacher’s email address.
FirstNameTCH.TFThe teacher’s first name
HighlyQualifiedStatusCode1TCH.HQTFor self-contained elementary classroom teachers, the method by which the teacher associated with Staff ID 1 became Highly Qualified
HighlyQualifiedStatusCode2TCH.HQ2For self-contained elementary classroom teachers, the method by which the teacher associated with Staff ID 2 became Highly Qualified
HighlyQualifiedStatusCode3TCH.HQ3For self-contained elementary classroom teachers, the method by which the teacher associated with Staff ID 3 became Highly Qualified
InactiveStatusCodeTCH.TGAny value other than blank indicates that this teacher is inactive. Inactive teachers should have no active class sections and no students.
LastNameTCH.TLNThe teacher’s last name
RoomTCH.RMThe teacher’s room number
SchoolCodeTCH.SCThe Aeries school code
StaffID1TCH.IDThe teacher’s staff ID
StaffID2TCH.ID2For team teaching, the 2nd teacher’s staff ID
StaffID3TCH.ID3For team teaching, the 3rd teacher’s staff ID
StateCourseCodeTCH.CBFor elementary schools without a master schedule, this value will be used when reporting course section enrollment to the state. If the school has a master schedule, the value will be taken from the Courses table instead.
TeacherNumberTCH.TNThe school-based Aeries teacher number
ClassCalendarSequenceNumberTCH.CSQClass Calendar Sequence Number - For Elementary without MST
UserCode1TCH.U1User Code 1
UserCode2TCH.U2User Code 2
UserCode3TCH.U3User Code 3
UserCode4TCH.U4User Code 4
UserCode5TCH.U5User Code 5
UserCode6TCH.U6User Code 6
UserCode7TCH.U7User Code 7
UserCode8TCH.U8User Code 8

For descriptions of the codes, use our “Code Sets” API: ~api/v5/codes/Teachers/{ElementName}

Example:

https://demo.aeries.net/aeries/api/v5/codes/Teachers/HighlyQualifiedStatusCode1


Staff-Teacher Information 

Security Area:

  • "Teacher Data"

URL(s):

  • /api/v5/staff/{StaffID}/teachers
    • StaffID (required) – The Aeries District Staff ID (numeric).

Notes:

  • This end point will return a list of teacher records associated with the given Staff ID.

Example Staff-Teacher Information Results:

https://demo.aeries.net/aeries/api/v5/staff/994605/teachers

  {
"UserCode1": "",
"UserCode2": "",
"UserCode3": "",
"UserCode4": "",
"UserCode5": "",
"UserCode6": "",
"UserCode7": "",
"UserCode8": "",
"SchoolCode": 994,
"TeacherNumber": 605,
"DisplayName": "Acosta",
"FirstName": "Heather",
"LastName": "",
"Room": "12",
"EmailAddress": "Teacher605@example.com",
"StaffID1": 994605,
"StaffID2": 0,
"StaffID3": 0,
"StateCourseCode": "",
"InactiveStatusCode": "",
"HighlyQualifiedStatusCode1": "",
"HighlyQualifiedStatusCode2": "",
"HighlyQualifiedStatusCode3": "",
"NextYearInactiveStatusCode": ""
}


Field Documentation:

(Same as Teacher Information field documentation above)