Aviva Vehicle Repairer Lookup API

vehicleRepairAnalyticsModelsRq

object

vehicleRepairAnalyticsModels Request.

hubCaseIdstring

The reference ID assigned to a Case. Required when modelId is RRR.

Match pattern:^[a-zA-Z0-9]*$

<= 16 characters

Example:J12345

internalClaimIdentifierstring

This is a combination of Claim Number and Exposure ID. Required when modelId is RRR.

Match pattern:^[a-zA-Z0-9-]*$

<= 40 characters

Example:4123456789-01

vehicleRegistrationNumberstring

The identifier held on a government sponsored register of vehicles. This identifier is displayed on a plate(s) attached to the vehicle. Required when modelId is RRR.

Match pattern:^[a-zA-Z0-9\s]*$

<= 10 characters

Example:BB67 ABC

vehicleLocationstring

A geographical locator that denotes whereabouts the vehicle to be repaired is located. Usually the postcode. Required when modelId is RRR.

Match pattern:^[a-zA-Z0-9\s]*$

<= 10 characters

Example:NR1 3NS

vehicleMakestring

The brand of the vehicle. Required when modelId is RRR.

<= 32 characters

Example:Ford

vehicleModelstring

The name of a car product and sometimes a range of products. Required when modelId is RRR.

<= 50 characters

Example:Fiesta

modelIdstringrequired

A unique reference given to a Data Science Model. Enabled only for RRR (Recommended Repairer Routing) as of now.

Allowed values:RRR

Example:RRR

roadsideRecoveryInstructedstringrequired

Indicator that denotes if instructions were given to a recovery agent to collect the claim vehicle and transport it to a repair centre.

Allowed values:YesNo

Example:Yes

Example

vehicleRepairAnalyticsModelsRs

object

An array of vehicleRepairAnalyticsModels Response

vehicleRepairAnalyticsModelsarray[object]

Data Related to VehicleRepairAnalyticsModels

Show Child Parameters
Example

VehicleRepairAnalyticsModels

object

Data Related to VehicleRepairAnalyticsModels

modelIdstring

A unique reference given to a Data Science Model. Only supports RRR (Recommended Repairer Routing) as of now.

Allowed values:RRR

outputDatestring(date-time)

Date as which the Model has been executed to provide results.

modelOutputarray[object]

Data Related to ModelOutput

Show Child Parameters
Example

ModelOutput

object

Data Related to ModelOutput

rankingnumber

Ranks the Probability attributes, to enable comparison of all Probabilities in order of rank.

organisationIdstring

For each of potentially many repairers, this denotes the unique identifier of the repairer to correspond with the repairer database held in the Hub.

stringTypesarray[object]

An array of string messages related to the model output and their description

Show Child Parameters
decimalTypesarray[object]

An array of decimal values related to the model output and their description

Show Child Parameters
Example

StringTypes

object

An array of string messages related to the model output and their description

messagestring

A result output from a data science model in text format.

descriptionstring

This describes the content and purpose of the String Value attribute, which then enables Marketeers to comprehend the relevance of using the String Value when creating marketing campaigns.

Example