Get Tickets

Note:The Get Tickets SOAP API no longer returns ticket results. Going forward, please use the 'GET All Tickets' and 'GET Ticket' REST APIs.

Returns an array of objects of type Ticket in your Vorex account. The list can be filtered by any text value in the searchStr parameter. The result set can be retrieved in a paged manner by supplying a startIndex and endIndex.

Request

URL	https://vorexlogin.com/GetTickets

Type	Params	Values
HEAD	WSUserCredentials	Object
PARAM	outputMessage	OUTPUT String

WSUserCredentials - A custom authentication SOAP header object consisting of:
- UserName
- Password
- CompanyName
searchStr - Remains empty to retrieve all tickets. If a value is supplied the system tries to match all text and date fields to get the matching tickets.
startIndex (required) - Allows you to retrieve tickets based on their row index. This will give the ability to implement paging.
endIndex (required) - The following example retrieves the first 50 records matching "Ticket xyz".
- searchStr - Ticket xyz
- startIndex - 0
- endIndex - 50

Example Request

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

<?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>
    <GetTickets xmlns="https://vorexlogin.com/">
      <searchStr>string</searchStr>
      <startIndex>int</startIndex>
      <endIndex>int</endIndex>
    </GetTickets>
  </soap:Body>
</soap:Envelope>

Response

Status

Response

Success

GetTicketsResult:

Array of Ticket:
- TicketId (int)
- TicketNumber (string)
- ClientId (int)
- ClientName (string)
- ClientSiteId (int)
- ClientSiteName (string)
- ClientContactId (int)
- ClientContactName (string)
- TicketTitle (string)
- TicketDetails (string)
- TicketTypeId (int)
- TicketType (string)
- TicketStatusId (int)
- TicketStatus (string)
- TicketPriorityId (int)
- TicketPriority (string)
- TicketQueueId (int)
- TicketQueue (string)
- TicketPrimaryAssigneeId (int)
- TicketPrimaryAssignee (string)
- TicketSourceId (int)
- TicketSource (string)
- TicketOpenDate (DateTime)
- TicketDueDate (DateTime)
- TicketCompletedDate (DateTime)
- TicketWorkType (string)
- TicketContractName (string)
- TicketLastUpdate (DateTime)
- TicketSLAName (string)

outputMessage:

Empty String

Failure

GetTicketsResult:

Returns Null

outputMessage:

"Failed to get tickets 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>
    <GetTicketsResult>
        <Ticket>
          <TicketId>int</TicketId>
          <TicketNumber>string</TicketNumber>
          <ClientId>int</ClientId>
          <ClientName>string</ClientName>
          <ClientSiteId>int</ClientSiteId>
          <ClientSiteName>string</ClientSiteName>
          <ClientContactId>int</ClientContactId>
          <ClientContactName>string</ClientContactName>
          <TicketTitle>string</TicketTitle>
          <TicketDetails>string</TicketDetails>
          <TicketTypeId>int</TicketTypeId>
          <TicketType>string</TicketType>
          <TicketStatusId>int</TicketStatusId>
          <TicketStatus>string</TicketStatus>
          <TicketPriorityId>int</TicketPriorityId>
          <TicketPriority>string</TicketPriority>
          <TicketQueueId>int</TicketQueueId>
          <TicketQueue>string</TicketQueue>
          <TicketPrimaryAssigneeId>int</TicketPrimaryAssigneeId>
          <TicketPrimaryAssignee>string</TicketPrimaryAssignee>
          <TicketSourceId>int</TicketSourceId>
          <TicketSource>string</TicketSource>
          <TicketOpenDate>dateTime</TicketOpenDate>
          <TicketDueDate>dateTime</TicketDueDate>
          <TicketCompletedDate>dateTime</TicketCompletedDate>
          <TicketWorkType>string</TicketWorkType>
          <TicketContractName>string</TicketContractName>
          <TicketLastUpdate>dateTime</TicketLastUpdate>
          <TicketSLAName>string</TicketSLAName>
        </Ticket>

      </GetTicketsResult>
      <outputMessage>string</outputMessage>
    </GetTicketsResponse>

  </soap:Body>
</soap:Envelope>