AutoSLM API Integration Information

To call any of the AutoSLM API webservices, just call the REST URL post the input body content as the input content listed below. Please replace the block marked "ACCESS CODE HERE" with your AutoSLM assigned access code which will be issued per third party company wanting to connect. Also where applicable, include the dealer code of the dealer this call relates to.

READ
Methods Available

GetDealers
GetCustomerList
GetCustomers
GetStaff
GetLeads
GetStockVehicles
CheckSale

WRITE
Methods Available

AddLead
AddLeadV2
AcceptLead
AddCustomer
AddActivity
AddStockVehicle
DeleteStockVehicle

GetLeads


This method gets a list of manufacturers

URL : http://webservice.dealerhub.net/dealerhub/WS/DealerHubV1.cfc?wsdl

Method : getleads

Input Parameters :

XMLSecurity
XMLData

There are always 2 parameters passed, these are both XML strings, and the first is XMLSecurity which holds the secuirty information, i.e your access code and the dealercode that you want to access the data for, and the second is the XML data you are going to pass in.

Example of value XMLData packet:

<?xml version="1.0" encoding="UTF-8"?>
<InputParams>
<NewLeadsOnly>0</NewLeadsOnly>
<StartDate>2012-05-10</StartDate>
<EndDate>2012-05-15</EndDate>
</InputParams>

NewLeadsOnly : If you pass a value of 1, then it will just return leads that have not yet been collected. If you do set a value of 1, then you do not need to pass the startdate or enddate parameters.

Startdate / Enddate : If you pass a NewLeadsOnly value of 0 (zero), then you must pass a startdate and enddate to display leads from. These options will show leads created on the system between these 2 dates.

Example output for a valid call:

<?xml version="1.0" encoding="UTF-8" ?>
<Lead>
     <LeadID>229</LeadID>
     <DealerCode>DHTEST01</DealerCode>
     <leadcreated>{ts '2012-05-15 10:22:27'}</leadcreated>
      <LeadType>Used Car Inquiry</LeadType>
      <LeadSource>Website</LeadSource>
<Customer>
      <customerurn>342343432</customerurn>
      <customertype>1</customertype>
      <title>Mr</title>
      <forename>Billy</forename>
      <lastname>Jones</lastname>
      <homephone>2395551122</homephone>
      <workphone>2395551123</workphone>
      <mobilephone>2395551124</mobilephone>
      <email>test@test.com</email>
      <address>
            <address1>463 Bury Av.</address1>
            <address2>Prestwich</address2>
            <city>Manchester</city>
            <county>Greater Manchester</county>
            <postcode>M25 0DR</postcode>
      </address>
      <dpa>
            <dpapostal>Y</dpapostal>
            <dpasms>N</dpasms>
            <dpatel>N</dpatel>
            <dpaemail>Y</dpaemail>
      </dpa>
      <marketing>
            <methodofcontact>Internet</methodofcontact>
            <sourceofenquiry>Website Lead</sourceofenquiry>
            <adcampaign>ADCAMP1</adcampaign>
      </marketing>
      <message>I want an estate car as I have a dog.</message>
</Customer>
<Vehicle>
      <slmid></slmid>
      <regno>MM55 FFV</regno>
      <vin></vin>
      <newused>USED</newused>
      <modelyear>2005</modelyear>
      <make>Mercedes</make>
      <model>ML280</model>
      <derivative>4 Motion</derivative>
      <fuel>Diesel</fuel>
      <colour>Red</colour>
</Vehicle>
</Lead>

Output Fields

Field Name Field Type Field Description
Lead.LeadID Numeric Our database Lead ID number (unique)
Lead.DealerCode String The dealercode of the dealer. Used to identify what dealer the leads belong to
Lead.leadcreated Date The date / time the lead was created on the dealer hub
Lead.LeadType String Description of the lead type, e.g Used Car Enquiry, Test Drive Leads, Brochure Request etc
Lead.LeadSource String Description of the source, e.g Dealers Website, Manufactuers Website, Motor Show,Showroom Tablet etc
Lead.Customer.CustomerURN String Customers Unique Reference Number on your system. Used to track leads when requesting status updates
Lead.Customer.CustomerType Numeric 1 = Retail Customer, 2 = Business / Fleet Customer. Please pass 1 or 2
Lead.Customer.Title String The customers title
Lead.Customer.Forename String The customers forename
Lead.Customer.LastName String The customers lastname / surname
Lead.Customer.CompanyName String The customers business name
Lead.Customer.HomePhone String

The customers home phone number, please remove any symbols or spaces
Lead.Customer.WorkPhone String The customers work phone number, please remove any symbols or spaces
Lead.Customer.MobilePhone String The customers mobile phone number, please remove any symbols or spaces
Lead.Customer.Email String The customers email address
Lead.Customer.Address.Address1 String The customers address details
Lead.Customer.Address.Address2 String The customers address details
Lead.Customer.Address.City String The customers address details
Lead.Customer.Address.County String The customers address details
Lead.Customer.Address.PostCode String The customers address details
Lead.Customer.DPA.DPAPostal String This is the DPA opt in/out for Postal. Please pass 'Y' or 'N' characters for yes or no
Lead.Customer.DPA.DPASMS String This is the DPA opt in/out for SMS. Please pass 'Y' or 'N' characters for yes or no
Lead.Customer.DPA.DPATel String This is the DPA opt in/out for Tel. Please pass 'Y' or 'N' characters for yes or no
Lead.Customer.DPA.DPAEmail String This is the DPA opt in/out for Email. Please pass 'Y' or 'N' characters for yes or no
Lead.Customer.Marketing.MethodOfContact String Method of Contact is how the customer gained contact, i.e Tel / Internet / Email / Visit etc
Lead.Customer.Marketing.SourceOfEnquiry String Source Of Enquiry is how the customer found you, ie. Newspaper / Radio / Passing trade etc..
Lead.Customer.Marketing.AdCampaign String Ad Campagin code or description if available
Lead.Customer.Message String Customer message that may have been typed on the website enquiry, or any customer notes
Lead.Vehicle.SLMID Numeric SLMID is the AutoSLM ID number for a vehicle specification. If you do not know this, please leave it blank and fill in the other vehicle fields. If you do fill this number in, you will not need to enter the details for make/model/spec etc..
Lead.Vehicle.RegNo String The vehicles registration number
Lead.Vehicle.VIN String VIN number of the vehicle of enquiry, if available
Lead.Vehicle.CapCode String The vehicle's CapCode if available
Lead.Vehicle.NewUsed String Is this a NEW or USED enquiry, enter new or used as the value passed
Lead.Vehicle.ModelYear Numeric Year the enquiry vehicle was made
Lead.Vehicle.Make String The vehicle make, i.e Ford
Lead.Vehicle.Model String The vehicle model, i.e Mondeo
Lead.Vehicle.Derivative String The vehicle derivative i.e Ghia
Lead.Vehicle.Fuel String The fuel type as a string
Lead.Vehicle.Colour String The enquiry vehicle colour

 

Example output for an invalid call / or general error in a webservice call

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
<Error>
<ErrorCode>2</ErrorCode>
<ErrorInfo>No Data found </ErrorInfo>
</Error>
</ResultSet>

There may be multiple errors returned in the XML packet, they are separated by <Error> blocks and each block contains an ErrorCode to allow you to do some processing logic on the numerical value returned, and an ErrorInfo which is used by the developer or administrator to visually see what the problem is with the submission.