autoVHC DMS Integration

DMS Push Job (PushJob)

Purpose: The purpose of the PushJob method is to allow a third party to add a vehicle health check into autoVHC.

Production: https://integrationfacade.autovhc.net/integrationlayerproxyapi.asmx

QA: https://qa-integrationfacade.autovhc.net/integrationlayerproxyapi.asmx

Development: https://dev-integrationfacade.wsautovhc.co.uk/integrationlayerproxyapi.asmx

Method: PushJob

Sequence Diagram:

Request Structure:

Example Code: Click here to download

<PushJob xmlns="http://www.wsautovhc.co.uk">
	<request>
		<CurrencyCode xmlns="http://autovhc.co.uk/">string</CurrencyCode>
		<Locale xmlns="http://autovhc.co.uk/">string</Locale>
		<Username xmlns="http://autovhc.co.uk/">string</Username>
		<Password xmlns="http://autovhc.co.uk/">string</Password>
		<Sitecode xmlns="http://autovhc.co.uk/">string</Sitecode>
		<ParametersCollection xmlns="http://autovhc.co.uk/">
			<Parameters>
				<DMSParameter xsi:nil="true" />
				<DMSParameter xsi:nil="true" />
			</Parameters>
		</ParametersCollection>
		<ServiceOrder xmlns="http://autovhc.co.uk/">
			<VHCDate>string</VHCDate>
			<Make>string</Make>
			<Model>string</Model>
			<VIN>string</VIN>
			<JobCardNumber>string</JobCardNumber>
			<RegistrationNumber>string</RegistrationNumber>
			<CustomerTitle>string</CustomerTitle>
			<CustomerFirstName>string</CustomerFirstName>
			<CustomerSurName>string</CustomerSurName>
			<CustomerEmail>string</CustomerEmail>
			<CustomerPostCode>string</CustomerPostCode>
			<CustomerTelephoneNumber>string</CustomerTelephoneNumber>
			<CustomerMobileNumber>string</CustomerMobileNumber>
			<CustomerUUID>string</CustomerUUID>
			<CustomerAddress1>string</CustomerAddress1>
			<CustomerAddress2>string</CustomerAddress2>
			<CustomerAddress3>string</CustomerAddress3>
			<CustomerAddress4>string</CustomerAddress4>
			<CustomerContactEmail>string</CustomerContactEmail>
			<CustomerContactHomePhone>string</CustomerContactHomePhone>
			<CustomerContactMail>string</CustomerContactMail>
			<CustomerContactSMS>string</CustomerContactSMS>
			<CustomerType>string</CustomerType>
			<FirstRegistrationDate>string</FirstRegistrationDate>
			<NextMotDate>string</NextMotDate>
			<NextServiceDate>string</NextServiceDate>
			<ServiceAdvisor>string</ServiceAdvisor>
			<Workshop>string</Workshop>
			<WorkRequired>string</WorkRequired>
			<Mileage>string</Mileage>
			<DateIn>string</DateIn>
			<DateOut>string</DateOut>
			<TimeIn>string</TimeIn>
			<TimeOut>string</TimeOut>
			<LastServiceDate>string</LastServiceDate>
			<MakeCode>string</MakeCode>
			<ModelCode>string</ModelCode>
			<AgreedEstimate>string</AgreedEstimate>
                       <TotalLabourHours>string</TotalLabourHours>
			<EngineNumber>string</EngineNumber>
			<CustomerNotes>string</CustomerNotes>
		</ServiceOrder>
	</request>
</PushJob>
PushJobRequest
PropertyName PropertyType Example Description Mandatory
CurrencyCode String GBP Code for local currency Yes
Locale String en-GB Culture code Yes
Username String DMSADMIN VHC Username Yes
Password String DMSPASSWORD VHC Password Yes
Sitecode String 123456 VHC Site Code Yes
VHCDate String 20120912 Date the vehicle is due at the dealership (YYYYMMDD) Yes
Make String FORD Vehicle manufacturer Yes
Model String FOCUS Vehicle model Yes
VIN String WF0BXXWPRB6U02664 Vehicle VIN or Chassis number Yes
JobCardNumber String 11522565 DMS Work order number Yes
RegistrationNumber String FG58 AXY Vehicle registration number Yes
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
CustomerPostCode String WR13 6PZ Customer PostCode No
CustomerTelephoneNumber String 01684 554477 Customer Land Line Telephone Number No
CustomerMobileNumber String 07977 115478 Customer Mobile/Cell Number No
CustomerUUID String 11544854 DMS Unique customer identifier Yes
CustomerAddress1 String 2 Mallard Court Customer Address Line 1 No
CustomerAddress2 String Mallard Way Customer Address Line 2 No
CustomerAddress3 String Crewe Customer Address Line 3 No
CustomerAddress4 String Cheshire Customer Address Line 4 No
CustomerContactEmail Boolean FALSE Whether or not the customer is to be contacted by Email. No Value will be assumed false Opt Out No
CustomerContactHomePhone Boolean FALSE Whether or not the customer is to be contacted by Telephone. No Value will be assumed false Opt Out No
CustomerContactMail Boolean FALSE Whether or not the customer is to be contacted by Mail. No Value will be assumed false Opt Out No
CustomerContactSMS Boolean FALSE Whether or not the customer is to be contacted by SMS. No Value will be assumed false Opt Out No
CustomerType String RETAIL-001 Customer Account category or type No
FirstRegistrationDate String 20081025 Date vehicle first registered (YYYYMMDD) No
NextMotDate String 20121128 Date of the next government vehicle inspection is due (YYYYMMDD) No
NextServiceDate String 20130528 Date when next vehicle service is due (YYYYMMDD) No
ServiceAdvisor String JLJ The DMS identification of the service advisor who will deal with the customer No
Workshop String MAIN Workshop in which the vehicle will be inspected No
WorkRequired String 35,000 km service Description of required work/reason for the booking No
Mileage String 1154458 Last know odometer reading No
DateIn String 20120912 Date the vehicle is due at the dealership (YYYYMMDD) No
DateOut String 20120912 Date the vehicle is due at the dealership (YYYYMMDD) No
TimeIn String 91500 Time the vehicle is due at the dealership (HH:MM:SS) No
TimeOut String 173000 Time the vehicle is due at the dealership (HH:MM:SS) No
LastServiceDate String 20120912 Date of last service (YYYYMMDD) No
MakeCode String 56 DMS Manufacturer Code No
ModelCode String 78 DMS Model Code No
AgreedEstimate String 250 Value quoted to the customer for completion of the work required No
EngineNumber String AB12345 The engine’s identifier number No
CustomerNotes String Front Brakes making knocking noise Any additional information provided by the customer No

Response Structure:

Example Code: Click here to download

<PushJobResponse xmlns="http://www.wsautovhc.co.uk">
	<PushJobResult>
		<Message xmlns="http://autovhc.co.uk/">string</Message>
		<JobID xmlns="http://autovhc.co.uk/">int</JobID>
		<Success xmlns="http://autovhc.co.uk/">boolean</Success>
	</PushJobResult>
</PushJobResponse>
PushJobResponse
PropertyName PropertyType Example Description Mandatory
Message String Success Success or Failure message Yes
JobID Int 123456 Unique Job ID Yes
Success Boolean True True or False Yes

If the import is for some reason unsuccessful, the user would get the below error response:

<PushJobResponse xmlns="http://www.wsautovhc.co.uk">
	<PushJobResult>
		<Message xmlns="http://autovhc.co.uk/">unauthorised</Message>
		<JobID xmlns="http://autovhc.co.uk/">0</JobID>
		<Success xmlns="http://autovhc.co.uk/">false</Success>
	</PushJobResult>
</PushJobResponse>

This shows that there has been an error and the job hasn’t pushed in correctly.