Skip to main content
EMS Software, LLC

API Functions - Kiosk Get Floors, Room Types, and Floor Availability

KioskGetFloorsAndRoomTypes

Description

Returns a list of floors and room types available for a specific Kiosk Profile and Group.

Request Parameters

Name

Description

Type

UserName *

EMS User Name

String

Password *

EMS User Password

String

Profile ID *

Kiosk Profile ID

Integer

GroupID *

Group ID

Integer

Response Elements

Name

Description

Type

FloorID

Floor ID

Integer

Floor

Floor Description

String

FloorSeqNo

Floor Sequence Number

Integer

RoomTypeID

Room Type ID

Integer

RoomType

Room Type Description

String

Notes

* Indicates required field.

KioskGetRoomAvailability

Description

Returns a list of available rooms based on the search criteria.

Request Parameters

Name

Description

Type

UserName *

EMS User Name

String

Password *

EMS User Password

String

Profile ID *

Kiosk Profile ID

Integer

GroupID *

Group ID

Integer

RoomTypeID *

Room Type ID

Integer

FloorID *

Floor ID

Integer

DateTimeList *

XML Date Time List

String

RowCount

Number of rows to return (defaults to 1000)

Integer

Response Elements

Name

Description

Type

RoomID

Room ID

Integer

RoomCode

Room Code

String

RoomDescription

Room Description

String

BuildingID

Building ID

Integer

BuildingCode

Building Code

String

BuildingDescription

Building Description

String

Capacity

Room Capacity

Integer

FloorID

Floor ID

Integer

RoomTypeID

Room Type ID

Integer

RoomType

Room Type Description

String

ExternalReference

Room External Reference

String

Notes

* Indicates required field.

GroupID, RoomTypeID and FloorID can be -1 to return all available results.

DateTimeList example: <Dates><Date requestedDate="2010-10-27" startTime="10:42:00" endTime="20:00:00" /></Dates>

For availability spanning multiple days just pass in additional <Date /> nodes in the DateList XML.

A maximum number of 100 records will be returned.