POST
Rooms.Availability
Return one room with its active reservation bookings so the UI can calculate availability for the room calendar.
Permissions
- User must be logged in with a valid bearer token.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Runs the Rooms.Availability function and returns JSON.
Push Service
No push is sent because this function only reads data or returns helper information.
Automation
No automation is run for this function.
Special Instructions
- Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
- Send parameters as POST body fields exactly as documented.
Required Parameters
| Name | Type | Sample | Explanation |
|---|---|---|---|
room_idpost | int | 3710 | Room id to check. |
Optional Parameters
No optional body parameters are defined for this function.
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/Rooms.Availability",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"room_id": "3710"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Rooms.Availability",
"url_domain": "https:\/\/{domain}\/app\/Rooms.Availability"
}Endpoint
POST /app/Rooms.Availability
POST https://{user}.bull36.com/app/Rooms.Availability
POST https://{domain}/app/Rooms.AvailabilitySample Output
{
"success": 1,
"message": "Room booking information retrieved successfully",
"data": {
"room_details": {
"id": "3710",
"name": "Room A"
},
"bookings": []
}
}JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ room_id: '3710' });
const res = await fetch('/app/Rooms.Availability', {
method: 'POST',
headers: { Authorization: 'Bearer ' + token },
body
});
const data = await res.json();
console.log(data);Error Example
{
"success": 0,
"message": "Room id Must Required"
}