Pricing VHC (GetPackage) - autoVHC DMS Integration

Purpose: The purpose of the GetPackage method is to import the previously searched package into the VHC. This will always succeed the SearchPackage method.

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

Sequence Diagram:

Request Structure:

Example Code: Click here to download

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

GetPackageRequest
PropertyName	PropertyType	Example	Description	Mandatory
Locale	String	en-GB	The .NET CurrentCulture.Name	Yes
MarketCode	String	019	Used by some DMS to identify the Market	Yes
LocationCode	String	M1	Used by some DMS require this to identify specific dealer data	Yes
JobCardNumber	String	11522565	DMS Work order number	Yes
PackageCode	String	45847	DMS Package Code	Yes
PackageNumber	String	378463	Additional Identifier used in DMS	No
PackageDescription	String	BRAKE KIT	Description of Packages to find, may include wild card search character	No
CustomerID	String	11544854	DMS Unique customer identifier	Yes
ModelCode	String	78	DMS Model Code	No
MakeCode	String	56	DMS Manufacturer Code	No
VIN	String	WF0BXXWPRB6U02664	Vehicle VIN or Chassis number	Yes
ParametersCollection	DMSParametersCollection	(see below)		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

<GetPackageResponse xmlns="http://autovhc.co.uk/">
	<GetPackageResult>
		<Success>true</Success>
		<Locale>en-GB</Locale>
		<CurrencyCode>GBP</CurrencyCode>
		<DMSPackageList>
			<DMSPackageHeader>
				<PackageDescription>Service</PackageDescription>
				<PackageCode>040KU08NL</PackageCode>
				<PackageFixedPrice>5300</PackageFixedPrice>
			</DMSPackageHeader>
			<PartCollection>
				<PartTransferObject>
					<MarketingCode>0</MarketingCode>
					<Discount>0,00</Discount>
					<OriginalPrice>500</OriginalPrice>
					<VATRate>20.00</VATRate>
					<CostItemID />
					<PartID>1747692</PartID>
					<PartNo>1747692</PartNo>
					<PartDesc>Part One</PartDesc>
					<Stock>false</Stock>
					<PartPrice>500</PartPrice>
					<Quantity>0</Quantity>
					<QuantityRequired>1</QuantityRequired>
					<LabourTime>0,00</LabourTime>
					<LabourPrice>0,00</LabourPrice>
					<FittedPrice>500</FittedPrice>
					<Auth>true</Auth>
					<Deleted>false</Deleted>
					<VHCitemID />
					<TimeStamp />
					<SiteCode>909022</SiteCode>
					<BinLocation>0</BinLocation>
				</PartTransferObject>
				<LabourCollection>
					<LabourTransferObject>
						<DMSLabourCode>584350</DMSLabourCode>
						<ComplexityRate>500</ComplexityRate>
						<VHCItemID />
						<Priceinctax>605,00</Priceinctax>
						<costsheetlabourid />
						<sitecode>909022</sitecode>
						<description>Labour One</description>
						<priceexcltax>500</priceexcltax>
						<quantity>1</quantity>
						<timeamount>1</timeamount>
						<taxrate>20.00</taxrate>
						<deleted>false</deleted>
						<LabourCodeSourceDMS>true</LabourCodeSourceDMS>
					</LabourTransferObject>
				</LabourCollection>
			</DMSPackageList>
	</GetPackageResult>
</GetPackageResponse>

GetPackageResponse
PropertyName	PropertyType	Example	Description	Mandatory
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
Locale	String	en-GB	Culture code	Yes
CurrencyCode	String	EUR	ISO Currency code	Yes
DMSPackageList	DMSPackageTransferObject	See Below	This will contain information about the package returned, Header, Parts, Labour etc	No

DMSPackageTransferObject
PropertyName	PropertyType	Example	Description	Mandatory
DMSPackageHeader	DMSPackageHeaderTransferObject	See DMSPackageHeaderTransferObject above.		No
PartCollection	PartTransferObject[]	See PartTransferObject description	Collection of Part Information	No
TyreCollection	TyreTransferObject[]	See TyreTransferObject description	Collection of Tyre Information	No
LabourCollection	LabourTransferObject[]	See LabourTransferObject description	Collection of Labour Information	No
CommentsCollection	String[]	Addition information	List of comments about the package	No

Testing