Package: interfolio-api
Interfolio APIA lightweight Python library for Interfolio.Note: Interfolio API is still in beta. It currently only supports the GET methods in the Faculty Activity Reporting application.Installationpip install interfolio_apiQuick StartFaculty Activity ReportingThe Faculty Activity Reporting API requires a public/private key pair and a database ID. These can either be passed in directly as strings or set as environment variables.INTERFOLIO_PUBLIC_KEYINTERFOLIO_PRIVATE_KEYFAR_DATABASE_IDIf not passed in directly, these values are assumed to come from the environment.If these values are not passed directly or found in the environment, an error will be raised.frominterfolio_apiimportInterfolioFAR# Passed directlyfar=InterfolioFAR(public_key="<your_public_key>",private_key="<your_private_key>",database_id="<your_database_ID>")# From environmentfar=InterfolioFAR()DocumentationFaculty Activity ReportingDetails on the parameters for each API method can be found inInterfolio's documentation.Required parameters are passed as positional arguments; optional parameters are passed as keyword args (**kwargs).Unitsfrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Retrieve a listing of academic unitsfar.get_units()# Retrieve details on a specific unitfar.get_unit(unit_id="<id>")Termsfrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Retrieve the 'term' periods that a school has set upfar.get_terms()Usersfrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Retrieve basic identifying information for a listing of usersfar.get_users()# Retrieve a full profile for the specified userfar.get_user(user_id="<id>")# Retrieve activity and section data for a listing of usersfar.get_user_data()# Retrieve a list of Tenant ID's for the current userfar.get_tenant_ids()Permissionsfrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Retrieve permission information for a listing of usersfar.get_permissions()# Retrieve permission information for a specified userfar.get_permission(user_id="<id>")Faculty Classificationsfrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Retrieve details on the available faculty classificationsfar.get_faculty_classifications()# Retrieve details on a specific faculty classificationfar.get_faculty_classification(faculty_classification_id="<id>")# Retrieve faculty classification data for a listing of usersfar.get_faculty_classification_data()Sectionsfrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Retrieve details on sectionsfar.get_sections()# Retrieve details for a specific sectionfar.get_section(section_id="<id>")Activitiesfrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Retrieve faculty activity IDs in sectionsfar.get_activities_ids_in_sections()# Retrieve faculty activity IDs for a specific sectionfar.get_activities_ids_for_section(section_id="<id>")# Retrieve faculty activity details for a specific sectionfar.get_activities_details_for_section(section_id="<id>")# Retrieve details for a specific activity IDfar.get_activity_details(section_id="<id>",activity_id="<id>")# Retrieve details for a given activity attachmentfar.get_activity_attachments(section_id="<id>",activity_id="<id>")# Retrieve activity classification datafar.get_activity_classifications()# Retrieve details for a specific activity classificationfar.get_activity_classification(activity_classification_id="<id>")Coursesfrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Retrieve course prefixesfar.get_course_prefixes()# Retrieve details for multiple coursesfar.get_courses()# Retrieve details for courses taught during one or more termsfar.get_courses_taught()# Retrieve details for a specific course taught during a specific termfar.get_course_taught(course_taught_id="<id>")# Retrieve attachment details for a specific course taught during specific termfar.get_course_taught_attachments(course_taught_id="<id>")Evaluationsfrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Retrieve evaluation details for multiple usersfar.get_evaluations()Vitaefrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Retrieve details on all vitaefar.get_vitae()# Retrieve details on a specific user's specific vitafar.get_vita(user_id="<id>",vita_id="<id>")# Retrieve a list of vitae that the user is permissioned to selectfar.get_paginated_vitae(tenant_id="<id>")Attachmentsfrominterfolio_apiimportInterfolioFARfar=InterfolioFAR()# Download an attachmentfar.download_attachment(attachment_id="<id>")