Page tree
Skip to end of metadata
Go to start of metadata

Overview


The Fizz Toolkit is joining data from disparate systems into a common data model. That model is based on the core use cases and also considers the natural state of the data as exposed by instructional systems and where those field data models overlap. The FIZZ model provides a blueprint for the capture of learning management system (LMS) data for K-12 education organizations.

It is important to note that Fizz is NOT attempting to extract and use ALL data out of instructional systems: to do so would not be efficient technically, and to try to present all data would overwhelm the teacher and  other decision makers. The project is therefore making careful choices to limit data to those elements the community has identified as most useful.

Please note that this model is subject to change.

Influences & Primary References

The proposed FIZZ model is based on the API capabilities of three of the largest learning applications:

FIZZ LMS UML Diagram



Figure 1. FIZZ model representation

Contents

Entities

Entity NameEntity SchemaEntity Definition
AssignmentfizzCourse work assigned to students enrolled in a section.
AssignmentSubmissionfizzA user's submission of course work for an assignment.
LMSGradefizzA grade assigned to a user in a section.
LMSSectionfizzAn organized grouping of course content and users over a period of time for the purpose of providing instruction.
LMSUserfizzA person using the instructional system.
LMSUserAttendanceEventfizzAttendance statuses assigned to users for a specific date.
LMSUserActivityfizzAn activity performed by a user within the instructional system.
LMSUserLMSSectionAssociationfizzThe association of a user and section. For a student, this would be a section enrollment. For a teacher, this would be a section assignment.

Attributes

Entity/Table OwnerTable NameColumn NameAttribute/Column DefinitionColumn Data TypeIs RequiredIs Part of Identity
fizzAssignmentAssignmentCategoryThe category or type of assignment.String, length 60YesNo
fizzAssignmentAssignmentDescriptionThe assignment description.String, length 1024NoNo
fizzAssignmentAssignmentIdentifierA unique numeric identifier assigned to the assignment.IntegerYesYes
fizzAssignmentDeletedAtThe datetime the record EntityStatus was changed to deleted.DateTimeNoNo
fizzAssignmentDueDateTimeThe date and time the assignment is due.DateTimeNoNo
fizzAssignmentEndDateTimeThe end date and time for the assignment. Students will no longer have access to the assignment after this date.DateTimeNoNo
fizzAssignmentEntityStatusThe status of the record.String, length 60YesNo
fizzAssignmentLMSSectionIdentifierA unique numeric identifier assigned to the section.IntegerYesNo
fizzAssignmentMaxPointsThe maximum number of points a student may receive for a submission of the assignment.IntegerNoNo
fizzAssignmentSourceSystemThe system code or name providing the assignment data.String, length 255YesNo
fizzAssignmentSourceSystemIdentifierA unique number or alphanumeric code assigned to a user by the source system.String, length 255YesNo
fizzAssignmentStartDateTimeThe start date and time for the assignment. Students will have access to the assignment after this date.DateTimeNoNo
fizzAssignmentTitleThe assignment title or name.String, length 255YesNo
fizzAssignmentSubmissionAssignmentIdentifierA unique numeric identifier assigned to the assignment.IntegerYesNo
fizzAssignmentSubmissionDeletedAtThe datetime the record EntityStatus was changed to deleted.DateTimeNoNo
fizzAssignmentSubmissionEarnedPointsThe points earned for the submission.IntegerNoNo
fizzAssignmentSubmissionEntityStatusThe status of the record.String, length 60YesNo
fizzAssignmentSubmissionGradeThe grade received for the submission.String, length 20NoNo
fizzAssignmentSubmissionLMSGradeIdentifierA unique numeric identifier assigned to the submission.IntegerYesYes
fizzAssignmentSubmissionSourceSystemThe system code or name providing the user data.String, length 255YesNo
fizzAssignmentSubmissionSourceSystemIdentifierA unique number or alphanumeric code assigned to a user by the source system.String, length 255YesNo
fizzAssignmentSubmissionStatusThe status of the submission in relation to the late acceptance policy.String, length 60YesNo
fizzAssignmentSubmissionSubmissionDateTimeThe date and time of the assignment submission.DateTimeYesNo
fizzAssignmentSubmissionLMSUserIdentifierA unique numeric identifier assigned to the user.IntegerYesNo
fizzAssignmentSubmissionTypeAssignmentIdentifierA unique numeric identifier assigned to the assignment.IntegerYesYes
fizzAssignmentSubmissionTypeSubmissionTypeThe type(s) of submissions available for the assignment.String, length 60YesYes
fizzLMSGradeDeletedAtThe datetime the record EntityStatus was changed to deleted.DateTimeNoNo
fizzLMSGradeEntityStatusThe status of the record.String, length 60YesNo
fizzLMSGradeGradeThe user's letter or numeric grade for the section.String, length 20YesNo
fizzLMSGradeGradeTypeThe type of grade reported. E.g., Current, Final.String, length 60NoNo
fizzLMSGradeLMSGradeIdentifierA unique numeric identifier assigned to the grade.IntegerYesYes
fizzLMSGradeLMSSectionIdentifierA unique numeric identifier assigned to the section.IntegerYesNo
fizzLMSGradeSourceSystemThe system code or name providing the grade data.String, length 255YesNo
fizzLMSGradeSourceSystemIdentifierA unique number or alphanumeric code assigned to a user by the source system.String, length 255YesNo
fizzLMSGradeLMSUserIdentifierA unique numeric identifier assigned to the user.IntegerYesNo
fizzLMSGradeLMSUserLMSSectionAssociationIdentifierA unique numeric identifier assigned to the user section association.IntegerYesNo
fizzLMSSectionDeletedAtThe datetime the record EntityStatus was changed to deleted.DateTimeNoNo
fizzLMSSectionEntityStatusThe status of the record.String, length 60YesNo
fizzLMSSectionLMSSectionIdentifierA unique numeric identifier assigned to the section.IntegerYesYes
fizzLMSSectionLMSSectionStatusThe section status from the source system. E.g., Published, Completed.String, length 60NoNo
fizzLMSSectionSISSectionIdentifierThe section identifier defined in the Student Information System (SIS).String, length 255NoNo
fizzLMSSectionSectionDescriptionThe section description.String, length 1024NoNo
fizzLMSSectionSourceSystemThe system code or name providing the section data.String, length 255YesNo
fizzLMSSectionSourceSystemIdentifierA unique number or alphanumeric code assigned to a user by the source system.String, length 255YesNo
fizzLMSSectionTermThe enrollment term for the section.String, length 60NoNo
fizzLMSSectionTitleThe section title or name.String, length 255YesNo
fizzLMSUserDeletedAtThe datetime the record EntityStatus was changed to deleted.DateTimeNoNo
fizzLMSUserEmailAddressThe primary e-mail address for the user.String, length 255YesNo
fizzLMSUserEntityStatusThe status of the record.String, length 60YesNo
fizzLMSUserLocalUserIdentifierThe user identifier assigned by a school or district.String, length 255NoNo
fizzLMSUserNameThe full name of the user.String, length 255YesNo
fizzLMSUserSISUserIdentifierThe user identifier defined in the Student Information System (SIS).String, length 255NoNo
fizzLMSUserSourceSystemThe system code or name providing the user data.String, length 255YesNo
fizzLMSUserSourceSystemIdentifierA unique number or alphanumeric code assigned to a user by the source system.String, length 255YesNo
fizzLMSUserLMSUserIdentifierA unique numeric identifier assigned to the user.IntegerYesYes
fizzLMSUserUserRoleThe role assigned to the user. E.g., Student, Teacher, Administrator.String, length 60YesNo
fizzLMSUserAttendanceEventDeletedAtThe datetime the record EntityStatus was changed to deleted.DateTimeNoNo
fizzLMSUserAttendanceEventEntityStatusThe status of the record.String, length 60YesNo
fizzLMSUserAttendanceEventEventDateThe date of the attendance event.DateYesNo
fizzLMSUserAttendanceEventLMSSectionIdentifierA unique numeric identifier assigned to the section.IntegerNoNo
fizzLMSUserAttendanceEventSourceSystemThe system code or name providing the user data.String, length 255YesNo
fizzLMSUserAttendanceEventSourceSystemIdentifierA unique number or alphanumeric code assigned to a user by the source system.String, length 255YesNo
fizzLMSUserAttendanceEventStatusA code describing the attendance event. E.g., In Attendance, Excused Absence, Unexcused Absence.String, length 60YesNo
fizzLMSUserAttendanceEventLMSUserAttendanceEventIdentifierA unique numeric identifier assigned to the user attendance event.IntegerYesYes
fizzLMSUserAttendanceEventLMSUserIdentifierA unique numeric identifier assigned to the user.IntegerYesNo
fizzLMSUserAttendanceEventLMSUserLMSSectionAssociationIdentifierA unique numeric identifier assigned to the user section association.IntegerNoNo
fizzLMSUserActivityActivityDateTimeThe date/time the activity occurred.DateTimeYesNo
fizzLMSUserActivityActivityStatusThe activity status.String, length 60YesNo
fizzLMSUserActivityActivityTimeInMinutesThe total activity time in minutes.IntegerNoNo
fizzLMSUserActivityActivityTypeThe type of activity. E.g., Discussion Post, Account Access/Log In.String, length 60YesNo
fizzLMSUserActivityAssignmentIdentifierA unique numeric identifier assigned to the assignment.IntegerNoNo
fizzLMSUserActivityContentContent associated with the activity.String, length 1024NoNo
fizzLMSUserActivityDeletedAtThe datetime the record EntityStatus was changed to deleted.DateTimeNoNo
fizzLMSUserActivityEntityStatusThe status of the record.String, length 60YesNo
fizzLMSUserActivityLMSSectionIdentifierA unique numeric identifier assigned to the section.IntegerNoNo
fizzLMSUserActivitySourceSystemThe system code or name providing the user data.String, length 255YesNo
fizzLMSUserActivitySourceSystemIdentifierA unique number or alphanumeric code assigned to a user by the source system.String, length 255YesNo
fizzLMSUserActivityLMSUserIdentifierA unique numeric identifier assigned to the user.IntegerYesNo
fizzLMSUserActivityLMSUserActivityIdentifierA unique numeric identifier assigned to the user activity.IntegerYesYes
fizzLMSUserLMSSectionAssociationDeletedAtThe datetime the record EntityStatus was changed to deleted.DateTimeNoNo
fizzLMSUserLMSSectionAssociationEndDateMonth, day, and year of the user's withdrawal or exit from the section.DateYesNo
fizzLMSUserLMSSectionAssociationEnrollmentStatusThe status of the user section association. E.g., Active, Inactive, Withdrawn.String, length 60YesNo
fizzLMSUserLMSSectionAssociationEntityStatusThe status of the record.String, length 60YesNo
fizzLMSUserLMSSectionAssociationLMSSectionIdentifierA unique numeric identifier assigned to the section.IntegerYesYes
fizzLMSUserLMSSectionAssociationSourceSystemThe system code or name providing the user data.String, length 255YesNo
fizzLMSUserLMSSectionAssociationSourceSystemIdentifierA unique number or alphanumeric code assigned to a user by the source system.String, length 255YesNo
fizzLMSUserLMSSectionAssociationStartDateMonth, day, and year of the user's entry or assignment to the section.DateYesNo
fizzLMSUserLMSSectionAssociationLMSUserIdentifierA unique numeric identifier assigned to the user.IntegerYesYes
fizzLMSUserLMSSectionAssociationLMSUserLMSSectionAssociationIdentifierA unique numeric identifier assigned to the user section association.IntegerYesYes

API Enumerations

The FIZZ utilities that pull data from each of the three major learning management systems keep the source system enumeration values intact. The following is a breakdown of those elements by LMS and a mapping to the equivalent attribute in the FIZZ LMS model.

Google Classroom Enumerations

The following enumerations and value sets for Google Classroom are based on the Google Classroom API documentation.

EnumerationSystem ValuesEquivalent FIZZ Attribute
courses.CourseState
  • COURSE_STATE_UNSPECIFIED
  • ACTIVE
  • ARCHIVED
  • PROVISIONED
  • DECLINED
  • SUSPENDED
LMSSection.LMSSectionStatus
courses.courseWork.CourseWorkType
  • COURSE_WORK_TYPE_UNSPECIFIED
  • ASSIGNMENT
  • SHORT_ANSWER_QUESTION
  • MULTIPLE_CHOICE_QUESTION
Assignment.AssignmentCategory
courses.courseWork.studentSubmissions.SubmissionState
  • SUBMISSION_STATE_UNSPECIFIED
  • NEW
  • CREATED
  • TURNED_IN
  • RETURNED
  • RECLAIMED_BY_STUDENT
AssignmentSubmission.SubmissionStatus
invitations.CourseRole
  • COURSE_ROLE_UNSPECIFIED
  • STUDENT
  • TEACHER
  • OWNER
User.UserRole

Schoology Enumerations

The following enumerations and value sets for Schoology are based on the Schoology API documentation. Note that user roles in Schoology are stored in a configurable attribute, Role.title so there are no static system values.

EnumerationSystem ValuesEquivalent FIZZ Attribute
enrollments.status
  • 1: Active
  • 2: Expired
  • 3: Invite pending
  • 4: Requrest Pending
  • 5: Archived
LMSUserLMSSectionAssociation.EnrollmentStatus
assignments.type
  • assignment
  • discussion
  • assessment
Assignment.AssignmentCategory
assignments.comments.status
  • 0: deleted
  • 1: available
  • 2: pending moderation approval
LMSUserActivity.ActivityStatus
attendance.status
  • 1: present
  • 2: absent
  • 3: late
  • 4: excused
LMSUserAttendanceEvent.AttendanceStatus

Canvas Enumerations

The following enumerations and value sets for Canvas are based on the Canvas API documentation.

EnumerationSystem ValuesEquivalent FIZZ Attribute
courses.enrollment_type
  • teacher
  • student
  • ta
  • observer
  • designer
LMSUser.UserRole
courses.enrollment_state
  • active
  • invited_or_pending
  • completed
LMSUserLMSSectionAssociation.EnrollmentStatus
courses.state
  • unpublished
  • available
  • completed
  • deleted
LMSSection.LMSSectionStatus
assignments.submission_type
  • online_quiz
  • none
  • on_paper
  • discussion_topic
  • external_tool
  • online_upload
  • oneline_text_entry
  • online_url
  • media_recording
Assignment.SubmissionType
discussion_topics.discussion_type
  • side_comment
  • threaded
LMSUserActivity.ActivityType
enrollments.state
  • active
  • invited
  • creation_pending
  • deleted
  • rejected
  • completed
  • inactive
  • current_and_invited
  • current_and_future
  • current_and_concluded
LMSUserLMSSectionAssociation.EnrollmentStatus
submissions.submission_type
  • online_text_entry
  • online_url
  • online_upload
  • media_recording
  • basic_lti_launch
Assignment.SubmissionType
submissions.workflow_state
  • submitted
  • unsubmitted
  • graded
  • pending_review
AssignmentSubmission.SubmissionStatus
  • No labels