Purpose: The purpose of the GetServiceOrderByID method is to pull a job that is either at C or A status back into the third party system with all VHC information.
Production: https://integrationfacade.autovhc.net/integrationlayerproxyapi.asmx
QA: https://qa-integrationfacade.autovhc.net/integrationlayerproxyapi.asmx
Development: https://dev-integrationfacade.wsautovhc.co.uk/integrationlayerproxyapi.asmx
Method: GetServiceOrderByID
Sequence Diagram:
Request Structure:
Example Code: Click here to download
<GetServiceOrderByID xmlns="http://www.wsautovhc.co.uk">
<request>
<CurrencyCode xmlns="http://autovhc.co.uk/">string</CurrencyCode>
<Locale xmlns="http://autovhc.co.uk/">string</Locale>
<Username xmlns="http://autovhc.co.uk/">string</Username>
<Password xmlns="http://autovhc.co.uk/">string</Password>
<Sitecode xmlns="http://autovhc.co.uk/">string</Sitecode>
<JobCardNumber xmlns="http://autovhc.co.uk/">string</JobCardNumber>
<IncludeParts xmlns="http://autovhc.co.uk/">boolean</IncludeParts>
<IncludeLabours xmlns="http://autovhc.co.uk/">boolean</IncludeLabours>
<IncludeItemImageUrls xmlns="http://autovhc.co.uk/">boolean</IncludeItemImageUrls>
<IncludeItemVideoUrls xmlns="http://autovhc.co.uk/">boolean</IncludeItemVideoUrls>
<IncludeVhcUrl xmlns="http://autovhc.co.uk/">boolean</IncludeVhcUrl>
<IntegrationId xmlns="http://autovhc.co.uk/">guid</IntegrationId>
<IncludeCustomerInfo xmlns="http://autovhc.co.uk/">boolean</IncludeCustomerInfo>
</request>
</GetServiceOrderByID>
GetServiceOrderByIDRequest | ||||
PropertyName | PropertyType | Example | Description | Mandatory |
CurrencyCode | String | EUR | ISO Currency code | Yes |
Locale | String | en-GB | The .NET CurrentCulture.Name | Yes |
Username | String | DMSADMIN | VHC Username | Yes |
Password | String | DMSPASSWORD | VHC Password | Yes |
Sitecode | String | 123456 | VHC Site Code | Yes |
JobCardNumber | String | 45847 | DMS Package Code | Yes |
IncludeParts | Boolean | True | Include any identified parts in the response | No |
IncludeLabours | Boolean | True | Include any identified labours in the response | No |
IncludeItemImageUrls | Boolean | True | Include links to images in the response | No |
IncludeItemVideoUrls | Boolean | True | Include links to videos in the response | No |
IncludeVhcUrl | Boolean | True | Include a link to the VHC in the response | No |
IntegrationId | Guid | intid123456 | An identifier for the integration. Please note, autoVHC will provide this | Yes |
IncludeCustomerInfo | Boolean | True | Include lany customer information in the response | No |
Response Structure:
Example Code: Click here to download
<GetServiceOrderByIDResponse xmlns="http://www.wsautovhc.co.uk">
<GetServiceOrderByIDResult>
<ServiceOrder>
<VHCDate>string</VHCDate>
<Make>string</Make>
<Model>string</Model>
<VIN>string</VIN>
<JobCardNumber>string</JobCardNumber>
<RegistrationNumber>string</RegistrationNumber>
<CustomerTitle>string</CustomerTitle>
<CustomerFirstName>string</CustomerFirstName>
<CustomerSurName>string</CustomerSurName>
<CustomerEmail>string</CustomerEmail>
<CustomerPostCode>string</CustomerPostCode>
<CustomerTelephoneNumber>string</CustomerTelephoneNumber>
<CustomerMobileNumber>string</CustomerMobileNumber>
<CustomerUUID>string</CustomerUUID>
<CustomerAddress1>string</CustomerAddress1>
<CustomerAddress2>string</CustomerAddress2>
<CustomerAddress3>string</CustomerAddress3>
<CustomerAddress4>string</CustomerAddress4>
<CustomerContactEmail>string</CustomerContactEmail>
<CustomerContactHomePhone>string</CustomerContactHomePhone>
<CustomerContactMail>string</CustomerContactMail>
<CustomerContactSMS>string</CustomerContactSMS>
<CustomerType>string</CustomerType>
<FirstRegistrationDate>string</FirstRegistrationDate>
<NextMotDate>string</NextMotDate>
<NextServiceDate>string</NextServiceDate>
<ServiceAdvisor>string</ServiceAdvisor>
<Workshop>string</Workshop>
<WorkRequired>string</WorkRequired>
<Mileage>string</Mileage>
<DateIn>string</DateIn>
<DateOut>string</DateOut>
<TimeIn>string</TimeIn>
<TimeOut>string</TimeOut>
<ServiceOrderItems>
<ServiceOrderItemTransferObject xsi:nil="true" />
<ServiceOrderItemTransferObject xsi:nil="true" />
</ServiceOrderItems>
<NextCheckTachographDate>string</NextCheckTachographDate>
<NextChangeCoolantDate>string</NextChangeCoolantDate>
<NextChangeBrakeFluidDate>string</NextChangeBrakeFluidDate>
<LastWorkshopVisitDate>string</LastWorkshopVisitDate>
<LastServiceDate>string</LastServiceDate>
<MileageLastWorkshopVisit>int</MileageLastWorkshopVisit>
<MileageLastService>int</MileageLastService>
<ServiceCode>string</ServiceCode>
<EngineOil>string</EngineOil>
<TransmissionOil>string</TransmissionOil>
<PositionNumber>int</PositionNumber>
<AxleLocation>string</AxleLocation>
<AxleNumber>int</AxleNumber>
<FirstTyreLocation>string</FirstTyreLocation>
<SecondTyreLocation>string</SecondTyreLocation>
<MakeCode>string</MakeCode>
<ModelCode>string</ModelCode>
<AgreedEstimate>string</AgreedEstimate>
<VhcUrl>string</VhcUrl>
</ServiceOrder>
<Message>string</Message>
<Success>boolean</Success>
</GetServiceOrderByIDResult>
</GetServiceOrderByIDResponse>
GetServiceOrderByIDResponse | ||||
PropertyName | PropertyType | Example | Description | Mandatory |
CurrencyCode | String | GBP | Code for local currency | Yes |
Locale | String | en-GB | Culture code | Yes |
Username | String | DMSADMIN | VHC Username | Yes |
Password | String | DMSPASSWORD | VHC Password | Yes |
Sitecode | String | 123456 | VHC Site Code | Yes |
VHCDate | String | 20120912 | Date the vehicle is due at the dealership (YYYYMMDD) | Yes |
Make | String | FORD | Vehicle manufacturer | Yes |
Model | String | FOCUS | Vehicle model | Yes |
VIN | String | WF0BXXWPRB6U02664 | Vehicle VIN or Chassis number | Yes |
JobCardNumber | String | 11522565 | DMS Work order number | Yes |
RegistrationNumber | String | FG58 AXY | Vehicle registration number | Yes |
CustomerTitle | String | Mr | Customer Title | No |
CustomerFirstName | String | Jamie | Customer First Name | No |
CustomerSurName | String | Lawrence-Jenner | Customer Surname | Yes |
CustomerEmail | String | jamie.jenner@autovhc.co.uk | Customer Email | No |
CustomerPostCode | String | WR13 6PZ | Customer PostCode | No |
CustomerTelephoneNumber | String | 01684 554477 | Customer Land Line Telephone Number | No |
CustomerMobileNumber | String | 07977 115478 | Customer Mobile/Cell Number | No |
CustomerUUID | String | 11544854 | DMS Unique customer identifier | No |
CustomerAddress1 | String | 12 Acacia Avenue | Customer Address Line 1 | No |
CustomerAddress2 | String | Great Malvern | Customer Address Line 2 | No |
CustomerType | String | RETAIL-001 | Customer Account category or type | No |
FirstRegistrationDate | String | 20081025 | Date vehicle first registered (YYYYMMDD) | No |
NextMotDate | String | 20121128 | Date of the next government vehicle inspection is due (YYYYMMDD) | No |
NextServiceDate | String | 20130528 | Date when next vehicle service is due (YYYYMMDD) | No |
ServiceAdvisor | String | JLJ | The DMS identification of the service advisor who will deal with the customer | No |
Workshop | String | MAIN | Workshop in which the vehicle will be inspected | No |
WorkRequired | String | 35,000 km service | Description of required work/reason for the booking | No |
Mileage | String | 1154458 | Last know odometer reading | No |
DateIn | String | 20120912 | Date the vehicle is due at the dealership (YYYYMMDD) | No |
DateOut | String | 20120912 | Date the vehicle is due at the dealership (YYYYMMDD) | No |
TimeIn | String | 91500 | Time the vehicle is due at the dealership (HH:MM:SS) | No |
TimeOut | String | 173000 | Time the vehicle is due at the dealership (HH:MM:SS) | No |
MakeCode | String | 56 | DMS Manufacturer Code | No |
ModelCode | String | 78 | DMS Model Code | No |
AgreedEstimate | String | 250 | Value quoted to the customer for completion of the work required | No |
EngineNumber | String | AB12345 | The engine’s identifier number | No |
CustomerNotes | String | Front Brakes making knocking noise | Any additional information provided by the customer | No |
A failed response would show the below code:
<GetServiceOrderByIDResponse xmlns="http://www.wsautovhc.co.uk">
<GetServiceOrderByIDResult>
<Message xmlns="http://autovhc.co.uk/">Unauthorized</Message>
<Success xmlns="http://autovhc.co.uk/">false</Success>
</GetServiceOrderByIDResult>
</GetServiceOrderByIDResponse>