studentvue.StudentVue¶
-
class
studentvue.StudentVue(username: str, password: str, district_domain: str, xmljson_serializer: xmljson.XMLData = <xmljson.Abdera object>, zeep_transport: zeep.transports.Transport = None, zeep_settings: zeep.settings.Settings = None, debug: bool = False)¶ The StudentVue API class
-
__init__(username: str, password: str, district_domain: str, xmljson_serializer: xmljson.XMLData = <xmljson.Abdera object>, zeep_transport: zeep.transports.Transport = None, zeep_settings: zeep.settings.Settings = None, debug: bool = False)¶ - Parameters
username (str) – student’s username
password (str) – student’s password
district_domain (str) – domain that the school district hosts StudentVue on
xmljson_serializer (xmljson.XMLData) – (optional) serializer used to serialize xml to json
zeep_transport (zeep.Transport) – (optional) custom zeep client transport
zeep_settings (zeep.Settings) – (optional) custom zeep client settings
debug (bool) – if set to true, turns on debug logging from zeep
-
get_attendance() → collections.OrderedDict¶ - Returns
student’s attendance
- Return type
OrderedDict
-
get_calendar() → collections.OrderedDict¶ - Returns
student’s assignments / events calendar
- Return type
OrderedDict
-
get_class_notes() → collections.OrderedDict¶ - Returns
student’s class notes
- Return type
OrderedDict
-
get_document(document_guid: str) → collections.OrderedDict¶ - Parameters
document_guid (str) – id of the document to fetch, found using
list_documents()- Returns
content of the specified document
- Return type
OrderedDict
-
get_gradebook(report_period: int = 0) → collections.OrderedDict¶ - Parameters
report_period (int) – (optional) report period to fetch gradebook for
- Returns
student’s gradebook for the specified report period
- Return type
OrderedDict
-
get_messages() → collections.OrderedDict¶ - Returns
student’s messages
- Return type
OrderedDict
-
get_report_card(document_guid: str) → collections.OrderedDict¶ - Parameters
document_guid (str) – id of the report card to fetch, found using
list_report_cards()- Returns
content of the specified report card
- Return type
OrderedDict
-
get_schedule(term_index: int = 0) → collections.OrderedDict¶ - Parameters
term_index (int) – (optional) term index to fetch schedule for
- Returns
student’s schedule for the specified term
- Return type
OrderedDict
-
get_school_info() → collections.OrderedDict¶ - Returns
student’s school information
- Return type
OrderedDict
-
get_student_info() → collections.OrderedDict¶ - Returns
student’s information
- Return type
OrderedDict
-
list_documents() → collections.OrderedDict¶ - Returns
list of student’s documents
- Return type
OrderedDict
-
list_report_cards() → collections.OrderedDict¶ - Returns
list of student’s report cards
- Return type
OrderedDict
-