Create Ticket Note

Creates a ticket note for a specific TicketId in your Vorex account using a ticketNote object.

Request

URL	https://vorexlogin.com/CreateTicketNote

Type	Params	Values
HEAD	WSUserCredentials	Object
PARAM	ticketNote	Object
PARAM	outputMessage	OUTPUT String

WSUserCredentials - A custom authentication SOAP header object consisting of:
- UserName
- Password
- CompanyName
ticketNote (Ticket Note Object) - The ticket note information will be specified in this Ticket Note Object consisting of the following parameters:
TicketId (Int) - Required. Links the note to a specific ticket.
UserId (Int) - Optional. If not specified the note will appear to be created by the system. Soap Action https://vorexlogin.com/GetEmployeesList can be used to Employees User IDs
NoteDetails (string) - Required.
NoteTypeId (Int) - Required. Soap Action https://vorexlogin.com/GetTicketNoteTypes can be used to get ticket types.
IsInternalNote (boolean) - Required. Specifies if this note is internal or public to the client to see.
NoteDate (datetime) - Required.

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

<?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>
    <CreateTicketNote xmlns="https://vorexlogin.com/">
      <ticketNote>
        <TicketId>int</TicketId>
        <UserId>int</UserId>
        <NoteDetails>string</NoteDetails>
        <NoteTypeId>int</NoteTypeId>
        <IsInternalNote>boolean</IsInternalNote>
        <NoteDate>dateTime</NoteDate>
      </ticketNote>
    </CreateTicketNote>
  </soap:Body>
</soap:Envelope>

Response

Status

Response

Success

CreateTicketNoteResult:

Integer representing the new Ticket Note ID

outputMessage:

Empty String

Failure

CreateTicketNoteResult:

Returns Null

outputMessage:

"Failed to create new note."
"A valid ticket note object is required."
"Note Details is required!"
"Invalid Ticket Number."
"Referenced Ticket could not be found!"

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>
    <CreateTicketNoteResponse xmlns="https://vorexlogin.com/">
      <CreateTicketNoteResult>int</CreateTicketNoteResult>
      <outputMessage>string</outputMessage>
    </CreateTicketNoteResponse>
  </soap:Body>
</soap:Envelope>