getInhouseGuests API Docs

getInhouseGuests API Docs

API Documentation for guests in house.

Request Payload Description

ComponentValueNote
URLhttps://{NOVOHIT_BASE_URL}/api/index.phpBase URL to reach API endpoint
Route/novohit/rcp/getInhouseGuests
If authentication valid, returns HTTP 200 with data payload.
MethodGETHTTP Method GET.
Parameters?{param=value}List of URL parameters in query string (name/value pairs).
id_hotel4260Novohit Hotel ID Code. Required.
token_auth{SEC_TOKEN}Unique token for authentication. Required. DO NOT SHARE. Sensitive information.
formatxml | jsonFormat in which the response is preferred. Optional. Default: json 

Request Example

The following example is a standard curl call:
curl https://${NOVOHIT_BASE_URL}/api/index.php/novohit/rcp/getInhouseGuests?id_hotel=${NOVOHIT_HOTEL_ID}&token_auth=${YOUR_TOKEN_AUTH}&format=xml

Return Payload Description

The returned data will be only Guests In House who have not checked out.

Field
Tag
Data Type
Notes
Hotel ID 
id_hotel
Integer
Novohit ID Code
Customer Unique IDid_customerInteger
Novohit ID Code.
Alert
Warning, this code may vary over time if the property merges Guests data. We do not recommend using this ID as primary key. Instead use holistic combination of other fields (e.g. email, last name, name, nationality) as keys.

Guest First Name 
first_name
String

Guest Last Name 
last_name
String

Birthdaydt_birthIntegerAlways in YYYYMMDD format. Example:19990711 for July 11th 1999.
Email 
e_mail
String

Guest’s Phone Number 
phone
String

LanguagelangStringISO 2-digit Code to identify guests preferred language. Example: pt for Portuguese
Countrycountry_codeStringISO 2-digit Code to identify guest's address. Example: US for USA
NationalitynationalityStringISO 2-digit Code to identify guests identified nationality at check-in. Example: BR for Brasil
Guest Segmentguest_segmentStringGuest's Segment
Guest Planguest_planStringGuest's Plan for this stay (usually associated to Food plan)
Guest Categoryguest_categoryStringGuest's category for this stay
Rate Typerate_typeStringGuests rate type for this stay
Agency (Channel)agencyStringAgency, channel or company on which this guest made his reservation
Room Name 
room_name
String

Arrival Date / check-in 
dt_arrival
Integer
Always in YYYYMMDD format. Example:20251201 for December 1st 2025.
Departure Date / check-out 
dt_departure
Integer
Always in YYYYMMDD format. Example:20260115 for January 15th 2026.
Reservation Datedt_rsvIntegerAlways in YYYYMMDD format. Example:20220510 for May 10th 2022.
Adults 
no_adults
Integer
Number of adults in this party for this stay
Children (Paying)no_children_payIntegerNumber of paying children in this party for this stay
Children (non-paying)no_children_freeIntegerNumber of non-paying (free) children in this party for this stay

Return Example

The following response is in XML format, as the request was made with format=xml:
  1. <?xml version="1.0"?>
  2. <response>
  3.     <item key="0">
  4.         <id_hotel>1055</id_hotel>
  5.         <dt_arrival>20251122</dt_arrival>
  6.         <dt_departure>20251126</dt_departure>
  7.         <room_name>4055</room_name>
  8.         <cd_rsv>ABC12</cd_rsv>
  9.         <dt_rsv>20200510</dt_rsv>
  10.         <id_customer>123456</id_customer>
  11.         <last_name>APLESEED</last_name>
  12.         <first_name>OSCAR</first_name>
  13.         <dt_birth>19990509</dt_birth>
  14.         <lang/>
  15.         <nationality>AE</nationality>
  16.         <e_mail>OSCAR.APPLESEED@EMAIL.COM</e_mail>
  17.         <phone>+97190125552</phone>
  18.         <country_code>AE</country_code>
  19.         <promo_name/>
  20.         <guest_segment>CORPORATE</guest_segment>
  21.         <guest_plan>BEDANDBREAKFAST</guest_plan>
  22.         <guest_category>BUSINESS</guest_category>
  23.         <rate_type>SINGLE</rate_type>
  24.         <no_adults>1</no_adults>
  25.         <no_children_pay>0</no_children_pay>
  26.         <no_children_free>0</no_children_free>
  27.         <agency>TRAVELOCITY</agency>
  28.     </item>
  29.     <item key="1">
  30.         <id_hotel>1055</id_hotel>
  31.         <dt_arrival>20251122</dt_arrival>
  32.         <dt_departure>20251230</dt_departure>
  33.         <room_name>1812</room_name>
  34.         <cd_rsv>CDE34</cd_rsv>
  35.         <dt_rsv>20211210</dt_rsv>
  36.         <id_customer>678954</id_customer>
  37.         <last_name>MOREIRA</last_name>
  38.         <first_name>ANDRESSA</first_name>
  39.         <dt_birth>20020220</dt_birth>
  40.         <lang>pt</lang>
  41.         <nationality>BR</nationality>
  42.         <e_mail/>
  43.         <phone/>
  44.         <country_code>US</country_code>
  45.         <promo_name/>
  46.         <guest_segment>TRAVELER</guest_segment>
  47.         <guest_plan>FAMILYMEALS</guest_plan>
  48.         <guest_category>TOUR</guest_category>
  49.         <rate_type>QUAD</rate_type>
  50.         <no_adults>2</no_adults>
  51.         <no_children_pay>2</no_children_pay>
  52.         <no_children_free>1</no_children_free>
  53.         <agency>HOTELRSV</agency>
  54.     </item>
  55.     ...
  56. </response>
Idea
If you wish to obtain JSON, use &format=json on the GET request. Fields are named the same


    • Related Articles

    • Analytics

      The Analytics platform is only available to customers with the HotelRSV Reservation engine. You can track Website and HotelRSV Reservation Engine behavior at analytics.novohit.com (https://analytics.novohit.com/). Please request your username and ...

    • Sync between Novohit and SiteMinder Channel Manager

      Novohit can connect to SiteMinder and allow the control of rates, availabilities and restrictions from our Novohit PMS platform, automating the online sales process in all OTA and GDS channels through SiteMinder Channel Manager. To see the ...