Handlers & Sub-handlers

All handlers are attributes of HiveClient. Sub-handlers are attributes of their parent handler.

Top-level handlers

Attribute	Class	Resource area
client.assignments_handler	AssignmentsHandler	Student assignments and submission responses
client.course_handler	CourseHandler	Programs, subjects, modules, exercises
client.help_handler	HelpHandler	Help threads and responses
client.management_handler	ManagementHandler	Users, classes, seating
client.notification_handler	NotificationHandler	Notifications
client.queues_handler	QueuesHandler	Assignment queues and queue items
client.schedule_handler	ScheduleHandler	Lessons, lesson rules, calendar events, event colors, daily reviews
client.tags_handler	TagsHandler	Exercise tags
client.time_handler	TimeHandler	Server time (health-check endpoint)

Sub-handlers

Under assignments_handler

Attribute	Class	Resource
assignments_handler.responses	AssignmentResponsesHandler	Submission responses for an assignment

Under course_handler

Attribute	Class	Resource
course_handler.programs	ProgramsHandler	Programs
course_handler.subjects	SubjectsHandler	Subjects within a program
course_handler.modules	ModulesHandler	Modules within a subject
course_handler.exercises	ExercisesHandler	Exercises within a module
course_handler.exercises.fields	ExerciseFieldsHandler	Form fields on an exercise

Under help_handler

Attribute	Class	Resource
help_handler.responses	HelpResponsesHandler	Responses (comments/files) on a help thread

Under management_handler

Attribute	Class	Resource
management_handler.classes	ClassesHandler	Student classes / groups
management_handler.users	UsersHandler	User accounts
management_handler.users.me	MeHandler	The currently authenticated user
management_handler.seating	SeatingHandler	Classroom seating arrangements

Under queues_handler

Attribute	Class	Resource
queues_handler.items	QueueItemsHandler	Items (exercises) within a queue

Under schedule_handler

Attribute	Class	Resource
schedule_handler.colors	ScheduleColorsHandler	Calendar event colors
schedule_handler.events	ScheduleEventsHandler	Calendar events (read-only)
schedule_handler.lessons	LessonsHandler	Lessons
schedule_handler.lessons.rules	LessonRulesHandler	Recurrence rules for a lesson
schedule_handler.daily_review	DailyReviewHandler	Daily-review module creation

Accessing sub-handlers

# Responses for a specific assignment
responses = client.assignments_handler.responses.search(assignment_id=10)

# Exercises in a module
exercises = client.course_handler.exercises.search(parent_module_id=3)

# Form fields on an exercise
fields = client.course_handler.exercises.fields.search(exercise_id=5)

# Queue items
items = client.queues_handler.items.search(queue_id=2)

# Lesson rules
rules = client.schedule_handler.lessons.rules.search(lesson_id=1)

# Current user profile
me = client.management_handler.users.me.get()