Pricing VHC (SearchPackage)

Purpose: The purpose of the SearchPackage method is to search the third party for any packages (if the third party has packages enabled) 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: SearchPackage

Sequence Diagram:

Request Structure:

Example Code: Click here to download

<SearchPackage xmlns="http://autovhc.co.uk/">
	<Request>
		<Locale>en-GB</Locale>
		<LocationCode>01</LocationCode>
		<JobCardNumber>2148110740</JobCardNumber>
		<PackageCode>040KU08NL</PackageCode>
		<PackageDescription />
		<PackageNumber />
		<CustomerID>60256</CustomerID>
		<ParametersCollection>
			<Parameters>
				<DMSParameter>
					<Name>USERNAME</Name>
					<Value />
				</DMSParameter>
				<DMSParameter>
					<Name>PASSWORD</Name>
					<Value />
				</DMSParameter>
			</Parameters>
		</ParametersCollection>
		<WildCardSearch>false</WildCardSearch>
	</Request>
</SearchPackage>

This example shows a user searching for a package number instead of a package code. The number being searched here is 14210, and as this is the active search term, the code and description both stay blank.

<SearchPackage xmlns="http://autovhc.co.uk/">
	<Request>
		<Locale>en-GB</Locale>
		<LocationCode>01</LocationCode>
		<JobCardNumber>2148110740</JobCardNumber>
		<PackageCode />
		<PackageNumber>14210</PackageNumber>
		<PackageDescription />
		<CustomerID>60256</CustomerID>
		<ParametersCollection>
			<Parameters>
				<DMSParameter>
					<Name>USERNAME</Name>
					<Value />
				</DMSParameter>
				<DMSParameter>
					<Name>PASSWORD</Name>
					<Value />
				</DMSParameter>
			</Parameters>
		</ParametersCollection>
		<WildCardSearch>false</WildCardSearch>
	</Request>
</SearchPackage>

The third way of searching for a package is by using a description. In this example, the user has searched for Clutch. As the Wildcard Search node is set to true in this example, this will search for any package that contains the word Clutch. The wildcards are shown by the use of ‘%’ either side of the word clutch.

<SearchPackage xmlns="http://autovhc.co.uk/">
	<Request>
		<Locale>en-GB</Locale>
		<LocationCode>01</LocationCode>
		<JobCardNumber>2148110740</JobCardNumber>
		<PackageCode />
		<PackageNumber />
		<PackageDescription>%Clutch%</PackageDescription>
		<CustomerID>60256</CustomerID>
		<ParametersCollection>
			<Parameters>
				<DMSParameter>
					<Name>USERNAME</Name>
					<Value />
				</DMSParameter>
				<DMSParameter>
					<Name>PASSWORD</Name>
					<Value />
				</DMSParameter>
			</Parameters>
		</ParametersCollection>
		<WildCardSearch>true</WildCardSearch>
	</Request>
</SearchPackage>

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

<SearchPackageResponse xmlns="http://autovhc.co.uk/">
	<SearchPackageResult>
		<Success>true</Success>
		<DMSPackageList>
			<DMSPackageHeaderTransferObject>
				<PackageDescription>Clutch</PackageDescription>
				<PackageCode>040KU08NL</PackageCode>
				<PackageNumber>14210</PackageNumber>
				<PackageFixedPrice>53.00</PackageFixedPrice>
			</DMSPackageHeaderTransferObject>
		</DMSPackageList>
		<AdditionalRecords>false</AdditionalRecords>
	</SearchPackageResult>
</SearchPackageResponse>