116 lines
6.5 KiB
XML
116 lines
6.5 KiB
XML
<?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>
|
|
<member name="T:PartSource.Api.Controllers.WebhooksController">
|
|
<remarks>
|
|
This endpoint handles Shopify webhooks
|
|
</remarks>
|
|
</member>
|
|
</members>
|
|
</doc>
|