class aeripy.Aeripy(hostname: str, api_key: str, ver: str = 'v5', ssl_verify: str = '', logger: Optional[Logger] = None, page_size: int = 5)

The Aeripy class provides access to the Aeries API.

Instances of this class are the primary way to interact with the Aeries API. To obtain and instance of this class:

from aeripy import Aeripy

aeries = Aeripy(
    hostname="demo.aeries.net/aeries/api",
    api_key="477abe9e7d27439681d62f4e0de1f5e1"
)

get_bell_schedule(school_code: int, date: str) → BellScheduleElement

Gets bell schedule for individual school. If the date is not a school day :param school_code: Int, required. :param date: Str, required, in the format “mm-dd-yyyy”. :return: BellScheduleElement

get_bell_schedules(school_code: int, date: Optional[str] = None) → List[BellScheduleElement]

Gets bell schedules for all schools. A date can be supplied to get the schedule for a specific date

Parameters

• school_code – Int, required

• date – Str, optional, in the format mm-dd-yyyy

Returns

List[BellScheduleElement]

get_school(school_code: int) → School

Gets info about a specific school. If the schools does not exist an HTTP 404 error is returned

Parameters

school_code – Int, required

Returns

School

get_schools() → List[School]

Gets all the schools in the Aeries system. To get info about one school, use get_school(). :return: List[School], a list of all schools in Aeries

get_staff(staff_id: Optional[int] = None) → List[StaffElement]

Return objects from a GET request to the staff endpoint. :param staff_id: Int, ID of staff to get. None to request all staff (default: None). :return: All staff will be returned if no staff_id is supplied

get_system_info() → SystemInfo

Gets information about the target Aeries SIS. :return: SystemInfo

get_terms(school_code: int) → List[Term]

Gets a list of terms for the school

Parameters

school_code – Int, required

Returns

List[Term]

insert_staff(data: dict) → StaffElement

Inserts staff into the Aeries SIS using POST. After a successful request, this end point returns HTTP status code 201, and the response body contains the staff object that was just created. :param data: Dict, the data to create the staff with. :return:

update_staff(data: dict, staff_id: Optional[int] = None) → StaffElement

Update staff using PUT. A 200 status will be returned if staff exists. A 201 status will be returned if staff was created. :param data: Dict, If property is omitted or null, it will be ignored. An empty string is a valid value. Except in the case of LeaveDate, which will be nulled if it is omitted. :param staff_id: Int, If staff_id is supplied, but doesn’t exist, and if auto-generate IDs IS NOT enabled, a new record will be created. If auto-generate IDs IS enabled, an error will be generated :return: