InnkeyPMS WiFi Interface Specifications

Part 1:

Usage

This API will help you get the room details. This API can be used to validate whether the room of the
guest trying to access WiFi is occupied in the hotel.

Details

API Request

https://www.innkeycloud.net/SerRest.svc/GetOccupiedRoomData?sharedkey=gjh0uYpcOFP
JM86m0Tai9AEk+2SBLzebcetr5/DsqU=&roomno=201

Parameter Value

Shared Key Unique Access Key used to authenticate WiFi Provider and Hotel
Room Number for which data is required. (If not passed, details of all the occupied
Room Number rooms will be fetched)

API Response

The result will be an XML response containing designated room details with the following fields.

Response Field Value

Room Number Room Number

Checkin ID Unique Checkin ID used to identify the folio

Adult Number of adults in the room

Guest Name Name of the Guest

Guest Mobile Number Mobile number of the guest

Checkout Date Checkout date of the guest/room

Successful Response Example

<result>
<roomData>
<roomno>202</roomno>
<checkinid>000026301</checkinid>
<guestname>Ketan Kudecha</guestname>
<guestmobileno>998762345</guestmobileno>
<checkoutdate>27-Dec-2017 12:00:00</checkoutdate>
<adult>1</adult>
<guestDetail1>
<guestName>Ketan Kudecha</guestName>
<mobileno>998762345</mobileno>
</guestDetail1>
<guestDetail2>
<guestName>Mayank Rami</guestName>
<mobileno>9875609832</mobileno>
</guestDetail2>
</roomData>
</result>

Error Response Example

<result>
<errorcode>500</ errorcode >
<message>Invalid Shared Key</ message >
</result>

Error Codes

Error Code Message

500 Invalid shared key

501 Invalid room number

502 Room not occupied

503 Error to fetch room data

Part 2:

Usage

This API will enable you post charges against internet usage to the respective guest folio in the PMS.

Details

API Request

https://www.innkeycloud.net/SerRest.svc/postWifiChargeAPI2?sharedkey=gjh0uYpcOFPJM
86m0Tai9AEk+2SBLzebcetr5/DsqU=&roomno=201&checkinid=000125400&totalamount=15
0

Parameter Value

Shared Key Unique Access Key used to authenticate WiFi Provider and Hotel

Room Number Room Number for which charges are to be pushed

Checkin ID Unique Checkin ID used to identify the folio

Total Amount Total amount to be posted to the room

API Response

The result will be an XML response containing status and a message

Response Field Value

Status True – Successfully posted to the folio

Message Message explaining the details

Successful Response Example

<result>
<status>true</ status >
<message>Charges posted successfully</ message >
</result>
Error Response Example

<result>
<status>false</ status >
<errorcode>500</ errorcode >
<message>Invalid Shared Key</ message >
</result>

Error Codes

Error Code Message

500 Invalid shared key

501 Invalid room number

502 Invalid Checkin ID

503 Room not occupied

504 Error to post charge