Next Topic

Previous Topic

Book Contents

Get Ticket Note Types

Returns a TicketNoteType array of possible ticket note types defined in your Vorex account.

Request

URL

https://vorexlogin.com/GetTicketNoteTypes

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/GetTicketNoteTypes"

<?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>
<GetTicketNoteTypes xmlns="https://vorexlogin.com/" />
</soap:Body>
</soap:Envelope>

Response

Status

Response

Success

GetTicketNoteTypesResult:

  • Array of TicketNoteType:
    • TypeId (int)
    • TypeName (string)

outputMessage:

  • Empty String

Failure

GetTicketNoteTypesResult:

  • Returns Null

outputMessage:

  • "Failed to get note types 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>
<GetTicketNoteTypesResponse xmlns="https://vorexlogin.com/">
<GetTicketNoteTypesResult>
<TicketNoteType>
<TypeId>int</TypeId>
<TypeName>string</TypeName>
</TicketNoteType>
<TicketNoteType>
<TypeId>int</TypeId>
<TypeName>string</TypeName>
</TicketNoteType>
</GetTicketNoteTypesResult>
<outputMessage>string</outputMessage>
</GetTicketNoteTypesResponse>
</soap:Body>
</soap:Envelope>