In the below example, the user has searched for the package code 040KU08NL. This has been searched through the DMS Search modal, where the user can input either a package code, package number or description. As the user can only search for one of these at any given time, the other nodes would remain blank.
There are 3 examples of this request. The first method allows the user to search for the package via a package code. In this example, the package code is 040KU08NL.
<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>
SearchPackageRequest | ||||
PropertyName | PropertyType | PropertyValue | Description | Mandatory |
Locale | String | en-GB | The .NET CurrentCulture.Name | Yes |
MarketCode | String | 019 | Used by some DMS to identify the Market | No |
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 | No |
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 | |
WildCardSearch | Boolean | TRUE | Indicates the user has request to seach the DMS using wild cards | No |
DMSParametersCollection | ||||
PropertyName | PropertyType | PropertyValue | Description | Mandatory |
Name | String | Username | The name of the key pair value | Yes |
Value | String | admin | The value of the key pair value | No |