Aviva Vehicle Repairer Lookup API

Aviva Vehicle Repairer Lookup API

1.0.0OAS 3.0

This API calls our analytics model which provides a list of recommended repairers.

API Base URL
  • Server 1:https://ec2-18-202-229-190.eu-west-1.compute.amazonaws.com:8443
Security
oauth2 (oauth2)

Use ‘test-client’ as the client_id and client_secret to obtain a token to access this API.

This API calls our analytics model which provides a list of recommended repairers.

This API calls our analytics model which provides a list of recommended repairers.

post
https://ec2-18-202-229-190.eu-west-1.compute.amazonaws.com:8443/v1/vehicleRepairAnalyticsModels/search

Headers

Correlation-IDstring

Unique identifier set by the client which can be used to correlate the message across systems

Example:c95377a8-e70f-49ac-82f8-97968196ae3e

Hub-Correlation-IDstring

Set by the caller to identify the transaction. This will be used by the Hub. Required when modelId is RRR. Maximum length 16.

Example:123456

Requesting-Systemstringrequired

Set by the caller to identify the requesting system. Maximum length 50. Allowed characters (A-Z,a-z,0-9,-,:) eg. EvolveHub

Example:EvolveHub

Acceptstringrequired

Content-Types that are acceptable for the response.Defaults to application/json

Example:application/json

Content-Typestringrequired

Defines the type of data being sent with the request

Allowed values:application/json

Default:application/json

Example:application/json

Authorizationstringrequired

Authentication credentials for HTTP authentication. eg. Bearer 0b79bab50daca910b000d4f1a2b675d604257e42

Example:Bearer 0b79bab50daca910b000d4f1a2b675d604257e42

Body

application/json

vehicleRepairAnalyticsModelsRq

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

Response

application/json

OK

vehicleRepairAnalyticsModelsRs

An array of vehicleRepairAnalyticsModels Response

vehicleRepairAnalyticsModelsarray[object]

Data Related to VehicleRepairAnalyticsModels

Show Child Parameters
post/v1/vehicleRepairAnalyticsModels/search

Body

{ "modelId": "RRR", "roadsideRecoveryInstructed": "Yes" }
 
application/json

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