Home > Uncategorized > #REST based #API open for feedback

#REST based #API open for feedback

Beta REST API reference

Overview

The REST Beta API is a JSON based API that accepts basic HTTP authentication for user identification.  This API is still in BETA, and is therefore open for discussion and feedback from our users, but also may be changed without warning. If you would like to use this API in production, please let us know.

The format of the REST URL is as follows:

https://www.regcheck.org.uk/api/json.aspx/{Method}/{Parameter1}/{Parameter2}

Where {Method} is one of the following options;

CarSpecifications
Get static data based on a make, model and year of a car

Check
Get details for a vehicle in the UK

CheckAustralia
Get details for a vehicle in Australia

CheckBelgium
Get details for a vehicle in Belgium

CheckCroatia
Get details for a vehicle in Croatia

CheckCzechRepublic
Get details for a vehicle in the Czech Republic

CheckDenmark
Get details for a vehicle in Denmark

CheckEstonia
Get details for a vehicle in Estonia

CheckFinland
Get details for a vehicle in Finland

CheckFrance
Get details for a vehicle in France

CheckHungary
Get details for a vehicle in Hungary

CheckIndia
Get details for a vehicle in India

CheckIreland
Get details for a vehicle in Ireland

CheckItaly
Get details for a vehicle in Italy

CheckMotorBikeUK
Get details for a motorbike in the UK

CheckNetherlands
Get details for a vehicle in the Netherlands

CheckNewZealand
Get details for a vehicle in New Zealand

CheckNorway
Get details for a vehicle in Norway

CheckPakistan
Get details for a vehicle in Pakistan

CheckPortugal
Get details for a vehicle in Portugal

CheckRussia
Get details for a vehicle in Russia

CheckSlovakia
Get details for a vehicle in Slovakia

CheckSouthAfrica
Get details for a vehicle in South Africa

CheckSpain
Get details for a vehicle in Spain

CheckSriLanka
Get details for a vehicle in Sri Lanka

CheckSweden
Get details for a vehicle in Sweden

CheckUAE
Get details for a vehicle in United Arab Emirates

CheckUSA
Get details for a vehicle in the USA

UKMOT
Get MOT (Vehicle test) data for a car in England, Scotland or Wales

VinCheck
Get details for a vehicle based on its VIN number

WheelSize
Get Wheel size data based on a make, model and year of a car

So a sample request for a search on plate YYO7XHH in the UK would be:

https://www.regcheck.org.uk/api/json.aspx/Check/YYO7XHH

Which would return the following JSON

{
 “ABICode”: “39049602”,
 “Description”: “2007 Peugeot 307 X-line, 1360CC Petrol, 5DR, Manual”,
 “RegistrationYear”: “2007”,
 “CarMake”: {
   “CurrentTextValue”: “Peugeot”
 },
 “CarModel”: {
   “CurrentTextValue”: “307”
 },
 “EngineSize”: {
   “CurrentTextValue”: “1360CC”
 },
 “FuelType”: {
   “CurrentTextValue”: “Petrol”
 },
 “MakeDescription”: “Peugeot”,
 “ModelDescription”: “307”,
 “Immobiliser”: {
   “CurrentTextValue”: “”
 },
 “NumberOfSeats”: {
   “CurrentTextValue”: 5
 },
 “IndicativeValue”: {
   “CurrentTextValue”: “”
 },
 “DriverSide”: {
   “CurrentTextValue”: “RHD”
 },
 “Transmission”: {
   “CurrentTextValue”: “Manual”
 },
 “NumberOfDoors”: {
   “CurrentTextValue”: “5”
 },
 “ImageUrl”: “http:\/\/www.regcheck.org.uk\/image.aspx\/@UGV1Z2VvdCAzMDc=”,
 “VehicleInsuranceGroup”: “04”
}

 

Exceptions:

Certain REST API calls require more than one parameter, and these are as follows;

CarSpecifications

This is called in the format Make / Model / Year, for example;

https://www.regcheck.org.uk/api/json.aspx/CarSpecifications/Honda/Civic/2014

CheckAustralia

This is called in the format Registration Number / State, for example:

https://www.regcheck.org.uk/api/json.aspx/CheckAustralia/CEC36T/NSW

CheckUSA

This is called in the format Registration Number / State, for example:

https://www.regcheck.org.uk/api/json.aspx/CheckUSA/jxv7422/pa

CheckPakistan

This is called in the format Registration Number / State / District, for example:

https://www.regcheck.org.uk/api/json.aspx/CheckPakistan/STR%206006/PB/Pathankot

UKMOT

This is called in the format Registration Number / Make, for example:

https://www.regcheck.org.uk/api/json.aspx/UKMOT/DE02VOV/PEUGEOT

VinCheck

This is called with a VIN number instead of a registration number. for example;

https://www.regcheck.org.uk/api/json.aspx/VinCheck/5XYZT3LB9FG259411

WheelSize

This is called in the format Make / Model / Year, for example;

https://www.regcheck.org.uk/api/json.aspx/WheelSize/Ford/Focus/2014

 

Advertisements
Categories: Uncategorized
  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: