Creating Customer Notes
Introduction
Posting to SecurityTrax is done via raw http post. In order to perform this action you will need the following information:
URL |
|
Partner ID |
This is the unique ID that SecurityTrax assigns to the partner company. Source ID Provided by the company using SecurityTrax. |
Username |
Set by company using SecurityTrax. Provided by them. |
Password |
Set by company using SecurityTrax. Provided by them. |
SecurityTraxUniqueID |
The unique SecurityTrax ID of the customer you wish to update. |
Note Subject |
Required. The subject of the note. |
Note Text |
Required. The body of the note. |
Note Type ID |
Required. 1 = Sales, 2 = Technician, 3 = Lead |
Ticket Type ID |
Optional. Only use if it is desired to make the note a ticket. 1 = Open Ticket, 2 = Closed Ticket |
User ID |
Optional. If creating as a ticket, the user it should be assigned to. |
Partner Company Unique ID |
Optional. Unique ID of the note with the partner company. |
Sample Request
The following is an example of a valid request.
<?xml version='1.0'?> <root> <requests> <request type='GetSystemAuthentication'> <attribute name='Username'>Username</attribute> <attribute name='Password'>Password</attribute> <attribute name='PartnerID'>PartnerID</attribute> </request> <request type="CreateCustomerNoteBySecurityTraxUniqueID"> <attribute name='SecurityTraxUniqueID'>9710</attribute> <attribute name='NoteSubject'>Note Subject</attribute> <attribute name="NoteText">Customer states they would like a new yard sign installed ASAP.</attribute> <attribute name="NoteTypeID">1</attribute> <attribute name='TicketTypeID'>1</attribute> <attribute name='UserID'>1024</attribute> <attribute name='PartnerCompanyUniqueID'>991234</attribute> </request> </requests> </root>
Sample Response
The following is an example of a successful response.
<?xml version="1.0"?> <root> <responses> <response type="GetSystemAuthentication" success="true"> <data> <message>Authenticated To System</message> </data> </response> <response type="CreateCustomerNoteBySecurityTraxUniqueID" success="true"> <data> <CustomerNoteID>3389</CustomerNoteID> </data> </response> </responses> </root>