RoomKitType Reference
Enums
Enumeration types used in the RoomKit library
LocationNodeType
Types of nodes in the location hierarchy.
enum LocationNodeType {
INSTITUTION = "institution",
CAMPUS = "campus",
BUILDING = "building",
FLOOR = "floor",
WING = "wing",
ROOM = "room",
}| Value | Description |
|---|---|
institution | Top-level institution (e.g., university) |
campus | A campus within an institution |
building | A building within a campus |
floor | A floor within a building |
wing | A wing or section within a floor |
room | A bookable room (leaf node) |
BookingStatus
Lifecycle states for a booking.
enum BookingStatus {
REQUESTED = "requested",
CONFIRMED = "confirmed",
IN_PROGRESS = "in_progress",
COMPLETED = "completed",
CANCELLED = "cancelled",
}| Value | Description | Terminal |
|---|---|---|
requested | Initial state after creation | No |
confirmed | Approved and scheduled | No |
in_progress | Currently active (checked in) | No |
completed | Finished successfully | Yes |
cancelled | Cancelled at any stage | Yes |
RecurrenceFrequency
Frequency patterns for recurring bookings.
enum RecurrenceFrequency {
WEEKLY = "weekly",
BIWEEKLY = "biweekly",
CUSTOM = "custom",
}| Value | Description |
|---|---|
weekly | Every week on the specified days |
biweekly | Every other week on the specified days |
custom | Only on specified ISO calendar weeks |
RecurrenceModType
Tracks how a recurring booking instance relates to its series.
enum RecurrenceModType {
ORIGINAL = "original",
MODIFIED = "modified",
DETACHED = "detached",
}| Value | Description |
|---|---|
original | Unmodified instance as expanded from the rule |
modified | Individual instance that was changed |
detached | Instance detached from the series |
BlackoutScope
Scope levels for blackout windows.
enum BlackoutScope {
ROOM = "room",
FLOOR = "floor",
BUILDING = "building",
CAMPUS = "campus",
INSTITUTION = "institution",
}ExamLayoutType
Layout configurations for exam sessions.
enum ExamLayoutType {
EVERY_OTHER_SEAT = "every-other-seat",
FULL = "full",
}| Value | Capacity Used |
|---|---|
every-other-seat | Room.examCapacity |
full | Room.seatedCapacity |
ConflictResolutionType
How a booking conflict was resolved.
enum ConflictResolutionType {
REJECT_NEW = "reject_new",
DISPLACE_EXISTING = "displace_existing",
MANUAL = "manual",
}BulkOperationType
Types of bulk operations.
enum BulkOperationType {
SEMESTER_IMPORT = "semester_import",
DATE_SHIFT = "date_shift",
BATCH_CANCEL = "batch_cancel",
}BulkOperationStatus
Lifecycle states for bulk operations.
enum BulkOperationStatus {
PENDING = "pending",
PROCESSING = "processing",
COMPLETED = "completed",
FAILED = "failed",
}