Pricing VHC (SearchParts)

Purpose: The purpose of the SearchParts method is to search the third party for any parts that are available.

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

Sequence Diagram:

Request Structure:

Example Code: Click here to download

<SearchParts xmlns="http://autovhc.co.uk/">
	<Request>
		<Locale>en-GB</Locale>
		<JobCardNumber>2148110729</JobCardNumber>
		<CustomerID>11426</CustomerID>
		<LocationCode>01</LocationCode>
		<PartCriteria>
			<PartNo>1763677</PartNo>
			<PartDesc />
			<QuantityRequired>1</QuantityRequired>
		</PartCriteria>
		<ParametersCollection>
			<Parameters>
				<DMSParameter>
					<Name>USERNAME</Name>
					<Value />
				</DMSParameter>
				<DMSParameter>
					<Name>PASSWORD</Name>
					<Value />
				</DMSParameter>
			</Parameters>
		</ParametersCollection>
		<WildCardSearch>true</WildCardSearch>
	</Request>
</SearchParts>

If the user wanted to, they could search for the required part by searching via the part description field. This returns the same request as above, however in this example, the part number is blank, and the part description is populated.

<SearchParts xmlns="http://autovhc.co.uk/">
	<Request>
		<Locale>en-GB</Locale>
		<JobCardNumber>2148110729</JobCardNumber>
		<CustomerID>11426</CustomerID>
		<LocationCode>01</LocationCode>
		<PartCriteria>
			<PartNo />
			<PartDesc>Brakes</PartDesc>
			<QuantityRequired>1</QuantityRequired>
		</PartCriteria>
		<ParametersCollection>
			<Parameters>
				<DMSParameter>
					<Name>USERNAME</Name>
					<Value />
				</DMSParameter>
				<DMSParameter>
					<Name>PASSWORD</Name>
					<Value />
				</DMSParameter>
			</Parameters>
		</ParametersCollection>
		<WildCardSearch>true</WildCardSearch>
	</Request>
</SearchParts>

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

<SearchParts xmlns="http://autovhc.co.uk/">
	<Request>
		<Locale>string</Locale>
		<JobCardNumber>string</JobCardNumber>
		<CustomerID>string</CustomerID>
		<LocationCode>string</LocationCode>
		<PartCriteria>
			<MarketingCode>string</MarketingCode>
			<Discount>string</Discount>
			<OriginalPrice>string</OriginalPrice>
			<VATRate>string</VATRate>
			<CostItemID>string</CostItemID>
			<PartID>string</PartID>
			<PartNo>string</PartNo>
			<PartDesc>string</PartDesc>
			<Stock>string</Stock>
			<PartPrice>string</PartPrice>
			<Quantity>string</Quantity>
			<QuantityRequired>string</QuantityRequired>
			<LabourTime>string</LabourTime>
			<LabourPrice>string</LabourPrice>
			<FittedPrice>string</FittedPrice>
			<Auth>string</Auth>
			<Deleted>string</Deleted>
			<VHCitemID>string</VHCitemID>
			<TimeStamp>string</TimeStamp>
			<SiteCode>string</SiteCode>
			<BinLocation>string</BinLocation>
			<BrandCode>string</BrandCode>
			<ServiceMenuCode>string</ServiceMenuCode>
			<Fluid>string</Fluid>
			<Make>string</Make>
			<Brand>string</Brand>
			<Sundries>string</Sundries>
			<DMSUniqueID>string</DMSUniqueID>
		</PartCriteria>
		<ParametersCollection>
			<Parameters>
				<DMSParameter>
					<Name>string</Name>
					<Value>string</Value>
				</DMSParameter>
				<DMSParameter>
					<Name>string</Name>
					<Value>string</Value>
				</DMSParameter>
			</Parameters>
		</ParametersCollection>
		<WildCardSearch>boolean</WildCardSearch>
	</Request>
</SearchParts>