Skip to content

Commit

Permalink
Update V3 API
Browse files Browse the repository at this point in the history
  • Loading branch information
waterfox0323 committed Mar 27, 2018
1 parent f952827 commit 3064448
Show file tree
Hide file tree
Showing 6 changed files with 428 additions and 423 deletions.
115 changes: 115 additions & 0 deletions source/chrome_consumer_info_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@

====================
Chrome Consumer Info
====================

Get chrome consumer info of a record.

.. warning::
Only for Automobile product.

.. sourcecode:: http

GET /records/:inspection_id/chrome_consumer_info HTTP/1.1

+------------+----------------------------------------------------------------------------------------+
| Production | https://api.cdemo.com/v3/records/:inspection_id/chrome_consumer_info?access_token=<xxx>|
+------------+----------------------------------------------------------------------------------------+

Parameters
==========

+-----------------------+---------------+---------------------------------------+
| Parameters | Is Mandatory | Notes |
+=======================+===============+=======================================+
| access_token | Yes | API Token |
+-----------------------+---------------+---------------------------------------+
| exclude_fields | No | fields do not want to return. |
| | | separate by ','. |
| | | like store,category |
+-----------------------+---------------+---------------------------------------+
| fields | No | fields want to return. |
| | | separate by ','. |
| | | like store,category |
+-----------------------+---------------+---------------------------------------+

Response
========

.. code-block:: python
[
{
"info_name": "Basic Years",
"info_value": "3",
"info_type": "Warranty"
},
{
"info_name": "Basic Miles/km",
"info_value": "60,000",
"info_type": "Warranty"
},
{
"info_name": "Drivetrain Years",
"info_value": "5",
"info_type": "Warranty"
},
{
"info_name": "Drivetrain Miles/km",
"info_value": "100,000",
"info_type": "Warranty"
},
{
"info_name": "Corrosion Years",
"info_value": "5",
"info_type": "Warranty"
},
{
"info_name": "Corrosion Miles/km",
"info_value": "Unlimited",
"info_type": "Warranty"
},
{
"info_name": "Roadside Assistance Years",
"info_value": "5",
"info_type": "Warranty"
},
{
"info_name": "Roadside Assistance Miles/km",
"info_value": "100,000",
"info_type": "Warranty"
},
{
"info_name": "NHTSA CAMPAIGN ID",
"info_value": "14V525000",
"info_type": "Recall"
},
{
"info_name": "Mfg's Report Date",
"info_value": "SEP 01, 2014",
"info_type": "Recall"
},
{
"info_name": "Component",
"info_value": "FUEL SYSTEM, GASOLINE:DELIVERY",
"info_type": "Recall"
},
{
"info_name": "Potential Number of Units Affected",
"info_value": "301",
"info_type": "Recall"
},
{
"info_name": "Summary",
"info_value": "Ford Motor Company (Ford) is recalling certain model year 2014 Ford Focus vehicles manufactured May 1, 2014, to May 24, 2014, 2014 Ford Escape vehicles manufactured on June 6, 2014, and 2015 Lincoln MKC vehicles manufactured June 4, 2014, to July 7, 2014. In the affected vehicles, the Fuel Delivery Module (FDM) may crack between the filter body and the filter cap, possibly resulting in low fuel pressure.",
"info_type": "Recall"
}
]
.. note::
- 1001: Automobile
- 1009: Motorcycle
- 1060: ATV/UTV
- 1064: Snowmobile
- 1061: Campers/RV

102 changes: 102 additions & 0 deletions source/chrome_equipments_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@

=================
Chrome Equipments
=================

Get chrome equipments of a record.

.. warning::
Only for Automobile product.

.. sourcecode:: http

GET /records/:inspection_id/chrome_equipments HTTP/1.1

+------------+-------------------------------------------------------------------------------------+
| Production | https://api.cdemo.com/v3/records/:inspection_id/chrome_equipments?access_token=<xxx>|
+------------+-------------------------------------------------------------------------------------+

Parameters
==========

+-----------------------+---------------+---------------------------------------+
| Parameters | Is Mandatory | Notes |
+=======================+===============+=======================================+
| access_token | Yes | API Token |
+-----------------------+---------------+---------------------------------------+
| exclude_fields | No | fields do not want to return. |
| | | separate by ','. |
| | | like store,category |
+-----------------------+---------------+---------------------------------------+
| fields | No | fields want to return. |
| | | separate by ','. |
| | | like store,category |
+-----------------------+---------------+---------------------------------------+

Response
========

.. code-block:: python
[
{
"standard_header_name": "MECHANICAL",
"description": "Engine: 2.0L I-4 GDI Ti-VCT Flex Fuel"
},
{
"standard_header_name": "MECHANICAL",
"description": "Transmission: 5-Speed Manual"
},
{
"standard_header_name": "MECHANICAL",
"description": "Front-Wheel Drive"
},
{
"standard_header_name": "MECHANICAL",
"description": "3.82 Axle Ratio"
},
{
"standard_header_name": "MECHANICAL",
"description": "590CCA Maintenance-Free Battery w/Run Down Protection"
},
{
"standard_header_name": "MECHANICAL",
"description": "3990# Gvwr 827# Maximum Payload"
},
{
"standard_header_name": "MECHANICAL",
"description": "Gas-Pressurized Shock Absorbers"
},
{
"standard_header_name": "MECHANICAL",
"description": "Front And Rear Anti-Roll Bars"
},
{
"standard_header_name": "MECHANICAL",
"description": "Electric Power-Assist Steering"
},
{
"standard_header_name": "MECHANICAL",
"description": "46.9 L Fuel Tank"
},
{
"standard_header_name": "MECHANICAL",
"description": "Single Stainless Steel Exhaust"
},
{
"standard_header_name": "MECHANICAL",
"description": "Strut Front Suspension w/Coil Springs"
},
{
"standard_header_name": "MECHANICAL",
"description": "Short And Long Arm Rear Suspension w/Coil Springs"
}
]
.. note::
- 1001: Automobile
- 1009: Motorcycle
- 1060: ATV/UTV
- 1064: Snowmobile
- 1061: Campers/RV

57 changes: 57 additions & 0 deletions source/chrome_packages_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@

=================
Chrome Packages
=================

Get chrome packages of a record.

.. warning::
Only for Automobile product.

.. sourcecode:: http

GET /records/:inspection_id/chrome_packages HTTP/1.1

+------------+-----------------------------------------------------------------------------------+
| Production | https://api.cdemo.com/v3/records/:inspection_id/chrome_packages?access_token=<xxx>|
+------------+-----------------------------------------------------------------------------------+

Parameters
==========

+-----------------------+---------------+---------------------------------------+
| Parameters | Is Mandatory | Notes |
+=======================+===============+=======================================+
| access_token | Yes | API Token |
+-----------------------+---------------+---------------------------------------+
| exclude_fields | No | fields do not want to return. |
| | | separate by ','. |
| | | like store,category |
+-----------------------+---------------+---------------------------------------+
| fields | No | fields want to return. |
| | | separate by ','. |
| | | like store,category |
+-----------------------+---------------+---------------------------------------+

Response
========

.. code-block:: python
[
{
"category": "OPTION PACKAGE",
"description": "ACCESSORY GRP 1",
"msrp": 500.00,
"include_equipments": "-inc: Popular Equipment Pkg w/AM/FM ETR stereo radio w/CD player & (6) speakers, pwr windows/mirrors/door locks",
"other_info": ""
}
]
.. note::
- 1001: Automobile
- 1009: Motorcycle
- 1060: ATV/UTV
- 1064: Snowmobile
- 1061: Campers/RV

7 changes: 6 additions & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ cDemo Rest API V3
:glob:


record_api
records_api
record_detail_api
inspection_points_api
chrome_equipments_api
chrome_packages_api
chrome_consumer_info_api

.. Indices and tables
.. ==================
Expand Down

0 comments on commit 3064448

Please sign in to comment.