POST api/GetVehicleData

Request Information

URI Parameters

None.

Body Parameters

GetVehicleDataRequest
NameDescriptionTypeAdditional information
User

string

None.

Password

string

None.

VINNumber

string

None.

ReportType

string

None.

GetOEMInfo

boolean

None.

GetNVSInfo

boolean

None.

GetRecallInfo

boolean

None.

GetNADAInfo

boolean

None.

GetBlackBookInfo

boolean

None.

GetImage

boolean

None.

mileage

integer

None.

GeneratePDFReport

boolean

None.

EmailReport

boolean

None.

EmailAddress

string

None.

LogToken

string

None.

GetCached

boolean

None.

WebApiAccessKey

string

None.

DataSource

string

None.

IP

string

None.

Request Formats

application/json, text/json

Sample:
{
  "User": "sample string 1",
  "Password": "sample string 2",
  "VINNumber": "sample string 3",
  "ReportType": "sample string 4",
  "GetOEMInfo": true,
  "GetNVSInfo": true,
  "GetRecallInfo": true,
  "GetNADAInfo": true,
  "GetBlackBookInfo": true,
  "GetImage": true,
  "mileage": 11,
  "GeneratePDFReport": true,
  "EmailReport": true,
  "EmailAddress": "sample string 14",
  "LogToken": "sample string 15",
  "GetCached": true,
  "WebApiAccessKey": "sample string 17",
  "DataSource": "sample string 18",
  "IP": "sample string 19"
}

Response Information

Resource Description

CheckVehicleDataResponse
NameDescriptionTypeAdditional information
OEMInfo

OEMInfo

None.

NVSInfo

Collection of NVSInfo

None.

RecallInfo

Collection of RecallInfo

None.

NADAInfo

NADAInfo

None.

ImageUrl

string

None.

BlackBookInfo

BlackBookInfo

None.

ReportId

string

None.

Message

string

None.

Status

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "OEMInfo": {
    "AntiBrake": "sample string 1",
    "Driveline": "sample string 2",
    "FuelEconomyCity": "sample string 3",
    "FuelEconomyHighway": "sample string 4",
    "OptionalSeating": "sample string 5",
    "OverallHeightInch": "sample string 6",
    "OverallLengthInch": "sample string 7",
    "OverallWidthInch": "sample string 8",
    "ProductionSeq": "sample string 9",
    "StandardSeating": "sample string 10",
    "Status": "sample string 11",
    "SteeringType": "sample string 12",
    "TankGal": "sample string 13",
    "Transmission": "sample string 14",
    "TrimLevel": "sample string 15",
    "vin_body": "sample string 16",
    "vin_engine": "sample string 17",
    "vin_make": "sample string 18",
    "vin_manufacture": "sample string 19",
    "vin_model": "sample string 20",
    "vin_year": "sample string 21"
  },
  "NVSInfo": [
    {
      "EventType": "sample string 1",
      "EventDate": "sample string 2",
      "EventDescription": "sample string 3"
    },
    {
      "EventType": "sample string 1",
      "EventDate": "sample string 2",
      "EventDescription": "sample string 3"
    }
  ],
  "RecallInfo": [
    {
      "CAMPNO": "sample string 1",
      "RCDATE": "sample string 2",
      "COMPNAME": "sample string 3",
      "DESC_DEFECT": "sample string 4",
      "CONEQUENCE_DEFECT": "sample string 5",
      "CORRECTIVE_ACTION": "sample string 6",
      "NOTES": "sample string 7"
    },
    {
      "CAMPNO": "sample string 1",
      "RCDATE": "sample string 2",
      "COMPNAME": "sample string 3",
      "DESC_DEFECT": "sample string 4",
      "CONEQUENCE_DEFECT": "sample string 5",
      "CORRECTIVE_ACTION": "sample string 6",
      "NOTES": "sample string 7"
    }
  ],
  "NADAInfo": {
    "Status": "sample string 1",
    "vin_retail": "sample string 2",
    "vin_loan": "sample string 3",
    "avg_tradein": "sample string 4",
    "rough_tradein": "sample string 5",
    "vin_tradein": "sample string 6",
    "vin_body": "sample string 7",
    "vin_make": "sample string 8",
    "vin_model": "sample string 9",
    "vin_year": "sample string 10",
    "basemsrp": "sample string 11"
  },
  "ImageUrl": "sample string 1",
  "BlackBookInfo": {
    "Status": "sample string 1",
    "retail_avg": 2,
    "retail_clean": 3,
    "retail_rough": 4,
    "retail_xclean": 5,
    "tradein_avg": 6,
    "tradein_clean": 7,
    "tradein_rough": 8,
    "whole_avg": 9,
    "tradein_fair": 10,
    "finadv": 11,
    "msrp": 12,
    "whole_rough": 13,
    "model_year": "sample string 14",
    "make": "sample string 15",
    "model": "sample string 16",
    "bb_api": "sample string 17"
  },
  "ReportId": "sample string 2",
  "Message": "sample string 3",
  "Status": true
}