Retrieving an Existing Vehicle Report

This section outlines how to retrieve vehicle reports in various formats using parameters that specify the report type and vehicle details.

These transaction can work with any existing vehicle reports generated either through this robot interface or through the MotorWeb web interface.

The report to retrieve can be specified in different ways with different parameters:

• reference : Reference number of the report. Reference is different to all other retrieval methods in that it will load reports belonging to any account and loads a specific report rather than the latest one linked to a vehicle.

• vehicleId : Retrieves the latest vehicle report against the vehicle with this ID (most probably this ID will have been retrieved from a previous transaction).

• transactionType : specify which type of vehicle report to retrieve (optional). The valid transaction types are: 'vir', 'vdr' (Motor Check), 'vdnor' (BVI), 'chassisCheck'.

• stockNumber : Retrieves the latest vehicle report against the vehicle with this stock number. In the possible (but silly) case where multiple vehicles have the same stock number the vehicle that most recently had a transaction performed against it will be used.

• transactionType : specify which type of vehicle report to retrieve (optional). The valid transaction types are: 'vir', 'vdr' (Motor Check), 'vdnor' (BVI), 'chassisCheck'.

• plateOrVin : Retrieves the latest vehicle report with that plate or VIN. This looks for plates and VINs in the report, not just the plate or VIN used to generate it.

Formats Available:

• XML: Returns data in XML format.

• HTML: Provides an HTML formatted version of the report.

• PDF: Delivers the report as a printable PDF document.

Vehicle report XML

Returns data from a report in XML (text/xml) format. The schema for the response is vir-4.0 .xsd. The schema also documents the different codes that can be returned for certain fields.

Current version: 4.0 For example: https://robot.motorweb.co.nz/action/robotLoadXml/4.0?reference=43888db2

Vehicle report as HTML

Returns an HTML formatted document (text/html) of the report suitable for displaying to users.

Current version: 2.0 For example: https://robot.motorweb.co.nz/action/robotVirHtml/2.0?reference=43888db2

Vehicle report as PDF

Returns PDF document of the report suitable for printing.

Current version: 2.0 For example: https://robot.motorweb.co.nz/action/robotVirPdf/2.0?reference=43888db2