Actions

Each call to the service must have an action value. Actions can return data or create records. Most actions return one or more objects that can be found following this section.

lookup

Searches for matching customers

Required Fields

Parameter
Description
search The name of the customer. Can be full, first, or last name.

Response

An array of Customer objects

queue

Returns a list of queue names for a location or user.

Required Fields

Parameter Description
locationID The ID of the location.
userID The ID of the user.

When retrieving all queue names for a location, userID is 0, when retrieving all queues names for a user, locationID is -1, when retrieving all queues names for a user at a specific location, both locationID and userIDare set.

Response 

An array of Queue objects

activityQueueList

Returns a list of all queue names, active or inactive.

Required Fields

none

Response

An array of Queue objects

service

Returns a list of service descriptions assigned to a specified queue.

Required Fields

Parameter Description
queueID The ID of the queue

Response

An array of Service objects

add

Creates a request (check-in) with a customer ID supplied. This call expects a valid customer ID fromLobbyCentral. If the customerID value is 0 or the customerID is not found, LobbyCentral will create anew account using the Optional fields.    

Required Fields                 

Parameter Description
custID The customer's customerID
queueID   The ID of the queue
serviceID The ID of the service description. Use -1 if Other
otherService Custom service description when serviceID = -1
locID Location ID

Optional Fields                                   

Parameter Description
accountNumber Customer's account number
comments Incoming comments for the request
middleName Customer's middle name
userID ID of user creating request. If not supplied, user is set to Mobile User
firstName Customer's first name
lastName Customer's last name
customFields A list of CustomFieldValue objects in JSON format. These custom fields must exist in LobbyCentral. Call the action 'customFields' to return a list of available custom fields.

Response

The ID for the request (requestID). If the ID returned is 0, LobbyCentral was not able to create the request. Check the Response's Error object or server log files for more information.

add2

Creates a request without supplying a customer ID. LobbyCentral will search for the customer's name to get the customerID. If no matching records or more than one matching record is returned, LobbyCentral will create a new customer account.

Required Fields    

Parameter Description
firstName Customer's first name
lastName Customer's last name
queueID The ID of the queue
serviceID The ID of the service description. Use -1 if Other
otherService Custom service description when serviceID = -1
locID Location ID
Optional Fields                                                        
Parameter Description
accountNumber Customer's account number. If known, it is recommended to pass this field for a precise hit. For example, if Bob Smith is passed, there may be multiple customers with the same name. The account number  identifies the proper customer record.
comments Incoming comments for the request
middleName Customer's middle name
userID ID of user creating request. If not supplied, user is set to Mobile User
firstName Customer's first name
lastName Customer's last name
customFields A list of CustomFieldValue objects in JSON format. These custom fields must exist in LobbyCentral. Call the action 'customFields' to return a list of available custom fields.

Response

The ID for the request (requestID). If the ID returned is 0, LobbyCentral was not able to create the request. Check the Response's Error object or server log files for more information.

getList

Returns a list of waiting and in-service customers.

Required Fields

Parameter Description
locID The ID of the location to return.
queueID The ID of the queue to return. Use -1 for all queues.
userID The ID of the user. If supplied, only returns requests for this user.

Response

An array of Request objects

If userID is supplied, the Request object will contain the WaitingFor and WaitingForID field. If the request status is 1 (In-Service), the Request object will contain InServiceWith andTimeSeen.

getCompletedRequests

Returns a list of completed requests for a customer.

Required Fields

Parameter Description
custID The ID of the customer
OR
Parameter Description
internalCustID The internal customer ID of the customer
OR
Parameter Description
startDate Beginning date range
endDate Ending date range
OR
Parameter Description
locID The ID of the location
startDate Beginning date range
endDate Ending date range
queueID (optional) to pull completed requests for a specific queue ID

Supply one input, not both. Response

An array of Request objects

getDetail

Returns the details of a request.

Required Fields

Parameter Description
requestID The ID of the request to return

Response

A MobileRequest object

locations

Returns a list of locations defined in LobbyCentral.

Required Fields

None

Response

An array of Location objects

takeRequest

Changes the status of a pending request to In-Service.

Required Fields

Parameter Description
requestID The ID of the request to take
userID The ID of the user to assign to the request

Response

None. 

Check the result of ErrorValue . 

0 = request was assigned, 2 = assignment failed. 

If assignment fails, it means that the request was taken by another user or has been deleted.

closeRequest

Changes the status of a request as close/completed (same as check-out).

Required Fields

Parameter Description
requestID The ID of the request to close

Response

None. 

Check ErrorValue for success. 0 = completed.

deleteRequest

Deletes a request from the database. Should not be used to CLOSE or CHECK-OUT a request.

Required Fields

Parameter Description
requestID The ID of the request to delete

Response

None. 

Check the result of Error Value. 0 = success.

abandonRequest

Changes the status of a request to abandoned.

Required Fields

Parameter Description
requestID The ID of the request to abandon

Response

None. 

Check Error Value for success. 

0 = completed.

return

Changes the status of a request from In-Service to Pending. Returns to the wait queue.

Required Fields

Parameter Description
requestID The ID of the request to return

Response

None. 

Check ErrorValue for success. 

0 = completed.

getCount

Returns the total number of requests waiting and in-service for a queue

Required Fields

Parameter Description
queueID The ID of the queue

Response

A QueueCount object.

customFields

Returns a list of active custom fields.

Required Fields

None.

Response

An array of CustomField objects.

login

Logs a LobbyCentral user account into the system. Cannot be used for user accounts using Single SignOn.Requires a LobbyCentral login account.

If a login is successful, the user's status is set to available for the location supplied.

Required Fields

Parameter Description
username LobbyCentral username
password User's password
locationID The ID of the location the user is logging into

Response

A UserProfile object. ErroValue will be set to 1 if the login fails.

logout

Signs out a LobbyCentral user account. Cannot be used for user accounts using Single Sign-On. Requires a LobbyCentral login account.

Required Fields

Parameter Description
userID The ID of the user to sign out
locationID The ID of the location the user is signing out of

Response

None.

ping

Used to verify if the API service is available.

Required Fields

None

Response

A Ping object

dataTable

Returns a list of items for a data table.

Required Fields

Parameter Description
tableID The ID of the data table. See DataTableID in the Defined Types section.

Response

An array of DataTable Item objects

userInfo

Returns information about a user. Cannot be used for user accounts using Single Sign-On. Requires aLobbyCentral login account.

Required Fields

Parameter Description
username LobbyCentral username

Response

A User object

* For security purposes, the password field will always be empty.

queueInfo

Returns information about a queue.

Required Fields

Parameter Description
queueID The ID of the queue to return

Response

A Queue object

availUsers

Returns a list of available users for a location.

Required Fields

Parameter Description
locationID The ID of the location

Response

An array of MobileUser objects.

getServerTime

Returns the server's date and time.

Required Fields

None.

Response

String containing the current date and time from the server

getAppointments

Searches for appointments for location that match a customer's last name.

Required Fields

Parameter Description
locationID The ID of the location to search
lastName The last name of the customer to search

Response

An array of Mobile Appointment objects that match the criteria.

apptCheckIn

Checks in an appointment.

Required Fields

Parameter Description
requestID The ID of the request

Response

None

summaryForRange

Returns summary of total customers seen, abandoned, total wait time, total service time by queue.  A location ID can be supplied to return a specific location. Otherwise, all locations are returned.

Required Fields

Parameter Description
startDate Use format mm/dd/yyy hh:mm am/pm
endDate Use format mm/dd/yyy hh:mm am/pm

Optional

Parameter Description
locationID The ID of the location

Response

List of LocationSummary objects

getUserList

Returns the complete user list including inactive accounts.   Pass withQueues set to true to include user's queue membership.

Required Fields

None

Optional Fields

Parameter Description
withQueues true or false (default)

Still need help? Contact Us Contact Us