| POST | /v1/AllAvailableVehiclesCsv/{vehicleType}/{includeBackOrderAccounts} | Get all available vehicles |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseAllAvailableVehiclesRequest:
vehicle_type: Optional[str] = None
include_back_order_accounts: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CsvVehicle:
vehicle_type: Optional[str] = None
vid: Optional[str] = None
vin: Optional[str] = None
fin: Optional[str] = None
commission_number: Optional[str] = None
chassis_number: Optional[str] = None
model_year: Optional[str] = None
model_year_code: Optional[str] = None
half_model_year_code: Optional[str] = None
full_model_year_code: Optional[str] = None
sales_description_long: Optional[str] = None
vehicle_class: Optional[str] = None
body_style: Optional[str] = None
model: Optional[str] = None
colour: Optional[str] = None
colour_group: Optional[str] = None
fuel_type: Optional[str] = None
transmission: Optional[str] = None
packages: Optional[str] = None
lines: Optional[str] = None
product_range: Optional[str] = None
engine: Optional[str] = None
is_a_m_g: bool = False
upholstery: Optional[str] = None
nst: Optional[str] = None
baumuster: Optional[str] = None
bm7_n_s_t: Optional[str] = None
acceleration: Optional[Decimal] = None
boot_capacity: Optional[int] = None
top_speed: Optional[Decimal] = None
drive_concept: Optional[str] = None
combustion_power_hp: Optional[Decimal] = None
electric_power_kw: Optional[Decimal] = None
electric_power_hp: Optional[Decimal] = None
combined_power_kw: Optional[Decimal] = None
combined_power_h_p: Optional[Decimal] = None
electric_range: Optional[Decimal] = None
electric_consumption: Optional[Decimal] = None
emission_combined: Optional[str] = None
emission_directive: Optional[str] = None
emission_extra_urban: Optional[str] = None
emission_urban: Optional[str] = None
emission: Optional[Decimal] = None
test_standard: Optional[str] = None
energy_efficiency_class: Optional[str] = None
wltp_combined: Optional[str] = None
wltp_low: Optional[str] = None
wltp_medium: Optional[str] = None
wltp_high: Optional[str] = None
wltp_extra_high: Optional[str] = None
wltp_emission_combined: Optional[str] = None
production_date: Optional[datetime.datetime] = None
port_arrival_date: Optional[datetime.datetime] = None
creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
last_updated: Optional[datetime.datetime] = None
retail_price__ex_v_a_t: Decimal = decimal.Decimal(0)
retail_price__inc_v_a_t: Decimal = decimal.Decimal(0)
otr: Decimal = decimal.Decimal(0)
actual_price: Decimal = decimal.Decimal(0)
usage_code: Optional[str] = None
secured: Optional[str] = None
account: Optional[str] = None
is_display_stock: Optional[str] = None
display_stock_agent: Optional[str] = None
is_specialist_car: Optional[str] = None
cesar_id_ship_to_party: Optional[str] = None
is_sellable: Optional[str] = None
under_offer: Optional[str] = None
secured_date: Optional[str] = None
secured_reason: Optional[str] = None
secured_by_gas_id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InternalAvailableStockResponse:
total_vehicles: int = 0
vehicles: Optional[List[CsvVehicle]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignExclusion:
vin: List[str] = field(default_factory=list)
commission_number: List[str] = field(default_factory=list)
model_year_code: Optional[str] = None
equipment_code: Optional[str] = None
gssn: List[str] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationDate:
from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
to: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Age:
date: datetime.datetime = datetime.datetime(1, 1, 1)
min: int = 0
max: int = 0
include_pipeline_stock: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortArrivalDate:
pipeline_stock: bool = False
from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
to: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleSearchV3Criteria:
vin: List[str] = field(default_factory=list)
model: List[int] = field(default_factory=list)
fuel: List[int] = field(default_factory=list)
transmission: List[int] = field(default_factory=list)
engine: List[int] = field(default_factory=list)
line: List[str] = field(default_factory=list)
mapped_line: List[int] = field(default_factory=list)
commission_number: List[str] = field(default_factory=list)
vehicle_type: Optional[str] = None
exclusion: Optional[CampaignExclusion] = None
reg_no: Optional[str] = None
include_offline: bool = False
registration_date: Optional[RegistrationDate] = None
age: Optional[Age] = None
port_arrival_date: Optional[PortArrivalDate] = None
is_available_online: Optional[bool] = None
is_back_ordered: Optional[bool] = None
is_sellable: Optional[bool] = None
is_under_offer: Optional[bool] = None
mbuk_secured: Optional[bool] = None
account: List[str] = field(default_factory=list)
baumuster: List[str] = field(default_factory=list)
colours: List[int] = field(default_factory=list)
upholstery: List[int] = field(default_factory=list)
package: List[int] = field(default_factory=list)
nst: List[str] = field(default_factory=list)
usage_code: List[str] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AllAvailableVehiclesByCriteriaCsvRequest(BaseAllAvailableVehiclesRequest, IPost):
criteria: Optional[VehicleSearchV3Criteria] = None
Python AllAvailableVehiclesByCriteriaCsvRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/AllAvailableVehiclesCsv/{vehicleType}/{includeBackOrderAccounts} HTTP/1.1
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
criteria:
{
vin:
[
String
],
model:
[
0
],
fuel:
[
0
],
transmission:
[
0
],
engine:
[
0
],
line:
[
String
],
mappedLine:
[
0
],
commissionNumber:
[
String
],
vehicleType: String,
exclusion:
{
vin:
[
String
],
commissionNumber:
[
String
],
modelYearCode: String,
equipmentCode: String,
gssn:
[
String
]
},
regNo: String,
includeOffline: False,
registrationDate:
{
from: 0001-01-01,
to: 0001-01-01
},
age:
{
date: 0001-01-01,
min: 0,
max: 0,
includePipelineStock: False
},
portArrivalDate:
{
pipelineStock: False,
from: 0001-01-01,
to: 0001-01-01
},
isAvailableOnline: False,
isBackOrdered: False,
isSellable: False,
isUnderOffer: False,
mbukSecured: False,
account:
[
String
],
baumuster:
[
String
],
colours:
[
0
],
upholstery:
[
0
],
package:
[
0
],
nst:
[
String
],
usageCode:
[
String
]
},
vehicleType: String,
includeBackOrderAccounts: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
totalVehicles: 0
}