[
    {
        "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:

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.
• The sequence number is assigned automatically. If the Staff ID does not exist, the end point returns HTTP 404; an invalid AssignmentType returns HTTP 400 “Invalid assignment type”.

POST Payload Object:

• “StaffJobAssignmentUpdate” object

“StaffJobAssignmentUpdate” Object Definition:

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. This requires Insert permission for that assignment type.
• 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
}

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.
• Only changes to the staff record itself are detected. Changes to the staff member’s user account, school access, assignments, or teacher records do not flag the staff member as changed. Deleted staff are included, so the follow-up Staff Information call for them returns HTTP 404.

Example Staff Data Changes Results:

{
        "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.
• A School Code of 0 returns an empty list. A single teacher that is not found returns HTTP 404.

Example Single Teacher Information Results:

{
    "ClassCalendarSequenceNumber": 0,
    "ClassCalendar": "",
    "UserCode1": "",
    "UserCode2": "",
    "UserCode3": "",
    "UserCode4": "",
    "UserCode5": "",
    "UserCode6": "",
    "UserCode7": "",
    "UserCode8": "",
    "LowGrade": 9,
    "HighGrade": 12,
    "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:

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

Example:

~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:

[
    {
        "ClassCalendarSequenceNumber": 0,
        "ClassCalendar": "",
        "UserCode1": "",
        "UserCode2": "",
        "UserCode3": "",
        "UserCode4": "",
        "UserCode5": "",
        "UserCode6": "",
        "UserCode7": "",
        "UserCode8": "",
        "LowGrade": 9,
        "HighGrade": 12,
        "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)