Model Reference
Blackboard Model Classes
- pydantic model blackboard.blackboard.BBAttachment
Blackboard File Attachment.
Show JSON schema
{ "title": "BBAttachment", "description": "Blackboard File Attachment.", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "fileName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filename" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mimetype" } }, "required": [ "id" ] }
- Config:
frozen: bool = True
- Fields:
- field fileName: str | None = None
- field id: str [Required]
- field mimeType: str | None = None
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- pydantic model blackboard.blackboard.BBAvailability
Show JSON schema
{ "title": "BBAvailability", "type": "object", "properties": { "available": { "anyOf": [ { "$ref": "#/$defs/BBAvailable" }, { "type": "null" } ], "default": null }, "allowGuests": { "default": false, "title": "Allowguests", "type": "boolean" }, "adaptiveRelease": { "additionalProperties": { "type": "string" }, "default": {}, "title": "Adaptiverelease", "type": "object" }, "duration": { "anyOf": [ { "$ref": "#/$defs/BBDuration" }, { "type": "null" } ], "default": null } }, "$defs": { "BBAvailable": { "enum": [ "Yes", "Term", "No", "Disabled", "PartiallyVisible", "__bblearn_other" ], "title": "BBAvailable", "type": "string" }, "BBDuration": { "properties": { "type": { "anyOf": [ { "$ref": "#/$defs/BBDurationType" }, { "type": "null" } ], "default": null } }, "title": "BBDuration", "type": "object" }, "BBDurationType": { "description": "Blackboard Course Duration Type.", "enum": [ "Continuous", "DateRange", "FixedNumDays", "Term", "__bblearn_other" ], "title": "BBDurationType", "type": "string" } } }
- Config:
frozen: bool = True
- Fields:
- field adaptiveRelease: dict[str, str] = {}
- field allowGuests: bool = False
- field available: BBAvailable | None = None
- field duration: BBDuration | None = None
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- class blackboard.blackboard.BBAvailable(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
- pydantic model blackboard.blackboard.BBContentHandler
Show JSON schema
{ "title": "BBContentHandler", "type": "object", "properties": { "id": { "anyOf": [ { "$ref": "#/$defs/BBResourceType" }, { "type": "null" } ], "default": null }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "file": { "anyOf": [ { "$ref": "#/$defs/BBFile" }, { "type": "null" } ], "default": null }, "gradeColumnId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Gradecolumnid" }, "groupContent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Groupcontent" }, "targetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Targetid" }, "targetType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Targettype" }, "placementHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Placementhandle" }, "assessmentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assessmentid" }, "proctoring": { "anyOf": [ { "$ref": "#/$defs/BBProctoring" }, { "type": "null" } ], "default": null } }, "$defs": { "BBFile": { "description": "Blackboard File.", "properties": { "fileName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filename" } }, "title": "BBFile", "type": "object" }, "BBProctoring": { "properties": { "secureBrowserRequiredToTake": { "default": false, "title": "Securebrowserrequiredtotake", "type": "boolean" }, "secureBrowserRequiredToReview": { "default": false, "title": "Securebrowserrequiredtoreview", "type": "boolean" }, "webcamRequired": { "default": false, "title": "Webcamrequired", "type": "boolean" } }, "title": "BBProctoring", "type": "object" }, "BBResourceType": { "description": "Different resource types on Blackboard.", "enum": [ "x-bb-folder", "x-bb-file", "x-bb-document", "x-bb-externallink", "x-bb-toollink", "x-turnitin-assignment", "x-bb-bltiplacement-Portal", "x-bb-assignment", "x-bb-asmt-test-link", "x-bb-syllabus", "x-bb-courselink", "x-bb-blankpage", "x-bb-lesson", "__bblearn_other" ], "title": "BBResourceType", "type": "string" } } }
- Config:
frozen: bool = True
- Fields:
- Validators:
- field assessmentId: str | None = None
- field gradeColumnId: str | None = None
- field groupContent: bool | None = None
- field id: BBResourceType | None = None
- Validated by:
- field placementHandle: str | None = None
- field proctoring: BBProctoring | None = None
- field targetId: str | None = None
- field targetType: str | None = None
- field url: str | None = None
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- pydantic model blackboard.blackboard.BBCourse
BlackboardCourse. Represents an academic course.
Show JSON schema
{ "title": "BBCourse", "description": "BlackboardCourse. Represents an academic course.", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "courseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Courseid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "created": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created" }, "modified": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Modified" }, "organization": { "default": false, "title": "Organization", "type": "boolean" }, "ultraStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ultrastatus" }, "closedComplete": { "default": false, "title": "Closedcomplete", "type": "boolean" }, "availability": { "anyOf": [ { "$ref": "#/$defs/BBAvailability" }, { "type": "null" } ], "default": null }, "enrollment": { "anyOf": [ { "$ref": "#/$defs/BBEnrollment" }, { "type": "null" } ], "default": null }, "locale": { "anyOf": [ { "$ref": "#/$defs/BBLocale" }, { "type": "null" } ], "default": null }, "externalAccessUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Externalaccessurl" } }, "$defs": { "BBAvailability": { "properties": { "available": { "anyOf": [ { "$ref": "#/$defs/BBAvailable" }, { "type": "null" } ], "default": null }, "allowGuests": { "default": false, "title": "Allowguests", "type": "boolean" }, "adaptiveRelease": { "additionalProperties": { "type": "string" }, "default": {}, "title": "Adaptiverelease", "type": "object" }, "duration": { "anyOf": [ { "$ref": "#/$defs/BBDuration" }, { "type": "null" } ], "default": null } }, "title": "BBAvailability", "type": "object" }, "BBAvailable": { "enum": [ "Yes", "Term", "No", "Disabled", "PartiallyVisible", "__bblearn_other" ], "title": "BBAvailable", "type": "string" }, "BBDuration": { "properties": { "type": { "anyOf": [ { "$ref": "#/$defs/BBDurationType" }, { "type": "null" } ], "default": null } }, "title": "BBDuration", "type": "object" }, "BBDurationType": { "description": "Blackboard Course Duration Type.", "enum": [ "Continuous", "DateRange", "FixedNumDays", "Term", "__bblearn_other" ], "title": "BBDurationType", "type": "string" }, "BBEnrollment": { "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" } }, "title": "BBEnrollment", "type": "object" }, "BBLocale": { "properties": { "force": { "default": false, "title": "Force", "type": "boolean" } }, "title": "BBLocale", "type": "object" } }, "required": [ "id" ] }
- Config:
frozen: bool = True
- Fields:
- field availability: BBAvailability | None = None
- field closedComplete: bool = False
- field courseId: str | None = None
- field created: datetime | None = None
- field description: str | None = None
- field enrollment: BBEnrollment | None = None
- field externalAccessUrl: str | None = None
- field id: str [Required]
- field modified: datetime | None = None
- field name: str | None = None
- field organization: bool = False
- field ultraStatus: str | None = None
- property code: str | None
Parse course code.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- property title: str | None
Parse course title.
- pydantic model blackboard.blackboard.BBCourseContent
Blackboard Content.
Show JSON schema
{ "title": "BBCourseContent", "description": "Blackboard Content.", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Body" }, "created": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created" }, "modified": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Modified" }, "position": { "default": 0, "title": "Position", "type": "integer" }, "hasChildren": { "default": false, "title": "Haschildren", "type": "boolean" }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parentid" }, "launchInNewWindow": { "default": false, "title": "Launchinnewwindow", "type": "boolean" }, "reviewable": { "default": false, "title": "Reviewable", "type": "boolean" }, "availability": { "anyOf": [ { "$ref": "#/$defs/BBAvailability" }, { "type": "null" } ], "default": null }, "contentHandler": { "anyOf": [ { "$ref": "#/$defs/BBContentHandler" }, { "type": "null" } ], "default": null }, "links": { "default": [], "items": { "$ref": "#/$defs/BBLink" }, "title": "Links", "type": "array" }, "hasGradebookColumns": { "default": false, "title": "Hasgradebookcolumns", "type": "boolean" }, "hasAssociatedGroups": { "default": false, "title": "Hasassociatedgroups", "type": "boolean" } }, "$defs": { "BBAvailability": { "properties": { "available": { "anyOf": [ { "$ref": "#/$defs/BBAvailable" }, { "type": "null" } ], "default": null }, "allowGuests": { "default": false, "title": "Allowguests", "type": "boolean" }, "adaptiveRelease": { "additionalProperties": { "type": "string" }, "default": {}, "title": "Adaptiverelease", "type": "object" }, "duration": { "anyOf": [ { "$ref": "#/$defs/BBDuration" }, { "type": "null" } ], "default": null } }, "title": "BBAvailability", "type": "object" }, "BBAvailable": { "enum": [ "Yes", "Term", "No", "Disabled", "PartiallyVisible", "__bblearn_other" ], "title": "BBAvailable", "type": "string" }, "BBContentHandler": { "properties": { "id": { "anyOf": [ { "$ref": "#/$defs/BBResourceType" }, { "type": "null" } ], "default": null }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "file": { "anyOf": [ { "$ref": "#/$defs/BBFile" }, { "type": "null" } ], "default": null }, "gradeColumnId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Gradecolumnid" }, "groupContent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Groupcontent" }, "targetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Targetid" }, "targetType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Targettype" }, "placementHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Placementhandle" }, "assessmentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Assessmentid" }, "proctoring": { "anyOf": [ { "$ref": "#/$defs/BBProctoring" }, { "type": "null" } ], "default": null } }, "title": "BBContentHandler", "type": "object" }, "BBDuration": { "properties": { "type": { "anyOf": [ { "$ref": "#/$defs/BBDurationType" }, { "type": "null" } ], "default": null } }, "title": "BBDuration", "type": "object" }, "BBDurationType": { "description": "Blackboard Course Duration Type.", "enum": [ "Continuous", "DateRange", "FixedNumDays", "Term", "__bblearn_other" ], "title": "BBDurationType", "type": "string" }, "BBFile": { "description": "Blackboard File.", "properties": { "fileName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filename" } }, "title": "BBFile", "type": "object" }, "BBLink": { "description": "Blackboard Link.", "properties": { "href": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Href" }, "rel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rel" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" } }, "title": "BBLink", "type": "object" }, "BBProctoring": { "properties": { "secureBrowserRequiredToTake": { "default": false, "title": "Securebrowserrequiredtotake", "type": "boolean" }, "secureBrowserRequiredToReview": { "default": false, "title": "Securebrowserrequiredtoreview", "type": "boolean" }, "webcamRequired": { "default": false, "title": "Webcamrequired", "type": "boolean" } }, "title": "BBProctoring", "type": "object" }, "BBResourceType": { "description": "Different resource types on Blackboard.", "enum": [ "x-bb-folder", "x-bb-file", "x-bb-document", "x-bb-externallink", "x-bb-toollink", "x-turnitin-assignment", "x-bb-bltiplacement-Portal", "x-bb-assignment", "x-bb-asmt-test-link", "x-bb-syllabus", "x-bb-courselink", "x-bb-blankpage", "x-bb-lesson", "__bblearn_other" ], "title": "BBResourceType", "type": "string" } }, "required": [ "id" ] }
- Config:
frozen: bool = True
- Fields:
- field availability: BBAvailability | None = None
- field body: str | None = None
- field contentHandler: BBContentHandler | None = None
- field created: datetime | None = None
- field hasAssociatedGroups: bool = False
- field hasChildren: bool = False
- field hasGradebookColumns: bool = False
- field id: str [Required]
- field launchInNewWindow: bool = False
- field modified: datetime | None = None
- field parentId: str | None = None
- field position: int = 0
- field reviewable: bool = False
- field title: str | None = None
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- property title_path_safe: str
Return a path safe version of the title.
- pydantic model blackboard.blackboard.BBDuration
Show JSON schema
{ "title": "BBDuration", "type": "object", "properties": { "type": { "anyOf": [ { "$ref": "#/$defs/BBDurationType" }, { "type": "null" } ], "default": null } }, "$defs": { "BBDurationType": { "description": "Blackboard Course Duration Type.", "enum": [ "Continuous", "DateRange", "FixedNumDays", "Term", "__bblearn_other" ], "title": "BBDurationType", "type": "string" } } }
- Config:
frozen: bool = True
- Fields:
- field type: BBDurationType | None = None
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- class blackboard.blackboard.BBDurationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Blackboard Course Duration Type.
- pydantic model blackboard.blackboard.BBEnrollment
Show JSON schema
{ "title": "BBEnrollment", "type": "object", "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" } } }
- Config:
frozen: bool = True
- Fields:
- field type: str | None = None
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- pydantic model blackboard.blackboard.BBFile
Blackboard File.
Show JSON schema
{ "title": "BBFile", "description": "Blackboard File.", "type": "object", "properties": { "fileName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filename" } } }
- Config:
frozen: bool = True
- Fields:
- field fileName: str | None = None
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- pydantic model blackboard.blackboard.BBLink
Blackboard Link.
Show JSON schema
{ "title": "BBLink", "description": "Blackboard Link.", "type": "object", "properties": { "href": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Href" }, "rel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rel" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" } } }
- Config:
frozen: bool = True
- Fields:
- field href: str | None = None
- field rel: str | None = None
- field title: str | None = None
- field type: str | None = None
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- pydantic model blackboard.blackboard.BBLocale
Show JSON schema
{ "title": "BBLocale", "type": "object", "properties": { "force": { "default": false, "title": "Force", "type": "boolean" } } }
- Config:
frozen: bool = True
- Fields:
- field force: bool = False
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- pydantic model blackboard.blackboard.BBMembership
Relation between student and course.
Show JSON schema
{ "title": "BBMembership", "description": "Relation between student and course.", "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Userid" }, "courseId": { "title": "Courseid", "type": "string" }, "dataSourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Datasourceid" }, "created": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created" }, "modified": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Modified" }, "availability": { "anyOf": [ { "$ref": "#/$defs/BBAvailability" }, { "type": "null" } ], "default": null }, "courseRoleId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Courseroleid" }, "lastAccessed": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Lastaccessed" }, "childCourseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Childcourseid" } }, "$defs": { "BBAvailability": { "properties": { "available": { "anyOf": [ { "$ref": "#/$defs/BBAvailable" }, { "type": "null" } ], "default": null }, "allowGuests": { "default": false, "title": "Allowguests", "type": "boolean" }, "adaptiveRelease": { "additionalProperties": { "type": "string" }, "default": {}, "title": "Adaptiverelease", "type": "object" }, "duration": { "anyOf": [ { "$ref": "#/$defs/BBDuration" }, { "type": "null" } ], "default": null } }, "title": "BBAvailability", "type": "object" }, "BBAvailable": { "enum": [ "Yes", "Term", "No", "Disabled", "PartiallyVisible", "__bblearn_other" ], "title": "BBAvailable", "type": "string" }, "BBDuration": { "properties": { "type": { "anyOf": [ { "$ref": "#/$defs/BBDurationType" }, { "type": "null" } ], "default": null } }, "title": "BBDuration", "type": "object" }, "BBDurationType": { "description": "Blackboard Course Duration Type.", "enum": [ "Continuous", "DateRange", "FixedNumDays", "Term", "__bblearn_other" ], "title": "BBDurationType", "type": "string" } }, "required": [ "courseId" ] }
- Config:
frozen: bool = True
- Fields:
- field availability: BBAvailability | None = None
- field childCourseId: str | None = None
- field courseId: str [Required]
- field courseRoleId: str | None = None
- field created: datetime | None = None
- field dataSourceId: str | None = None
- field id: str | None = None
- field lastAccessed: datetime | None = None
- field modified: datetime | None = None
- field userId: str | None = None
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- pydantic model blackboard.blackboard.BBProctoring
Show JSON schema
{ "title": "BBProctoring", "type": "object", "properties": { "secureBrowserRequiredToTake": { "default": false, "title": "Securebrowserrequiredtotake", "type": "boolean" }, "secureBrowserRequiredToReview": { "default": false, "title": "Securebrowserrequiredtoreview", "type": "boolean" }, "webcamRequired": { "default": false, "title": "Webcamrequired", "type": "boolean" } } }
- Config:
frozen: bool = True
- Fields:
- field secureBrowserRequiredToReview: bool = False
- field secureBrowserRequiredToTake: bool = False
- field webcamRequired: bool = False
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- class blackboard.blackboard.BBResourceType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
Different resource types on Blackboard.
- pydantic model blackboard.blackboard.ImmutableModel
Model with const attributes.
Show JSON schema
{ "title": "ImmutableModel", "description": "Model with const attributes.", "type": "object", "properties": {} }
- Config:
frozen: bool = True
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.