CRM endpoint

This topic provides a quick reference for the method signatures of CRM API methods.

Location: http://smile.example.com:port/stage/smile/ws/v2/crm

WSDL: http://smile.example.com:port/stage/smile/ws/v2/crm?wsdl

Table 1. CRM API methods
Method Method signature Purpose
echo()
string echo(string value)
Returns any value passed to the method.
addTicketAttachment()
void addTicketAttachment(
 string ticketNumber,
 Attachment attachment)
Adds an attachment to a ticket.
getAppointmentAvailabilities()
AppointmentAvailability getAppointmentAvailabilities(
 AppointmentAvailabilitiesRequest
 availabilitiesRequest)
Retrieves appointment availabilities.
getTemplateTicketDescription()
TemplateTicketDescription getTemplateTicketDescription(
 string templateTicketNumber)
Returns the details of a template ticket.
getTicket()
Ticket getTicket(
 string ticketNumber)
Retrieves ticket information.
getTickets()
TicketList getTickets(
 string usn)
Retrieves all tickets for an account.
raiseTicket()
Ticket raiseTicket(
 string templateTicketNumber,
 string usn,
 NewTicketRequest newTicketRequest)
Creates a ticket and starts a workflow.
runTicketAction()
Ticket runTicketAction(
 string ticketNumber,
 int ticketAction)
Retrieves information about a ticket after running a ticket action.
updateTicket()
void updateTicket(
 string ticketNumber,
 TicketUpdate ticketUpdate)
Updates a tickets' subject, body text, custom fields or owning account or subscription details.