Technical Documentation

Transcription

1 Technical Documentation Newsletter SilverDAT Interfaces Information for DAT interface partner Version No.054 Published INTERFACE Seite 1 von 24

2 Contents 1. First page ATTENTION - maintenance work Currently supported browsers Registering for the DAT workshop Examples for DAT interfaces DAT vehicle selection: test for VIN request replies myclaim - Important webservice changes myclaim - new services and functions VXS - exchange format: scheduled changes in VXS Vehicle object VXS - exchange format: changes in VXS RepairCalculation object SilverDAT valuatepro: change of function postsale Managing dossiers: functionality DossierService Managing dossiers: lump-sum values - part I Managing dossiers: lump-sum values - part II VehicleRepairService - new functions VehicleRepairService - outdated functions VehicleRepairService - user-surface extension for Austria, Switzerland and Poland VehicleRepairService - interface extension for Austria, Switzerland and Poland Interface product CalculationAudit Last page Seite 2 von 24

3 1. First page Dear DAT interface partner: with this newsletter 054 concerning the interface compendium update of December 2016, we would like to inform you of the following new features: Optimized dossier functions Lump-sum valuation for vehicle valuation Test for VIN request replies Test VIN numbers are provided to test the scope of all potential replies to a VIN request free of charge These test VIN numbers comprise various vehicles and fault codes Important webservice changes myclaim New functions in myclaimexternalservice User surface extension of VehicleRepairService: Austria: additional-costs lump sum, disposal costs, small parts and consumables, spare-parts procurement costs Switzerland: small parts and consumables Poland: small parts and consumables New interface surface for the products SilverDAT calculatepro, SilverDAT calculateexpert Country-specific new parameters for Austria New parameter for small parts and consumables for Switzerland New parameter for small parts and consumables for Poland New parameter for the origin of spare parts for Germany Outlook on new functions in release of August 2017 in VehicleRepairService: New function for the hand-over of insurance data: createcontractn New function for the additional output of the calculation protocol: getcalculationresultswithprotocol Further information for DAT interface partners is provided at After customer login, you will find the interface compendium, the newsletters and a contact template at mydat Services. Your data for the customer login is available from our sales support: sales-support@dat.eu mailto:sales-support@dat.eu Questions concerning the interface compendium will be answered by our customer service for interface partners interfaces@dat.eu mailto:schnittstellenpartner@dat.de Seite 3 von 24

4 Please provide the following information when contacting us: Customer number <DAT customer number of the client> Address instead of customer number Contact person Phone number. When inquiring about interface functions, please provide: Name of the product to which the interface belongs Request and Response of the parameter. This information helps us to respond to your inquiry in short time. Please make sure to work with the latest version! Sincerely yours, Your DAT interface partner team 2. ATTENTION - maintenance work Maintenance work will be performed on the following dates: Sunday, 11th December 2016 Sunday, 26th February 2017 Sunday, 07th May 2017 Sunday, 30th July 2017 Sunday, 26th November 2017 On these dates, DAT applications will not be accessible at all or only to a limited extent. Please take notice! Seite 4 von 24

5 3. Currently supported browsers In the last newsletter, we had published various announcements regarding browser support. Unfortunately these were not as clear and unambiguous as we thought. For the DAT products we recommend additionally to the browsers already mentioned in the newsletter, the following browsers: Google Chrome Version 51 or later Mozilla Firefox Version 46 or later Of course, we are still supporting the following Microsoft browsers Internet Explorer 8 Internet Explorer 9 Internet Explorer 10 Internet Explorer 11 However, as mentioned in the last publication, we will end the support for the following browsers with the update of March 2017 Internet Explorer 8 Internet Explorer 9 Internet Explorer 10 While using Microsoft Edge at the moment, this could cause to few malfunctions. Expectedly until the end of April 2017, our applications are also going to be fully functionable under Microsoft Edge. Please check your browser and follow our recommendation! Seite 5 von 24

6 4. Registering for the DAT workshop Dates of the DAT workshop DAT holds workshops to help customers make optimal use of the DAT interfaces in their tools. The next workshops will be held on the following dates: Wednesday, 08th February 2017 Thursday, 16th March 2017 Thursday, 11th May 2017 Please let us know which of the following topics are of interest to you: 1) Basics and log-in 2) DAT uropa-code vehicle selection 3) Calculation 4) Valuation 5) Customer Service 6) Business Management 7) Licensing and costs For further information about registering contact the DAT sales support: 5. Examples for DAT interfaces The GitHub provides developers with sample codes. The examples show the integration of interfaces and the use of the DAT interfaces: Seite 6 von 24

7 6. DAT vehicle selection: test for VIN request replies We recommend to test the scope of all potential replies when programming and using the interface function getvehicleidentificationbyvin (VIN request). To this end, we have created a function test which provides simulated VIN numbers for testing purposes. Requests made with these test VIN numbers are free of charge. These test VIN numbers are available for various vehicles and for all fault codes potentially occurring. Please follow our recommendation! For further information refer to the SilverDAT interface compendium at: SilverDAT Products > DAT uropa-code Vehicle selection > Vehicle identification - Functions > Vehicle identification by VIN (VIN-request) > Test VIN numbers (free of charge) SilverDAT Products > DAT uropa-code Vehicle selection > Vehicle identification - Functions > Vehicle identification by VIN (VIN-request) > Test VIN numbers for all Fault codes (free of charge) Seite 7 von 24

8 7. myclaim - Important webservice changes In the next release December 2016, in addition to the already existing WSDL languages, new (V2) WSDL versions will be released in parallel with the following major changes: These changes only apply to the V2 WSDL languages - The WSDL is no longer generated dynamically. If a new WSDL has to be generated (in the case of new mehodes etc...), it must be generated and committed with the Ant task createwsdls. - MTOM will not be supported any more - Correction "Dossier/dossier" in external service. From now the web service accepts only dossier with large "D". This makes VXS.jar and myclaim compatible. The new V2 WSDL languages can be accessed from December 2016 at the following URL addresses: vice?wsdl The old WSDL languages (without the above changes) remain active until the release August This gives enough time to upgrade to the new V2 WSDL languages! Important! All myclaim Webservice customers must change to the new services by August 2017 at the latest! After the release August 2017, the old WSDL languages will not be supported any more! Seite 8 von 24

9 8. myclaim - new services and functions In addition to the new functions, the release of December 2016 of myclaim includes services for damage calculation (VehicleRepairService) and vehicle valuation (ValuationService). New services in myclaim Calculation (VehicleRepairService) Valuation (ValuationService) Vehicle selection (VehicleSelection) Vehicle identification (VehicleIdentification) New functions in myclaim listinvoicerates This function lists invoicing rates within a customer number assigninvoiceratetocontract The function can be used to allocate an invoicing rate to a new order. 9. VXS - exchange format: scheduled changes in VXS Vehicle object Scheduled changes from August 2017: Changes to element 'Engine type': Element Engine.EngingeType is deleted. Element Engine.EngineType can be used alternatively (scheduled from March 2017 available). Scheduled changes from December 2017: Seite 9 von 24

10 Changes to element 'Fuel type': Element Engine.FuelMethod is deleted. Element TechInfo.FuelMethod can be used alternatively. Please check your applications for compatibility. Make necessary adjustments in due time! 10. VXS - exchange format: changes in VXS RepairCalculation object With the release of December 2016 a new field will be added to our interface in tag RepairParameters : New element (from December 2016) Element Type Description Return values <RepairCalculation><RepairParameters> <LacquerTimeUnitSystem> String The time measure for the labour values for painting methods AZT and Eurolack. "STD" = hours "AE" = labour unit (Netherlands only) "ZE" = time unit "AW" = labour value From April 2017, the source of a spare part will be shown in area RepairPositions of our interface. New element (from April 2017) Seite 10 von 24

11 Element Type Description Return values <RepairCalculation><RepairPositions> <PartOrigin> String Source of a spare part. "OE" = genuine part with manufacturer price "EX" = exchange part "NA" = information not available (default, no further details about the source or origin of the part available) Planned change in calculation result of interface surface calculatepro/ calculateexpert: The designation "VAT for exchange parts" has been replaced by "VAT (19%) on 10% of value of old exchange part" in section 'Total amounts' of 'Net repair costs'. The value of the old part is assumed as a lump sum of 10% of the value of the exchange part ( 10 German VAT law - Umsatzsteuergesetz (UStG)). The VAT on the value of the old exchange part applies in Germany only. It is therefore only shown in the 'Protocol' section for data country Germany, with the same also applying to the print-out. 11. SilverDAT valuatepro: change of function postsale The booking function for the sale of a vehicle postsale has been corrected. Element OrderDate has been deleted. Element PurchaseDate has been adopted. PurchaseDate is mandatory unless this date has not been specified and saved before, e. g. using function postadmission or postpurchase. For further information refer to the SilverDAT interface compendium at: e/dat_schnittstellen/englisch/silverdat%20interface%20compendium/index.htm#4007 Seite 11 von 24

12 12. Managing dossiers: functionality DossierService The Dossier functions are used to manage your procedures via the Soap interface. Overview of functions and their availability: SilverDAT SilverDAT valuteexpert/ Function Description valuatefinance/ Partner/ valuatepro PlusPartner SilverDAT calculatepro/ Expert createdossier Creation of new procedures X X getdossier Calling of existing procedures X X X changedossier Changing of procedures X X X updatedossier Updating of procedure valuation X X resetdossier2- Default Resetting a procedure to DAT default settings X X deletedossier Deleting existing procedures X X exportdossier Creation of printable documents X searchdossierlist Retrieval of existing procedures X X The specific interface functions of the SilverDAT valuatefinance, SilverDAT valuatepro, SilverDAT valuateexpert, SilverDAT valuateexpertpartner, SilverDAT valuateexpertpluspartner, SilverDAT calculatepro und SilverDAT calculateexpert for the administration of procedures and their descriptions are available at the following URL addresses: WSDL Seite 12 von 24

13 Service request Managing dossiers: lump-sum values - part I The functionality of the lump-sum valuation is planned for the interface functions for December This affects functions createdossier and changedossier Description of parameters Element vxs:valuation Seite 13 von 24

14 Parameter Data type Description vxs:valuationtype vxs:equipmentprice vxs:manualequipmentoriginal- Price Planned from December 2016 vxs:equipmentpercentage Planned from December 2016 vxs:equipmentdecreasetype Planned from December 2016 String, conditional Decimal, Integer, Integer, String, Valuation type; Mandatory for lump-sum equipment values; The default value is VALUATION; If value NEW VEHICLE is selected, fields MileageEstimated and InitialRegistration are ignored. NEW VEHICLE is only possible in connection with DossierType = EVALUATION. Manual input of equipment residual value (total) Not permissible in combination with ManualEquipmentOriginal- Price Manual input of a lump-sum equipment total price in Euro. Not permissible in combination with EquipmentPrice The lump-sum equipment total price can be split in two parts of different devaluation. Example: Package 1: 60%, RW Package 2: T4. This value defines the first percentage. Devaluation type for first percentage Seite 14 von 24

15 Parameter Data type Description vxs:equipmentdecreasetype- Remaining String, Devaluation type for remaining percentage Planned from December 2016 For further information refer to the SilverDAT interface compendium at: e/dat_schnittstellen/englisch/silverdat%20interface%20compendium/index.htm# Managing dossiers: lump-sum values - part II The functionality of the lump-sum valuation is planned for the interface functions for December This affects functions createdossier and changedossier Application and values of parameters Element vxs:valuation Seite 15 von 24

16 Parameter Spelling Values vxs:valuationtype VALUATION - Used vehicle NEW VEHICLE - New Vehicle vxs:equipmentprice vxs:manualequipmentoriginal- Numerical, positive Numerical, positive Price Planned from December 2016 vxs:equipmentpercentage Numerical [1-100] Planned from December 2016 vxs:equipmentdecreasetype Planned from December 2016 vxs:equipmentdecreasetype- Remaining Planned from December 2016 For further information refer to the SilverDAT interface compendium at: e/dat_schnittstellen/englisch/silverdat%20interface%20compendium/index.htm#3786 Seite 16 von 24

17 15. VehicleRepairService - new functions The release of August 2017 includes the following new functions for service VehicleRepairService for products calculatepro and calculateexpert: createcontractn In addition to method createcontract, this method hands over insurance data. It substitutes the method createcontract from August getcalculationresultswithprotocol The function also allows you to output the calculation protocol. It replaces the method getcalculationresults from August VehicleRepairService - outdated functions createcontract will be replaced by the function createcontractn. getcalculationresults will be replaced by the function getcalculationresultswithprotocol. Attention These functions will be cancelled with the upcoming release August 2017 and it will be removed from the interfaces. 17. VehicleRepairService - user-surface extension for Austria, Switzerland and Poland With the release of December 2016, the service VehicleRepairService will provide new fields for Austrian and, in parts, Swiss and Polish users of calculatepro/calculateexpert. The interface will be extended accordingly. 1) Additional-costs lump sum Seite 17 von 24

18 The value of the additional-costs lump sum is defined once per procedure. Current default: Euro at 100%. Permissible value range [ Euro], two decimal digits allowed. The value of the additional-costs lump sum may be varied by specifying a value between 0.0 and 100.0%. Adjustment of interface surface of products calculatepro/calculateexpert: Extension of the procedure-related data: In section 'Calculation', a line with the fields 'Additional-costs lump sum (100%=) xx (EUR) and 'xx (%)' will be added to the end of the section. Extension in calculation result: In the total sums, a line with the value of the additional-costs lump sum at (%) will be added to the end of the section. Example: Additional-costs lump sum (at 100%) Euro. 2) Disposal costs Disposal costs can be calculated in % of the spare parts costs. Adjustment of interface surface of products calculatepro/calculateexpert: Extension of procedure-related data: The field 'Disposal costs in (%)' will be added in section 'Spare parts factors'. Extension in calculation result: A line with the disposal costs in (%) will ben added to the block of total amount for spare parts. 3) Small parts and consumables Exclusively for the data countries Austria, Switzerland and Poland, an option is provided to distinguish between the percentage of the labour costs and the percentage of the spare parts price for small parts. A minimal value and a maximum value can be specified. Adjustment of interface surface of products calculatepro/calculateexpert: Extension of procedure-related data: The percentage of spare parts or percentage of labour costs can be specified in section 'Spare parts factors' under 'Small parts'. Extension in calculation result: A line with the calculated value for small parts and consumables will be added to the block of total amount for spare parts. 4) Procurement costs for spare parts: Seite 18 von 24

19 The procurement costs for spare parts can be entered as a percentage of the spare parts costs, with the option of specifying an upper limit in Euro. A limit value of 350 is set as default in the DAT data, and the calculated value will be limited to the amount. Adjustment of interface surface of products calculatepro/calculateexpert: Extension of procedure-related data: The fields 'Spare parts (%)', 'Spare parts max. (EUR)', 'Bodyshell (%)' and 'Bodyshell max. (EUR)' will be added to section 'Spare parts factors' under 'Procurement costs'. Extension in calculation result: A line with the procurement costs will be added to the end of the block of total amount of spare parts. 18. VehicleRepairService - interface extension for Austria, Switzerland and Poland With the release of December 2016 the service VehicleRepairService will provide new functions for Austrian and, in parts, Swiss and Polish users of calculatepro/ calculateexpert. These are outlined in the following: In the VXS file in RepairCalculation tag in element RepairParameters: Seite 19 von 24

20 Element Type Description Additional-costs lump sum Once per procedure, covers the costs for order-related handling, production and transmission of photos, final cleaning and colour-tone matching. Current default: Euro at 100%. Applies to data country Austria only. <RepairCalculation><RepairParameters> <AdditionalCostsFlatAmount> <AdditionalCostsPercent> decimal, decimal, Specifies the additional-costs lump sum in Euro. Optional amount in Euro, value range [ ] Specifies the percentage at which the additional-costs lump sum is applied. Optional percentage for additional-costs lump sum, value range [ ]. Wording: Euro at 80 percent. Disposal costs A Specification in percentage per procedure to determine the disposal costs based on the sum of the spare parts prices. Applies to data country Austria only. <RepairCalculation><RepairParameters> <DisposalCostsSparePartsPercentage> decimal Specifies the disposal costs in percent of the sum of the spare parts prices. Optional percentage, value range [ ]. Seite 20 von 24

21 Element Type Description Small parts and consumables Small parts and consumables are determined either as a percentage of the sum of the spare parts prices or of the sum of the labour costs. A lump sum in the currency unit can also be specified. Also applies to data countries Switzerland and Poland. <RepairCalculation><RepairParameters> <ConsumablesPercentage> <ConsumablesPercentageForOpt> <ConsumablesType> <ConsumablesFlatAmount> decimal, decimal, Werteliste decimal, Specifies a percentage to determine small parts and consumables. Optional percentage, value range [ ]. Optional percentage for optimisation by bodyshell, value range [ ]. (<CalcResultToUse>optimized </CalcResultToUse>) ConsumablesType can assume value 0, 1 or 2 and defines how to determine small parts and consumables with ConsumablesPercentage. 0 = lump-sum value 1 = percentage of sum of spare parts prices 2 = percentage of sum of labour costs Lump-sum amount in a currency. Procurement costs Procurement costs for spare parts. A limited of 350 applies. Applies to data country Austria only. Seite 21 von 24

22 Element Type Description <RepairCalculation><RepairParameters> <ProcurementCostsPercent> decimal, <ProcurementCostsPercentBodyInWhite> decimal, <ProcurementCostsMax> decimal, <ProcurementCostsMaxBodyInWhite> decimal, Optional percentage to determine the procurement costs based on the sum of the spare parts prices. Value range [ ]. This parameter is only effective when optimising for bodyshell // only with <CalcResultToUse>optimized </CalcResultToUse> Specifies a maximum value for the procurement costs derived from the percentage. The amount is output in a currency. Maximum value for the procurement costs. Value range [ ]. This parameter is only effective when optimising for bodyshell // only with <CalcResultToUse>optimised </CalcResultToUse> In VXS file in area RepairCalculationSummary: Seite 22 von 24

23 Element Type Description Additional-costs lump sum <RepairCalculationSummary> <AdditionalCostsFlatRate> Disposal costs decimal Is calculated without additional-costs lump sum because e.g. the user has entered 0 Euro for the lump sum or a percentage of 0, the value will be missing in the result, accordingly. <RepairCalculationSummary><SparePartsCosts> <DisposalCostsSpareParts> Small parts and consumables decimal, Amount in a currency. <RepairCalculationSummary><SparePartsCosts> <ConsumablesSurcharge> Procurement costs decimal, Calculated amount in a currency, may also be the lump-sum value. Depending on ConsumablesType. <RepairCalculationSummary><SparePartsCosts> <ProcurementCostsPercent> decimal, Determined value, possibly when optimising for bodyshell. 19. Interface product CalculationAudit The interface product CalculationAudit will be removed with the release in December This product will be replaced by the product SilverDAT PartsInfo in the future time. Seite 23 von 24

24 20. Last page Please observe the revision history for each section. Make sure to work only with the latest version of the interface compendium. The upcoming update of the interface compendium will be released in December The next update is scheduled for April We will inform you through our newsletter. Questions concerning the interface compendium will be answered by our customer service for interface partners. Sincerely yours, Your DAT interface partner team Seite 24 von 24