WebAPI Documentation Hotel

General information

Before a command can be invoked in the ITK appliance, a login is mandatory. The only exception is querying the system information.

Authorization on the ITK appliances takes place via Digest Access Authentication (DAA) in accordance with RFC 2617. Session recognition runs away from the standard digest implementation. It is done by means of a cookie AUERSessionID (15 characters long value) from the webserver of the ITK appliance, in the first successful login. If this application does not transfer this cookie, the web server will request a renewed authorization with Digest Access Authentication every time it is called. It should be noted that then another session is created. Currently, the webserver supports a maximum of 100 sessions. If this value is exceeded, the oldest participant sessions in the webserver of the ITK appliance are deleted.

Call The following commands are invoked exclusively via https. The individual commands are appended to the URL, e.g. Eg https://192.168.0.240/app_.

Response All responses from the system are made using content-type application / json (charset = utf-8). Hotel API is implemented in version 6 of the API, the version level of the API is shown in http header “X-AppVersion”.


Get List of hotel rooms

API call (URL)Access LevelParameters
/app_hotel_listSub-Admin
Admin
none

Example call https://192.168.0.240/app_hotel_list

Notes / reminders:

  • Activation code for hotel subscriber needed to use this API call
ResponsePossible content
idUnique id of hotel room / subscriber
nameName for hotel room / subscriber
nrSubscriber number of hotel room

Example response:

[
	{
		"id": 7382,
		"name": "Room 213",
		"nr": 213
	},
	{
		...
	}
]

Get state of hotel room

API call (URL)Access LevelParameters
/app_hotel_getSub-Admin
Admin
id Unique id of hotel room / subscriber

Example call https://192.168.0.240/app_hotel_get?id=7382

Notes / reminders:

  • Activation code for hotel subscriber needed to use this API call
ResponsePossible content
checkedIn0 hotel room free (no check in) 1 hotel room occupied (check in)
checkinId0 hotel room free (no check in)
1…65535 (system generated) itarated checkin id
checkinDateDate of last checkin (format: “yymmddhhmm”)
exchangeLine0 no outgoing calls
1 in and outgoing calls
locked0 hotel room is locked
1 hotel room is available
cleaned0 hotel room needs cleanup
1 hotel room is clean
noInternalCalls0 calls to other guest rooms are allowed
1 calls to other guest rooms are not allowd
chargescall charges (incurred in hundredths)
chargesFormattedFormatted String of call charges

Example response:

[
	{
		"checkedIn": 1,
		"checkinId": "20965",
		"checkinDate": "1804171413",
		"exchangeLine": 1,
		"locked": 0,
		"cleaned": 1,
		"nointernalCalls": 0,
		"charges": 2250,
		"chargesFormatted": "22.50 €"
	},
	{
		...
	}
]

Set state of hotel room

API call (URL)Access LevelParameters
/app_hotel_setSub-Admin
Admin
id Unique id of hotel room / subscriber
checkedIn 0 Check-Out 1 check-In
exchangeLine 0 no outgoing calls 1 in and outgoing calls
locked 0 hotel room is locked 1 hotel room is available
cleaned 0 hotel room needs cleanup 1 hotel room is clean

Example call https://192.168.0.240/app_hotel_set?id=7382&checkedIn=1

https://192.168.0.240/app_hotel_set?id=7382&checkedIn=1&locked=0

https://192.168.0.240/app_hotel_set?id=7382&exchangeLine=0&locked=1&cleaned=0

Notes / reminders:

  • id is mandatory, other parameters are optional
  • Activation code for hotel subscriber needed to use this API call
ResponsePossible content
successfultrue set state was successful
false set state was not successful

Example response:

{ "successful": true }

Get call list of hotel room

API call (URL)Access LevelParameters
/app_hotel_callsSub-Admin
Admin
id Unique id of hotel room / subscriber
or
checkinId check in id
wakeupCalls optional parameter to get list of wake up calls

Example call https://192.168.0.240/app_hotel_calls?id=7382

https://192.168.0.240/app_hotel_calls?checkinId=20965

https://192.168.0.240/app_hotel_calls?id=7382&wakeupCalls

https://192.168.0.240/app_hotel_calls?checkinId=20965&wakeupCalls

Notes / reminders:

  • You can access call data after check out via parameter check in id
  • Activation code for hotel subscriber needed to use this API call
ResponsePossible content
idid of call data entry
extNameName of caller, if stored in address book of pbx, transmitted by network operator or resolved by online name search
extRufNrNumber of caller (if transmitted)
datumCall date
startZeitCall start time
dauerDuration / call time in seconds
msnOwn called line extension
dirDirection 0 incoming 1 outgoing
SuccessState of wake up call 0 unanswered 1 answered

Example response (hotel calls):

[
 {
    "id": 58447,
    "extName": "",
    "extRufNr": "0530692000",
    "datum": "04.04.17",
    "startZeit": "12:44:59",
    "dauer": "48",
    "msn": "970851",
    "dir": 0
  },
  {
    "id": 58448,
    "extName": "",
    "extRufNr": "0530692000",
    "datum": "02.04.17",
    "startZeit": "12:10:29",
    "dauer": "147",
    "msn": "970851",
    "dir": 1
  }
]

Example response (wake up calls):

[
  {
        "id": 1518,
        "datum": "10.07.18",
        "startZeit": "15:22:29",
        "dauer": "00:00:29",
        "success": 0
  },
  {
        "id": 1517,
        "datum": "10.07.18",
        "startZeit": "15:21:07",
        "dauer": "00:00:07",
        "success": 1
  }
]

Get wake up calls of hotel room

API call (URL)Access LevelParameters
/app_hotel_wakeup_listSub-Admin
Admin
id Unique id of hotel room / subscriber

Example call https://192.168.0.240/app_hotel_wakeup_ist?id=7382

Notes / reminders:

  • Activation code for hotel subscriber needed to use this API call

|Response|Possible content|

idUnique id of wake up call
zeittime, format hh:mm.
tagday(s) 1 Monday 2 Tuesday 4 Wednesday 8 Thursday 16 Friday 32 Saturday 64 Sunday
31 Monday to Friday 96 Saturday to Sunday 127 every day
aktivWake up call state 0 deactivated 1 activated
immerWake up repetition 0 once 1 recurrend
fwProgZorigin of wake up call 0 Webserver / API 1 programmed by
 

Example response:

[
 {
    "id": 5070,
    "zeit": "08:16",
    "tag": 31,
    "aktiv": 1,
    "immer": 1,
    "fwProg": 0
 },
 {
    "id": 5813,
    "zeit": "09:15",
    "tag": 96,
    "aktiv": 1,
    "immer": 1,
    "fwProg": 1
 }
]

Set wake up call for hotel room

API call (URL)Access LevelParameters
/app_hotel_wakeup_setSub-Admin
Admin
id Unique id of hotel room / subscriber
action 0 create 1 modify 2 delete
weckId unique id of wake up call (id)
zeit time, formatted hh:mm tag day(s) 1 Monday 2 Tuesday 4 Wednesday 8 Thursday 16 Friday 32 Saturday 64 Sunday 31 Monday to Friday 96 Saturday to Sunday 127 every day immer
Wake up repetition 0 once 1 recurrend
aktiv
Wake up call state
0 deactivated 1 aktivated

Example call https://192.168.0.240/app_hotel_wakeup_set?id=7382&action=0&zeit=08:00&tag=31&aktiv=1&immer=1

https://192.168.0.240/app_hotel_wakeup_set?id=7382&action=1&zeit=07:30

Notes / reminders:

  • Activation code for hotel subscriber needed to use this API call

|Response|Possible content|

successfultrue create / modify / delete success
false create / modify / delete not success

Example response:

{ "successful": true }