autoVHC Pull Job (GetServiceOrderByDate) - autoVHC DMS Integration

Purpose: The purpose of the GetServiceOrderByDate method is to pull all available appointments between a specific date range.

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.wsautovhc.co.uk/IntegrationAPI.asmx

Method: GetServiceOrderByDate

Sequence Diagram:

Request Structure:

Example Code: Click here to download

<GetServiceOrderByDate xmlns="http://autovhc.co.uk/">
	<Request>
		<Locale>string</Locale>
		<LocationCode>string</LocationCode>
		<DateTo>string</DateTo>
		<DateFrom>string</DateFrom>
		<ParametersCollection>
			<Parameters>
				<DMSParameter xsi:nil="true" />
				<DMSParameter xsi:nil="true" />
			</Parameters>
		</ParametersCollection>
	</Request>
</GetServiceOrderByDate>

GetServiceOrderByDateRequest
PropertyName	PropertyType	Example	Description	Mandatory
LocationCode	String	M1	Used by some DMS require this to identify specific dealer data	Yes
DateTo	String	20130123	Date range to return jobs between DateTo and DateFrom all job cards will be imported	Yes
DateFrom	String	20171214	Date range to return jobs between DateTo and DateFrom all job cards will be imported	Yes
Locale	String	en-GB	The .NET CurrentCulture.Name	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

<GetServiceOrderByDateResponse xmlns="http://autovhc.co.uk/">
	<GetServiceOrderByDateResult>
		<Locale>string</Locale>
		<Message>string</Message>
		<Success>boolean</Success>
		<ServiceOrders>
			<ServiceOrderTransferObject>
				<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>
				<ModelCode>string</ModelCode>
				<AgreedEstimate>string</AgreedEstimate>
                              <TotalLabourHours>string</TotalLabourHours>
				<EngineNumber>string</EngineNumber>
				<CustomerNotes>string</CustomerNotes>
				<ParentCode>string</ParentCode>
			</ServiceOrderTransferObject>
		</ServiceOrders>
	</GetServiceOrderByDateResult>
</GetServiceOrderByDateResponse>

GetServiceOrderByDateResponse
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
ServiceOrder	ServiceOrderTransferObject	(see below)		Yes

ServiceOrderTransferObject
PropertyName	PropertyType	Example	Description	Mandatory
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	12 Acacia Avenue	Customer Address Line 1	No
CustomerAddress2	String	Great Malvern	Customer Address Line 2	No
CustomerAddress3	String	Great Malvern	Customer Address Line 3	No
CustomerAddress4	String	Great Malvern	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
AgreedEstimate	String	250	Value quoted to the customer for completion of the work required	No
TotalLabourHours	String	2	Total Labour Hours for completion of the work required	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	091500	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
EngineNumber	String	AB12345	The engine’s identifier number	No
CustomerNotes	String	Front Brakes making knocking noise	Any additional information provided by the customer	No
ParentCode	String	MAKECODE1234	Vehicle Model Code	No

Create VHC

Testing