QueueProvider Service

An API to track queues and queue configurations.

Namespace
http://airportal.service.cbtweb.cbt.com/
WSDL
airportal.wsdl
Path
/QueueProviderService

getQueueById Operation

Get a queue using the ID.

Input Parameters
name type description
queueId long The ID of the queue to retrieve.
Return Value
type description
queue A queue object.

updateQueue Operation

Create or update a queue.

Input Parameters
name type description
record queue The queue to create or update.
Return Value
type description
queue The queue to create or update.

updateQueueProperties Operation

Update only the properties in a queue.

Input Parameters
name type description
record queue The queue record with the desired updates.
Return Value
type description
queue The updated queue.

updateQueueSortSetting Operation

Update the queue sort settings in a queue.

Input Parameters
name type description
setting queueSortSetting The setting to update.
queueid long The ID of the queue to add the setting to.
Return Value
type description
queue The updated queue after the addition.

deleteQueueSortSetting Operation

Delete a queue setting rule.

Input Parameters
name type description
settingid long The id of the setting.
Return Value
type description
queue The queue after the deletion.

updateQueueAgentSortSetting Operation

Update the queue sort agent setting in a queue.

Input Parameters
name type description
setting queueAgentSortSetting The setting to update.
queueid long The ID of the queue to add the setting to.
Return Value
type description
queue The updated queue after the addition.

deleteQueueAgentSortSetting Operation

Delete a queue agent setting rule.

Input Parameters
name type description
settingid long The ID of the setting to remove.
Return Value
type description
queue The updated queue after the deletion.

getQueueSortSettingById Operation

Get a queue using the ID.

Input Parameters
name type description
sortId long The ID of the queue to retrieve.
Return Value
type description
queueSortSetting A queue object.

deleteQueue Operation

Delete a queue.

Input Parameters
name type description
id long The ID of the queue sort setting.

searchQueues Operation

Search for a queue using a custom query.

Input Parameters
name type description
search searchList The query to search for queues.
Return Value
type description
list of queue A list of queues described by the query

countQueues Operation

Search for a queue using a custom query.

Input Parameters
name type description
search searchList The query to search for queues.
Return Value
type description
long A list of queues described by the query

searchQueueErrors Operation

Get a list of errors involving queues.

Input Parameters
name type description
list searchList A searchlist identifying errors in the queue sorting.
Return Value
type description
list of queueErrorReport A list of queue error reports.

countQueueErrors Operation

Search for a queue using a custom query.

Input Parameters
name type description
search searchList The query to search for queues.
Return Value
type description
long A list of queues described by the query

resolveQueueError Operation

Set a QueueErrorReport to resolved.

Input Parameters
name type description
errorId long The id of the queue error report to set to resolved.
Return Value
type description
queueErrorReport The resolved Queue Error

getQueuesForAgent Operation

Get all of the queues that an agent has.

Input Parameters
name type description
id long The ID of the queue.
Return Value
type description
list of queue A list of all queues that an agent has.

getQueueTypes Operation

Get all queue types that are available.

Return Value
type description
list of queueType A list of all queue types that are available.