API Reference

Veracross Client

class veracross_client.VeracrossClient(school_route, client_id, client_secret, scopes)

Bases: object

class MyClass

Bases: object

get_admission_application(application_id=None, x_api_revision=None, x_api_value_lists=None)

Get the admission application.

Parameters:

application_id (int) – The ID of the application.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – Include value lists in the response.

Returns:

A DataFrame containing the admission application.

Return type:

pandas.DataFrame

admission_application_checklists_read(application_id, id, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the checklist items for a specific admission application.

Parameters:

application_id (int) – The ID of the admission application.
id (int) – The ID of the checklist item.

Returns:

A DataFrame containing the checklist items.

Return type:

pandas.DataFrame

admission_households_read(id)

Get information about a specific household.

Parameters:: id (int) – The ID of the household. (required)
Returns:: A DataFrame with information about the household.
Return type:: pandas.DataFrame

admission_languages_read(id=None)

Get the information about an admission language.

Parameters:: id (int) – The ID of the admission language.
Returns:: A DataFrame containing the information about the admission language.
Return type:: pandas.DataFrame

create_academics_classes(class_id, description, status, school_year, begin_date, end_date, primary_grade_level_id, school_level, internal_course_id, primary_teacher_id, room_id, virtual_meeting_url, subject_id, x_api_revision=None)

Create an academic class.

Parameters:

class_id (str) – The ID of the class.
description (str) – The description of the class.
status (int) – The status of the class.
school_year (int) – The school year of the class.
begin_date (str) – The begin date of the class. Format: “YYYY-MM-DD”.
end_date (str) – The end date of the class. Format: “YYYY-MM-DD”.
primary_grade_level_id (int) – The ID of the primary grade level.
school_level (int) – The ID of the school level.
internal_course_id (int) – The ID of the course.
primary_teacher_id (int) – The ID of the primary teacher.
room_id (int) – The ID of the room.
virtual_meeting_url (str) – The virtual meeting URL of the class.
subject_id (int) – The ID of the subject.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the created academic class.

Return type:

pandas.DataFrame

create_academics_course(course_id, name, subject_id, catalog_title, catalog_description, course_type, x_api_revision=None)

Create a new academic course.

Parameters:

course_id (str) – The ID of the course.
name (str) – The name of the course.
subject_id (str) – The ID of the subject.
catalog_title (str) – The title of the course in the catalog.
catalog_description (str) – The description of the course in the catalog.
course_type (int) – The type of the course.

Returns:

A DataFrame containing the newly created academic course.

Return type:

pandas.DataFrame

create_academics_enrollments(internal_class_id, person_id, currently_enrolled, late_date_enrolled, date_withdrawn, level, notes, x_api_revision)

Create a new enrollment record for an academic class.

Parameters:

internal_class_id (int) – The ID of the internal class.
person_id (int) – The ID of the person.
currently_enrolled (bool) – Indicates if the person is currently enrolled.
late_date_enrolled (str) – The late date enrolled. Format: “YYYY-MM-DD”.
date_withdrawn (str) – The date withdrawn. Format: “YYYY-MM-DD”.
level (int) – The enrollment level.
notes (str) – Additional notes for the enrollment.
x_api_revision (str) – API Revision.

Returns:

A DataFrame containing the newly created enrollment record.

Return type:

pandas.DataFrame

create_academics_rubric(category_id, description, report_override_description, sort_key, allow_curriculum, x_api_revision=None)

Create a new academic rubric.

Parameters:

category_id (int) – The ID of the rubric category.
description (str) – The description of the rubric.
report_override_description (str) – The override description of the rubric for report cards.
sort_key (int) – The sort key of the rubric.
allow_curriculum (bool) – Flag to allow the rubric to be used in the curriculum.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the created academic rubric.

Return type:

pandas.DataFrame

create_academics_rubric_categories(school_route, x_api_revision, data)

Create a new academic rubric category.

Parameters:

school_route (str) – The specific school route for creating the rubric category.
x_api_revision (str) – The API revision.
data (dict) – The data for creating the rubric category. - description (str, required): The rubric category description. - report_override_description (str, required): The report card description. - allow_curriculum (bool, required): Specify whether the rubric category allows curriculum. - sort_key (int, required): The sort key for ordering the rubric categories.

Returns:

A DataFrame containing the response data for the created rubric category.

Return type:

pandas.DataFrame

create_academics_rubric_criteria(data: object, category_id: int, rubric_id: int, description: str, report_override_description: str, scale_id: int, type: int, notes: str, sort_key: int)

Create a new rubric criteria.

Parameters:

data (object, required) – The data object that contains the rubric criteria details.
category_id (int) – The ID of the category the rubric criteria belongs to.
rubric_id (int, required) – The ID of the rubric the criteria is associated with.
description (str) – The description of the rubric criteria.
report_override_description (str) – The report override description of the rubric criteria.
scale_id (int) – The ID of the scale for the rubric criteria.
type (int) – The type of the rubric criteria.
notes (str) – Additional notes for the rubric criteria.
sort_key (int) – The sort key for the rubric criteria.

Returns:

A DataFrame containing the created rubric criteria.

Return type:

pandas.DataFrame

create_academics_rubric_scale(description, portal_display_format, x_api_revision=None)

Create a new academic rubric scale.

Parameters:

description (str) – Description of the rubric scale.
portal_display_format (int) – Portal assignment criteria grade display field.
x_api_revision (str, optional) – API revision.

Returns:

A DataFrame containing the created rubric scale information.

Return type:

pandas.DataFrame

create_academics_rubric_scale_levels(description, abbreviation, numeric_value, notes, sort_key, scale_id, scale_description)

Create new rubric scale levels for academics.

Parameters:

description (str) – The description of the rubric scale level.
abbreviation (str) – The abbreviation of the rubric scale level.
numeric_value (float) – The numeric value of the rubric scale level.
notes (str) – Additional notes for the rubric scale level.
sort_key (int) – The sort key of the rubric scale level.
scale_id (int) – The ID of the rubric scale.
scale_description (str) – The description of the rubric scale.

Returns:

A DataFrame containing the created rubric scale level.

Return type:

pandas.DataFrame

create_admission_applicant_relationship(applicant_id, data)

Create an admission applicant relationship.

Parameters:

applicant_id (int) – The ID of the applicant.
data (dict) – The data for creating the relationship. - related_person_id (int, required): The ID of the related person. - relationship (int, required): The ID of the relationship. - legal_custody (bool): Whether the related person has legal custody. - admissions_access (bool): Whether the related person has admissions access.

Returns:

A DataFrame containing the created admission applicant relationship.

Return type:

pandas.DataFrame

create_admission_applicants(household_id, address_1, address_2, address_3, city, state, postal_code, country, name_prefix, first_name, middle_name, last_name, name_suffix, nick_name, gender, pronouns, ethnicity, date_of_birth, email, phone_mobile, current_grade, application_id, year_applying_for, month_applying_for, grade_applying_for, resident_status_applying_for, campus_applying_for, student_group_applying_for, admission_source, candidate_pool, requesting_financial_aid, admission_lead_date, inquiry_date, visit_date, application_date, application_status, application_decision_date, application_decision_response, application_decision_response_date, x_api_revision=None, x_api_value_lists=None)

Create admission applicants.

Parameters:

household_id (int) – The ID of the household.
address_1 (str) – The first line of the address.
address_2 (str) – The second line of the address.
address_3 (str) – The third line of the address.
city (str) – The city of the address.
state (str) – The state of the address.
postal_code (str) – The postal code of the address.
country (int) – The ID of the country.
name_prefix (int) – The ID of the name prefix.
first_name (str) – The first name.
middle_name (str) – The middle name.
last_name (str) – The last name.
name_suffix (int) – The ID of the name suffix.
nick_name (str) – The nick name.
gender (int) – The ID of the gender.
pronouns (int) – The ID of the pronouns.
ethnicity (int) – The ID of the ethnicity.
date_of_birth (str) – The date of birth. Format: “YYYY-MM-DD”.
email (str) – The email address.
phone_mobile (str) – The mobile phone number.
current_grade (int) – The ID of the current grade.
application_id (int) – The ID of the application.
year_applying_for (int) – The year applying for.
month_applying_for (int) – The month applying for.
grade_applying_for (int) – The ID of the grade applying for.
resident_status_applying_for (int) – The ID of the resident status applying for.
campus_applying_for (int) – The ID of the campus applying for.
student_group_applying_for (int) – The ID of the student group applying for.
admission_source (int) – The ID of the admission source.
candidate_pool (int) – The ID of the candidate pool.
requesting_financial_aid (bool) – Whether financial aid is requested.
admission_lead_date (str) – The admission lead date. Format: “YYYY-MM-DD”.
inquiry_date (str) – The inquiry date. Format: “YYYY-MM-DD”.
visit_date (str) – The visit date. Format: “YYYY-MM-DD”.
application_date (str) – The application date. Format: “YYYY-MM-DD”.
application_status (int) – The ID of the application status.
application_decision_date (str) – The application decision date. Format: “YYYY-MM-DD”.
application_decision_response (int) – The ID of the application decision response.
application_decision_response_date (str) – The application decision response date. Format: “YYYY-MM-DD”.

Returns:

A DataFrame containing the created admission applicants.

Return type:

pandas.DataFrame

create_admission_applications(data)

Create admission applications.

Parameters:: data (dict) – The data for creating admission applications. The required keys and types are: - applicant_id (int): Applicant ID. - year_applying_for (int): Year Applying For. - month_applying_for (int): Month Applying For. - grade_applying_for (int): Grade Applying For. - resident_status_applying_for (int): Resident Status Applying For. - campus_applying_for (int): Campus Applying For. - student_group_applying_for (int): Student Group Applying For. - admission_source (int): Admission Source. - candidate_pool (int): Candidate Pool. - admission_lead_date (str): Admission Lead Date. - inquiry_date (str): Inquiry Date. - visit_date (str): Visit Date. - application_date (str): Application Date. - requesting_financial_aid (bool): Requesting Financial Aid. - application_status (int): Application Status. - application_decision_date (str): Application Decision Date. - application_decision_response (int): Application Decision Response. - application_decision_response_date (str): Application Decision Response Date.
Returns:: A DataFrame containing the created admission applications.
Return type:: pandas.DataFrame

create_admission_citizenship(person_id, country, is_primary, passport_number, passport_issue_date, passport_issuing_authority, passport_expiration_date)

Create a new admission citizenship.

Parameters:

person_id (int) – Person ID. Required.
country (int) – Country of Citizenship. Required.
is_primary (bool) – Primary Citizenship. Required.
passport_number (str) – Passport Number. Required.
passport_issue_date (str) – Passport Issue Date. Required.
passport_issuing_authority (str) – Passport Issuing Authority. Required.
passport_expiration_date (str) – Passport Expiration Date. Required.

Returns:

A DataFrame containing the created admission citizenship.

Return type:

pandas.DataFrame

create_admission_languages(person_id, language, is_primary, reading_proficiency, writing_proficiency, speaking_proficiency, listening_proficiency, years_studying, spoken_at_home, notes)

Create admission languages for a person.

Parameters:

person_id (int) – The ID of the person.
language (int) – The ID of the language.
is_primary (bool) – The primary code.
reading_proficiency (int) – The reading proficiency.
writing_proficiency (int) – The writing proficiency.
speaking_proficiency (int) – The speaking proficiency.
listening_proficiency (int) – The listening proficiency.
years_studying (int) – The years studying.
spoken_at_home (bool) – Spoken at home.
notes (str) – Additional notes.

Returns:

A DataFrame containing the created admission languages.

Return type:

pandas.DataFrame

create_admission_relative(data, x_api_revision)

Create an admission relative.

Parameters:

data (dict) – The data for creating the admission relative. The keys are as follows: - household_id (int): Required. The household ID. - address_1 (str): Optional. Address Line 1. - address_2 (str): Optional. Address Line 2. - address_3 (str): Optional. Address Line 3. - city (str): Optional. The city. - state (str): Optional. The state. - postal_code (str): Optional. The postal code. - country (int): Required. The country. - name_prefix (int): Required. The name prefix. - first_name (str): Optional. The first name. - middle_name (str): Optional. The middle name. - last_name (str): Required. The last name. - name_suffix (str): Required. The name suffix. - nick_name (str): Optional. The nick name. - maiden_name (str): Optional. The maiden name. - marital_status (int): Required. The marital status. - pronouns (int): Required. The pronouns. - gender (int): Required. The gender. - ethnicity (int): Required. The ethnicity. - date_of_birth (str): Optional. The date of birth. Format: “YYYY-MM-DD”. - place_of_birth (str): Optional. The place of birth. - date_of_death (str): Optional. The date of death. Format: “YYYY-MM-DD”. - graduation_year (int): Required. The graduation year. - email (str): Optional. The email address. - mobile_phone (str): Optional. The mobile phone number. - work_phone (str): Optional. The work phone number. - applicant_id (int): Required. The applicant ID. - relationship (int): Required. The relationship. - legal_custody (bool): Required. Legal custody. - admissions_access (bool): Required. Admissions access.
x_api_revision (str) – The API revision.

Returns:

A DataFrame containing the details of the created admission relative.

Return type:

pandas.DataFrame

create_admission_relative_relationships(relative_id, data, x_api_revision=None)

Create admission relative relationships.

Parameters:

relative_id (int) – The ID of the relative.
data (dict) – The data for creating the admission relative relationships.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the created admission relative relationships.

Return type:

pandas.DataFrame

create_athletics_rosters(internal_class_id, person_id, first_name, last_name, grade_level_id, currently_enrolled, data=None)

Create athletics rosters.

Parameters:

internal_class_id (int) – The internal class ID.
person_id (int) – The person ID.
first_name (str) – The first name.
last_name (str) – The last name.
grade_level_id (int) – The grade level ID.
currently_enrolled (bool) – Whether the person is currently enrolled.
data (dict, optional) – Additional data for creating the athletics rosters. Default is None.

Returns:

A DataFrame containing the created athletics rosters.

Return type:

pandas.DataFrame

create_athletics_sports(data)

Create a new athletics sport.

Parameters:: data (dict) – A dictionary containing the details of the athletics sport. - description (str): The description of the sport. - abbreviation (str): The abbreviation of the sport. - gender (int): The gender of the sport. - subject_id (int): The ID of the subject associated with the sport.
Returns:: A DataFrame containing the details of the created athletics sport.
Return type:: pandas.DataFrame

create_athletics_teams(school_level, internal_sport_id, team_id, description, sport_id, head_coach_id, assistant_coach_id, begin_date, end_date, x_api_revision=None, x_api_value_lists=None)

Create athletics teams.

Parameters:

school_level (int) – The school level.
internal_sport_id (int) – The internal sport ID.
team_id (str) – The team ID.
description (str) – The team description.
sport_id (int) – The sport.
head_coach_id (int) – The coach ID.
assistant_coach_id (int) – The assistant coach ID.
begin_date (str) – The begin date. Format: “YYYY-MM-DD”.
end_date (str) – The end date. Format: “YYYY-MM-DD”.

Returns:

A DataFrame containing the created athletics teams.

Return type:

pandas.DataFrame

create_behavior(data)

Create a behavior record.

Parameters:: data (dict) – A dictionary containing the data for the behavior record. - incident_date (str): The date of the incident. Format: “YYYY-MM-DD”. - incident_type (int): The type of the incident. - student_id (int): The ID of the student involved in the incident. - reporting_person_id (int): The ID of the person reporting the incident. - assigned_to_person_id (int): The ID of the person assigned to handle the incident. - internal_class_id (int): The ID of the internal class associated with the incident. - class_name (str): The name of the class associated with the incident. - incident_notes (str): Additional notes about the incident. - status (int): The status of the incident. - status_date (str): The date of the incident status. Format: “YYYY-MM-DD”. - outcome_type (int): The type of outcome for the incident. - outcome_date (str): The date of the incident outcome. Format: “YYYY-MM-DD”. - outcome_notes (str): Additional notes about the incident outcome. - follow_up_status (int): The status of the incident follow-up. - follow_up_status_date (str): The date of the incident follow-up status. Format: “YYYY-MM-DD”. - last_modified_date (str): The date of the last modification. Format: “YYYY-MM-DD”.
Returns:: A DataFrame containing the created behavior record.
Return type:: pandas.DataFrame

create_class_assignments(internal_class_id=None, assignment_type=None, description=None, assignment_details=None, max_score=None, weight=None, not_to_be_graded=None, date_assigned=None, date_due=None, display_status=None)

Create class assignments.

Parameters:

internal_class_id (int, required) – The ID of the internal class.
assignment_type (int, required) – The type of the assignment.
description (str, required) – The description of the assignment.
assignment_details (str, required) – The details of the assignment.
max_score (int, required) – The maximum score of the assignment.
weight (int, required) – The weight of the assignment.
not_to_be_graded (bool, required) – Boolean indicating if the assignment should not be graded.
date_assigned (str, required) – The date when the assignment was assigned. Format: “YYYY-MM-DD”.
date_due (str, required) – The due date of the assignment. Format: “YYYY-MM-DD”.
display_status (int, required) – The display status of the assignment.

Returns:

A DataFrame containing the created class assignments.

Return type:

pandas.DataFrame

create_emergency_contacts(person_id, student_id, first_name, last_name, relationship, country, last_modified_date=None, middle_name=None, nick_name=None, legal_custody=None, pick_up=None, medical_notification=None, email_1=None, email_2=None, home_phone=None, mobile_phone=None, business_phone=None, address_1=None, address_2=None, city=None, state_province=None, postal_code=None, notes=None)

Create emergency contacts.

Parameters:

person_id (int) – Person ID.
student_id (int) – Student ID.
first_name (str) – First Name.
last_name (str) – Last Name.
relationship (int) – Relationship.
country (int) – Country.
last_modified_date (str, optional) – Last Modified Date.
middle_name (str, optional) – Middle Name.
nick_name (str, optional) – Nick Name.
legal_custody (bool, optional) – Legal Custody.
pick_up (bool, optional) – Pick Up.
medical_notification (bool, optional) – Medical Notification.
email_1 (str, optional) – Email 1.
email_2 (str, optional) – Email 2.
home_phone (str, optional) – Home Phone.
mobile_phone (str, optional) – Mobile Phone.
business_phone (str, optional) – Business Phone.
address_1 (str, optional) – Address 1.
address_2 (str, optional) – Address 2.
city (str, optional) – City.
state_province (str, optional) – State Province.
postal_code (str, optional) – Postal Code.
notes (str, optional) – Notes.

Returns:

A DataFrame containing the created emergency contacts.

Return type:

pandas.DataFrame

create_extended_care_classes(internal_course_id, class_id, description, status, school_year, begin_date, end_date, primary_grade_level_id, school_level_id, primary_teacher_id, room_id, virtual_meeting_url, x_api_revision=None)

Create extended care classes.

Parameters:

internal_course_id (int) – Course ID (Internal).
class_id (str) – Class ID.
description (str) – Description.
status (int) – Status.
school_year (int) – School Year.
begin_date (str) – Begin Date.
end_date (str) – End Date.
primary_grade_level_id (int) – Primary Grade Level ID.
school_level_id (int) – School Level.
primary_teacher_id (int) – Teacher ID.
room_id (int) – Room ID.
virtual_meeting_url (str) – Virtual Meeting URL.
x_api_revision (str, optional) – API Revision.

Returns:

A DataFrame containing the created extended care classes.

Return type:

pandas.DataFrame

create_extended_care_courses(name, subject_id, course_id, catalog_title, catalog_description)

Create extended care courses.

Parameters:

name (str) – The name of the course.
subject_id (str) – The ID of the subject.
course_id (str) – The ID of the course.
catalog_title (str) – The title of the course in the catalog.
catalog_description (str) – The description of the course in the catalog.

Returns:

A DataFrame containing the created extended care courses.

Return type:

pandas.DataFrame

create_health_patient_medications(patient_id, medication, start_date, end_date, dosage_instruction, notes, x_api_revision)

Create a new health patient medication record.

Parameters:

patient_id (int) – The ID of the patient.
medication (int) – The ID of the medication.
start_date (str) – The start date of the medication. Format: “YYYY-MM-DD”.
end_date (str) – The end date of the medication. Format: “YYYY-MM-DD”.
dosage_instruction (str) – The dosage instruction for the medication.
notes (str) – Additional notes for the medication.
x_api_revision (str) – The API revision value.

Returns:

A DataFrame containing the created health patient medication record.

Return type:

pandas.DataFrame

create_patient_condition(patient_id, data)

Create a new patient condition.

Parameters:

patient_id (str) – The ID of the patient.
data (dict) – The data for the new patient condition. - description (str): [Required] Description. - condition_code (int): [Required] Condition Code. - new_condition_code_description (str): [Required] Condition Code Description. - intervention_code (int): [Required] Intervention Code. - new_intervention_code_description (str): [Required] Intervention Code Description. - begin_date (str): Begin Date. - end_date (str): End Date. - notes (str): Notes. - critical (bool): [Required] Critical.

Returns:

A DataFrame containing the new patient condition.

Return type:

pandas.DataFrame

create_program_class(class_id, description, status, school_year, begin_date, end_date, primary_grade_level_id, internal_course_id, primary_teacher_id, room_id, virtual_meeting_url)

Create a program class.

Parameters:

class_id (str) – The ID of the class.
description (str) – The description of the class.
status (int) – The status of the class.
school_year (int) – The school year of the class.
begin_date (str) – The begin date of the class. Format: “YYYY-MM-DD”.
end_date (str) – The end date of the class. Format: “YYYY-MM-DD”.
primary_grade_level_id (int) – The primary grade level ID of the class.
internal_course_id (int) – The internal course ID of the class.
primary_teacher_id (int) – The primary teacher ID of the class.
room_id (int) – The room ID of the class.
virtual_meeting_url (str) – The virtual meeting URL of the class.

Returns:

A DataFrame containing the created program class information.

Return type:

pandas.DataFrame

create_program_enrollment(internal_class_id, person_id, currently_enrolled=True, late_date_enrolled=None, date_withdrawn=None, level=None, notes=None)

Create a program enrollment.

Parameters:

internal_class_id (int) – The internal class ID for the enrollment.
person_id (int) – The ID of the person for the enrollment.
currently_enrolled (bool, optional) – Whether the person is currently enrolled in the program. Default is True.
late_date_enrolled (str, optional) – The late date the person enrolled in the program. Format: “YYYY-MM-DD”.
date_withdrawn (str, optional) – The date the person withdrew from the program. Format: “YYYY-MM-DD”.
level (int, optional) – The enrollment level.
notes (str, optional) – Additional notes for the enrollment.

Returns:

A DataFrame containing the created program enrollment.

Return type:

pandas.DataFrame

create_programs_courses(school_route, data)

Create programs courses.

Parameters:

school_route (str) – The route for the school.
data (dict) – The data for creating the programs courses.

Returns:

A DataFrame containing the created programs courses.

Return type:

pandas.DataFrame

create_student_logistics_request(student_id, request_date, request_status, request_category, request_reason, request_notes, attendance_start_date, attendance_time, attendance_end_date, attendance_return_time, attendance_type, transportation_method, am_pm, bus_stop, bus_route, response_notes, internal_notes, extended_care_type, extended_care_arrival_time, extended_care_leave_time, posted, x_api_revision)

Create a logistics request for a student.

Parameters:

student_id (int) – The ID of the student.
request_date (str) – The date of the request. Format: “YYYY-MM-DD”.
request_status (int) – The status of the request.
request_category (str) – The category of the request.
request_reason (str) – The reason for the request.
request_notes (str) – Additional notes for the request.
attendance_start_date (str) – The start date for the attendance.
attendance_time (str) – The time of the attendance.
attendance_end_date (str) – The end date for the attendance.
attendance_return_time (str) – The return time for the attendance.
attendance_type (int) – The type of attendance.
transportation_method (str) – The method of transportation.
am_pm (int) – The AM/PM value for attendance.
bus_stop (int) – The bus stop ID.
bus_route (str) – The bus route.
response_notes (str) – Additional notes for the response.
internal_notes (str) – Internal notes regarding the request.
extended_care_type (str) – The type of extended care.
extended_care_arrival_time (str) – The arrival time for extended care.
extended_care_leave_time (str) – The leave time for extended care.
posted (bool) – Indicates if the request has been posted.

Returns:

A DataFrame containing the logistics request details.

Return type:

pandas.DataFrame

create_summer_classes(data)

Create summer classes.

Parameters:: data (dict) – The data for creating summer classes. - class_id (str, required): Class ID. - description (str, required): Description. - status (int): Status. - school_year (int): School Year. - begin_date (str): Begin Date. - end_date (str): End Date. - primary_grade_level (int): Primary Grade Level. - school_level (int): School Level. - internal_course_id (int, required): Course ID. - primary_teacher_id (int): Teacher ID. - room_id (int): Room ID. - virtual_meeting_url (str): Virtual Meeting URL.
Returns:: A DataFrame containing the created summer classes.
Return type:: pandas.DataFrame

create_summer_course(name, subject_id, course_id, catalog_title, catalog_description, x_api_revision=None)

Create a summer course.

Parameters:

name (str) – The name of the summer course.
subject_id (str) – The ID of the subject.
course_id (str) – The ID of the course.
catalog_title (str) – The title of the catalog.
catalog_description (str) – Notes for the catalog.

Returns:

A DataFrame containing the created summer course.

Return type:

pandas.DataFrame

create_summer_enrollments(internal_class_id: int, person_id: int, currently_enrolled: bool, late_date_enrolled: str, date_withdrawn: str, level: int, notes: str, x_api_revision=None)

Create summer enrollments.

Parameters:

internal_class_id (int) – Required. Internal Class ID.
person_id (int) – Required. Person ID.
currently_enrolled (bool) – Required. Currently Enrolled.
late_date_enrolled (str) – Required. Late Date Enrolled.
date_withdrawn (str) – Required. Date Withdrawn.
level (int) – Required. Enrollment Level.
notes (str) – Required. Notes.

Returns:

A DataFrame containing the created summer enrollments.

Return type:

pandas.DataFrame

delete_academics_class_assignment(id: int, internal_class_id: int, x_api_revision: str | None = None)

Delete an academic class assignment.

Parameters:

id (int) – The ID of the class assignment to be deleted.
internal_class_id (int) – The internal ID of the class to which the assignment belongs.
x_api_revision (str, optional) – The API revision.

Returns:

An empty DataFrame.

Return type:

pandas.DataFrame

delete_emergency_contact(id, x_api_revision=None)

Delete an emergency contact.

Parameters:: id (int) – The ID of the person whose emergency contact needs to be deleted.
Returns:: A DataFrame containing the response from the API after deleting the emergency contact.
Return type:: pandas.DataFrame

delete_student_logistics_request(id)

Delete a student logistics request.

Parameters:: id (int) – The ID of the student logistics request. (Required)
Returns:: An empty DataFrame.
Return type:: pandas.DataFrame

expand_dict_columns(df, columns_to_expand)

Expand DataFrame columns containing dictionaries into multiple columns.

Parameters:

df (pandas.DataFrame) – The DataFrame containing the columns with dictionaries.
columns_to_expand (list) – A list of column names containing the dictionaries.

Returns:

A new DataFrame with the expanded columns.

Return type:

pandas.DataFrame

extended_care_class_meeting_times(internal_class_id, id, x_api_revision: str, x_api_value_lists: str)

Get the meeting times for an extended care class.

Parameters:

internal_class_id (str) – The internal ID of the class.
id (str) – The ID of the extended care class.
x_api_revision (str) – The API revision value.
x_api_value_lists (str) – The API value lists.

Returns:

A DataFrame containing the meeting times for the extended care class.

Return type:

pandas.DataFrame

fetch_data_from_api(endpoint, headers, params)

Helper function to fetch data from an API endpoint using the GET method with pagination support.

Parameters:

endpoint (str) – The specific API endpoint to fetch data from.
headers (dict) – Headers required for API authentication and pagination.
params (dict) – Query parameters for filtering the data.

Returns:

A list containing the fetched data from all pages.

Return type:

list

get_academic_department(id)

Get the details of an academic department.

Parameters:: id (int) – The ID of the academic department.
Returns:: A DataFrame containing the details of the academic department.
Return type:: pandas.DataFrame

get_academics_block_groups(id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the details of an academic block group.

Parameters:

id (int) – The ID of the academic block group.
x_api_revision (str, optional) – The revision of the API.
x_api_value_lists (str, optional) – The value lists for the API.
x_page_number (int, optional) – The page number for pagination.
x_page_size (int, optional) – The page size for pagination.

Returns:

A DataFrame containing the details of the academic block group.

Return type:

pandas.DataFrame

get_academics_blocks_by_group(id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of academic blocks by group.

Parameters:: id (int, required) – The ID of the block group.
Returns:: A DataFrame containing the list of academic blocks by group.
Return type:: pandas.DataFrame

get_academics_calendar_rotation_days(block_schedule_id=None, date=None, date_on_or_after=None, date_on_or_before=None, day_id=None, rotation_id=None, school_year=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of calendar rotation days for academics.

Parameters:

block_schedule_id (int, optional) – Only return calendar rotation days for the specified block schedule ID.
date (str, optional) – Only return calendar rotation days for the specified date.
date_on_or_after (str, optional) – Only return calendar rotation days on or after the specified date.
date_on_or_before (str, optional) – Only return calendar rotation days on or before the specified date.
day_id (int, optional) – Only return calendar rotation days for the specified day ID.
rotation_id (int, optional) – Only return calendar rotation days for the specified rotation ID.
school_year (int, optional) – Only return calendar rotation days for the specified school year.

Returns:

A DataFrame containing the list of calendar rotation days.

Return type:

pandas.DataFrame

get_academics_class_assignments(internal_class_id=None, id=None, x_api_revision=None, x_api_value_lists=None)

Get the list of class assignments for a specific academic class.

Parameters:

internal_class_id (int, required) – The internal ID of the academic class.
id (int, optional) – The ID of the class assignment.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The API value lists.

Returns:

A DataFrame containing the list of class assignments.

Return type:

pandas.DataFrame

get_academics_class_meeting_times(internal_class_id=None, id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of meeting times for a specific academic class.

Parameters:

internal_class_id (int, optional) – The internal ID of the academic class.
id (int, optional) – The ID of the meeting time.

Returns:

A DataFrame containing the list of meeting times for the academic class.

Return type:

pandas.DataFrame

get_academics_class_permissions(id)

Get the class permissions for a specific ID.

Parameters:: id (int) – The ID of the class permission.
Returns:: A DataFrame containing the class permission data.
Return type:: pandas.DataFrame

get_academics_classes(id, x_api_revision=None, x_api_value_lists=None)

Get the details of an academic class.

Parameters:

id (int) – The ID of the academic class.
x_api_revision (str, optional) – The revision of the API.
x_api_value_lists (str, optional) – Include value lists in the response.

Returns:

A DataFrame containing the details of the academic class.

Return type:

pandas.DataFrame

get_academics_config_blocks(id, x_page_number=1, x_page_size=1000)

Get the specified academic configuration block.

Parameters:: id (int) – The ID of the academic configuration block.
Returns:: A DataFrame containing the specified academic configuration block.
Return type:: pandas.DataFrame

get_academics_config_blocks_by_group(block_group_id, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of academic config blocks by block groups.

Parameters:: block_group_id (int) – The ID of the block group.
Returns:: A DataFrame containing the list of academic config blocks by block groups.
Return type:: pandas.DataFrame

get_academics_configuration_block_schedules(x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of academic configuration block schedules.

Parameters:

x_api_revision (str, optional) – The API revision version.
x_api_value_lists (str, optional) – Include value lists in the response.
x_page_number (int, optional) – The page number of the response.
x_page_size (int, optional) – The number of entries per page.

Returns:

A DataFrame containing the list of academic configuration block schedules.

Return type:

pandas.DataFrame

get_academics_configuration_block_times(id=None, x_api_revision=None, x_api_value_lists=None, data=None)

Get the configuration of block times for academics.

Parameters:

id (int, required) – Period Time ID.
x_api_revision (str) – API Revision.
x_api_value_lists (str) – Include Value Lists in response.

Returns:

A DataFrame containing the configuration of block times for academics.

Return type:

pandas.DataFrame

get_academics_courses(id=None, x_api_revision=None, x_api_value_lists=None)

Get information about an academic course.

Parameters:: id (int) – The ID of the academic course.
Returns:: A DataFrame containing the information about the academic course.
Return type:: pandas.DataFrame

get_academics_departments(last_modified_date=None, on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of academic departments.

Parameters:

last_modified_date (str, optional) – Only return departments that were last modified on this specific date. Format: “YYYY-MM-DD”.
on_or_after_last_modified_date (str, optional) – Only return departments that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return departments that were last modified on or before this specific date. Format: “YYYY-MM-DD”.

Returns:

A DataFrame containing the list of academic departments.

Return type:

pandas.DataFrame

get_academics_enrollments(course_type=None, internal_class_id=None, person_id=None, school_year=None, subject=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of academic enrollments.

Parameters:

course_type (str, optional) – The type of the course.
internal_class_id (int, optional) – The internal ID of the class.
person_id (int, optional) – The ID of the person.
school_year (int, optional) – The school year.
subject (str, optional) – The subject of the course.

Returns:

A DataFrame containing the list of academic enrollments.

Return type:

pandas.DataFrame

get_academics_grading_periods(id)

Get the details of an academic grading period.

Parameters:: id (int) – The ID of the academic grading period.
Returns:: A DataFrame containing the details of the academic grading period.
Return type:: pandas.DataFrame

get_academics_numeric_grades(class_id=None, enrollment_id=None, grading_period_id=None, last_modified_date=None, locked=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of numeric grades for academics.

Parameters:

class_id (int, optional) – Internal ID of the class.
enrollment_id (int, optional) – ID of the enrollment.
grading_period_id (int, optional) – ID of the grading period.
last_modified_date (str, optional) – Last modified date. Format: “YYYY-MM-DD”.
locked (bool, optional) – Indicates if the grades are locked.

Returns:

A DataFrame containing the list of numeric grades for academics.

Return type:

pandas.DataFrame

get_academics_permissions(class_id=None, course_id=None, last_modified_date=None, on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, person_id=None, school_level=None, school_year=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of academic permissions.

Parameters:

class_id (int, optional) – The ID of the class.
course_id (int, optional) – The ID of the course.
last_modified_date (str, optional) – Only return permissions that were last modified on this specific date. Format: “YYYY-MM-DD”.
on_or_after_last_modified_date (str, optional) – Only return permissions that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return permissions that were last modified on or before this specific date. Format: “YYYY-MM-DD”.
person_id (int, optional) – Only return permissions for the specified person ID.
school_level (int, optional) – Only return permissions for the specified school level.
school_year (int, optional) – Only return permissions for the specified school year.

Returns:

A DataFrame containing the list of academic permissions.

Return type:

pandas.DataFrame

get_academics_qualitative_grades(id, enrollment_id, grading_period, student, rubric, rubric_category, rubric_criteria, proficiency_level, comment, locked, x_api_revision=None, x_api_value_lists=None)

Get the qualitative grades for a specific enrollment.

Parameters:

id (int) – The ID of the grade.
enrollment_id (int) – The ID of the enrollment.
grading_period (dict) – The grading period information.
student (dict) – The student information.
rubric (dict) – The rubric information.
rubric_category (dict) – The rubric category information.
rubric_criteria (dict) – The rubric criteria information.
proficiency_level (str) – The proficiency level.
comment (str) – The comments for the grade.
locked (bool) – Flag indicating if the grade is locked.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – Include value lists in the response.

Returns:

A DataFrame containing the qualitative grades.

Return type:

pandas.DataFrame

get_academics_rooms(id)

Get a specific academic room.

Parameters:: id (int) – The ID of the academic room.
Returns:: A DataFrame containing the specific academic room.
Return type:: pandas.DataFrame

get_academics_rotation_days(last_modified_date=None, on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, rotation_id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of academic rotation days.

Parameters:

last_modified_date (str, optional) – Only return rotation days that were last modified on this specific date. Format: “YYYY-MM-DD”.
on_or_after_last_modified_date (str, optional) – Only return rotation days that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return rotation days that were last modified on or before this specific date. Format: “YYYY-MM-DD”.
rotation_id (int, optional) – Only return rotation days for the specified rotation ID.

Returns:

A DataFrame containing the list of academic rotation days.

Return type:

pandas.DataFrame

get_academics_rubric_categories(archived=False, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of academic rubric categories.

Parameters:: archived (bool, optional) – Filter rubric categories by archived status.
Returns:: A DataFrame containing the list of academic rubric categories.
Return type:: pandas.DataFrame

get_academics_rubric_criteria(id)

Get the rubric criteria for a specific ID.

Parameters:: id (int) – The ID of the rubric criteria.
Returns:: A DataFrame containing the rubric criteria information.
Return type:: pandas.DataFrame

get_academics_rubric_scales(id=None, x_api_revision=None, x_api_value_lists=None)

Get the rubric scales for academics.

Parameters:

id (int, required) – The ID of the rubric scale.
x_api_revision (str, optional) – API Revision.
x_api_value_lists (str, optional) – Include Value Lists in response. Allowed value: include.

Returns:

A DataFrame containing the rubric scales for academics.

Return type:

pandas.DataFrame

get_academics_rubrics(archived=None, category=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of academic rubrics.

Parameters:

archived (bool, optional) – Indicates whether to include archived rubrics.
category (int, optional) – The ID of the rubric category.

Returns:

A DataFrame containing the list of academic rubrics.

Return type:

pandas.DataFrame

get_academics_subjects(id, x_api_revision=None, x_api_value_lists=None)

Get the academic subject with the specified ID.

Parameters:

id (int) – The ID of the academic subject.
x_api_revision (str, optional) – The revision of the API.
x_api_value_lists (str, optional) – Include value lists in the response.

Returns:

A DataFrame containing the academic subject.

Return type:

pandas.DataFrame

get_admission_applicant(applicant_id)

Get the details of an admission applicant.

Parameters:: applicant_id (int) – The ID of the applicant.
Returns:: A DataFrame containing the details of the admission applicant.
Return type:: pandas.DataFrame

get_admission_applicant_relationships(applicant_id, id, x_api_revision=None, x_api_value_lists=None)

Get the list of admission applicant relationships.

Parameters:

applicant_id (int) – The ID of the applicant.
id (int) – The ID of the relationship.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The value list.

Returns:

A DataFrame containing the list of admission applicant relationships.

Return type:

pandas.DataFrame

get_admission_applicants(date_of_birth=None, email=None, first_name=None, last_name=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of admission applicants.

Parameters:

date_of_birth (str, required) – Birthday of the applicant. Format: “YYYY-MM-DD”.
email (str, required) – Email address of the applicant.
first_name (str, required) – First name of the applicant.
last_name (str, required) – Last name of the applicant.

Returns:

A DataFrame containing the list of admission applicants.

Return type:

pandas.DataFrame

get_admission_applications(applicant_id=None, application_status=None, first_name=None, last_name=None, year_applying_for=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of admission applications.

Parameters:

applicant_id (str, optional) – The ID of the applicant.
application_status (str, optional) – The status of the application.
first_name (str, optional) – The first name of the applicant.
last_name (str, optional) – The last name of the applicant.
year_applying_for (int, optional) – The year the applicant is applying for.

Returns:

A DataFrame containing the list of admission applications.

Return type:

pandas.DataFrame

get_admission_citizenships(id=None, x_api_revision=None, x_api_value_lists=None)

Get the details of a specific admission citizenship or a list of admission citizenships.

Parameters:

id (int, optional) – The ID of the admission citizenship.
x_api_revision (str, optional) – The API revision for the request.
x_api_value_lists (str, optional) – Include value lists in the response. Allowed value: “include”.

Returns:

A DataFrame containing the details of the admission citizenship(s).

Return type:

pandas.DataFrame

get_admission_config_years(id=None, x_api_revision=None, x_api_value_lists=None)

Get the admission configuration years.

Parameters:: id (int, optional) – The ID of the admission configuration year.
Returns:: A DataFrame containing the admission configuration years.
Return type:: pandas.DataFrame

get_admission_configuration_checklists(id=None, school_year=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of admission configuration checklists.

Parameters:

id (int, optional) – The Registration Season Checklist Item ID.
school_year (int, optional) – The School Year.

Returns:

A DataFrame containing the list of admission configuration checklists.

Return type:

pandas.DataFrame

get_admission_configuration_years(x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of admission configuration years.

Parameters:

x_api_revision (str, optional) – API Revision.
x_api_value_lists (str, optional) – Include Value Lists in response.
x_page_number (int, optional) – Page number. Default: 1.
x_page_size (int, optional) – Number of records per page. Default: 100.

Returns:

A DataFrame containing the list of admission configuration years.

Return type:

pandas.DataFrame

get_admission_household_members(household_id, first_name=None, last_name=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of household members for a specific admission household.

Parameters:

household_id (int) – The ID of the admission household.
first_name (str, optional) – Only return household members with the specified first name.
last_name (str, optional) – Only return household members with the specified last name.
x_api_revision (str, optional) – The API revision value.
x_api_value_lists (str, optional) – The API value lists.
x_page_number (int, optional) – The page number for pagination.
x_page_size (int, optional) – The page size for pagination.

Returns:

A DataFrame containing the list of household members.

Return type:

pandas.DataFrame

get_admission_households(address_1=None, address_2=None, address_3=None, city=None, country=None, name=None, postal_code=None, state=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of admission households.

Parameters:

address_1 (str, optional) – Address 1.
address_2 (str, optional) – Address 2.
address_3 (str, optional) – Address 3.
city (str, optional) – City.
country (int, optional) – Country.
name (str, optional) – Name.
postal_code (str, optional) – Postal Code.
state (str, optional) – State.

Returns:

A DataFrame containing the list of admission households.

Return type:

pandas.DataFrame

get_admission_languages(person_id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of admission languages.

Parameters:

person_id (int, optional) – The ID of the person.
x_api_revision (str, optional) – The version of the API.
x_api_value_lists (str, optional) – The value lists for the API.
x_page_number (int, optional) – The page number for pagination.
x_page_size (int, optional) – The page size for pagination.

Returns:

A DataFrame containing the list of admission languages.

Return type:

pandas.DataFrame

get_admission_relative_relationships(relative_id, id, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of relative relationships for an admission.

Parameters:

relative_id (int) – The ID of the relative.
id (int) – The ID of the admission.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The API value lists.
x_page_number (int, optional) – The page number for pagination.
x_page_size (int, optional) – The page size for pagination.

Returns:

A DataFrame containing the list of relative relationships for an admission.

Return type:

pandas.DataFrame

get_admission_relatives(email=None, first_name=None, last_name=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of admission relatives.

Parameters:

email (str, optional) – The email address of the relative.
first_name (str, optional) – The first name of the relative.
last_name (str, optional) – The last name of the relative.

Returns:

A DataFrame containing the list of admission relatives.

Return type:

pandas.DataFrame

get_application_checklists(application_id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of application checklists.

Parameters:

application_id (int, required) – The ID of the application.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The API value lists.
x_page_number (int, optional) – The page number for pagination.
x_page_size (int, optional) – The page size for pagination.

Returns:

A DataFrame containing the list of application checklists.

Return type:

pandas.DataFrame

get_assignment_grades(assignment_id, id, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the assignment grades.

Parameters:

assignment_id (int) – The ID of the assignment.
id (int) – The ID of the grade.

Returns:

A DataFrame containing the assignment grades.

Return type:

pandas.DataFrame

get_athletics_rosters(internal_class_id=None, person_id=None, school_year=None, sport=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of athletics rosters.

Parameters:

internal_class_id (int, optional) – Internal Class ID.
person_id (int, optional) – Person ID.
school_year (int, optional) – School Year.
sport (int, optional) – Sport.

Returns:

A DataFrame containing the list of athletics rosters.

Return type:

pandas.DataFrame

get_athletics_sports(id, x_api_revision=None, x_api_value_lists=None)

Get the details of a specific athletics sport.

Parameters:: id (int) – The internal course ID.
Returns:: A DataFrame containing the details of the athletics sport.
Return type:: pandas.DataFrame

get_athletics_teams(id)

Get the details of an athletics team.

Parameters:: id (string) – The ID of the team.
Returns:: A DataFrame containing the details of the athletics team.
Return type:: pandas.DataFrame

get_behavior(id=None, incident_date=None, incident_type=None, student_id=None, reporting_person_id=None, assigned_to_person_id=None, internal_class_id=None, class_name=None, incident_notes=None, behavior_points=None, status=None, status_date=None, outcome_type=None, outcome_date=None, outcome_notes=None, follow_up_status=None, follow_up_status_date=None, last_modified_date=None, value_lists=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get behavior data.

Parameters:

id (int, optional) – Behavior ID.
incident_date (str, optional) – Incident Date (Format: “YYYY-MM-DD”).
incident_type (int, optional) – Incident Type.
student_id (int, optional) – Student ID.
reporting_person_id (int, optional) – Reporting Person ID.
assigned_to_person_id (int, optional) – Assigned To Person ID.
internal_class_id (int, optional) – Class ID.
class_name (str, optional) – Description.
incident_notes (str, optional) – Incident Notes.
behavior_points (int, optional) – Behavior Points.
status (int, optional) – Status.
status_date (str, optional) – Status Date (Format: “YYYY-MM-DD”).
outcome_type (int, optional) – Outcome Type.
outcome_date (str, optional) – Outcome Date (Format: “YYYY-MM-DD”).
outcome_notes (str, optional) – Outcome Notes
follow_up_status (int, optional) – Follow Up Status.
follow_up_status_date (str, optional) – Follow Up Status Date (Format: “YYYY-MM-DD”).
last_modified_date (str, optional) – Update Date (Format: “YYYY-MM-DD”).
value_lists (List[Dict[str, Any]], optional) – Value lists.
x_api_revision (str, optional) – API Revision.
x_api_value_lists (str, optional) – Include Value Lists in response (Allowed value: “include”).
x_page_number (int, optional) – Page number for pagination. Defaults to 1.
x_page_size (int, optional) – Page size for pagination. Defaults to 1000.

Returns:

A DataFrame containing the behavior data.

Return type:

pandas.DataFrame

get_block_schedule(id, x_api_revision=None, x_api_value_lists=None)

Get the block schedule by ID.

Parameters:

id (int) – The ID of the block schedule.
x_api_revision (str, optional) – API Revision.
x_api_value_lists (str, optional) – Include Value Lists in response. Allowed value: include.

Returns:

A DataFrame containing the block schedule.

Return type:

pandas.DataFrame

get_boarding_dorm_students(id=None, internal_dorm_id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of boarding dorm students.

Parameters:

id (int, optional) – The ID of the boarding dorm student.
internal_dorm_id (int, optional) – The ID of the internal dorm.

Returns:

A DataFrame containing the list of boarding dorm students.

Return type:

pandas.DataFrame

get_boarding_dorms(id)

Get a specific boarding dorm.

Parameters:: id (int) – The internal ID of the dorm.
Returns:: A DataFrame containing the specific boarding dorm.
Return type:: pandas.DataFrame

get_calendar_rotation_day(id, school_year, date, rotation, x_api_revision=None, x_api_value_lists=None)

Get the calendar rotation day with the specified ID.

Parameters:

id (int) – The ID of the calendar day rotation.
school_year (int) – The school year of the calendar day rotation.
date (str) – The date of the calendar day rotation. Format: “YYYY-MM-DD”.
rotation (dict) – The rotation details for the calendar day rotation.
x_api_revision (str, optional) – API revision header.
x_api_value_lists (str, optional) – Include value lists in the response header.

Returns:

A DataFrame containing the calendar rotation day details.

Return type:

pandas.DataFrame

get_class(id)

Get the details of a specific class.

Parameters:: id (int) – The ID of the class to retrieve.
Returns:: A DataFrame containing the details of the class.
Return type:: pandas.DataFrame

get_class_attendance(internal_class_id, attendance_date=None, block_description=None, block_id=None, on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of class attendance.

Parameters:

internal_class_id (int) – The internal ID of the class.
attendance_date (str, optional) – The date of the attendance in format “YYYY-MM-DD”.
block_description (str, optional) – The description of the class block.
block_id (int, optional) – The ID of the class block.
on_or_after_last_modified_date (str, optional) – Only return attendance records that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return attendance records that were last modified on or before this specific date. Format: “YYYY-MM-DD”.

Returns:

A DataFrame containing the list of class attendance.

Return type:

pandas.DataFrame

get_classes(on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, primary_teacher_id=None, room_id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of academic classes.

Parameters:

on_or_after_last_modified_date (str, optional) – Only return classes that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return classes that were last modified on or before this specific date. Format: “YYYY-MM-DD”.
primary_teacher_id (int, optional) – Only return classes taught by the specified primary teacher ID.
room_id (int, optional) – Only return classes taught in the specified room ID.

Returns:

A DataFrame containing the list of academic classes.

Return type:

pandas.DataFrame

get_config_rotation_days(id)

Get a specific rotation day configuration.

Parameters:: id (int) – The ID of the rotation day configuration.
Returns:: A DataFrame containing the specific rotation day configuration.
Return type:: pandas.DataFrame

get_configuration_blocks_periods(x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of configuration blocks periods.

Parameters:

x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The API value lists.
x_page_number (int, optional) – The page number.
x_page_size (int, optional) – The page size.

Returns:

A DataFrame containing the list of configuration blocks periods.

Return type:

pandas.DataFrame

get_contact_info(id, x_api_revision=None, x_api_value_lists=None)

Get contact information for a specific person.

Parameters:: id (int) – The ID of the person.
Returns:: A DataFrame containing the contact information for the person.
Return type:: pandas.DataFrame

get_courses(id, x_api_revision=None, x_api_value_lists=None)

Get the details of a specific course.

Parameters:

id (int) – The internal ID of the course.
x_api_revision (str, optional) – API Revision header.
x_api_value_lists (str, optional) – Include Value Lists in response header.

Returns:

A DataFrame containing the details of the course.

Return type:

pandas.DataFrame

get_directory_preferences_household(id, x_api_revision=None, x_api_value_lists=None)

Read the directory preferences for a household.

Parameters:

id (int) – The ID of the household.
x_api_revision (str, optional) – The X-API-Revision header value.
x_api_value_lists (str, optional) – The X-API-Value-Lists header value.

Returns:

A DataFrame containing the directory preferences for the household.

Return type:

pandas.DataFrame

get_directory_preferences_person(id, x_api_revision=None, x_api_value_lists=None)

Get the directory preferences for a specific person.

Parameters:

id (int) – The ID of the person.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – Include value lists in the response.

Returns:

A DataFrame containing the directory preferences for the person.

Return type:

pandas.DataFrame

get_directory_type_configurations(category=None, configuration=None, directory_type=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of directory type configurations.

Parameters:

category (str, optional) – The category of the configuration.
configuration (str, optional) – The specific configuration.
directory_type (int, optional) – The directory type.

Returns:

A DataFrame containing the list of directory type configurations.

Return type:

pandas.DataFrame

get_dorm_attendance(internal_dorm_id, on_or_after_attendance_date=None, on_or_after_last_modified_date=None, on_or_before_attendance_date=None, on_or_before_last_modified_date=None, school_year=None, X_API_Revision=None, X_API_Value_Lists=None, X_Page_Number=1, X_Page_Size=1000)

Retrieve the list of dorm attendance records.

Parameters:

internal_dorm_id (int) – The internal ID of the dorm.
on_or_after_attendance_date (str, optional) – Only return attendance records on or after this date. Format: “YYYY-MM-DD”.
on_or_after_last_modified_date (str, optional) – Only return attendance records that were last modified on or after this date. Format: “YYYY-MM-DD”.
on_or_before_attendance_date (str, optional) – Only return attendance records on or before this date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return attendance records that were last modified on or before this date. Format: “YYYY-MM-DD”.
school_year (int, optional) – Only return attendance records from the specified school year.
X_API_Revision (str, optional) – The API revision version.
X_API_Value_Lists (str, optional) – The value lists to include in the response.
X_Page_Number (int, optional) – The page number of the results.
X_Page_Size (int, optional) – The number of records per page.

Returns:

A DataFrame containing the list of dorm attendance records.

Return type:

pandas.DataFrame

get_emergency_contact(id)

Get the emergency contact with the specified ID.

Parameters:: id (int) – The ID of the emergency contact.
Returns:: A DataFrame containing the emergency contact information.
Return type:: pandas.DataFrame

get_emergency_contacts(legal_custody=None, medical_notification=None, on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, person_id=None, pick_up=None, relationship=None, student_id=None, student_role=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of emergency contacts.

Parameters:

legal_custody (bool, optional) – Legal custody indicator.
medical_notification (bool, optional) – Medical notification indicator.
on_or_after_last_modified_date (str, optional) – Only return contacts that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return contacts that were last modified on or before this specific date. Format: “YYYY-MM-DD”.
person_id (int, optional) – The ID of the person.
pick_up (bool, optional) – Pick up indicator.
relationship (int, optional) – The ID of the relationship.
student_id (int, optional) – The ID of the student.
student_role (int, optional) – The role of the student.

Returns:

A DataFrame containing the list of emergency contacts.

Return type:

pandas.DataFrame

get_enrollment(id)

Get enrollment details for a specific enrollment ID.

Parameters:: id (int) – The ID of the enrollment.
Returns:: A DataFrame containing the enrollment details.
Return type:: pandas.DataFrame

get_event(id, x_api_revision=None, x_api_value_lists=None)

Get the details of a specific event.

Parameters:

id (int) – The ID of the event.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – Include Value Lists in the response.

Returns:

A DataFrame containing the details of the event.

Return type:

pandas.DataFrame

get_events(campus=None, event_type=None, grade_level=None, internal_group_id=None, on_or_after_start_date=None, on_or_after_update_date=None, on_or_before_end_date=None, on_or_before_update_date=None, public=None, resource_id=None, school_level=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of events.

Parameters:

campus (int, optional) – The ID of the campus.
event_type (int, optional) – The ID of the event type.
grade_level (int, optional) – The grade level of the event.
internal_group_id (int, optional) – The ID of the internal group.
on_or_after_start_date (str, optional) – Only return events that start on or after this specific date. Format: “YYYY-MM-DD”.
on_or_after_update_date (str, optional) – Only return events that were updated on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_end_date (str, optional) – Only return events that end on or before this specific date. Format: “YYYY-MM-DD”.
on_or_before_update_date (str, optional) – Only return events that were updated on or before this specific date. Format: “YYYY-MM-DD”.
public (bool, optional) – Indicates if the event is public or not.
resource_id (int, optional) – The ID of the resource associated with the event.
school_level (int, optional) – The ID of the school level.

Returns:

A DataFrame containing the list of events.

Return type:

pandas.DataFrame

get_events_athletics(id=None, x_api_revision=None, x_api_value_lists=None)

Get the details of an athletics event.

Parameters:

id (int) – The ID of the athletics event.
x_api_revision (str, optional) – The revision number of the API.
x_api_value_lists (str, optional) – The value lists required for the API.

Returns:

A DataFrame containing the details of the athletics event.

Return type:

pandas.DataFrame

get_extended_care_class_attendance(internal_class_id, id, x_api_revision=None, x_api_value_lists=None)

Get extended care class attendance.

Parameters:

internal_class_id (int) – The internal ID of the class.
id (int) – The ID of the attendance record.
x_api_revision (str, optional) – The API revision version.
x_api_value_lists (str, optional) – The value lists.

Returns:

A DataFrame containing the extended care class attendance.

Return type:

pandas.DataFrame

get_extended_care_class_meeting_times(internal_class_id, day=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of extended care class meeting times.

Parameters:

internal_class_id (int) – The internal class ID.
day (str, optional) – The description of the day.

Returns:

A DataFrame containing the list of extended care class meeting times.

Return type:

pandas.DataFrame

get_extended_care_classes(on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, primary_teacher_id=None, room_id=None, school_year=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of extended care classes.

Parameters:

on_or_after_last_modified_date (str, optional) – Only return classes that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return classes that were last modified on or before this specific date. Format: “YYYY-MM-DD”.
primary_teacher_id (int, optional) – Only return classes taught by the specified primary teacher ID.
room_id (int, optional) – Only return classes taught in the specified room ID.
school_year (int, optional) – Only return classes from the specified school year.
x_api_revision (str, optional) – The value of the X-API-Revision header.
x_api_value_lists (str, optional) – The value of the X-API-Value-Lists header.
x_page_number (int, optional) – The page number of the results to retrieve. Default is 1.
x_page_size (int, optional) – The number of results per page. Default is 1000.

Returns:

A DataFrame containing the list of extended care classes.

Return type:

pandas.DataFrame

get_extended_care_course(id=None, name=None, subject_id=None, subject_description=None, course_id=None, catalog_title=None, catalog_description=None, last_modified_date=None, value_lists=None)

Get the details of an extended care course.

Parameters:

id (int, required) – Internal Course ID.
name (str, required) – Course Name.
subject_id (int, required) – Subject ID.
subject_description (str, required) – Description of the subject.
course_id (str, required) – Course ID.
catalog_title (str, required) – Catalog Title.
catalog_description (str, required) – Catalog Description.
last_modified_date (str, required) – Last Modified Date. Format: “YYYY-MM-DD”.
value_lists (list, optional) – A list of value lists. Present only with header X-API-Value-Lists=include.

Returns:

A DataFrame containing the details of the extended care course.

Return type:

pandas.DataFrame

get_extended_care_courses(on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of extended care courses.

Parameters:

on_or_after_last_modified_date (str, optional) – Only return courses that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return courses that were last modified on or before this specific date. Format: “YYYY-MM-DD”.
x_api_revision (str, optional) – API Revision.
x_api_value_lists (str, optional) – Include Value Lists in response. Allowed value: “include”.
x_page_number (int, optional) – Page number. Default: 1.
x_page_size (int, optional) – Number of records per page. Default: 100.

Returns:

A DataFrame containing the list of extended care courses.

Return type:

pandas.DataFrame

get_extended_care_registration(id)

Get information about an extended care registration.

Parameters:: id (int) – The ID of the extended care registration.
Returns:: A DataFrame containing the information about the extended care registration.
Return type:: pandas.DataFrame

get_extended_care_registrations(internal_class_id=None, person_id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of extended care registrations.

Parameters:

internal_class_id (int, optional) – Internal Class ID.
person_id (int, optional) – Person ID.

Returns:

A DataFrame containing the list of extended care registrations.

Return type:

pandas.DataFrame

get_health_patient_conditions(patient_id, id, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of conditions for a specific patient.

Parameters:

patient_id (int) – The ID of the patient.
id (int) – The ID of the condition.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The API value lists.
x_page_number (int, optional) – The page number for pagination.
x_page_size (int, optional) – The page size for pagination.

Returns:

A DataFrame containing the list of conditions for the patient.

Return type:

pandas.DataFrame

get_health_patients(id)

Get information about a specific health patient.

Parameters:: id (int) – The ID of the health patient.
Returns:: A DataFrame containing the information about the health patient.
Return type:: pandas.DataFrame

get_households(id)

Get information about a specific household.

Parameters:: id (int) – The ID of the household.
Returns:: A DataFrame containing the information about the household.
Return type:: pandas.DataFrame

get_master_attendance(id)

Retrieve the master attendance record for a specific ID.

Parameters:: id (int) – The ID of the master attendance record.
Returns:: A DataFrame containing the master attendance record.
Return type:: pandas.DataFrame

get_parent(id)

Get the information of a parent.

Parameters:: id (int) – The ID of the parent.
Returns:: A DataFrame containing the information of the parent.
Return type:: pandas.DataFrame

get_parents(household_id=None, include_deceased=None, role=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of parents.

Parameters:

household_id (int, optional) – The ID of the household.
include_deceased (bool, optional) – Flag to include deceased parents.
role (str, optional) – The role of the parent.

Returns:

A DataFrame containing the list of parents.

Return type:

pandas.DataFrame

get_patient_medication(id=None, patient_id=None, x_api_revision=None, x_api_value_lists=None)

Get the details of a patient’s medication.

Parameters:

id (int, required) – The ID of the medication.
patient_id (int, required) – The ID of the patient.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The API value lists.

Returns:

A DataFrame containing the details of the patient’s medication.

Return type:

pandas.DataFrame

get_patient_medications(patient_id, medication=None, on_or_after_start_date=None, on_or_before_start_date=None, on_or_after_end_date=None, on_or_before_end_date=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of medications for a specific patient.

Parameters:

patient_id (int) – The ID of the patient.
medication (int, optional) – The ID of the medication.
on_or_after_start_date (str, optional) – Only return medications that start on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_start_date (str, optional) – Only return medications that start on or before this specific date. Format: “YYYY-MM-DD”.
on_or_after_end_date (str, optional) – Only return medications that end on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_end_date (str, optional) – Only return medications that end on or before this specific date. Format: “YYYY-MM-DD”.

Returns:

A DataFrame containing the list of medications for the patient.

Return type:

pandas.DataFrame

get_person_relationships(id, emergency=None, legal_custody=None, on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, pick_up=None, relationship=None, resident=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of person relationships.

Parameters:

id (int) – The ID of the person.
emergency (bool, optional) – Filter relationships by emergency flag.
legal_custody (bool, optional) – Filter relationships by legal custody flag.
on_or_after_last_modified_date (str, optional) – Filter relationships that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Filter relationships that were last modified on or before this specific date. Format: “YYYY-MM-DD”.
pick_up (bool, optional) – Filter relationships by pick up flag.
relationship (int, optional) – Filter relationships by relationship ID.
resident (bool, optional) – Filter relationships by resident flag.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The value lists.
x_page_number (int, optional) – The page number for pagination. Default is 1.
x_page_size (int, optional) – The page size for pagination. Default is 1000.

Returns:

A DataFrame containing the list of person relationships.

Return type:

pandas.DataFrame

get_program_classes(on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, primary_teacher_id=None, room_id=None, school_year=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of program classes.

Parameters:

on_or_after_last_modified_date (str, optional) – Only return classes that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return classes that were last modified on or before this specific date. Format: “YYYY-MM-DD”.
primary_teacher_id (int, optional) – Only return classes taught by the specified primary teacher ID.
room_id (int, optional) – Only return classes taught in the specified room ID.
school_year (int, optional) – Only return classes from the specified school year.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The value lists for the API.
x_page_number (int, optional) – The page number for pagination. Default is 1.
x_page_size (int, optional) – The page size for pagination. Default is 1000.

Returns:

A DataFrame containing the list of program classes.

Return type:

pandas.DataFrame

get_programs_class(id)

Get details of a specific program class.

Parameters:: id (int) – The internal ID of the class.
Returns:: A DataFrame containing the details of the program class.
Return type:: pandas.DataFrame

get_programs_class_attendance(id=None, internal_class_id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the programs class attendance.

Parameters:

id (int, required) – The ID of the program class attendance.
internal_class_id (int, required) – The internal ID of the class.

Returns:

A DataFrame containing the programs class attendance data.

Return type:

pandas.DataFrame

get_programs_class_meeting_times(id, internal_class_id, date=None, start_time=None, end_time=None, grading_period=None, day=None, block=None, room=None, value_lists=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the class meeting times for a specific program.

Parameters:

id (int) – The ID of the program.
internal_class_id (int) – The internal ID of the class.
date (str, optional) – The date of the meeting time. Format: “YYYY-MM-DD”.
start_time (str, optional) – The start time of the meeting time. Format: “HH:MM”.
end_time (str, optional) – The end time of the meeting time. Format: “HH:MM”.
grading_period (dict, optional) – The grading period information.
day (dict, optional) – The day information.
block (dict, optional) – The block information.
room (dict, optional) – The room information.
value_lists (list, optional) – An array of objects for value lists.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The value lists string for API.
x_page_number (int, optional) – The page number for pagination.
x_page_size (int, optional) – The page size for pagination.

Returns:

A DataFrame containing the class meeting times.

Return type:

pandas.DataFrame

get_programs_courses(id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the details of a specific course in a program.

Parameters:: id (int) – The internal course ID.
Returns:: A DataFrame containing the details of the course in a program.
Return type:: pandas.DataFrame

get_programs_enrollments(id=None, data=None)

Get the enrollment details for a specific program.

Parameters:

id (int) – The ID of the enrollment.
data (dict) – The data for the enrollment including enrollment ID, internal class ID, person ID, grade level ID, currently enrolled status, late date enrolled, date withdrawn, enrollment level, and notes.

Returns:

A DataFrame containing the enrollment details.

Return type:

pandas.DataFrame

get_qualitative_grades(class_id=None, enrollment_id=None, grading_period_id=None, last_modified_date=None, on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, rubric_category_id=None, rubric_criteria_id=None, rubric_id=None, school_year=None, student_id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=100)

Get the list of qualitative grades.

Parameters:

class_id (int, optional) – Internal Class ID.
enrollment_id (int, optional) – Enrollment ID.
grading_period_id (int, optional) – ID.
last_modified_date (str, optional) – Last Modified Date.
on_or_after_last_modified_date (str, optional) – Last Modified Date.
on_or_before_last_modified_date (str, optional) – Last Modified Date.
rubric_category_id (int, optional) – ID.
rubric_criteria_id (int, optional) – Rubric Criteria ID.
rubric_id (int, optional) – ID.
school_year (int, optional) – School Year.
student_id (int, optional) – Person ID.

Returns:

A DataFrame containing the list of qualitative grades.

Return type:

pandas.DataFrame

get_relationships(id, x_api_revision=None, x_api_value_lists=None)

Get the relationships for a specific person.

Parameters:: id (int) – The ID of the person.
Returns:: A DataFrame containing the relationships for the specified person.
Return type:: pandas.DataFrame

get_report_card_academic_classifications(id, person_id, x_api_revision=None, x_api_value_lists=None)

Get the academic classifications for a specific person in a report card.

Parameters:

id (int) – The ID of the report card.
person_id (int) – The ID of the person.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The API value lists.

Returns:

A DataFrame containing the academic classifications.

Return type:

pandas.DataFrame

get_report_card_documents(id)

Get the academic document for a person.

Parameters:: id (int) – Person Academic Document ID.
Returns:: A DataFrame containing the academic document.
Return type:: pandas.DataFrame

get_report_card_enrollments(id, x_api_revision=None, x_api_value_lists=None)

Read the report card enrollments.

Parameters:: id (int) – The enrollment ID.
Returns:: A DataFrame containing the report card enrollments.
Return type:: pandas.DataFrame

get_report_card_gpas(id, person_id, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the GPAs for a specific report card.

Parameters:

id (int) – The ID of the report card.
person_id (int) – The ID of the person.

Returns:

A DataFrame containing the GPAs for the specified report card.

Return type:

pandas.DataFrame

get_report_card_qualitative_grades(enrollment_id, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of report card qualitative grades.

Parameters:

enrollment_id (int) – The ID of the enrollment.
x_api_revision (str, optional) – The revision of the API.
x_api_value_lists (str, optional) – The value lists for the API.
x_page_number (int, optional) – The page number for pagination.
x_page_size (int, optional) – The page size for pagination.

Returns:

A DataFrame containing the list of report card qualitative grades.

Return type:

pandas.DataFrame

get_report_card_students_gpas(person_id, grading_period=None, school_year=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the GPA of the specified person for the report card.

Parameters:

person_id (int) – The ID of the person.
grading_period (int, optional) – The grading period ID.
school_year (int, optional) – The school year.

Returns:

A DataFrame containing the GPA of the specified person for the report card.

Return type:

pandas.DataFrame

get_report_cards_class_curriculum(id, internal_class_id, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the curriculum for a specific class in the report cards.

Parameters:

id (int) – The ID of the report card.
internal_class_id (int) – The internal class ID.

Returns:

A DataFrame containing the curriculum for the specified class in the report cards.

Return type:

pandas.DataFrame

get_report_cards_class_teachers(id=None, internal_class_id=None, x_api_revision=None, x_api_value_lists=None)

Get the list of report card class teachers.

Parameters:

id (int, optional) – The ID of the report card.
internal_class_id (int, optional) – The ID of the internal class.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The API value lists.

Returns:

A DataFrame containing the list of report card class teachers.

Return type:

pandas.DataFrame

get_report_cards_documents(academic_document_id=None, grading_period_id=None, person_id=None, school_year_id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of report card documents.

Parameters:

academic_document_id (int, optional) – The ID of the academic document.
grading_period_id (int, optional) – The ID of the grading period.
person_id (int, optional) – The ID of the person.
school_year_id (int, optional) – The ID of the school year.

Returns:

A DataFrame containing the list of report card documents.

Return type:

pandas.DataFrame

get_report_cards_numeric_grades(enrollment_id: int, id: int, x_api_revision: str, x_api_value_lists: str)

Get the numeric grades for a specific report card enrollment.

Parameters:

enrollment_id (int) – The ID of the report card enrollment.
id (int) – The ID of the report card.
x_api_revision (str) – The revision of the API.
x_api_value_lists (str) – The value lists for the API.

Returns:

A DataFrame containing the numeric grades for the report card enrollment.

Return type:

pandas.DataFrame

get_report_cards_qualitative_grades(enrollment_id, id, X_API_Revision=None, X_API_Value_Lists=None)

Read the qualitative grades for the specified report card enrollment.

Parameters:

enrollment_id (int) – The ID of the report card enrollment.
id (int) – The ID of the qualitative grade.
X_API_Revision (str, optional) – The API revision.
X_API_Value_Lists (str, optional) – The API value lists.

Returns:

A DataFrame containing the qualitative grades for the specified report card enrollment.

Return type:

pandas.DataFrame

get_rubric(id, x_api_revision=None, x_api_value_lists=None)

Get a specific rubric by ID.

Parameters:

id (int) – The ID of the rubric to retrieve.
x_api_revision (str, optional) – The API revision version.
x_api_value_lists (str, optional) – The value lists for the rubric.

Returns:

A DataFrame containing the requested rubric data.

Return type:

pandas.DataFrame

get_rubric_category(id, x_api_revision=None, x_api_value_lists=None)

Get the rubric category with the specified ID.

Parameters:

id (int) – The ID of the rubric category.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – Include value lists in the response.

Returns:

A DataFrame containing the rubric category details.

Return type:

pandas.DataFrame

get_rubric_scale_levels(id, description, abbreviation, numeric_value, notes, sort_key, scale_id, scale_description, value_lists=None)

Get the list of rubric scale levels.

Parameters:

id (int) – The ID of the rubric scale level.
description (str) – The description of the rubric scale level.
abbreviation (str) – The abbreviation of the rubric scale level.
numeric_value (float) – The numeric value of the rubric scale level.
notes (str) – The notes for the rubric scale level.
sort_key (int) – The sort key of the rubric scale level.
scale_id (int) – The ID of the scale.
scale_description (str) – The description of the scale.
value_lists (list, optional) – Present only with header X-API-Value-Lists = include.

Returns:

A DataFrame containing the list of rubric scale levels.

Return type:

pandas.DataFrame

get_staff_faculty(id=None, x_api_revision=None, x_api_value_lists=None)

Get the information of a specific staff or faculty member.

Parameters:: id (int) – The ID of the staff or faculty member.
Returns:: A DataFrame containing the information of the staff or faculty member.
Return type:: pandas.DataFrame

get_student(id, x_api_revision=None, x_api_value_lists=None)

Get the details of a student.

Parameters:

id (int) – The ID of the student.
x_api_revision (str, optional) – API Revision.
x_api_value_lists (str, optional) – Include Value Lists in response.

Returns:

A DataFrame containing the student details.

Return type:

pandas.DataFrame

get_student_logistics_request(id)

Get the details of a student logistics request.

Parameters:: id (int) – The ID of the student logistics request.
Returns:: A DataFrame containing the details of the student logistics request.
Return type:: pandas.DataFrame

get_student_logistics_requests(on_or_after_last_modified_date=None, on_or_before_last_modified_date=None, x_page_number=1, x_page_size=1000, x_api_revision=None, x_api_value_lists=None)

Get the list of student logistics requests.

Parameters:

on_or_after_last_modified_date (str, optional) – Only return requests that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return requests that were last modified on or before this specific date. Format: “YYYY-MM-DD”.
x_page_number (int, optional) – The page number of the results to retrieve.
x_page_size (int, optional) – The number of results per page.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The value lists to include.

Returns:

A DataFrame containing the list of student logistics requests.

Return type:

pandas.DataFrame

get_students(advisor_id=None, campus_id=None, homeroom=None, homeroom_teacher_id=None, household_id=None, on_or_after_entry_date=None, on_or_after_exit_date=None, on_or_after_last_modified_date=None, on_or_before_entry_date=None, on_or_before_exit_date=None, on_or_before_last_modified_date=None, role=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of students.

Parameters:

advisor_id (int, optional) – Advisor ID.
campus_id (int, optional) – Campus ID.
homeroom (int, optional) – Homeroom ID.
homeroom_teacher_id (int, optional) – Homeroom Teacher ID.
household_id (int, optional) – Household ID..
on_or_after_entry_date (str, optional) – Only return students who entered on or after this specific date. Format: “YYYY-MM-DD”.
on_or_after_exit_date (str, optional) – Only return students who exited on or after this specific date. Format: “YYYY-MM-DD”.
on_or_after_last_modified_date (str, optional) – Only return students who were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_entry_date (str, optional) – Only return students who entered on or before this specific date. Format: “YYYY-MM-DD”.
on_or_before_exit_date (str, optional) – Only return students who exited on or before this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return students who were last modified on or before this specific date. Format: “YYYY-MM-DD”.
role (int, optional) – Role ID.
x_api_revision (str, optional) – API revision.
x_api_value_lists (str, optional) – Include value lists in the response (allowed value: include).
x_page_number (int, optional) – Page number (>= 1, default: 1).
x_page_size (int, optional) – Number of records per page (>= 1, <= 1000, default: 100).

Returns:

A DataFrame containing the list of students.

Return type:

pandas.DataFrame

get_summer_class_attendance(id, internal_class_id, X_API_Revision=None, X_API_Value_Lists=None)

Read summer class attendance.

Parameters:

id (int) – Class Attendance ID.
internal_class_id (int) – Internal Class ID.
X_API_Revision (str, optional) – API Revision.
X_API_Value_Lists (str, optional) – Include Value Lists in response.

Returns:

A DataFrame containing the summer class attendance data.

Return type:

pandas.DataFrame

get_summer_class_attendance_list(internal_class_id, on_or_after_attendance_date=None, on_or_after_last_modified_date=None, on_or_before_attendance_date=None, on_or_before_last_modified_date=None, person_id=None, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the list of summer class attendances.

Parameters:

internal_class_id (int) – The ID of the internal class.
on_or_after_attendance_date (str, optional) – Only return attendances that occurred on or after this specific date. Format: “YYYY-MM-DD”.
on_or_after_last_modified_date (str, optional) – Only return attendances that were last modified on or after this specific date. Format: “YYYY-MM-DD”.
on_or_before_attendance_date (str, optional) – Only return attendances that occurred on or before this specific date. Format: “YYYY-MM-DD”.
on_or_before_last_modified_date (str, optional) – Only return attendances that were last modified on or before this specific date. Format: “YYYY-MM-DD”.
person_id (int, optional) – Only return attendances for the specified person ID.

Returns:

A DataFrame containing the list of summer class attendances.

Return type:

pandas.DataFrame

get_summer_class_meeting_times(id, internal_class_id, x_api_revision=None, x_api_value_lists=None)

Get the summer class meeting times for a specific class.

Parameters:

id (int) – The ID of the class.
internal_class_id (int) – The internal ID of the class.
x_api_revision (str, optional) – The API revision version.
x_api_value_lists (str, optional) – The API value lists.

Returns:

A DataFrame containing the summer class meeting times.

Return type:

pandas.DataFrame

get_summer_classes(id, x_api_revision=None, x_api_value_lists=None)

Read the details of a summer class.

Parameters:

id (int) – The internal class ID of the summer class.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – Include value lists in the response.

Returns:

A DataFrame containing the details of the summer class.

Return type:

pandas.DataFrame

get_summer_courses(id, x_api_revision=None, x_api_value_lists=None, x_page_number=1, x_page_size=1000)

Get the details of a specific summer course.

Parameters:

id (int) – The ID of the summer course to retrieve.
x_api_revision (str, optional) – The API revision.
x_api_value_lists (str, optional) – The value lists required for API.
x_page_number (int, optional) – The page number for pagination.
x_page_size (int, optional) – The number of items to return per page.

Returns:

A DataFrame containing the details of the summer course.

Return type:

pandas.DataFrame

get_summer_enrollments(id)

Get a summer enrollment by ID.

Parameters:: id (int) – The ID of the summer enrollment.
Returns:: A DataFrame containing the summer enrollment data.
Return type:: pandas.DataFrame

send_data_to_api(endpoint, headers, data)

Helper function to send data to an API endpoint using the POST method.

Parameters:

endpoint (str) – The specific API endpoint to send data to.
headers (dict) – Headers required for API authentication and content type.
data (dict) – The data to be sent as the request body.

Returns:

The response object of the API request.

Return type:

requests.Response

update_academics_class_assignment(internal_class_id, id, data)

Update an academic class assignment.

Parameters:

internal_class_id (int) – The internal ID of the class.
id (int) – The ID of the assignment.
data (dict) – The updated assignment data. It should contain the following fields: - assignment_type (int): The type of the assignment. - description (str): The description of the assignment. - assignment_details (str): The details of the assignment. - max_score (int): The maximum score of the assignment. - weight (int): The weight of the assignment. - not_to_be_graded (bool): Whether the assignment should not be graded. - date_assigned (str): The date the assignment is assigned. Format: “YYYY-MM-DD”. - date_due (str): The due date of the assignment. Format: “YYYY-MM-DD”. - display_status (int): The display status of the assignment.

Returns:

A DataFrame containing the updated assignment.

Return type:

pandas.DataFrame

update_academics_classes(id, data, x_api_revision=None)

Update an academic class.

Parameters:

id (str) – The ID of the class to be updated.
data (dict) – The updated data for the class.

Returns:

A DataFrame containing the updated class.

Return type:

pandas.DataFrame

update_academics_courses(id, data, x_api_revision=None)

Update an academic course.

Parameters:

id (int) – The internal Course ID.
data (dict) – The updated course data. It should include the following keys: - course_id (str): The course ID. - name (str): The name of the course. - subject_id (int): The ID of the subject. - subject_description (str): The description of the subject. - department_description (str): The description of the department. - catalog_title (str): The title of the course catalog. - catalog_description (str): The description of the course catalog. - classification (int): The classification of the course. - course_type (int): The type of the course.
x_api_revision (str, optional) – The API Revision.

Returns:

A DataFrame containing the updated course data.

Return type:

pandas.DataFrame

update_academics_enrollment(id, data)

Update the enrollment for a student in an academic class.

Parameters:

id (int) – The ID of the enrollment to be updated.
data (dict) – A dictionary containing the updated enrollment data. - currently_enrolled (bool): Whether the student is currently enrolled in the class. - late_date_enrolled (str): The date when the student was enrolled in the class (format: “YYYY-MM-DD”). - date_withdrawn (str): The date when the student withdrew from the class (format: “YYYY-MM-DD”). - level (int): The level of the student in the class. - notes (str): Any additional notes or comments.

Returns:

A DataFrame containing the updated enrollment details.

Return type:

pandas.DataFrame

update_academics_rubric_criteria(id, data, x_api_revision, auth_token)

Update the rubric criteria.

Parameters:

id (int) – The ID of the rubric criteria.
data (dict) – The updated data for the rubric criteria. It should contain the following fields: - category_id (int): The category ID. - rubric_id (int): The rubric ID. - description (str): The description. - report_override_description (str): The report card description. - scale_id (int): The scale ID. - type (int): The type. - notes (str): The notes. - sort_key (int): The sort key.
x_api_revision (str) – The API revision.
auth_token (str) – The authorization token.

Returns:

A DataFrame containing the updated rubric criteria.

Return type:

pandas.DataFrame

update_academics_rubric_scale_levels(id, data)

Update an academic rubric scale level.

Parameters:

id (str) – The ID of the rubric scale level to update.
data (dict) – A dictionary containing the updated data for the rubric scale level. It should have the following keys: - description (str): The description of the rubric scale level. - abbreviation (str): The abbreviation of the rubric scale level. - numeric_value (float): The numeric value of the rubric scale level. - notes (str): Any additional notes for the rubric scale level. - sort_key (int): The sort key of the rubric scale level. - scale_id (int): The ID of the scale associated with the rubric scale level. - scale_description (str): The description of the scale associated with the rubric scale level.

Returns:

A DataFrame containing the updated rubric scale level.

Return type:

pandas.DataFrame

update_academics_rubric_scales(id, data)

Update an academic rubric scale.

Parameters:

id (str) – The ID of the rubric scale to update.
data (dict) – The data to update the rubric scale with. - description (str): The description of the rubric scale. - portal_display_format (int): The display format of the rubric scale in the portal.

Returns:

A DataFrame containing the updated rubric scale.

Return type:

pandas.DataFrame

update_academics_rubrics(id, data, x_api_revision)

Update an academic rubric.

Parameters:

id (int) – The ID of the rubric to update.
data (dict) – The data to update the rubric with. - category_id (int): The ID of the category. - description (str): The description of the rubric. - report_override_description (str): The report card description of the rubric. - sort_key (int): The sort key of the rubric. - allow_curriculum (bool): Whether curriculum is allowed for the rubric.
x_api_revision (str) – API revision.

Returns:

A DataFrame containing the updated academic rubric.

Return type:

pandas.DataFrame

update_admission_applicant(applicant_id, data=None, household_id=None, name_prefix=None, first_name=None, middle_name=None, last_name=None, name_suffix=None, nick_name=None, gender=None, pronouns=None, ethnicity=None, date_of_birth=None, email=None, mobile_phone=None, current_grade=None, x_api_revision=None, x_page_number=1, x_page_size=1000)

Update an admission applicant.

Parameters:

applicant_id (int) – The ID of the applicant to update.
data (object, optional) – The data object to update the applicant.
household_id (int, optional) – The ID of the household associated with the applicant.
name_prefix (int, optional) – The ID of the name prefix.
first_name (str, optional) – The first name of the applicant.
middle_name (str, optional) – The middle name of the applicant.
last_name (str, optional) – The last name of the applicant.
name_suffix (int, optional) – The ID of the name suffix.
nick_name (str, optional) – The nick name of the applicant.
gender (int, optional) – The ID of the gender.
pronouns (int, optional) – The ID of the pronouns.
ethnicity (int, optional) – The ID of the ethnicity.
date_of_birth (str, optional) – The date of birth of the applicant. Format: “YYYY-MM-DD”.
email (str, optional) – The email of the applicant.
mobile_phone (str, optional) – The mobile phone number of the applicant.
current_grade (int, optional) – The ID of the current grade.
x_api_revision (str, optional) – The API revision.
x_page_number (int, optional) – The page number for pagination.
x_page_size (int, optional) – The page size for pagination.

Returns:

A DataFrame containing the updated admission applicant.

Return type:

pandas.DataFrame

update_admission_applicant_relationships(applicant_id, id, data)

Update the relationships of an admission applicant.

Parameters:

applicant_id (int) – The ID of the admission applicant.
id (int) – The ID of the relationship to be updated.
data (dict) – The data to update the relationship. It should have the following keys: - related_person_id (int): The ID of the related person. - relationship (int): The ID of the relationship type. - legal_custody (bool): Whether the related person has legal custody. - admissions_access (bool): Whether the related person has access to admissions data.

Returns:

A DataFrame containing the updated relationship information.

Return type:

pandas.DataFrame

update_admission_application_checklists(application_id, id, data)

Update the admission application checklists.

Parameters:

application_id (int) – The ID of the application.
id (int) – The ID of the checklist item.
data (dict) – A dictionary containing the updated checklist item data.

Returns:

A DataFrame containing the updated admission application checklists.

Return type:

pandas.DataFrame

update_admission_applications(application_id, data)

Update an admission application.

Parameters:

application_id (int) – The ID of the application to update.
data (dict) – The data to update the application with. Required fields: - applicant_id (int): Applicant ID - year_applying_for (int): Year Applying For - month_applying_for (int): Month Applying For - grade_applying_for (int): Grade Applying For - resident_status_applying_for (int): Resident Status Applying For - campus_applying_for (int): Campus Applying For - student_group_applying_for (int): Student Group Applying For - admission_source (int): Admission Source - candidate_pool (int): Candidate Pool - admission_lead_date (str): Admission Lead Date - inquiry_date (str): Inquiry Date - visit_date (str): Visit Date - application_date (str): Application Date - requesting_financial_aid (bool): Requesting Financial Aid - application_status (int): Application Status - application_decision_date (str): Application Decision Date - application_decision_response (int): Application Decision Response - application_decision_response_date (str): Application Decision Response Date

Returns:

A DataFrame containing the updated admission application.

Return type:

pandas.DataFrame

update_admission_citizenships(id, data)

Update the citizenships for an admission.

Parameters:

id (int) – The ID of the admission.
data (dict) – The data for updating citizenships. It should have the following keys: - person_id (int): The ID of the person. - country (int): The ID of the country. - is_primary (bool): Indicates if it is the primary citizenship. - passport_number (str): The passport number. - passport_issue_date (str): The passport issue date in the format “YYYY-MM-DD”. - passport_issuing_authority (str): The authority issuing the passport. - passport_expiration_date (str): The passport expiration date in the format “YYYY-MM-DD”.

Returns:

A DataFrame containing the updated citizenships for the admission.

Return type:

pandas.DataFrame

update_admission_households(id, data, x_api_revision=None)

Update an admission household.

Parameters:

id (str) – The ID of the admission household to update.
data (dict) – The updated data for the admission household.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the updated admission household.

Return type:

pandas.DataFrame

update_admission_languages(id, person_id, language, is_primary, reading_proficiency, writing_proficiency, speaking_proficiency, listening_proficiency, years_studying, spoken_at_home, notes, x_api_revision)

Update the admission languages for a specific ID.

Parameters:

id (str) – The ID of the admission.
person_id (int) – Person ID.
language (int) – Language.
is_primary (bool) – Primary Code.
reading_proficiency (int) – Reading Proficiency.
writing_proficiency (int) – Writing Proficiency.
speaking_proficiency (int) – Speaking Proficiency.
listening_proficiency (int) – Listening Proficiency.
years_studying (int) – Years Studying.
spoken_at_home (bool) – Spoken At Home.
notes (str) – Notes.
x_api_revision (str) – X-API-Revision value.

Returns:

A DataFrame containing the updated admission languages.

Return type:

pandas.DataFrame

update_admission_relative_relationships(relative_id, id, data, x_api_revision=None)

Update the admission relative relationships.

Parameters:

relative_id (int) – The ID of the relative.
id (int) – The ID of the relationship.
data (dict) – The data to update the relationship. It should contain the ‘related_person_id’ and ‘relationship’ as integers.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the updated admission relative relationships.

Return type:

pandas.DataFrame

update_admission_relatives(id, data, x_api_revision=None, content_type='application/json')

Update the admission relatives.

Parameters:

id (int) – The ID of the admission relative to update.
data (dict) – A dictionary containing the updated information for the admission relative.
x_api_revision (str, optional) – The API revision.
content_type (str, optional) – The content type of the request header.

Returns:

A DataFrame containing the updated admission relative.

Return type:

pandas.DataFrame

update_assignment_grades(assignment_id, id, data, completion_status, raw_score, private_notes_for_teacher, last_modified_date, x_api_revision)

Update the grades for an assignment.

Parameters:

assignment_id (int) – The ID of the assignment.
id (int) – The ID of the grade.
data (object) – The data object containing the updated grade information.
completion_status (int) – The completion status of the assignment.
raw_score (float) – The raw score for the assignment.
private_notes_for_teacher (str) – The private notes for the teacher.
last_modified_date (str) – The last modified date of the grade.
x_api_revision (str) – The X-API-Revision header value.

Returns:

None.

update_athletics_rosters(id, data, x_api_revision=None)

Update the athletics rosters for a specific enrollment.

Parameters:

id (int) – The ID of the enrollment.
data (dict) – The data to update for the enrollment.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the updated athletics rosters.

Return type:

pandas.DataFrame

update_athletics_sports(id, data)

Update the details of an athletics sport.

Parameters:

id (int) – The ID of the athletics sport to be updated.
data (dict) – The data to be updated. It should include the following fields: - description (str): The description of the athletics sport. - abbreviation (str): The abbreviation of the athletics sport. - school_level (str): The school level of the athletics sport. - gender (int): The gender of the athletics sport. - subject_id (int): The ID of the subject related to the athletics sport. - subject_description (str): The description of the subject related to the athletics sport.

Returns:

A DataFrame containing the updated details of the athletics sport.

Return type:

pandas.DataFrame

update_athletics_teams(id, x_api_revision=None, data=None)

Update an athletics team.

Parameters:

id (int) – The internal Class ID of the team to update.
x_api_revision (str, optional) – The API Revision.
data (dict, optional) – The data to update the athletics team.

Returns:

A DataFrame containing the updated athletics team details.

Return type:

pandas.DataFrame

update_behavior(school_route, id, data)

Update a behavior record.

Parameters:

school_route (str) – The route for the specific school.
id (int) – The ID of the behavior record to update.
data (dict) – The data for updating the behavior record. It should include the following keys: - incident_date (str): The date of the incident. Format: “YYYY-MM-DD”. - incident_type (int): The type of the incident. - student_id (int): The ID of the student involved in the incident. - reporting_person_id (int): The ID of the person who reported the incident. - assigned_to_person_id (int): The ID of the person assigned to handle the incident. - internal_class_id (int): The ID of the internal class. - class_name (str): The name of the class associated with the incident. - incident_notes (str): Any notes related to the incident. - status (int): The status of the incident. - status_date (str): The date when the status was updated. Format: “YYYY-MM-DD”. - outcome_type (int): The type of the outcome of the incident. - outcome_date (str): The date when the outcome was updated. Format: “YYYY-MM-DD”. - outcome_notes (str): Any notes related to the outcome of the incident. - follow_up_status (int): The status of the follow-up for the incident. - follow_up_status_date (str): The date when the follow-up status was updated. Format: “YYYY-MM-DD”. - last_modified_date (str): The date when the record was last modified. Format: “YYYY-MM-DD”.

Returns:

A DataFrame containing the updated behavior record.

Return type:

pandas.DataFrame

update_boarding_dorm_attendance(internal_dorm_id, id, attendance_date, block, status, notes, x_api_revision)

Update the attendance record for a specific boarding dorm.

Parameters:

internal_dorm_id (str) – The internal ID of the boarding dorm.
id (str) – The ID of the attendance record to be updated.
attendance_date (str) – The date of the attendance record. Format: “YYYY-MM-DD”.
block (int) – The block number for the attendance record.
status (int) – The status of the attendance record.
notes (str) – Additional notes for the attendance record.
x_api_revision (str) – The API revision number.

Returns:

A DataFrame containing the updated attendance record.

Return type:

pandas.DataFrame

update_boarding_dorm_students(internal_dorm_id, id, data)

Update the students in a boarding dorm.

Parameters:

internal_dorm_id (str) – The internal ID of the dorm.
id (str) – The ID of the boarding dorm student.
data (dict) – The data to update the student in the boarding dorm. Should include the following fields: - room_number (str): The room number of the student. - floor_number (int): The floor number of the student. - bed_number (int): The bed number of the student. - currently_enrolled (bool): Whether the student is currently enrolled in the dorm. - late_date_enrolled (str): The date the student was enrolled in the dorm. Format: “YYYY-MM-DD”. - date_withdrawn (str): The date the student was withdrawn from the dorm. Format: “YYYY-MM-DD”. - notes (str): Any additional notes about the student.

Returns:

A DataFrame containing the updated boarding dorm student information.

Return type:

pandas.DataFrame

update_class_attendance(internal_class_id, id, attendance_date, status, notes, x_api_revision)

Update the attendance for a specific class.

Parameters:

internal_class_id (str) – The internal ID of the class.
id (str) – The attendance ID.
attendance_date (str) – The date of the attendance. Format: “YYYY-MM-DD”.
status (int) – The status of the attendance.
notes (str) – Additional notes for the attendance.
x_api_revision (str) – The API revision.

Returns:

A DataFrame containing the updated attendance details.

Return type:

pandas.DataFrame

update_course(id, name=None, course_type=None, course_id=None, catalog_title=None, catalog_description=None, subject_description=None, department_id=None, department_description=None, x_api_revision=None)

Update a course.

Parameters:

id (int) – The ID of the course to be updated.
name (str, optional) – The name of the course.
course_type (int, optional) – The type of the course.
course_id (str, optional) – The ID of the course.
catalog_title (str, optional) – The title of the course in the catalog.
catalog_description (str, optional) – The description of the course in the catalog.
subject_description (str, optional) – The description of the subject.
department_id (int, optional) – The ID of the department.
department_description (str, optional) – The description of the department.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the updated course.

Return type:

pandas.DataFrame

update_data_from_api(endpoint, headers, data)

Helper function to update data in an API endpoint using the PATCH method.

Parameters:

endpoint (str) – The specific API endpoint to update data in.
headers (dict) – Headers required for API authentication.
data (dict) – The data to update in the API endpoint.

Returns:

None

update_directory_preferences_household(id, data, x_api_revision=None)

Update the directory preferences for a household.

Parameters:

id (int) – The ID of the household directory type preference.
data (dict) – The updated data for the household.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the updated directory preferences for the household.

Return type:

pandas.DataFrame

update_directory_preferences_person(id, data, x_api_revision=None)

Update the directory preferences for a person.

Parameters:

id (int) – The ID of the person to update.
data (dict) –
The data object containing the directory preferences to update. It should include the following optional fields:
- person_id (int): The ID of the person.
- directory_type (int): The directory type.
- status (int): The status.
- parents_display (int): The display option for parents.
- photo_display (int): The display option for photos.
- mobile_phone_display (int): The display option for mobile phones.
- email_1_display (int): The display option for email 1.
- email_2_display (int): The display option for email 2.
- business_phone_display (int): The display option for business phones.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the updated directory preferences for the person.

Return type:

pandas.DataFrame

update_emergency_contact(id, data)

Update an emergency contact.

Parameters:

id (int) – The ID of the emergency contact to be updated.
data (dict) – The data to be updated. It should include the following fields: - person_id (int): The ID of the person. - student_id (int): The ID of the student. - first_name (str): The first name of the contact. - middle_name (str): The middle name of the contact. - last_name (str): The last name of the contact. - nick_name (str): The nickname of the contact. - relationship (int): The ID of the relationship. - legal_custody (bool): True if the contact has legal custody, False otherwise. - pick_up (bool): True if the contact can pick up the student, False otherwise. - medical_notification (bool): True if the contact should receive medical notifications, False otherwise. - email_1 (str): The first email address of the contact. - email_2 (str): The second email address of the contact. - home_phone (str): The home phone number of the contact. - mobile_phone (str): The mobile phone number of the contact. - business_phone (str): The business phone number of the contact. - address_1 (str): The first line of the contact’s address. - address_2 (str): The second line of the contact’s address. - city (str): The city of the contact’s address. - state_province (str): The state or province of the contact’s address. - postal_code (str): The postal code of the contact’s address. - country (int): The ID of the country. - notes (str): Additional notes about the contact. - last_modified_date (str): The last modified date of the contact. Format: “YYYY-MM-DD”.

Returns:

A DataFrame containing the updated emergency contact.

Return type:

pandas.DataFrame

update_extended_care_classes(id, data, x_api_revision=None)

Update extended care classes.

Parameters:

id (int) – Internal Class ID.
data (dict) – Data to update the extended care class.
x_api_revision (str, optional) – API Revision.

Returns:

A DataFrame containing the updated extended care class.

Return type:

pandas.DataFrame

update_extended_care_course(id, name, subject_id, subject_description, course_id, catalog_title, catalog_description, x_api_revision=None)

Update an extended care course.

Parameters:

id (int) – The ID of the extended care course to be updated.
name (str) – The name of the extended care course.
subject_id (int) – The ID of the subject associated with the extended care course.
subject_description (str) – The description of the subject associated with the extended care course.
course_id (str) – The ID of the course.
catalog_title (str) – The title of the course in the catalog.
catalog_description (str) – The description of the course in the catalog.
x_api_revision (str, optional) – The revision of the API.

Returns:

A DataFrame containing the updated extended care course.

Return type:

pandas.DataFrame

update_health_patient_condition(patient_id, id, description, condition_code, intervention_code, begin_date, end_date, notes, critical)

Update a patient’s health condition.

Parameters:

patient_id (str) – The ID of the patient.
id (str) – The ID of the condition.
description (str) – The description of the condition.
condition_code (int) – The condition code.
intervention_code (int) – The intervention code.
begin_date (str) – The begin date of the condition. Format: “YYYY-MM-DD”.
end_date (str) – The end date of the condition. Format: “YYYY-MM-DD”.
notes (str) – Any notes related to the condition.
critical (bool) – Specifies if the condition is critical or not.

Returns:

A DataFrame containing the updated condition details.

Return type:

pandas.DataFrame

update_health_patients(id, data, x_api_revision=None)

Update the health information of a patient.

Parameters:

id (int) – The ID of the person.
data (dict) – The updated health information of the patient.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the updated health information of the patient.

Return type:

pandas.DataFrame

update_master_attendance(id, data, x_api_revision=None)

Update the master attendance.

Parameters:

id (int) – Daily Attendance ID.
data (dict) – Attendance data.
x_api_revision (str, optional) – API Revision.

Returns:

A DataFrame containing the updated master attendance.

Return type:

pandas.DataFrame

update_numeric_grade(id, data, x_api_revision=None)

Update a numeric grade.

Parameters:

id (int) – The ID of the grade to be updated.
data (dict) – The data to be updated for the grade.
x_api_revision (str, optional) – The API Revision.

Returns:

A DataFrame containing the updated grade data.

Return type:

pandas.DataFrame

update_patient_medication(patient_id, id, data)

Update a patient’s medication.

Parameters:

patient_id (int) – The ID of the patient.
id (int) – The ID of the medication.
data (dict) – The updated information for the medication. - patient_id (int): The ID of the patient. - medication (int): The ID of the medication. - start_date (str): The start date of the medication. Format: “YYYY-MM-DD”. - end_date (str): The end date of the medication. Format: “YYYY-MM-DD”. - dosage_instruction (str): The dosage instructions for the medication. - notes (str): Additional notes for the medication.

Returns:

A DataFrame containing the updated patient’s medication information.

Return type:

pandas.DataFrame

update_programs_class_attendance(internal_class_id, id, data)

Update the attendance for a class in the programs module.

Parameters:

internal_class_id (int) – The internal ID of the class.
id (int) – The ID of the attendance record.
data (dict) – The data to be updated. - attendance_date (str): The date of the attendance. - block (dict): The block information. - status (int): The attendance status. - notes (str): Additional notes for the attendance.

Returns:

A DataFrame containing the updated attendance record for the class.

Return type:

pandas.DataFrame

update_programs_classes(id, x_api_revision=None, data=None)

Update a specific program class.

Parameters:

id (int) – The internal Class ID of the program class to be updated.
x_api_revision (str, optional) – The API Revision.
data (dict, optional) – The data to be updated for the program class. Should include the following keys: - class_id (str) - description (str) - status (int) - school_year (int) - begin_date (str) - end_date (str) - primary_grade_level_id (int) - internal_course_id (int) - primary_teacher_id (int) - room_id (int) - virtual_meeting_url (str)

Returns:

A DataFrame containing the updated program class.

Return type:

pandas.DataFrame

update_programs_course(id, data, x_api_revision=None, auth_token=None)

Update a program’s course.

Parameters:

id (int) – Internal Course ID.
data (dict) – Data to update the course.
name (-) – Course Name.
course_id (-) – Course ID.
subject (-) –
- catalog_title (str): Catalog Title.
- catalog_description (str): Catalog Description.
x_api_revision (str, optional) – API Revision.
auth_token (str, optional) – Authorization Token.

Returns:

A DataFrame representing the updated program’s course.

Return type:

pandas.DataFrame

update_programs_enrollment(id=None, currently_enrolled=None, late_date_enrolled=None, date_withdrawn=None, level=None, notes=None, x_api_revision=None, auth_token=None)

Update the enrollment details of a program.

Parameters:

id (int) – The ID of the program enrollment to be updated.
currently_enrolled (bool, optional) – Indicates if the student is currently enrolled in the program.
late_date_enrolled (str, optional) – The date the student was enrolled late in the program. Format: “YYYY-MM-DD”.
date_withdrawn (str, optional) – The date the student was withdrawn from the program. Format: “YYYY-MM-DD”.
level (int, optional) – The level of the student in the program.
notes (str, optional) – Additional notes or comments about the program enrollment.
x_api_revision (str) – The API revision version.
auth_token (str) – The authorization token.

Returns:

A DataFrame containing the updated program enrollment details.

Return type:

pandas.DataFrame

update_qualitative_grade(id, data, x_api_revision=None)

Update a qualitative grade.

Parameters:

id (int) – Grade ID.
data (dict) – Data for updating the grade.
x_api_revision (str, optional) – API Revision.

Returns:

A DataFrame containing the updated qualitative grade.

Return type:

pandas.DataFrame

update_rubric_category(id, data, x_api_revision=None)

Update a rubric category.

Parameters:

id (str) – The ID of the rubric category to update.
data (dict) – The data to update the rubric category.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the updated rubric category.

Return type:

pandas.DataFrame

update_student_logistics_request(id, data)

Update a student’s logistics request.

Parameters:

id (int) – The ID of the logistics request.
data (dict) – The updated data for the logistics request. The keys and types of the required fields are as follows: - student_id (int): Student ID. - date (str): Request Date. - status (int): Request Status. - category (str): Request Category. - reason (str): Request Reason. - notes (str): Request Notes. - attendance_start_date (str): Attendance Start Date. - attendance_time (str): Attendance Time. - attendance_end_date (str): Attendance End Date. - attendance_return_time (str): Attendance Return Time. - attendance_type (int): Attendance Type. - transportation_method (str): Transportation Method. - am_pm (int): AM/PM. - bus_stop (int): Bus Stop. - bus_route (str): Bus Route. - response_notes (str): Response Notes. - internal_notes (str): Internal Notes. - extended_care_type (str): Extended Care Type. - extended_care_arrival_time (str): Extended Care Arrival Time. - extended_care_leave_time (str): Extended Care Leave Time. - posted (bool): Posted.

Returns:

An empty DataFrame if the request was successful, otherwise an error message.

Return type:

pandas.DataFrame

update_summer_class_attendance(internal_class_id, id, data: dict)

Update the attendance for a summer class.

Parameters:

internal_class_id (str) – The internal ID of the summer class.
id (str) – The ID of the attendance record.
data (dict) – The data for updating the attendance record. Should include the following keys: - attendance_date (str): The date of the attendance in “YYYY-MM-DD” format. - status (int): The status of the attendance. - notes (str): Additional notes for the attendance.

Returns:

A DataFrame containing the updated attendance record.

Return type:

pandas.DataFrame

update_summer_classes(id, data)

Update the summer classes.

Parameters:

id (str) – The ID of the summer class to be updated.
data (dict) – The data to be updated for the summer class. It should be in the format:
{ – “class_id”: str, “description”: str, “status”: int, “school_year”: int, “begin_date”: str, “end_date”: str, “primary_grade_level”: int, “school_level”: int, “internal_course_id”: int, “primary_teacher_id”: int, “room_id”: int, “virtual_meeting_url”: str
} –

Returns:

A DataFrame containing the updated summer classes.

Return type:

pandas.DataFrame

update_summer_course(id, name=None, course_id=None, classification=None, catalog_title=None, catalog_description=None, subject_id=None, subject_description=None, department_description=None, x_api_revision=None)

Update a summer course.

Parameters:

id (str) – The ID of the course to be updated.
name (str, optional) – The name of the course.
course_id (str, optional) – The course ID.
classification (int, optional) – The classification of the course.
catalog_title (str, optional) – The catalog title of the course.
catalog_description (str, optional) – The catalog description of the course.
subject_id (int, optional) – The ID of the subject.
subject_description (str, optional) – The description of the subject.
department_description (str, optional) – The description of the department.
x_api_revision (str, optional) – The API revision.

Returns:

A DataFrame containing the updated summer course.

Return type:

pandas.DataFrame

update_summer_enrollment(school_route, id, currently_enrolled=None, late_date_enrolled=None, date_withdrawn=None, level=None, notes=None, x_api_revision=None, auth_token=None)

Update the summer enrollment.

Parameters:

school_route (str) – The specific school route.
id (int) – The ID of the summer enrollment to update.
currently_enrolled (bool, optional) – Indicates if the student is currently enrolled.
late_date_enrolled (str, optional) – The late date the student enrolled in the summer program. Format: “YYYY-MM-DD”.
date_withdrawn (str, optional) – The date the student withdrew from the summer program. Format: “YYYY-MM-DD”.
level (int, optional) – The level of the summer enrollment.
notes (str, optional) – Any additional notes related to the summer enrollment.
x_api_revision (str, optional) – The API revision.
auth_token (str, optional) – The authorization token.

Returns:

A DataFrame containing the updated summer enrollment.

Return type:

pandas.DataFrame