Skip to main content
EMS Software, LLC

API Functions - Kiosk Get Event Types, Rooms, Combo Components, Check Status, and Checkout

KioskGetEventTypes

Description

Returns a list of active Kiosk Event Types.

Request Parameters

Name

Description

Type

UserName *

EMS User Name

String

Password *

EMS User Password

String

Response Elements

Name

Description

Type

ID

Event Type ID

Integer

Description

Event Type Description

String

Notes

* Indicates required field.

KioskGetAllRooms

Description

Returns a list of all available rooms 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

FloorID *

Floor ID

Integer

CategoryGroupID *

Room Category Group ID

Integer

ShowActive *

Show Active Rooms (0 or 1)

Integer

ShowInactive *

Show Inactive Rooms (0 or 1)

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

RoomSize

Room Size (sq/ft)

Integer

SetupType

Room Setup Type

String

Capacity

Room Capacity

Integer

FloorID

Floor ID

Integer

FloorDescription

Floor Description

String

CategoryGroupDescription

Room Category Group Description

String

RoomTypeID

Room Type ID

Integer

RoomTypeDesc

Room Type Description

String

 

 

 

Notes

* Indicates required field.

For FloorID and CategoryGroupID just pass in a -1 if no real value is available to search on.

This result set can include both ‘Combo’ and ‘Standard’ rooms.  A ‘Combo’ room (RoomTypeID = 2) can be partitioned into n number of ‘Component’ rooms.  For a list of ‘Component’ rooms that are associated with the ‘Combo’ rooms for a specific Kiosk Profile use KioskGetRoomComboComponents().

KioskGetRoomComboComponents

Description

Returns a list of all available Component rooms 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

ComponentRoomID

Component Room ID

Integer

ComponentRoomCode

Component Room Code

String

ComponentRoom

Component Room Description

String

ComboRoomID

Combo Room ID

Integer

ComboRoomCode

Combo Room Code

String

ComboRoom

Combo Room Description

String

BuildingID

Building ID

Integer

Notes

* Indicates required field.

This result set includes all ‘Component’ rooms, if any exist, that are associated with the ‘Combo’ rooms for a specific Kiosk Profile. 

KioskGetCheckInStatus

Description

Returns the Check-In Status of a given 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

TransactionDate

Transaction Date

Date

TransactionTypeID

Transaction Type ID

Integer

BuildingID

Building ID

Integer

Notes

* Indicates required field.

The result set will be empty if there has been no transactions for the given search criteria (i.e. the group/user has neither checked in or out yet).

Return values for TransactionTypeID: 0 = Checked In, 1 = Checked Out

KioskCheckInCheckOut

Description

Checks In or Checks Out a group/user for daily events

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

TransactionType *

Transaction Type

Integer

Response Elements

Name

Description

Type

Result

Success or Failure

String

Notes

* Indicates required field.

Parameter values for TransactionType: 0 = Check-In, 1 = Check-Out