Pricing VHC (SearchLabour)

Purpose: The purpose of the SearchLabour method is to search the third party for any labour work that can be applied to the VHC.

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: SearchLabour

Sequence Diagram:

Request Structure:

Example Code: Click here to download

<SearchLabour xmlns="http://autovhc.co.uk/">
	<Request>
		<Locale>en-GB</Locale>
		<JobCardNumber>2148110740</JobCardNumber>
		<CustomerID>60256</CustomerID>
		<LocationCode>01</LocationCode>
		<LabourCriteria>
			<DMSLabourCode>336747</DMSLabourCode>
			<description />
			<timeamount>2</timeamount>
			<LabourCodeSourceDMS>True</LabourCodeSourceDMS>
                       <ParentCode>string</ParentCode>
		</LabourCriteria>
		<ParametersCollection>
			<Parameters>
				<DMSParameter>
					<Name>USERNAME</Name>
					<Value />
				</DMSParameter>
				<DMSParameter>
					<Name>PASSWORD</Name>
					<Value />
				</DMSParameter>
			</Parameters>
		</ParametersCollection>
		<WildCardSearch>false</WildCardSearch>
	</Request>
</SearchLabour>

This example shows what is requested when the user searches via a description, instead of a Labour Code. The below example shows a blank labour code, with the description showing BrakesLabour.

<SearchLabour xmlns="http://autovhc.co.uk/">
	<Request>
		<Locale>en-GB</Locale>
		<JobCardNumber>2148110740</JobCardNumber>
		<CustomerID>60256</CustomerID>
		<LocationCode>01</LocationCode>
		<LabourCriteria>
			<DMSLabourCode />
			<description>BrakesLabour</description>
			<timeamount>2</timeamount>
			<LabourCodeSourceDMS>True</LabourCodeSourceDMS>
                       <ParentCode>string</ParentCode>
		</LabourCriteria>
		<ParametersCollection>
			<Parameters>
				<DMSParameter>
					<Name>USERNAME</Name>
					<Value />
				</DMSParameter>
				<DMSParameter>
					<Name>PASSWORD</Name>
					<Value />
				</DMSParameter>
			</Parameters>
		</ParametersCollection>
		<WildCardSearch>false</WildCardSearch>
	</Request>
</SearchLabour>

A wildcard can be used with a search term to find items in the external system which contain the term, and not just an exact match. In an example where the wildcard character is ‘%’, and the user wants to find all windscreen wipers, they may enter %Wiper% – this will return ‘Front Wipers’, ‘Rear Wipers’, ‘Wiper blades’ and so on.

Response Structure:

Example Code: Click here to download

<SearchLabourResponse xmlns="http://autovhc.co.uk/">
	<SearchLabourResult>
		<Message />
		<Success>true</Success>
		<Locale>en-GB</Locale>
		<CurrencyCode>GBP</CurrencyCode>
		<LabourCollection>
			<LabourTransferObject>
				<DMSLabourCode>336747</DMSLabourCode>
				<ComplexityRate>1000</ComplexityRate>
				<VHCItemID />
				<Priceinctax>484.00</Priceinctax>
				<costsheetlabourid />
				<sitecode>909022</sitecode>
				<description>Service</description>
				<priceexcltax>400.00</priceexcltax>
				<quantity>1</quantity>
				<timeamount>0.40</timeamount>
				<taxrate>21.00</taxrate>
				<deleted>false</deleted>
				<LabourCodeSourceDMS>true</LabourCodeSourceDMS>
			</LabourTransferObject>
		</LabourCollection>
		<AdditionalRecords>false</AdditionalRecords>
	</SearchLabourResult>
</SearchLabourResponse>