Skip to content
Popular Search passwordcancelapiresourcesgoogle calendar
View Categories

Reservations

3 min read

Lookup Data #

Weekdays
IdWeekday
0Sunday
1Monday
2Tuesday
3Wednesday
4Thursday
5Friday
6Saturday
Reservation Update Scope (default is full)
ScopeDetails
thisCurrent Reservation Instance
fullFull Reservation Series
futureFuture Instances of Reservation Series

GET Methods #

Get Reservations #

Description
Gets a list of reservations for the specified parameters.
Query String Parameters
NameDescription
userIdId of owner to get reservations for.
resourceIdId of resource to get reservations for.
scheduleIdId of schedule to get reservations for.
startDateTimeEarliest datetime to get reservations for (inclusive). If no dates are provided, reservations for the next two weeks will be returned.
endDateTimeLatest datetime to get reservations for (inclusive). If no dates are provided, reservations for the next two weeks will be returned.
If dates do not include the timezone offset, the timezone of the authenticated user will be assumed.
Route
/Reservations/
Authentication
This service is secure and requires authentication headers
Example Response
{ "reservations": [ { "referenceNumber": "refnum", "startDate": "2023-01-17T21:40:13-0500", "endDate": "2023-01-17T21:40:13-0500", "firstName": "first", "lastName": "last", "resourceName": "resourcename", "title": "reservation title", "description": "reservation description", "requiresApproval": true, "isRecurring": true, "scheduleId": 22, "userId": 11, "resourceId": 123, "duration": "1 hours 45 minutes", "bufferTime": "1 minutes", "bufferedStartDate": "2023-01-17T21:40:13-0500", "bufferedEndDate": "2023-01-17T21:40:13-0500", "participants": [ "participant name" ], "invitees": [ "invitee name" ], "participatingGuests": [ "guest@email.com" ], "invitedGuests": [ "guest@email.com" ], "coOwners": [ "co owner name" ], "startReminder": 10, "endReminder": 10, "color": "#FFFFFF", "textColor": "#000000", "checkInDate": "2023-01-17T21:40:13-0500", "checkOutDate": "2023-01-17T21:40:13-0500", "originalEndDate": "2023-01-17T21:40:13-0500", "isCheckInEnabled": true, "autoReleaseMinutes": 1, "resourceStatusId": null, "creditsConsumed": 15, "customAttributes": [ { "id": 123, "label": "label", "value": "value", "links": [], "message": null } ], "links": [], "message": null } ], "startDateTime": null, "endDateTime": null, "links": [], "message": null }

Get Reservation #

Description
Loads a specific reservation by reference number.
Route
/Reservations/:referenceNumber
Authentication
This service is secure and requires authentication headers
Example Response
{ "referenceNumber": "refnum", "startDate": "2023-01-17T21:40:13-0500", "endDate": "2023-01-17T21:40:13-0500", "title": "reservation title", "description": "reservation description", "requiresApproval": true, "isRecurring": true, "scheduleId": 123, "resourceId": 123, "owner": { "userId": 123, "firstName": "first", "lastName": "last", "emailAddress": "email@address.com", "links": [], "message": null }, "participants": [ { "userId": 123, "firstName": "first", "lastName": "last", "emailAddress": "email@address.com", "links": [], "message": null } ], "invitees": [ { "userId": 123, "firstName": "first", "lastName": "last", "emailAddress": "email@address.com", "links": [], "message": null } ], "coOwners": [ { "userId": 123, "firstName": "first", "lastName": "last", "emailAddress": "email@address.com", "links": [], "message": null } ], "participatingGuests": [ "guest@email.com" ], "invitedGuests": [ "guest@email.com" ], "customAttributes": [ { "id": 123, "label": "label", "value": "value", "links": [], "message": null } ], "recurrenceRule": { "type": "daily|monthly|none|weekly|yearly", "interval": 3, "monthlyType": "dayOfMonth|dayOfWeek|null", "weekdays": [ 0, 1, 2, 3, 4, 5, 6 ], "repeatTerminationDate": "2023-01-17T21:40:13-0500", "repeatDates": [ "2023-01-17T21:40:13-0500" ] }, "attachments": [ { "url": "http:\/\/example\/attachments\/url" } ], "resources": [ { "id": 123, "name": "resource name", "type": null, "groups": null, "links": [], "message": null } ], "accessories": [ { "id": 1, "name": "Example", "quantityAvailable": 12, "quantityReserved": 3, "links": [], "message": null } ], "startReminder": { "value": 15, "interval": "hours or minutes or days" }, "endReminder": { "value": 15, "interval": "hours or minutes or days" }, "allowParticipation": null, "checkInDate": null, "checkOutDate": null, "originalEndDate": null, "isCheckInAvailable": null, "isCheckoutAvailable": null, "autoReleaseMinutes": null, "meetingLink": "https:\/\/www.bookedscheduler.com", "links": [], "message": null }

POST Methods #

Create Reservation #

Description
Creates a new reservation.
Route
/Reservations/
Authentication
This service is secure and requires authentication headers
Example Request
{ "accessories": [ { "accessoryId": 1, "quantityRequested": 2 } ], "customAttributes": [ { "attributeId": 2, "attributeValue": "some value" } ], "description": "reservation description", "endDateTime": "2023-01-17T21:40:13-0500", "invitees": [ 1, 2, 3 ], "participants": [ 4, 5, 6 ], "coOwners": [ 7, 8, 9 ], "participatingGuests": [ "participating.guest@email.com" ], "invitedGuests": [ "invited.guest@email.com" ], "recurrenceRule": { "type": "daily|monthly|none|weekly|yearly", "interval": 3, "monthlyType": "dayOfMonth|dayOfWeek|null", "weekdays": [ 0, 1, 2, 3, 4, 5, 6 ], "repeatTerminationDate": "2023-01-17T21:40:13-0500", "repeatDates": [ "2023-01-17T21:40:13-0500" ] }, "resourceId": 1, "resources": [ 2, 3 ], "startDateTime": "2023-01-17T21:40:13-0500", "title": "reservation title", "userId": 1, "startReminder": { "value": 15, "interval": "hours or minutes or days" }, "endReminder": null, "allowParticipation": true, "retryParameters": [ { "name": "name", "value": "value" } ], "termsAccepted": true }
Example Response
{ "referenceNumber": "referenceNumber", "isPendingApproval": true, "links": [ { "href": "http:\/\/url\/to\/reservation", "title": "get_reservation" }, { "href": "http:\/\/url\/to\/update\/reservation", "title": "update_reservation" } ], "message": null }

Update Reservation #

Description
Updates an existing reservation.
Pass an optional updateScope query string parameter to restrict changes.
Route
/Reservations/:referenceNumber
Authentication
This service is secure and requires authentication headers
Example Request
{ "accessories": [ { "accessoryId": 1, "quantityRequested": 2 } ], "customAttributes": [ { "attributeId": 2, "attributeValue": "some value" } ], "description": "reservation description", "endDateTime": "2023-01-17T21:40:13-0500", "invitees": [ 1, 2, 3 ], "participants": [ 4, 5, 6 ], "coOwners": [ 7, 8, 9 ], "participatingGuests": [ "participating.guest@email.com" ], "invitedGuests": [ "invited.guest@email.com" ], "recurrenceRule": { "type": "daily|monthly|none|weekly|yearly", "interval": 3, "monthlyType": "dayOfMonth|dayOfWeek|null", "weekdays": [ 0, 1, 2, 3, 4, 5, 6 ], "repeatTerminationDate": "2023-01-17T21:40:13-0500", "repeatDates": [ "2023-01-17T21:40:13-0500" ] }, "resourceId": 1, "resources": [ 2, 3 ], "startDateTime": "2023-01-17T21:40:13-0500", "title": "reservation title", "userId": 1, "startReminder": { "value": 15, "interval": "hours or minutes or days" }, "endReminder": null, "allowParticipation": true, "retryParameters": [ { "name": "name", "value": "value" } ], "termsAccepted": true }
Example Response
{ "referenceNumber": "referenceNumber", "isPendingApproval": true, "links": [ { "href": "http:\/\/url\/to\/reservation", "title": "get_reservation" }, { "href": "http:\/\/url\/to\/update\/reservation", "title": "update_reservation" } ], "message": null }

Approve Reservation #

Description
Approves a pending reservation.
Route
/Reservations/:referenceNumber/Approval
Authentication
This service is secure and requires authentication headers
Example Request
No request body
Example Response
{ "referenceNumber": "referenceNumber", "isPendingApproval": true, "links": [ { "href": "http:\/\/url\/to\/reservation", "title": "get_reservation" }, { "href": "http:\/\/url\/to\/update\/reservation", "title": "update_reservation" } ], "message": null }

Check In Reservation #

Description
Checks in to a reservation.
Route
/Reservations/:referenceNumber/CheckIn
Authentication
This service is secure and requires authentication headers
Example Request
No request body
Example Response
{ "referenceNumber": "referenceNumber", "isPendingApproval": true, "links": [ { "href": "http:\/\/url\/to\/reservation", "title": "get_reservation" }, { "href": "http:\/\/url\/to\/update\/reservation", "title": "update_reservation" } ], "message": null }

Check Out Reservation #

Description
Checks out of a reservation.
Route
/Reservations/:referenceNumber/CheckOut
Authentication
This service is secure and requires authentication headers
Example Request
No request body
Example Response
{ "referenceNumber": "referenceNumber", "isPendingApproval": true, "links": [ { "href": "http:\/\/url\/to\/reservation", "title": "get_reservation" }, { "href": "http:\/\/url\/to\/update\/reservation", "title": "update_reservation" } ], "message": null }

DELETE Methods #

Delete Reservation #

Description
Deletes an existing reservation.
Pass an optional updateScope query string parameter to restrict changes.
Route
/Reservations/:referenceNumber
Authentication
This service is secure and requires authentication headers
Example Request
No request body
Example Response
{ "links": [], "message": "The item was deleted" }
How was this article?

Powered by BetterDocs

Booked Scheduler