PMS Integration

PMS systems can transmit commands to Tegsoft infrastructure with HTTP protocol. The URL format to be used to access thiscommand system is as follows.

http://TEGSOFT_SERVERIP/Tobe/app/ApplicationServletexternalService=PMS&usercode=USERCODE&clearpassword=PASSWORD&EXTEN=ROOM_NUMBER&EXTID=ROOM_ID&ROOMSTATUS=ROOM_STATE&CALLERID=GUEST_NAME&LOCATION

Parameters in this URL and their descriptions are given below.

• TEGSOFT_SERVERIP  ➔  The IP address of the server where the Tegsoft system is installed (such as 192.168.47.207, 10.45.119.21).
  
  
• USERCODE  ➔  The user code authorized to call the web service.
  
  
• PASSWORD or CLEARPASSWORD  ➔  The password of the user.
  
  
• ROOM_NUMBER  ➔ The extension number of the room.
  (1003, 1007, etc.)
  The ROOM_ID or ROOM_NUMBER should be declared for the system to work properly. If both are declared as parameters, ROOM_ID is taken into account.
  
  
• ROOM_ID  ➔ The unique number of the room extension phone number.
  (ad020c35-8e6d-48da-b977-7ff79b39ae1e, b4631d31-da9d-4621-b0bb-e7f0b5dc9e43, etc.)
  The ROOM_ID or ROOM_NUMBER should be declared for the system to work properly. If both are declared as parameters, ROOM_ID is taken into account.
  
  
• ROOM_STATUS  ➔ The new room status code to be assigned. If this parameter is specified, the system changes the room status.
  
  
• GUEST_NAME  ➔ The guest name to be displayed on the phone. If this parameter is specified, the system changes itsinternal name.
  
  
• GUEST_LANGUAGE  ➔ The language setting of the texts on the phone. If this parameter is specified, the system changes the extension language.
  
  

Sample URLs are given below.

http://192.168.47.201/Tobe/app/ApplicationServlet?externalService=PMS&usercode=test&clearpassword=test123&EXTEN=1005&ROOMSTATUS=Check-out

http://192.168.47.201/Tobe/app/ApplicationServlet?externalService=PMS&usercode=test&clearpassword=test123&EXTEN=1005&ROOMSTATUS=Check-in&CALLERID=JanePoe&LANGUAGE=tr

http://192.168.47.201/Tobe/app/ApplicationServlet?externalService=PMS&usercode=test&clearpassword=test123&EXTEN=1005&ROOMSTATUS=Clean&CALLERID=RichardMiles&LANGUAGE=ru

http://192.168.47.201/Tobe/app/ApplicationServlet?externalService=PMS&usercode=test&clearpassword=test123&EXTEN=1005&CALLERID=JohnDoe&LANGUAGE=de

If the URL is triggered in the specified format, a response in XML format is received. Sample answers are given below.

PMS
ERROR
< code >NOPASSWORD
Authantication is required. INVALID USERCODE OR PASSWORD


PMS
OK
< code >NOERROR
PMS Functions DONE.

Tegsoft makes no representations or warranties, either express or implied, by or with respect to anything in this document, and shall not be liable for any implied warranties of merchantability or fitness for a particular purpose or for any indirect, special or consequential damages.

Copyright © 2022, Tegsoft. All rights reserved.

"Tegsoft" and Tegsoft’s products are trademarks of Tegsoft. References to other companies and their products use trademarks owned by the respective companies and are for reference purpose only.