Next Topic

Previous Topic

Book Contents

Get Ticket Queues

Returns a TicketQueue array of possible ticket queues defined in your Vorex account.

Request

URL

https://vorexlogin.com/GetTicketQueues

Type

Params

Values

HEAD

WSUserCredentials

Object

PARAM

outputMessage

OUTPUT String

Example Request

POST /WS/OpenAPI.asmx HTTP/1.1
Host: vorexlogin.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://vorexlogin.com/GetTicketQueues"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<WSUserCredentials xmlns="https://vorexlogin.com/">
<UserName>string</UserName>
<Password>string</Password>
<CompanyName>string</CompanyName>
</WSUserCredentials>
</soap:Header>
<soap:Body>
<GetTicketQueues xmlns="https://vorexlogin.com/" />
</soap:Body>
</soap:Envelope>

Response

Status

Response

Success

GetTicketQueuesResult:

  • Array of TicketQueue:
    • QueueId (int)
    • QueueName (string)

outputMessage:

  • Empty String

Failure

GetTicketQueuesResult:

  • Returns Null

outputMessage:

  • "Failed to get Queues list."

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTicketQueuesResponse xmlns="https://vorexlogin.com/">
<GetTicketQueuesResult>
<TicketQueue>
<QueueId>int</QueueId>
<QueueName>string</QueueName>
</TicketQueue>
<TicketQueue>
<QueueId>int</QueueId>
<QueueName>string</QueueName>
</TicketQueue>
</GetTicketQueuesResult>
<outputMessage>string</outputMessage>
</GetTicketQueuesResponse>
</soap:Body>
</soap:Envelope>