Reserved Rooms Calendar

This API helps you to populate a stayview calendar with needful information for specific date ranges on your selected rooms. The API can return data in JSON formats. The web service responds to HTTP POST requests.

End Point URL

Note: You need set Authcode in Header.

Header

Content-Type: application/json; AUTH_CODE: XXXXXXXXXXXXXXXXX

Parameter

NameData TypeDescription Example
request_type *VARCHAR(150)Use Keyword “get_calendar”
hotel_id *INT(11)Unique Hotel codeXXXX
room_id *INT(20)List of room Ids(If a date range is same for all Room IDs then all Ids will be listed in a single block else separate block will be there for a different date range) 1234500000000001, 1234500000000002
room_code *INT(20)List of room codes“102”, “104”,”108″
from_date *DateStart date of calendar information is to be requested
Format: YYYY-MM-DD
2020-06-15
to_date *DateEnd date of calendar information is to be requested
Format: YYYY-MM-DD
2020-07-15

Request 

{    "request_type": "get_calendar",
    "body": {

        "hotel_id": "xxxx",
        "rooms": [{
                "room_id": ["1234500000000000002", "1234500000000000003"],
           "room_code": ["107", "111", "112", "113"],
                "from_date": "2020-04-15",
                "to_date": "2020-05-15"
            },
            {
                "room_id": ["1234500000000000007"],
                "room_code": ["125","126"],
                "from_date": "2020-04-15",
                "to_date": "2020-05-15"
            }
        ]
    }
}

Response

NameData TypeDescription Example
statusStringFailure or success of the request
Values: Success, Error
Success
data.*IntegerHere * means Room type ID1234500000000001
data.*.room_nameStringName of RoomSuper Deluxe
data.*.room_name.dateDateCalendar DateFormat: YYYY-MM-DD2020-03-01
data.*.room_name.statusStringStatus of the roomValues : Reserved: If book is BookedBlocked: If sell is stopped for particular reasonReserved
data.*.room_name.reservation_infoIf Room status is blocked then the Value of this Parameter will be blank else if room is booked, then reservation details will be supplied. 
data.*.room_name.reservation_info.reservation_idStringReservation Id
data.*.room_name.reservation_info.channelStringChannel name & channel hotel code from where a booking has been come in below formatname_channelHotelCode
data.*.room_name.reservation_info.guest_nameStringName of guestGuest Name
data.*.room_name.reservation_info.check_inDateDate of Check-in2020-04-01 12:00:00
data.*.room_name.reservation_info.check_outDateDate of Check-Our2020-05-03 12:00:00
error_codeError code in case of failure101
error_messageError Message in case of failureInvalid Authentication Data

Success

{ "status": "success",
 "data": {
  "1234500000000000002": {
   "room_info": "No Booking/Blocks are available for supplied Date Range"
  },
  "1234500000000000003": {
   "room_info": "No Booking/Blocks are available for supplied Date Range"
  },
  "1234500000000000007": {
   "room_name": "Stander",
   "room_info": [
    {
     "room_code": "125",
     "date": "2020-05-09",
     "status": "Reserved",
     "reservation_info": {
      "folios": {
       "33": {
        "Room Charges": "450.0000",
        "Service Tax": "100.0000",
        "All in Package [Qty -2.0000]": "300.0000"
       }
      },
      "reservation_id": "32",
      "guest_name": "Mam. Daya",
      "channel": "",
      "remark": "",
      "check_in": "2020-05-09 12:00:00",
      "check_out": "2020-05-10 11:00:00",
      "booking_status": "Confirmed Reservation",
      "total_amount": 850,
      "currency": "INR",
      "payment_type": "Pay At Hotel"
     }
    }
   ]
  }
 }
}

Error Codes

Error CodeError Name
101Invalid Hotel Id
102Invalid Authentication
103Blank Request
104Invalid Request Format
105Missing Required Parameter
106Invalid Reservation ID
107Invalid Date Format
108Invalid Date Range
109Currently Data can be requested for max 15 days
110Invalid Room Id
111IP Address is not Authorised
112Invalid Request Method
113Hotel Code is not Active
114Invalid Room Code or not associated with supplied room ID
115Internal Problem

Click here to Register