Requesting Customer Information

Last updated
Save as PDF

Introduction

Posting to SecurityTrax is done via raw http post. In order to perform this action you will need the following information:

URL	https://secure.securitytrax.com/site...nrequester.php
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.

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'>id</attribute>
        </request>
        <request type="AllAccess-GetCustomerStatusBySecurityTraxUniqueID">
            <attribute name='SecurityTraxUniqueID'>343</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>
      <system_request>
        <request type="GetSystemAuthentication">
            <attribute name="Username">username</attribute>
            <attribute name="Password">password</attribute>
            <attribute name="PartnerID">id</attribute>
        </request>
      </system_request>
    </response>
    <response type="AllAccess-GetCustomerStatusBySecurityTraxUniqueID" success="true">
      <data>
        <Customer>
          <ID>343</ID>
          <FirstName>John</FirstName>
          <LastName>Doe</LastName>
          <BusinessContact/>
          <BusinessName/>
          <City>Selma</City>
          <State>CA</State>
          <County>Fresno</County>
          <Zip>93662</Zip>
          <Address1>ABC Street</Address1>
          <Address2/>
          <CrossStreet/>
          <Phone1>1112223344</Phone1>
          <Phone2/>
          <Phone3/>
          <Phone4/>
          <Email>HOST@DOMAIN.COM</Email>
          <SecurityTraxUniqueID>343</SecurityTraxUniqueID>
          <PartnerCompanyID>1</PartnerCompanyID>
          <PartnerCompanyCampaignID>0</PartnerCompanyCampaignID>
          <PartnerCompanyUniqueID/>
          <SoldToCompanyID/>
          <SoldToCompanyUniqueID/>
          <InstallIsScheduled>true</InstallIsScheduled>
          <InstallDate>2013-05-29</InstallDate>
          <InstallUnixTime>1369868400</InstallUnixTime>
          <InstallNotes>PACKAGE 3 THERMO AND LIGHTS ALSO REBATING 2 MONTHS OF MONITORING</InstallNotes>
          <InstallDuration>10800</InstallDuration>
          <InstallIsComplete>false</InstallIsComplete>
          <InstallTechArrivalUnixTime/>
          <InstallConfirmationStatusID>1</InstallConfirmationStatusID>
          <InstallConfirmationStatusName>Not Confirmed</InstallConfirmationStatusName>
          <CustomerHasCanceled>false</CustomerHasCanceled>
          <AccountNumber/>
          <ADTCustomerNumber/>
          <AccountType>Residential</AccountType>
          <ConfirmationNumber/>
          <ReceiverNumber>1111122222222</ReceiverNumber>
          <AbortCode/>
          <MMRAmount>45.99</MMRAmount>
          <MMRID>10</MMRID>
          <DealerNumber/>
          <DealerNumberID>0</DealerNumberID>
          <ActivationFeeAmount>99.00</ActivationFeeAmount>
          <ActivationFeeID>1</ActivationFeeID>
          <MonitoringCompanyName>Rapid Response</MonitoringCompanyName>
          <MonitoringCompanyID>1</MonitoringCompanyID>
          <ADTMonitoringSystemTypeName/>
          <ADTMonitoringSystemTypeID>0</ADTMonitoringSystemTypeID>
          <RepID>1044</RepID>
          <RepName>Jane Doe</RepName>
          <TrainID>1044</TrainID>
          <TrainName>Mark Doe</TrainName>
          <LocationID>3</LocationID>
          <LocationName>Fresno</LocationName>
          <CreatedDate>2013-05-28 22:11:18</CreatedDate>
          <LeadCreatedDate>2013-05-28 21:56:37</LeadCreatedDate>
          <CustomerCancelDate/>
          <CustomerCancelReasonID/>
          <CustomerCancelReasonName/>
        </Customer>
      </data>
      <system_request>
        <request type="AllAccess-GetCustomerStatusBySecurityTraxUniqueID">
            <attribute name="SecurityTraxUniqueID">343</attribute>
        </request>
      </system_request>
    </response>
  </responses>
</root>