getTemplateTicketDescription()

TemplateTicketDescription getTemplateTicketDescription(string templateTicketNumber)

This method retrieves the details of a template ticket. The returned document describes the template ticket's default values for the ticket, as well as the description of the ticket's custom form definition.

This can be used to discover the ticket's definition to dynamically render a form for a customer or operator, to fill in on an external website, or to synchronise configuration.

Parameters

templateTicketNumber: Format: string; Purpose: Specifies the Smile template ticket number of which to retrieve details.

Results

This method returns a TemplateTicketDescription XML document containing the details of the template ticket.

There are no messages defined by this method.

Example: A returned TemplateTicketDescription XML document

This example shows a TemplateTicketDescription XML document for template ticket 127.

<TemplateTicketDescription xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <TemplateTicket>
    <Number>127</Number>
    <Subject>Refund Request</Subject>
    <TicketType key="381">Refund Request</TicketType>
    <TicketStatus key="1">New</TicketStatus>
    <Created>2014-05-03T17:41:23.833+10:00</Created>
    <Opened>2014-05-03T17:41:23.872+10:00</Opened>
    <Closed>2014-05-03T17:41:23.872+10:00</Closed>
    <Properties>
      <Object>
        <String name="ReceiptNumber">1239874213</String>
      </Object>
    </Properties>
  </TemplateTicket>
  <Form>
    <Attributes>
      <Attribute>
        <Required>false</Required>
        <Label>Refund Amount</Label>
        <Visibility>VisibleAndEditable</Visibility>
        <AttributeType>
          <AttributeType>469</AttributeType>
          <Name>RefundAmount</Name>
          <Label>Refund Amount</Label>
          <SmileObjectXMLType type="Decimal"/>
        </AttributeType>
      </Attribute>
      <Attribute>
        <Required>false</Required>
        <Label>Receipt Number</Label>
        <Visibility>VisibleAndEditable</Visibility>
        <AttributeType>
          <AttributeType>468</AttributeType>
          <Name>Receipt Number</Name>
          <Label>Receipt Number</Label>
          <SmileObjectXMLType type="String"/>
        </AttributeType>
      </Attribute>
      <Attribute>
        <Required>false</Required>
        <Label>Refund transaction number</Label>
        <Visibility>VisibleAndEditable</Visibility>
        <AttributeType>
          <AttributeType>472</AttributeType>
          <Name>TransactionNumber</Name>
          <Label>Refund transaction number</Label>
          <SmileObjectXMLType type="String"/>
        </AttributeType>
      </Attribute>
    </Attributes>
  </Form>
</TemplateTicketDescription>

Faults

NoSuchItemException

This fault is returned when the requested template ticket number does not exist or does not refer to a template ticket.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetTemplateTicketDescription
 templateTicketNumber

templateTicketNumber: Purpose: Specifies the Smile template ticket number of which to retrieve details.

Note: For more information about the Java client and the options it accepts, see Java client syntax.