Facilitron Public APIs (v1)

Schemas

PropertyDto

_idstring · ObjectId · required
The unique identifier (_id) of the property
namestring · required
The name of the property
u_idstring · uuid · required
The unique identifier (u_id) of the property
addressstring · required
The address of the property
citystring · required
The city of the property
zipstring · required
The zip code of the property
statestring · required
The state of the property
timezonestring · required
The timezone of the property
propertiesstring[] · required
Array of property IDs (_id) that are children of this property

FacilityDto

property_idstring · ObjectId · required
The unique identifier (_id) of the property
_idstring · ObjectId · required
The unique identifier (_id) of the facility
u_idstring · uuid · required
The unique identifier (u_id) of the facility
namestring · required
The name of the facility
capacitynumber | null · required
The capacity of the facility
typestring · required
The type of the facility
search_termstring · required
The search term for the facility

EventDto

_idstring · required
short_idstring · required
rate_categorystring · required
statusstring · required
external_system_event_idstring | null · required
created_by_external_apiboolean · required
namestring · required
activity_typerequired
attendancenumber · required
property_idstring · required
timeslotsobject[] · required
submit_datestring · required
typestring · required
property_timezonestring · required

TimeslotDto

external_system_timeslot_idstring | null · pattern: ^[a-zA-Z0-9._-]+$ · required
The unique identifier of the timeslot from the external system. Alphanumeric plus ‘.’, ‘-’, and ‘_’ allowed.
activity_namestring | null · required
Descriptive name or note for the timeslot activity
facilityobject · required
Facility where the timeslot takes place
start_datetimestring · date-time · required
Start time of the timeslot in ISO 8601 format
end_datetimestring · date-time · required
End time of the timeslot in ISO 8601 format
statusstring · enum · required
Indicates the status of the timeslot. Can be active or suspended.
Enum values:
active
suspended

ActivityTypeDto

_idnumber · required
namestring · required

TimeslotFacilityDto

_idstring · ObjectId · required
The unique identifier (_id) of the facility
u_idstring · uuid · required
The unique identifier (u_id) of the facility
namestring · required
The name of the facility
capacitynumber | null · required
The capacity of the facility
typestring · required
The type of the facility

CancelEventSuccessResponse

messagestring · required
message_codestring · required
eventobject · required
invocation_idstring · uuid · required

UpdateTimeslotSuccessResponse

messagestring · required
message_codestring · required
timeslotobject · required
invocation_idstring · uuid · required

GetEventByIdResponse

messagestring · required
Response message
message_codestring · required
Response message code
invocation_idstring · uuid · required
Request ID
eventobject · required

GetEventsByFacilityIdResponse

messagestring · required
Response message
message_codestring · required
Response message code
invocation_idstring · uuid · required
Request ID
eventsobject[] · required
List of events which include the requested facility

GetEventsByPropertyIdResponse

messagestring · required
Response message
message_codestring · required
Response message code
invocation_idstring · uuid · required
Request ID
eventsobject[] · required
List of events which belong to the requested property

GetFacilitiesByPropertyIdResponse

messagestring · required
Response message
message_codestring · required
Response message code
invocation_idstring · uuid · required
Request ID
facilitiesobject[] · required
A list of all facilities that belong to the requested property (e.g., school)

GetPropertyByIdResponse

messagestring · required
Response message
message_codestring · required
Response message code
invocation_idstring · uuid · required
Request ID
propertyobject · required
Property details

GetAllPropertiesResponse

messagestring · required
Response message
message_codestring · required
Response message code
invocation_idstring · uuid · required
Request ID
propertiesobject[] · required
List of all properties (e.g., schools) that the API user has access to

CreateTimeslotDto

external_system_timeslot_idstring · minLength: 3 · maxLength: 50 · pattern: ^[a-zA-Z0-9._-]+$ · required
The unique identifier of the timeslot from the external system. Alphanumeric plus ‘.’, ‘-’, and ‘_’ allowed.
start_datetimestring · date-time · required
Start time of the timeslot in ISO 8601 format (local to the property timezone)
end_datetimestring · date-time · required
End time of the timeslot in ISO 8601 format (local to the property timezone)
facility_u_idstring · minLength: 1 · maxLength: 50 · required
Facility UID where the event takes place

activity_namestring · maxLength: 250
Descriptive name or note for the timeslot activity

CreateEventDto

external_system_event_idstring · minLength: 3 · maxLength: 50 · pattern: ^[a-zA-Z0-9._-]+$ · required
External event ID. Alphanumeric plus ".", "-", and "_" allowed
event_typestring · enum · required
The type of event (e.g. "reservation", "maintenance-block"). Always "reservation" for now
Enum values:
reservation
maintenance-block
namestring · minLength: 1 · maxLength: 100 · required
Event name
renter_emailstring · email · required
Renter email
statusstring · enum · required
Event status. Always approved for now.
Enum values:
approved
activity_type_idnumber · required
Activity type ID
timeslotsobject[] · required
List of event timeslots. At least one timeslot is required.

attendancenumber · min: 0 · max: 500000
Attendance. Defaults to 0 if not provided.
Default: 0
event_log_messagestring · maxLength: 250
Optional log message for event
renter_rate_category_idstring · minLength: 3 · maxLength: 50
Renter rate category ID

CreatedEventDto

external_system_event_idstring · minLength: 3 · maxLength: 50 · pattern: ^[a-zA-Z0-9._-]+$ · required
External event ID. Alphanumeric plus ".", "-", and "_" allowed
_idstring · ObjectId · required
Internal Facilitron event ID
short_idstring · uuid · required
Short public ID of the event
has_conflictboolean · required
Indicates whether the event creation caused a conflict

UpdateTimeslotDto

start_datetimestring · date-time · required
New start datetime
end_datetimestring · date-time · required
New end datetime

event_log_messagestring · maxLength: 250
Optional log message for auditing the change

UpdatedTimeslotDto

_idstring · required
Internal Facilitron timeslot ID
external_system_timeslot_idstring · required
External system timeslot ID

UpdateTimeslotResponse

messagestring · required
Response message
message_codestring · required
Response message code
invocation_idstring · uuid · required
Request ID
timeslotobject · required

CancelEventDto

statusstring · enum · required
New status of the event. Must be "cancelled".
Enum values:
cancelled

event_log_messagestring · maxLength: 250
Optional log message for event cancellation.

CancelledEventDto

external_system_event_idstring · minLength: 3 · maxLength: 50 · pattern: ^[a-zA-Z0-9._-]+$ · required
External event ID. Alphanumeric plus ".", "-", and "_" allowed
_idstring · ObjectId · required
Internal Facilitron event ID
short_idstring · uuid · required
Short public ID of the event

CancelEventResponse

messagestring · required
Response message
message_codestring · required
Response message code
invocation_idstring · uuid · required
Request ID
eventobject · required

CreateEventResponse

messagestring · required
Response message
message_codestring · required
Response message code
invocation_idstring · uuid · required
Request ID
eventobject · required

BadRequestError

invocation_idstring · uuid · required
Request ID
messagestring · required
message_codestring · required

UnauthorizedError

invocation_idstring · uuid · required
Request ID
messagestring · required
message_codestring · required

ForbiddenError

invocation_idstring · uuid · required
Request ID
messagestring · required
message_codestring · required

NotFoundError

invocation_idstring · uuid · required
Request ID
messagestring · required
message_codestring · required

TooManyRequestsError

invocation_idstring · uuid · required
Request ID
messagestring · required
message_codestring · required

InternalServerError

invocation_idstring · uuid · required
Request ID
messagestring · required
message_codestring · required

ConflictError

invocation_idstring · uuid · required
Request ID
messagestring · required
message_codestring · required

BadGatewayError

invocation_idstring · uuid · required
Request ID
messagestring · required
message_codestring · required

ServiceUnavailableError

invocation_idstring · uuid · required
Request ID
messagestring · required
message_codestring · required

GatewayTimeoutError

invocation_idstring · uuid · required
Request ID
messagestring · required
message_codestring · required

PropertyDto

_idstring · ObjectId · required
The unique identifier (_id) of the property
namestring · required
The name of the property
u_idstring · uuid · required
The unique identifier (u_id) of the property
addressstring · required
The address of the property
citystring · required
The city of the property
zipstring · required
The zip code of the property
statestring · required
The state of the property
timezonestring · required
The timezone of the property
propertiesstring[] · required
Array of property IDs (_id) that are children of this property

FacilityDto

property_idstring · ObjectId · required
The unique identifier (_id) of the property
_idstring · ObjectId · required
The unique identifier (_id) of the facility
u_idstring · uuid · required
The unique identifier (u_id) of the facility
namestring · required
The name of the facility
capacitynumber | null · required
The capacity of the facility
typestring · required
The type of the facility
search_termstring · required
The search term for the facility

EventDto

_idstring · required
short_idstring · required
rate_categorystring · required
statusstring · required
external_system_event_idstring | null · required
created_by_external_apiboolean · required
namestring · required
activity_typerequired
attendancenumber · required
property_idstring · required
timeslotsobject[] · required
submit_datestring · required
typestring · required
property_timezonestring · required

TimeslotDto

external_system_timeslot_idstring | null · pattern: ^[a-zA-Z0-9._-]+$ · required
The unique identifier of the timeslot from the external system. Alphanumeric plus ‘.’, ‘-’, and ‘_’ allowed.
activity_namestring | null · required
Descriptive name or note for the timeslot activity
facilityobject · required
Facility where the timeslot takes place
start_datetimestring · date-time · required
Start time of the timeslot in ISO 8601 format
end_datetimestring · date-time · required
End time of the timeslot in ISO 8601 format
statusstring · enum · required
Indicates the status of the timeslot. Can be active or suspended.
Enum values:
active
suspended

TimeslotFacilityDto

_idstring · ObjectId · required
The unique identifier (_id) of the facility
u_idstring · uuid · required
The unique identifier (u_id) of the facility
namestring · required
The name of the facility
capacitynumber | null · required
The capacity of the facility
typestring · required
The type of the facility

CreateTimeslotDto

external_system_timeslot_idstring · minLength: 3 · maxLength: 50 · pattern: ^[a-zA-Z0-9._-]+$ · required
The unique identifier of the timeslot from the external system. Alphanumeric plus ‘.’, ‘-’, and ‘_’ allowed.
start_datetimestring · date-time · required
Start time of the timeslot in ISO 8601 format (local to the property timezone)
end_datetimestring · date-time · required
End time of the timeslot in ISO 8601 format (local to the property timezone)
facility_u_idstring · minLength: 1 · maxLength: 50 · required
Facility UID where the event takes place

activity_namestring · maxLength: 250
Descriptive name or note for the timeslot activity

CreateEventDto

external_system_event_idstring · minLength: 3 · maxLength: 50 · pattern: ^[a-zA-Z0-9._-]+$ · required
External event ID. Alphanumeric plus ".", "-", and "_" allowed
event_typestring · enum · required
The type of event (e.g. "reservation", "maintenance-block"). Always "reservation" for now
Enum values:
reservation
maintenance-block
namestring · minLength: 1 · maxLength: 100 · required
Event name
renter_emailstring · email · required
Renter email
statusstring · enum · required
Event status. Always approved for now.
Enum values:
approved
activity_type_idnumber · required
Activity type ID
timeslotsobject[] · required
List of event timeslots. At least one timeslot is required.

attendancenumber · min: 0 · max: 500000
Attendance. Defaults to 0 if not provided.
Default: 0
event_log_messagestring · maxLength: 250
Optional log message for event
renter_rate_category_idstring · minLength: 3 · maxLength: 50
Renter rate category ID

CreatedEventDto

external_system_event_idstring · minLength: 3 · maxLength: 50 · pattern: ^[a-zA-Z0-9._-]+$ · required
External event ID. Alphanumeric plus ".", "-", and "_" allowed
_idstring · ObjectId · required
Internal Facilitron event ID
short_idstring · uuid · required
Short public ID of the event
has_conflictboolean · required
Indicates whether the event creation caused a conflict

CancelledEventDto

external_system_event_idstring · minLength: 3 · maxLength: 50 · pattern: ^[a-zA-Z0-9._-]+$ · required
External event ID. Alphanumeric plus ".", "-", and "_" allowed
_idstring · ObjectId · required
Internal Facilitron event ID
short_idstring · uuid · required
Short public ID of the event