soundpress/Partsource
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

.

Browse Source
This commit is contained in:
Tom Raterman
2020-09-02 20:53:34 -04:00
parent 85d99d2615
commit d06925204d
38 changed files with 913 additions and 679 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
PartSource.Api/PartSource.Api.xml Normal file
View File

@@ -0,0 +1,110 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>PartSource.Api</name>
</assembly>
<members>
<member name="T:PartSource.Api.Controllers.LegacyVehiclesController">
<summary>
This controller exists to enable legacy support for the old Nexpart-based vehicle lookup.
</summary>
</member>
<member name="T:PartSource.Api.Controllers.VehiclesController">
<remarks>
This endpoint gets vehicle data from WHI's SEO data.
</remarks>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetVehicles(PartSource.Data.Dtos.VehicleDto)">
<summary>
Get Vehicles
</summary>
<response code="200"><strong>OK:</strong> An array of vehicles matching the query.</response>
<response code="204"><strong>No Content:</strong> The query executed successfully, but no vehicles were found.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetVehicleById(System.Int32)">
<summary>
Get Vehicle by ID
</summary>
<param name="id">A WHI VehicleToEngineConfigId</param>
<response code="200"><strong>OK:</strong> The vehicle with the provided VehicleToEngineConfigId.</response>
<response code="404"><strong>Not Found:</strong> No vehicle was found matching the provided VehicleToEngineConfigId.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetMakes(PartSource.Data.Dtos.VehicleDto)">
<summary>
Get Makes
</summary>
<response code="200"><strong>OK:</strong> An array of makes matching the query.</response>
<response code="204"><strong>No Content:</strong> The query executed successfully, but no makes were found.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetMakeById(System.Int32)">
<summary>
Get Make by ID
</summary>
<param name="id">A WHI MakeId</param>
<response code="200"><strong>OK:</strong> The make with the provided MakeId.</response>
<response code="404"><strong>Not Found:</strong> No make was found matching the provided MakeId.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetModels(PartSource.Data.Dtos.VehicleDto)">
<summary>
Get Models
</summary>
<response code="200"><strong>OK:</strong> An array of models matching the query.</response>
<response code="204"><strong>No Content:</strong> The query executed successfully, but no models were found.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetModelById(System.Int32)">
<summary>
Get Model by ID
</summary>
<param name="id">A WHI ModelId</param>
<response code="200"><strong>OK:</strong> The model with the provided ModelId.</response>
<response code="404"><strong>Not Found:</strong> No model was found matching the provided ModelId.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetSubmodels(PartSource.Data.Dtos.VehicleDto)">
<summary>
Get Submodels
</summary>
/// <remarks><em>Note: Submodels can be shared between models. Do not assume a submodel is unique to a given model.</em></remarks>
<response code="200"><strong>OK:</strong> An array of submodels matching the query.</response>
<response code="204"><strong>No Content:</strong> The query executed successfully, but no submodels were found.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetSubmodels(System.Int32)">
<summary>
Get Submodel by ID
</summary>
<remarks><em>Note: Submodels can be shared between models. Do not assume a submodel is unique to a given model.</em></remarks>
<param name="id">A WHI SubmodelId</param>
<response code="200"><strong>OK:</strong> The submodel with the provided SubmodelId.</response>
<response code="404"><strong>Not Found:</strong> No submodel was found matching the provided SubmodelId.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetBaseVehicles(PartSource.Data.Dtos.VehicleDto)">
<summary>
Get Base Vehicles
</summary>
<response code="200"><strong>OK:</strong> An array of base vehicles matching the query.</response>
<response code="204"><strong>No Content:</strong> The query executed successfully, but no base vehicles were found.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetBaseVehicleById(System.Int32)">
<summary>
Get Base Vehicle by ID
</summary>
<param name="id">A WHI BaseVehicleId</param>
<response code="200"><strong>OK:</strong> The base vehicle with the provided BaseVehicleId.</response>
<response code="404"><strong>Not Found:</strong> No base vehicle was found matching the provided BaseVehicleId.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetEngines(PartSource.Data.Dtos.VehicleDto)">
<summary>
Get Engines
</summary>
<response code="200"><strong>OK:</strong> An array of engines matching the query.</response>
<response code="204"><strong>No Content:</strong> The query executed successfully, but no engines were found.</response>
</member>
<member name="M:PartSource.Api.Controllers.VehiclesController.GetEngineById(System.Int32)">
<summary>
Get Engine by ID
</summary>
<param name="id">A WHI EngineConfigId</param>
<response code="200"><strong>OK:</strong> The engine with the provided EngineConfigId.</response>
<response code="404"><strong>Not Found:</strong> No engine was found matching the provided EngineConfigId.</response>
</member>
</members>
</doc>