Change Status of Booking Room Reservation

post
Change Status of Booking Room Reservation

[PlatformAddress]/api/1.0/venue?action=changeStatusOfBookingRoomReservation
Change the status of a specific room reservation on a venue booking. NOTE: Currently this only supports changing the status to "checked in" or "checked out". Use this action to confirm a room reservation, and this one to cancel.
Request
Response
Request
Body Parameters
venueId
required
integer
The unique id of the venue to which the booking belongs
bookingId
required
integer
The unique id of the booking to which the room reservation belongs
id
required
integer
The unique id of the room reservation to change status
status
required
integer
The status to which the room reservation will be changed. Only a value of 4 (Checked In) or 5 (Checked Out) are supported by this action
roomIds
optional
array
Optionally, the array of ids of the individual rooms on the reservation to change status
Response
200: OK
Successfully changing a confirmed room reservation to checked-in
{
"success": true,
"errorType": null
}

Status Transitions

The following describes how the status of a booking room reservation can transition from one status to another.

NOTES: To delete a booking room reservation, use the Remove Booking Room Reservation action. To confirm a booking room reservation, use the Confirm Booking Room Reservation action. To cancel a booking room reservation, use the Cancel Booking Room Reservation action.

Response Error Types

Error Type

Reason

0

Unknown error

1

The new status is the same as the current status

2

The current status cannot transition to the new status

3

The new status is not supported. Only "checked in" and "checked out" are supported

4

The canBeEdited flag of the room reservation is false, which prevents any changes

5

Changing status of one or more room failed when roomIds parameter were set. See "failedRooms" in response for more details

Failed Rooms Error Codes

Code

Message

1

The new status is the same as the current status

2

The current status cannot transition to the new status

3

The new status is not supported

4

The reservation of room cannot be edited