Skip to content

Latest commit

 

History

History
512 lines (448 loc) · 38.8 KB

api_returns.rst

File metadata and controls

512 lines (448 loc) · 38.8 KB
Raw
API Sample Returns (JSON)
Sample Return for Retrieve Unique Record ID's (Inspection ID's)

Sample Return for querying inspection IDs:

{
"status":0,"message":"","content":
["20131126kwsgnnis","20131126lxhmobvx","20131125gguuulwg","20131122pbrjcrii",
"20131122uumxpitu","20131121nffiosmx","20131121uxntydkq","20131121yeudydnp","20131121ywlswcod","20131119ycdkfoyq",
"20131119bevlkucl","20131119sgqkbdey","20131118owootgmb","20131115fycqfndt","20131114grfnulmv","20131112pmmwutyb",
"20131107jkpiokjy","20131106nmiykxjl","20131106njjlwwgo"]
}

Sample Return for Record Details

Querrying the record details API will return a large json response. The response is mapped into 6 sections:

  • Record Attributes
  • Chrome Equipments
  • Chrome Options
  • Inspection Points
  • Chrome Consumer Info
  • cDemo Record

Please use the navigator on the left to go to the section you are looking for.

Record Attributes

{
    "record_attributes":

    "attribute_key": "VIN",
    "language": "EN",
    "attribute_value": "1GCEC14W1VZ159730"
}

Sample Snipit of of the JSON return

Attribute Key Sample Value
VIN VIN 1GCEC14W1VZ159730
Stock Number STOCK_NUMBER E12531
Vehicle Year VEH_YEAR 2009
Vehicle Make VEH_MAKE Chevrolet
Vehicle Model VEH_MODEL Silverado 1500HD
Engine VEH_ENGINE V6 Cylinder Engine
Engine Displacement ENGINE_DISP 4.3
Engine Cylinders CYLINDERS 6
Horse Power HORSE_POWER 325
Fuel Type FUEL_TYPE Gasoline
Transmission Spd VEH_TRANS 6-Speed A/T
Drivetrain VEH_DRIVETRAIN Rear Wheel Drive
Exterior Color VEH_EXT_COLOR White[50U,Summit White]
Interoir Color VEH_INT_COLOR Gray
Body Style VEH_BODY 2 Door Pickup
Chrome Style CHROME_STYLE Reg Cab 131.5" WB
Chrome Style ID CHROME_STYLE_ID 103562
Vehicle Series VEH_SERIES
Vehicle Trim VEH_TRIM base
Odometer KM ODOMETER_KM 1535
Odometer Miles ODOMETER_MILE 0
Odometer Reading ODOMETER_READING 1535
Odometer Type ODOMETER_TYPE Miles
Fuel Economy Units FUEL_ECONOMY_UNIT MPG
Fuel Economy City FUEL_ECONOMY_CITY 16.0 - 17.0
Fuel Economy Highway FUEL_ECONOMY_HWY 21.0 - 22.0
# of Passenger Doors PASSENGER_DOORS 2
Comments LISTING_COMMENT This is a test comment
Seating Capacity SEAT_CAPACITY 2
Certified Program CERTIFIED_PROGRAM
Vin Decode Status VIN_DECODE_STATUS SC

Chrome Equipment

{
    "chrome_equipments":

    "lang": "EN",
    "header_name": "MECHANICAL",
    "description": "4.3L (262) SFI V6 (Vortec) engine"

    "lang": "EN",
    "header_name": "MECHANICAL",
    "description": "5-speed manual transmission w/OD"

    "lang": "EN",
    "header_name": "EXTERIOR",
    "description": "Daytime running lamps"
}

+---------------------+-------------------------------------------------------+ | Header Name | Description | +---------------------+-------------------------------------------------------+ | Mechanical | 4.3L (262) SFI V6 (Vortec) engine | + +-------------------------------------------------------+ | | 5-speed manual transmission w/OD | + +-------------------------------------------------------+ | | Rear wheel drive | + +-------------------------------------------------------+ | | HD 600 CCA 12-volt battery | + +-------------------------------------------------------+ | | 100 amp alternator | +---------------------+-------------------------------------------------------+ | Exterior | Dark argent air dam | + +-------------------------------------------------------+ | | Singular rectangular halogen headlamps | + +-------------------------------------------------------+ | | Daytime running lamps | + +-------------------------------------------------------+ | | Solar-Ray tinted glass (all windows) | + +-------------------------------------------------------+ | | Removable tailgate with W/T decal | +---------------------+-------------------------------------------------------+ | Interior | Scotchgard Fabric Protector on all cloth surfaces | + +-------------------------------------------------------+ | | Simulated leather steering wheel | + +-------------------------------------------------------+ | | Heater/defogger w/side window defoggers | + +-------------------------------------------------------+ | | Dual dash cupholders | + +-------------------------------------------------------+ | | Cigarette lighter | +---------------------+-------------------------------------------------------+ | Safety Features | Four-wheel anti-lock brake system | + +-------------------------------------------------------+ | | Front outboard shoulder belt height adjusters | + +-------------------------------------------------------+ | | Head restraints, front seat | + +-------------------------------------------------------+ | | Daytime running lamp | + +-------------------------------------------------------+ | | Side door guard beams | +---------------------+-------------------------------------------------------+

cDemo Record

{
    "cdemo_record":

    "lang": "EN",
    "photo_count": 7,
    "create_date": "Sep 29, 2017 6:19:44 PM",
    "days_in_inventory": 0,
    "last_mod_by": "",
    "status_code": 1,
}
Key Value
record_id 65325943
lang EN
photo_count 7
title 1997 Chevrolet C/K 1500 Work
days_in_inventory 24
calculate_inventory_date Sep 29, 2017 6:23:10 PM
status_code 1
primary_photo_url http://static.cdemo.com/65325943/1024/automobiles-used-1997-chevrolet-ck-1500-work-1364383-primary-listing-photo-Image.jpg
primary_photo_thumbnail http://static.cdemo.com/65325943/150/automobiles-used-1997-chevrolet-ck-1500-work-1364383-primary-listing-photo-Image.jpg
urls_for_360_image http://static.cdemo.com/65325943/150/automobiles-used-1997-chevrolet-ck-1500-work-1364383-primary-listing-photo-Image.jpg
youtube_watch_url http://www.youtube.com/v/None
youtube_embed_url http://www.youtube.com/embed/None
date_feed_id 1
youtube_video_id null
record_type Basic Listing
country_code US
region UT
city Murray
detail_page_url http://live.cdemo.com/SD/idZ20170929bbcwwtkc/
qr_code_url http://static.cdemo.com/20170929bbcwwtkc/qr100.png
listing_currency USD
sale_price 27980
listing_price 0
msrp 25000
whole_sale_price 0
invoice_price 0
category Used Auto
submit_date Sep 29, 2017 6:23:10 PM
create_by nroberts
last_mod_by wrobert
create_date Sep 29, 2017 6:19:44 PM
workflow_id 3477
party_id 20301
condition_id 2
auto_generated_flag false
style_id 8

Chrome Consumer Info

{
    "chrome_consumer_info":

    "info_value": "3",
    "lang": "EN",
    "info_type": "Warranty",
    "info_name": "Basic Years"
}
Info Type Info Name Info Value
Warranty Basic Years 3
Warranty Basic Miles/km 36,000
Warranty Basic Note No Deductible Supplemental Inflatable Restraint - 3 years/36,000 miles
Warranty Emissions Note Emission component coverage - Varies by geographical region.
Warranty Roadside Assistance Note Basic Years Roadside Basic Care Assistance Program includes - Toll Free Assistance # 1-800-CHEV-USA Free Towing to nearest Chevy Dealer Reasonable cost Wrecker...

Chrome Options

Client_confirmed, pkg_flag, installed-flag and standard_flag will always be true/false answers.

{
    "chrome_options":

    "lang": "EN",
    "client_confirmed": false,
    "header_name": "BODY CODE",
    "description": "FLEETSIDE BODY",
    "pkg_includes": "",
    "pkg_flag": false,
    "installed_flag": false,
    "standard_flag": true
}

+-------------------------------+------------------------------------------------+-------------------------------------+ | Header Name | Description | Package Includes | +-------------------------------+------------------------------------------------+-------------------------------------+ | BODY CODE | FLEETSIDE BODY | | +-------------------------------+------------------------------------------------+-------------------------------------+ | MODEL OPTION | WORK TRUCK PKG | | +-------------------------------+------------------------------------------------+-------------------------------------+ | GVWR | 6100# GVWR | | +-------------------------------+------------------------------------------------+-------------------------------------+ | EMISSIONS | FEDERAL EMISSIONS | | + +------------------------------------------------+-------------------------------------+ | | NEW YORK/MASSACHUSETTS EMISSIONS | | + +------------------------------------------------+-------------------------------------+ | | CALIFORNIA EMISSIONS | | + +------------------------------------------------+-------------------------------------+ | | FEDERAL EMISSION OVERRIDE | | +-------------------------------+------------------------------------------------+-------------------------------------+ | ENGINE | 4.3L (262) SFI V6 (VORTEC) ENGINE | | +-------------------------------+------------------------------------------------+-------------------------------------+ | TRANSMISSION | 5-SPEED MANUAL TRANSMISSION W/OD | | +-------------------------------+------------------------------------------------+-------------------------------------+ | DIFFERENTIAL | LOCKING DIFFERENTIAL NOT DESIRED | | + +------------------------------------------------+-------------------------------------+ | | LOCKING DIFFERENTIAL | | +-------------------------------+------------------------------------------------+-------------------------------------+ | AXLE | 3.08 AXLE RATIO | | + +------------------------------------------------+-------------------------------------+ | | 3.42 AXLE RATIO | | +-------------------------------+------------------------------------------------+-------------------------------------+ | DECOR | WORK TRUCK DECOR | -inc: base vehicle only | +-------------------------------+------------------------------------------------+-------------------------------------+ | PREFERRED EQUIPMENT GROUP | PREFERRED EQUIPMENT GROUP 1 | -inc: work truck decor | + +------------------------------------------------+-------------------------------------+ | | 1SW PREFERRED EQUIPMENT GROUP SAVINGS | | +-------------------------------+------------------------------------------------+-------------------------------------+ | FRONT TIRES | P235/75R15 SBR BSW ALL-SEASON FRONT TIRES | | +-------------------------------+------------------------------------------------+-------------------------------------+ | REAR TIRES | P235/75R15 SBR BSW ALL-SEASON REAR TIRES | | +-------------------------------+------------------------------------------------+-------------------------------------+ | SPARE TIRE | P235/75R15 SBR BSW ALL-SEASON SPARE TIRE | | +-------------------------------+------------------------------------------------+-------------------------------------+ | SEAT TYPE | FRONT BENCH SEAT | | +-------------------------------+------------------------------------------------+-------------------------------------+ | SEAT TRIM | VINYL SEAT TRIM | | +-------------------------------+------------------------------------------------+-------------------------------------+ | PAINT | SOLID PAINT | | +-------------------------------+------------------------------------------------+-------------------------------------+ | AIR CONDITIONING | AIR CONDITIONING NOT DESIRED | | +-------------------------------+------------------------------------------------+-------------------------------------+ | ADDITIONAL OPTIONS | MULTIPLE ORDER ACKNOWLEDGEMENT | | + +------------------------------------------------+-------------------------------------+ | | UNDER-RAIL BEDLINER | | + +------------------------------------------------+-------------------------------------+ | | ENGINE HOUR METER | | +-------------------------------+------------------------------------------------+-------------------------------------+

Inspection Points

{
    "inspection_points":

    "blank_photo_flag": false,
    "language": "EN",
    "question_text": "Do you want to use the default value for Listing Type?",
    "last_mod_date": "Sep 29, 2017 6:22:05 PM",
    "stage_text": "Listing Information",
    "photo_point_flag": false,
    "damage_flag": false,
    "stage_order": 1,
    "secondary_question_type_id": 0,
    "option_flag": false,
    "stock_photo_flag": false,
    "answer_parent": "",
    "photo_available_flag": false,
    "question_order": 1,
    "answer": "NO",
    "video_point_flag": false,
    "parent_question_id": 0,
    "question_type_id": 2765,
    "question_text_short": "Change Default Listing Type",
    "question_id": 5802

    "original_photo_url": "http://static.cdemo.com/65325943/1506709202849.jpg",
    "stage_text": "Vehicle Information",
    "photo_point_flag": true,
    "stage_order": 2,
    "answer_parent": "",
    "photo_available_flag": true,
    "damage_flag": false,
    "photo_processed": 1,
    "question_type_id": 1,
    "blank_photo_flag": false,
    "seo_photo_name": "automobiles-used-1997-chevrolet-ck-1500-work-1364383-primary-listing-photo-Image.jpg",
    "question_text": "PRIMARY PHOTO. Turn your Device horizontal to the left and take photo.",
    "video_point_flag": false,
    "question_order": 5,
    "answer": "",
    "secondary_question_type_id": 0,
    "option_flag": false,
    "stock_photo_flag": false,
    "parent_question_id": 0,
    "question_text_short": "Primary Listing Photo",
    "photo_url": "http://static.cdemo.com/65325943/1024/automobiles-used-1997-chevrolet-ck-1500-work-1364383-primary-listing-photo-Image.jpg",
    "last_mod_date": "Sep 29, 2017 6:23:12 PM",
    "language": "EN",
    "photo_uploaded": 1,
    "question_id": 1
}

To Extract Photos

Key Value
question_text_short Primary Listing Photo
original_photo_url http://static.cdemo.com/65325943/1506709202849.jpg
photo_url http://static.cdemo.com/65325943/1024/automobiles-used-1997-chevrolet-ck-1500-work-1364383-primary-listing-photo-Image.jpg
seo_photo_name automobiles-used-1997-chevrolet-ck-1500-work-1364383-primary-listing-photo-Image.jpg

To Extract Vehicle Info

Key Value
question_text_short Odometer Type
answer Miles

Sample Return for Records.

Querying the paginated records API will return a large json response.

{
  "status": 200,
  "timestamp": "2017-10-27T12:10:26.524",
  "message": "Successful",
    "content": [
      {
        "links": {
          "next": "https://uat.cdemo.com/api/api/latest/inventories?access_token=xxxxxx&page=2",
          "prev": null,
          "total_results": 1343
        },
        "paginated_results": [
            {
                "inspection_id": "20150902cwtuvoeq",
                "cdemo_record": {},
                "record_attributes": [],
                "inspection_points": [],
                "chrome_options": [],
                "chrome_equipments": [],
                "chrome_consumer_infos": []
            },
            ...
        ]
      }
  ]
}

These objects return the same formats response as Record Details API.

  • Record Attributes
  • Chrome Equipments
  • Chrome Options
  • Inspection Points
  • Chrome Consumer Info
  • cDemo Record