HTMLHOTELTV PMS API

[:en]

This document will help you to communicate your PMS system with HTMLHOTELTV admin panel.

APIS

1- Guest Check-In

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/customer/add
HEADERS = content-type : application/json

This endpoint will provide the ability to add and check-in a new guest onto the HtmlHotelTv platform

BODY PARAMETERS

                 hbysCustomer           object
                 hbysCheckStatus      object

HBYSCUSTOMER PARAMETERS

firstName(required)	string	Guest Name
lastName(required)	string	Guest Surname
birthdate(required)	Date	Date of birth of the Guest (mm.dd.yy)
gender	string	Guest Gender
tvRight	string	TV Rights
language_code(required)	string	Guest Language
country_code(required)	string	Guest Country
room_id(required)	string	Room Number
pmsid(required)	Int	Reservation Number
prefix	string	Guest Prefix
title	string	Guest Title
address	string	Guest Address
guestShare	boolean	Share Flag
groupNumber	string	Guest Group Number
vipStatus	string	Guest VIP Status
noPostStatus	boolean	No Post Status
minibarRight	string	Minibar Rights
videoRight	string	Video Rights

HBYSCHECKSTATUS PARAMETERS

arrivalDate (required)	date	Guest Arrival Date (mm.dd.yy)
plannedDepartureDate (required)	date	Guest Departure Date (mm.dd.yy)

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.1.13/api/hbys/customer/add

REQUEST EXAMPLE :

{ 
	"hbysCustomer" : { 
		"firstName" : "Test", 
		"lastName": "Guest", 
		"birthDate" : "02.05.1996", 
		"tvRight" : "TU", 
		"gender": "Male", 
		"language_code" : "tr", 
		"country_code" : "CHI", 
		"room_id" : "1", 
		"pmsid" : 8080, 
		"prefix" : "MR.", 
		"title" : "General Manager", 
		"address" : "523 Yandell Rd Canton, Mississippi(MS), 39046", 
		"guestShare" : true, 
		"groupNumber": "715", 
		"vipStatus" : "VIP", 
		"noPostStatus" : false, 
		"minibarRight" : "MU", 
		"videoRight" : "VA" 
	}, 
	"hbysCheckStatus": [{ 
		"arrivalDate":"05.26.2022" , 
		"plannedDepartureDate" : "05.30.2022" 
	}] 
}

REQUEST RESPONSE :

Response Example For Success Request :

{ 
	"hbysCustomer": { 
		"id": 0, 
		"firstName": "Test", 
		"lastName": "Guest", 
		"isParentalLockActive": false, 
		"gender": "Male", 
		"phone": null, 
		"birthDate": "1996-02-05T00:00:00", 
		"isBillable": false, 
		"country_code": "CHI", 
		"pmsid": 8080, 
		"prefix": "MR.", 
		"title": "General Manager", 
		"address": "523 Yandell Rd Canton, Mississippi(MS), 39046", 
		"guestShare": true, 
		"groupNumber": "715", 
		"vipStatus": "VIP", 
		"noPostStatus": false, 
		"minibarRight": "MU", 
		"tvRight": "TU", 
		"language_code": "tr", 
		"videoRight": "VA", 
		"room_ID": "71" 
	}, 
	"hbysCheckStatus": [ 
		{ 
			"id": 0, 
			"arrivalDate": "2022-05-26T00:00:00", 
			"departureDate": null, 
			"plannedDepartureDate": "2022-05-30T00:00:00", 
			"customerId": 0 
		} 
	] 
}

Response Example For Not Acceptable Request :

"Missing Data"

2- Guest Check-Out

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/customer/guestout
HEADERS = content-type : application/json

This endpoint will provide the ability to check-out a guest from the HtmlHotelTv platform

BODY PARAMETERS

pmsid(required)	int	Reservation Number
guestShare(required)	boolean	Share Flag
departureDate(required)	date	Guest Departure Date
roomid(required)	string	Room Number

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.1.13/api/hbys/customer/ guestout
REQUEST EXAMPLE : 

{
	"pmsid" : 8080, 
	"firstName" : "Test", 
	"lastName" : "Guest", 
	"guestShare" : true, 
	"departureDate" : "03.09.2022", 
	"roomId" : "1" 
}

REQUEST RESPONSE :

"Guest Checked out!!!"

3- Guest Change

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/customer/roomswap
HEADERS = content-type : application/json

This endpoint will provide the ability to change guest informations from the HtmlHotelTv platform

BODY PARAMETERS

pmsid(required)	int	Reservation Number
firstName	string	Guest Name
lastName	string	Guest Surname
guestShare(required)	boolean	Share Flag
arrivalDate(required)	date	Guest Departure Date
planneddepartureDate(required)	date	Guest Departure Date
roomid(required)	string	Room Number

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.1.13/api/hbys/customer/roomswap
REQUEST EXAMPLE :

{ 
	"pmsid" : 8080, 
	"firstName" : "Test", 
	"lastName" : "Guest", 
	"guestShare":true, 
	"arrivalDate":"05.26.2022" , 
	"plannedDepartureDate" : "06.23.2022", 
	"roomId" : "3" 
}

REQUEST RESPONSE :

"Customer room changed to 3"

4- Room Equipment

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/room/roomequipment
HEADERS = content-type : application/json
This endpoint will provide the ability to add room or change room informations of
HtmlHotelTv platform

BODY PARAMETERS

Id(required)	string	Room Number
classOfService	int	Class of Service
description	string	Room Description
doNotDisturb	boolean	Do-not-Disturb
minibarRight	string	Minibar Rights
tvRight	string	TV Rights

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.1.14/api/hbys/room/roomequipment
REQUEST EXAMPLE :

{
"id": "13",
"classOfService" : 2,
"description": "Created For VESTELAPI Service Documentation",
"doNotDisturb" : false,
"minibarRight" : "MU",
"tvRight": "TU"
}

Response Examples For Not Acceptable Request :

"Missing Data".

5-Add Room

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/room/add
HEADERS = content-type : application/json
This endpoint will provide the ability to add room onto the HtmlHotelTv platform

BODY PARAMETERS

Id(required)	string	Room Number
isVacant(required)	int	Room Vacanty Status
isActive(required)	string	Room Activity Status
description	boolean	Room Description
roomOwner	string	Room Owner

REQUEST EXAMPLE :

{
"id": "96",
"isVacant": true,
"isActive": true,
"description": "Created For VESTELAPI Service Documentation",
"roomOwner": "Vestel HtmlHotelTv"
} 

Response Examples For Not Acceptable Request :

"Data format not correct"
"This room already exist"
"Missing Data"

6- Change Room

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/room/change
HEADERS = content-type : application/json
This endpoint will provide the ability to change room from the HtmlHotelTv platform

BODY PARAMETERS

Id(required)	string	Room Number
isVacant	int	Room Vacanty Status
isActive	string	Room Activity Status
description	boolean	Room Description
roomOwner	string	Room Owner

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.1.14/api/hbys/room/change
REQUEST EXAMPLE :

{
"id": "96",
"isVacant": false,
"isActive": false,
"description": "Modified for VESTELAPI Service Documentation",
"roomOwner": "Vestel HtmlHotelTv"
} 

Response Examples For Not Acceptable Request :

"Data format not correct"
"This room is not exist"
"Missing Data"

7- Delete Room

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/room/delete
HEADERS = content-type : application/json
This endpoint will provide the ability to delete room from the HtmlHotelTv platform

BODY PARAMETERS

Id(required)

string

Room Number

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.1.14/api/hbys/room/delete
REQUEST EXAMPLE :

{
"id": "96"
} 

REQUEST RESPONSE :

Response Example For Success Request:

"Room has deleted"

Response Examples For Not Acceptable Request :

“Data format not correct”
“There is a customer at this Room. You must check-out customer before delete room.”
“Missing Data”
“This room is not exist”

8- Add Alarm

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/alarm/add
HEADERS = content-type : application/json
This endpoint will provide the ability to set alarm to room from the HtmlHotelTv platform

BODY PARAMETERS

roomId(required)	string	Room Number
alarmDate(required)	date	Alarm Date
alarmTime(required)	time	Alarm Time
repeat	string	Alarm Repeat Status

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.1.15/api/hbys/alarm/add
REQUEST EXAMPLE :

{
"roomId": "96",
"alarmDate": "06.29.2022",
"alarmTime": "09:05:00",
"repeat": true
}

REQUEST RESPONSE :
Response Example For Success Request:

"Alarm is set"

Response Examples For Not Acceptable Request :

"Data format not correct"
"This alarm already exist."
"Missing Data"
"Alarm must set at least 1 minute before."
"Room is not exist."
"Room has not have any TV."

9- Delete Alarm

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/alarm/delete
HEADERS = content-type : application/json
This endpoint will provide the ability to delete alarm from the HtmlHotelTv platform

BODY PARAMETERS

roomId(required)	string	Room Number
alarmDate(required)	date	Alarm Date
alarmTime(required)	time	Alarm Time

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.1.15/api/hbys/alarm/delete
REQUEST EXAMPLE :

{
"roomId": "96",
"alarmDate": "06.29.2022",
"alarmTime": "09:05:00"
}

REQUEST RESPONSE :
Response Example For Success Request :

"Alarm is deleted"

Response Examples For Not Acceptable Request :

"Data format not correct"
"Alarm is not exist"
"Missing Data"

 

10- Send Emergency Alarm

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/alarm/sendemergency
HEADERS = content-type : application/json
This endpoint will provide the ability to send an emergency alarm to room from the HtmlHotelTv platform

BODY PARAMETERS

roomId(required)	string	Room Number
alarmMessage	string	Message For Alarm

 

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.2.5/api/hbys/alarm/sendemergency
REQUEST EXAMPLE :

{
"roomId": "1",
"alarmMessage" : "Danger! Please leave the room!"
} 

REQUEST RESPONSE :
Response Examples For Success Request :

"Emergency Alarm sent but cannot played on all Tvs because of Tv connection failed"
"Emergency Alarm Sent"

Response Examples For Not Acceptable Request :

"Data format not correct"
"Room is not exist."
"Missing Data"
"Room has not have any TV."

11- Stop Emergency Alarm

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/alarm/stopemergency
HEADERS = content-type : application/json
This endpoint will provide the ability to stop an emergency alarm from the HtmlHotelTv
platform

BODY PARAMETERS

roomId(required)

string

Room Number

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.2.5/api/hbys/alarm/sendemergency
REQUEST EXAMPLE :

{
"roomId": "1"
} 

REQUEST RESPONSE :
Response Examples For Success Request :

" Emergency Alarm cannot stopped on all Tvs because of Tv connection failed."
"Emergency Alarm Stopped"

Response Examples For Not Acceptable Request :

"Data format not correct"
"Room is not exist."
"Missing Data"
"Room has not have any TV."

12- Send Message

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/message/send
HEADERS = content-type : application/json
This endpoint will provide the ability to send message to room from HtmlHotelTv platform

BODY PARAMETERS

roomId(required)	string	Room Number
text(required)	string	Message Text
messageDate	date	Alarm Date
messageTime	time	Alarm Time
hotelMessageId(required)	int	Hotel Message Id

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.1.15/api/hbys/message/send
REQUEST EXAMPLE :

{
"roomId": "1",
"text" : "This message will self-destruct in five seconds.",
"hotelMessageId" : 44,
"messageDate": "06.29.2026",
"messageTime": "09:37:00"
} 

Response Examples For Success Request :

"Message sent"
"Message sent but cannot seen on all Tvs because of Tv connection failed." **

**When the message sent but there is a problem about some of Tv’s connection so the message
cannot be displayed on Tv screen instantly, this response will return.

Response Examples For Not Acceptable Request :

"Data format not correct"
" Room is not exist."
"Missing Data"
" Room has not have any TV."

 

 

13- Delete Message

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/message/delete
HEADERS = content-type : application/json
This endpoint will provide the ability to delete message from HtmlHotelTv platform

BODY PARAMETERS

roomId(required)	string	Room Number
hotelMessageId(required)	int	Hotel Message Id

If you send request with only roomId parameter, all of messages for the specified room
will be deleted according to sent roomId. If you send request with only hotelMessageId
parameter, all of messages from HotelTv will be deleted according to sent hotelMessageId. If
you send request with both parameters, specified message from specified room according to
sent parameters.

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.1.15/api/hbys/message/send
REQUEST EXAMPLES :

1)
{
"roomId": "1",
"hotelMessageId" : 44
}

2)
{
"roomId": "1"
}
3)
{
"hotelMessageId" : 44
}

Response Example For Success Request :

"Message deleted"

Response Examples For Not Acceptable Request:

"Data format not correct"
" Room is not exist."
"Missing Data"
" Message is not exist at any room.”
"There is no message at this room."
"This room does not have this message."

14- Sales Outlet

METHOD : POST
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/salesoutlet
HEADERS = content-type : application/json
This endpoint will provide the ability to buy items from HtmlHotelTv platform

BODY PARAMETERS

roomId(required)	string	Room Number
itemType(required)	string	Item Type
itemId(required)	int	Item Id

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.2.5/api/hbys/salesoutlet

REQUEST EXAMPLES :

1)
{
"roomId": "1",
"itemType" : "VideoContent",
"itemId" : 3
}
2)
{
"roomId": "1",
"itemType" : "VideoPackage",
"itemId" : 7
}
3)
{
"roomId": "1",
"itemType" : "PayTv",
"itemId" : 11
}
4)
{
"roomId": "1",
"itemType" : "Music",
"itemId" : 5
}

Response Examples For Success Request :

"PayTv purchased."
"Music purchased."
"Video Content purchased."
"Video Package purchased.”

Response Examples For Not Acceptable Request :

"Data format not correct"
" Room is not exist."
"Missing Data"
"No billable customer at this room."
"Channel id is not correct"
"Music id is not correct"
"VideoContent id is not correct"
"VideoPackage id is not correct"
"Item Type is not in list"

15- List PayTvs

METHOD : GET
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/paytv/list
This endpoint will provide the ability to send message to room from HtmlHotelTv platform

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.2.5/api/hbys/paytv/list
REQUEST EXAMPLE :
Response Examples For Success Request :

{
"id": 27189,
"name": "Test1"
},
{
"id": 27190,
"name": "Test2"
},
{
"id": 27191,
"name": "Test3"
}

Response Examples:

"There is no PayTv"

16- List Music Albums

METHOD : GET
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/musicalbum/list
This endpoint will provide the ability to send message to room from HtmlHotelTv platform

REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.2.5/api/hbys/musicalbum/list
REQUEST EXAMPLE :
Response Examples For Success Request :

{
"id": 77,
"name": "Album01"
},
{
"id": 78,
"name": "Album02"
}

Response Examples:

"There is no Music Album"

17- List Video Packeges

METHOD : GET
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/videopackage /list
This endpoint will provide the ability to send message to room from HtmlHotelTv platform
REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.2.5/api/hbys/videopackage /list
REQUEST EXAMPLE :
Response Examples For Success Request :

{
"id": 7,
"name": "VideoPack_01"
},
{
"id": 8,
"name": "VideoPack_02"
}

Response Examples:

"There is no Video Package"

18- List Video

METHOD : GET
URL : http://{Server IP}/htmlhoteltv_v{version}/api/hbys/video/list
This endpoint will provide the ability to send message to room from HtmlHotelTv platform
REQUEST URL : http://192.168.1.101/htmlhoteltv_v1.2.5/api/hbys/video/list
REQUEST EXAMPLE :
Response Examples For Success Request :

{
"id": 62,
"name": "X-Men"
}

Response Examples:

"There is no Video"

LANGUAGES	CODES
English/American	EA
French	FR
German	GE
Italian	IT
Arabic	SA
Spanish	SP
Portuguese	PO
Russian	RU
Turkish	TR

COUNTRIES	CODES
United Arab Emirates	ARE
Bulgaria	BGR
Switzerland	CHE
China	CHI
Germany	DEU
Denmark	DNK
Spain	ESP
Finland	FIN
France	FRA
United Kingdom	GBR
Greece	GRE
Hungary	HUN
Italy	ITA
Japan	JPN
Monaco	MNC
Netherlands	NLD
Norway	NOR
Poland	POL
Portugal	PRT
Romania	ROU
Russia	RUS
Slovakia	SVK
Slovenia	SVN
Sweden	SWE
Turkey	TUR
United States	USA

GUEST RIGHTS

TV Rights

TU	Unlimited Pay Channels
TM	No Pay Movies
TX	No Adult Movies
TN	No TV Rights

Minibar Rights

MU	Unlock Minibar
MN	Minibar Normal Vending
ML	Lock Minibar

Video Rights

VA	View Bill & Remote C/O
VB	Only View Bill
VN	No Video Rights