Description

The Compare API provides a service interface allowing vehicles to be selected and compared. The endpoints in this API support both vehicle selection and the creation of the compare API.

Note: You can use the provided endpoints for vehicle selection or you can develop the selection mechanism independent of this API.

This API has 11 endpoints:

• GET /models/primary – Returns the Primary vehicle set from which the base vehicle for a compare can be selected.
• GET /models/secondary – Returns model-level attribute and display information for secondary vehicles.
• GET models/secondary/search – Returns list of available Secondary vehicle information based on Make and Model information passed.
• GET models/secondary/years – Returns list of available secondary years based on RCRM client profile.
• GET /models/{modelCodes}/vehicles – Returns model-level attribute and display information.
• GET /vehicles/{vehicleCode}/common-competitors – Returns the common competitors for the specified primary vehicle.
• GET /media/types – Returns a list of your pre-selected media types.
• POST /image – Returns a photo compare, where vehicle photos can be compared side-by-side.
• POST /image.pdf – Returns a photo compare in PDF format.
• POST /text – Returns a text compare where vehicle features can be compared side-by-side in a grid.
• POST /text.pdf – Returns a textual feature grid compare in PDF format.

These endpoints interact with your client profile, as set up during initial configuration, and together the web service endpoints and the client profile settings determine the response from the Compare web service. For specific information about client profile settings, refer to the CDS Compare Setup Client Profile Configuration document.