Response Objects
Error
| Parameter |
Description |
| ErrorValue |
0 = no errors. If greater than 0, check Error for reason |
| Error |
Error message if ErrorValue is not 0 |
Customer
| Parameter |
Description |
| CustomerID |
|
| FirstName |
|
| LastName |
|
| MiddleName |
|
| Phone |
|
| Mobile |
|
| Status |
See CustomerStatus in Defined Types for values. |
| InternalCustomerID |
custom customer ID not created by LobbyCentral |
Queue
| Parameter |
Description |
| QueueID |
|
| QueueName |
|
| LocationID |
|
| QueueType |
See QueueType in Defined Types for values. |
These fields will only contain data if the action supports them
| Parameter |
Description |
| QueueCount |
number of requests pending in queue |
| LocationName |
|
Service
| Parameter |
Description |
| ServiceID |
|
| ServiceName |
|
CustomFieldValue
| Parameter |
Description |
| FieldName |
|
| FieldID |
|
| FieldValue |
|
MobileRequest
| Parameter |
Description |
| RequestID |
|
| ServiceDec |
|
| CheckInTime |
|
| QueueName |
|
| Status |
See RequestStatus in Defined Types for values. |
| CustomFieldsData |
array of CustomField objects |
| Customer |
A Customer Object |
| LocationID |
ID of the location request was created in |
These fields will only contain data if the action supports them
| Parameter |
Description |
| TimeSeen |
The time the customer was taken. See notes for getList. |
| TimeCompleted |
The time the customer left. |
| WaitingFor |
The name of the requested user. See notes for getList. |
| WatingForID |
The ID of the requested user. See notes for getList. |
| InServiceWith |
The name of the user that is assisting the customer. See notes for getList. |
| CompletedBy |
Name of the user that completed the request (if closed) |
Location
| Parameter |
Description |
| LocationID |
|
| LocationName |
|
QueueCount
| Parameter |
Description |
| Waiting |
|
| InService |
|
| WaitingExpired |
total number of pending requests (waiting) that are older than the current date |
| InServiceExpired |
total number of in-service requests that are older than the current date |
CustomField
| Parameter |
Description |
| FieldID |
|
| FieldName |
|
| IsRequired |
|
| ScreenID |
See ScreenTypeID in Defined Types for values |
Ping
| Parameter |
Description |
| PingTime |
date/time of the ping |
| AppVersion |
version of the API |
DataTableItem
| Parameter |
Description |
| LutTableID |
See LutTableID in Defined Types for values. |
| ItemName |
Item's name |
| ItemStatus |
Item status |
| ItemValue |
Value of the item |
| ItemTypeID |
(internal use only) |
| ExtDesc |
Extra data for the item |
MobileUser
| Parameter |
Description |
| UserID |
|
| UserName |
|
| FirstName |
|
| LastName |
|
| Status |
See GeneralStatusType in Defined Types for values |
| Password |
|
| LocationID |
user's default location |
| PwdChangeDate |
date password was last changed |
| UserLevel |
user's assigned level. See Defined Types. |
| WindowsLogin |
|
| PlaySound |
|
| Email |
|
| CurrentSessionID |
user's web session ID |
| SecurityQuestion |
(not used) |
| SecurityAnswer |
(not used) |
| LoginStatus |
user's login status. See Defined Types. |
MobileAppointment
| Parameter |
Description |
| CustomerName |
|
| RequestedEmployee |
ID of the requested user |
| RequestID |
|
| ScheduledDateTime |
|
| ServiceID |
If value is -1, it is an "Other" service. |
| ServiceName |
If ServiceID is -1, ServiceName will contain the description of the service |
UserObject
| Parameter |
Description |
| UserID |
Unique ID |
| FirstName |
User's first name |
| Last Name |
User's last name |
| QueueMembership |
List of queue IDs that the user is a member of |
| Status |
User's account status. 0 = inactive, 1= active |
