Skip to main content
EMS Software, LLC

API Functions - Kiosk Get Profiles, Settings, Buildings, Floors, Room Types, and Group

KioskGetProfiles

Description

Returns a list of active Kiosk Profiles

Request Parameters

Name

Description

Type

UserName *

EMS User Name

String

Password *

EMS User Password

String

Response Elements

Name

Description

Type

ID

Kiosk Profile ID

Integer

Description

Kiosk Profile Description

String

Notes

* Indicates required field.

KioskGetProfileSettings

Description

Returns a list of settings for a specific Kiosk Profile.

Request Parameters

Name

Description

Type

UserName *

EMS User Name

String

Password *

EMS User Password

String

Profile ID *

Kiosk Profile ID

Integer

 

Response Elements

Name

Description

Type

Description

Parameter Description

String

DisplayValue

Parameter Text Display Value

String

Number

Parameter Numeric Value

Integer

Notes

* Indicates required field.

KioskGetBuildings

Description

Returns a list of buildings available for a specific Kiosk Profile for Today’s Events.

Request Parameters

Name

Description

Type

UserName *

EMS User Name

String

Password *

EMS User Password

String

Profile ID *

Kiosk Profile ID

Integer

 

Response Elements

Name

Description

Type

Description

Building Description Text

String

BuildingCode

Unique Building Code

String

BuildingID

Building ID

Integer

Notes

* Indicates required field.

KioskGetFloors

Description

Returns a list of floors for a specific Kiosk Profile for Today’s Events.

Request Parameters

Name

Description

Type

UserName *

EMS User Name

String

Password *

EMS User Password

String

Profile ID *

Kiosk Profile ID

Integer

 

Response Elements

Name

Description

Type

Floor

Floor Description

String

SeqNo

Floor Sequence Number

Integer

FloorID

Floor ID

Integer

BuildingID

Building ID

Integer

Notes

* Indicates required field.

Floors CAN be associated with more than one building.

Passing in a value of zero for the ProfileID will return ALL (active) floors in the database.

KioskGetRoomTypes

Description

Returns a list of room types for a specific Kiosk Profile for Today’s Events.

Request Parameters

Name

Description

Type

UserName *

EMS User Name

String

Password *

EMS User Password

String

Profile ID *

Kiosk Profile ID

Integer

Response Elements

Name

Description

Type

Type

Room Type Description

String

RoomTypeID

Room Type ID

Integer

FloorID

Floor ID

Integer

BuildingID

Building ID

Integer

Notes

* Indicates required field.

Room Types CAN be associated with more than one floor which can be associated with more than one building. 

Passing in a value of zero for the ProfileID will return ALL (active) room types in the database.

KioskGetGroup

Description

Returns a group or list of groups based on ‘GroupName’ search criteria.

Request Parameters

Name

Description

Type

UserName *

EMS User Name

String

Password *

EMS User Password

String

GroupName *

Group Name (whole or part)

String

Response Elements

Name

Description

Type

ID

Group ID

Integer

GroupName

Group Name

String

City

Group’s City

String

State

Group’s State

String

Notes

* Indicates required field.

An empty string can be passed in for GroupName to return ALL results.

A maximum number of 200 records will be returned.