Search Customer - autoVHC DMS Integration

Purpose: The purpose of the SearchCustomer method is to pull specific customer data in to autoVHC from the Third Party database directly, allowing a user to create a job manually with all customer information already populated.

Detail: The example API below can be used by third party to generate an API from the WSDL. The below is only an example and we require the third party to creating an API for autoVHC to interact with.

Example API: http://demo.autovhc.co.uk/IntegrationAPI.asmx

Method: SearchCustomer

Sequence Diagram:

Request Structure:

Example Code: Click here to download

<SearchCustomer xmlns="http://autovhc.co.uk/">
	<Request>
		<LocationCode>string</LocationCode>
		<CustomerFirstName>string</CustomerFirstName>
		<CustomerSurName>string</CustomerSurName>
		<CustomerMobileNumber>string</CustomerMobileNumber>
		<RegistrationNumber>string</RegistrationNumber>
		<VIN>string</VIN>
		<ParametersCollection>
			<Parameters>
				<DMSParameter>
					<Name>string</Name>
					<Value>string</Value>
				</DMSParameter>
				<DMSParameter>
					<Name>string</Name>
					<Value>string</Value>
				</DMSParameter>
			</Parameters>
		</ParametersCollection>
	</Request>
</SearchCustomer>

SearchCustomerRequest
PropertyName	PropertyType	Example	Description	Mandatory
LocationCode	String	M1	Used by some DMS require this to identify specific dealer data	Yes
CustomerFirstName	String	Tom	The forename of the customer	No
CustomerSurName	String	Barker	The surname of the customer	Yes
CustomerMobileNumber	String	07000000000	The customer’s mobile number	No
VIN	String	WF0BXXWPRB6U02664	Vehicle VIN or Chassis number	Yes
ParametersCollection	DMSParametersCollection	(see below)	Not required at present	No

DMSParametersCollection
PropertyName	PropertyType	Example	Description	Mandatory
Name	String	Username	The name of the key pair value	Yes
Value	String	admin	The value of the key pair value	No

Response Structure:

Example Code: Click here to download

<SearchCustomerResponse xmlns="http://autovhc.co.uk/">
	<SearchCustomerResult>
		<Locale>string</Locale>
		<Message>string</Message>
		<Success>string</Success>
		<CustomerRecords>
			<CustomerRecord>
				<CustomerTitle>string</CustomerTitle>
				<CustomerFirstName>string</CustomerFirstName>
				<CustomerSurName>string</CustomerSurName>
				<CustomerEmail>string</CustomerEmail>
				<CustomerAddress1>string</CustomerAddress1>
				<CustomerAddress2>string</CustomerAddress2>
				<CustomerAddress3>string</CustomerAddress3>
				<CustomerAddress4>string</CustomerAddress4>
				<CustomerPostCode>string</CustomerPostCode>
				<CustomerAddressCountry>string</CustomerAddressCountry>
				<CustomerTelephoneNumber>string</CustomerTelephoneNumber>
				<CustomerMobileNumber>string</CustomerMobileNumber>
				<CustomerContactEmail>string</CustomerContactEmail>
				<CustomerContactHomePhone>string</CustomerContactHomePhone>
				<CustomerContactMail>string</CustomerContactMail>
				<CustomerContactSMS>string</CustomerContactSMS>
				<PreferredContactType>string</PreferredContactType>
				<CustomerUUID>string</CustomerUUID>
				<VehicleRecords>
					<VehicleRecord>
						<Make>string</Make>
						<Model>string</Model>
						<VIN>string</VIN>
						<RegistrationNumber>string</RegistrationNumber>
					</VehicleRecord>
				</VehicleRecords>
			</CustomerRecord>
		</CustomerRecords>
	</SearchCustomerResult>
</SearchCustomerResponse>

SearchCustomerResponse
PropertyName	PropertyType	Example	Description	Mandatory
Locale	String	en-GB	Culture code	Yes
Message	String	Call successful	A message that will indicate why the request failed, Call Successful if it succeeds	Yes
Success	Boolean	TRUE	Will be either True or False depending on the success of the request	Yes
CustomerRecord	CustomerRecord	(see below)		Yes

CustomerRecord
PropertyName	PropertyType	Example	Description	Mandatory
CustomerTitle	String	Mr	Customer Title	No
CustomerFirstName	String	Jamie	Customer First Name	No
CustomerSurName	String	Lawrence-Jenner	Customer Surname	Yes
CustomerEmail	String	jamie.jenner@autovhc.co.uk	Customer Email	No
CustomerAddress1	String	12 Acacia Avenue	Customer Address Line 1	No
CustomerAddress2	String	Great Malvern	Customer Address Line 2	No
CustomerAddress3	String	Worcester	Customer Address Line 3	No
CustomerAddress4	String	Worcestershire	Customer Address Line 4	No
CustomerPostCode	String	WR13 6PZ	Customer PostCode	No
CustomerAddressCountry	String	England	Country in which the customer resides	No
CustomerTelephoneNumber	String	01684 554477	Customer Land Line Telephone Number	No
CustomerMobileNumber	String	07977 115478	Customer Mobile/Cell Number	No
CustomerContactEmail	Boolean	FALSE	Whether or not the customer is to be contacted by Email.	No
CustomerContactHomePhone	Boolean	FALSE	Whether or not the customer is to be contacted by their Home Phone number.	No
CustomerContactMail	Boolean	FALSE	Whether or not the customer is to be contacted by mail.	No
CustomerContactSMS	Boolean	FALSE	Whether or not the customer is to be contacted by SMS.	No
PreferredContactType	Boolean	Email	The customer’s preferred method of contact	No
CustomerUUID	String	11544854	DMS Unique customer identifier	No

VehicleRecords
PropertyName	PropertyType	Example	Description	Mandatory
Make	String	FORD	Vehicle manufacturer	Yes
Model	String	FOCUS	Vehicle model	Yes
VIN	String	WF0BXXWPRB6U02664	Vehicle VIN or Chassis number	Yes
RegistrationNumber	String	FG58 AXY	Vehicle registration number	Yes

Node Information

CSV Import