API Base URL
https://api.connect.buildingengines.com
Resources
Get Resource
GET /resource_reservations/resources/<id>
Get list of Resources
GET /resource_reservations/resources
Create Resource
POST /spaces
Example payload:
name: Meeting Room 1
floor_id: 37915880-c4f1-49cb-a1e0-0d6a72bcd54e is_common: false
is_exterior: false
resourcetype: CommonArea
account_id: b0216330-ea16-47d1-bf0e-aa387c1c76d6
building_id: 59507734-b41b-43b2-bd8e-4825623c955c
Edit Resource
PATCH /resource_reservations/resources/<id>
Pause Resource
PATCH /resource_reservations/resources/<id>/pause
Query Parameters
- Status
- building__id
- type
- available_hours_day
status (status of resource)
Draft
Active
Inactive
Example query for status Active:
GET resource_reservations/resources?status__in=Active
Example query for status Active and Draft:
GET resource_reservations/resources?status__in=Active%2CDraft
building__id (unique building id)
Example query for building id 59507734-b41b-43b2-bd8e-4825623c955c:
GET /resource_reservations/resources?building__id__in=59507734-b41b-43b2-bd8e-
4825623c955c
Example query for building ids 59507734-b41b-43b2-bd8e-4825623c955c and 2Ceb3982ee- ea07-472e-b128-a686380f1814:
GET /resource_reservations/resources?building__id__in=59507734-b41b-43b2-bd8e-
4825623c955c%2Ceb3982ee-ea07-472e-b128-a686380f1814
type (type of bookable resource)
Example query for CommonArea:
GET /resource_reservations/resources?type__in=CommonArea
Example query for CommonArea and Other:
GET /resource_reservations/resources?type__in=CommonArea%2COther
availability_hours_day (day of week)
1 (Monday)
2 (Tuesday)
3 (Wednesday)
4 (Thursday)
5 (Friday)
6 (Saturday)
7 (Sunday)
Example query for Wednesday:
GET /resource_reservations/resources?availability_hours__day__in=3
Example query for Wednesday and Friday:
GET /resource_reservations/resources?availability_hours__day__in=3%2C
Reservations
Get Reservation
GET /resource_reservations/reservations/<id>
Get list of Reservations
GET /resource_reservations/reservations
Create Reservation
POST /resource_reservations/reservations
Example payload:
amenities: []
bookable_resource_id: "54b09abb-3041-4dfe-ba7d-48686110a6fc"
building_id: "59507734-b41b-43b2-bd8e-4825623c955c"
created_for_id: "393d0b18-e6a1-4c35-b7d3-6798c29f4ff8"
date: "2022-08-09"
start_time: "13:00"
end_time: "17:00"
floor_setup_option_id: null
name: "test"
organization_id: "d4ed8624-bcb0-45e9-ae76-c9383705624f"
space_id: "034fa018-ffa7-4122-ae7e-a900e13efbad"
Edit Reservation
PATCH /resource_reservations/reservations
Query Parameters
- status
- building__id
- type
- target
status (status of reservation)
- Upcoming
- Past
- Canceled
- Pending
- Denied
- Current
Example query for status Current:
GET resource_reservations/reservations?status__in=Current
Example query for status Current and Upcoming:
GET resource_reservations/reservations?status__in=Current%2CUpcoming
building__id (unique building id)
Example query for building id 59507734-b41b-43b2-bd8e-4825623c955c:
GET /resource_reservations/reservations?building__id__in=59507734-b41b-43b2-bd8e-
4825623c955c
Example query for building ids 59507734-b41b-43b2-bd8e-4825623c955c and 2Ceb3982ee- ea07-472e-b128-a686380f1814:
GET /resource_reservations/reservations?building__id__in=59507734-b41b- 43b2-bd8e-
4825623c955c%2Ceb3982ee-ea07-472e-b128-a686380f1814
type (type of bookable resource)
Example query for CommonArea:
GET /resource_reservations/reservations?bookable_resource__type__in=CommonArea
Example query for CommonArea and Other:
GET /resource_reservations/reservations?bookable_resource__type__in=CommonArea%2COther
target (common date ranges)
- today
- yesterday
- last_week
- this_week
- last_month
- this_month
- last_quarter
- this_quarter
Example query for last_week:
GET /resource_reservations/reservations?target=last_week
date__gte & date__lte (custom date range)
Example query for dates 7/1/2022 through 7/15/2022:
GET /resource_reservations/reservations?date__gte=2022-07-01&date__lte=2022-07-15