Mercedes.Agency.Orchestration.API

<back to all web services

FiltersRequest

Filters
Requires Authentication
The following routes are available for this service:
GET/v1/filters/{vehicletype}Get filters by vehicle type
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 Model:
    id: int = 0
    description: Optional[str] = None
    display_name: Optional[str] = None
    image_url_small: Optional[str] = None
    image_url_medium: Optional[str] = None
    image_url_large: Optional[str] = None
    specialist: bool = False
    priority: int = 0
    exclude_from_online_showroom_filters: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BodyStyle:
    id: int = 0
    description: Optional[str] = None
    models: Optional[List[Model]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Brand:
    id: int = 0
    description: Optional[str] = None
    display_name: Optional[str] = None
    body_styles: Optional[List[BodyStyle]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Fuel:
    id: int = 0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Line:
    id: int = 0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Engine:
    id: int = 0
    description: Optional[str] = None
    brand_id: Optional[int] = None
    brand: Optional[str] = None
    badge: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Transmission:
    id: int = 0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetailerOpeningTime:
    day: Optional[str] = None
    open_from: Optional[str] = None
    open_to: Optional[str] = None
    special: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetailerOpeningTimes:
    new: List[RetailerOpeningTime] = field(default_factory=list)
    used: List[RetailerOpeningTime] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Retailer:
    id: int = 0
    gssn_id: Optional[str] = None
    description: Optional[str] = None
    street: Optional[str] = None
    city: Optional[str] = None
    postcode: Optional[str] = None
    google_map_postcode: Optional[str] = None
    phone: Optional[str] = None
    fax: Optional[str] = None
    email: Optional[str] = None
    website: Optional[str] = None
    retailer_group_id: Optional[str] = None
    retailer_group_name: Optional[str] = None
    is_online: bool = False
    is_new_car_retailer: bool = False
    is_used_car_retailer: bool = False
    is_central_retailer: bool = False
    chat_enabled: bool = False
    trade_in_enabled: bool = False
    smart: bool = False
    display_phone_number_new: Optional[str] = None
    display_phone_number_used: Optional[str] = None
    latitude: Decimal = decimal.Decimal(0)
    longitude: Decimal = decimal.Decimal(0)
    smart_description: Optional[str] = None
    smart_website: Optional[str] = None
    smart_phone: Optional[str] = None
    legacy_id: Optional[str] = None
    agent: bool = False
    market_area_id: int = 0
    digital_lounge_parent_gssn_id: Optional[str] = None
    send_leads_to_digital_lounge_parent: bool = False
    opening_times: Optional[RetailerOpeningTimes] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Colour:
    id: int = 0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Upholstery:
    id: int = 0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Package:
    id: int = 0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeliveryTime:
    id: int = 0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetailerGroup:
    id: int = 0
    retailer_group_id: Optional[str] = None
    description: Optional[str] = None
    retailer_group_name: Optional[str] = None
    gssn_ids: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MarketArea:
    id: int = 0
    market_area_name: Optional[str] = None
    description: Optional[str] = None
    gssn_ids: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NonOptimalReason:
    id: int = 0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccountRetailer:
    name: Optional[str] = None
    gssn: Optional[str] = None
    is_smart: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LookupValue:
    id: Optional[int] = None
    label: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Filters(Filters):
    fuels: List[Fuel] = field(default_factory=list)
    lines: List[Line] = field(default_factory=list)
    engines: List[Engine] = field(default_factory=list)
    transmissions: List[Transmission] = field(default_factory=list)
    colours: List[Colour] = field(default_factory=list)
    upholsteries: List[Upholstery] = field(default_factory=list)
    packages: List[Package] = field(default_factory=list)
    brands: List[Brand] = field(default_factory=list)
    equipment: List[str] = field(default_factory=list)
    retailers: List[Retailer] = field(default_factory=list)
    account_retailers: List[AccountRetailer] = field(default_factory=list)
    retailer_groups: List[RetailerGroup] = field(default_factory=list)
    market_areas: List[MarketArea] = field(default_factory=list)
    customer_locations: List[LookupValue] = field(default_factory=list)
    assistance_providers: List[LookupValue] = field(default_factory=list)
    non_optimal_reasons: List[NonOptimalReason] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FiltersResponse:
    filters: Optional[Filters] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FiltersRequest(IGet):
    vehicle_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Filters:
    brands: List[Brand] = field(default_factory=list)
    fuels: List[Fuel] = field(default_factory=list)
    lines: List[Line] = field(default_factory=list)
    engines: List[Engine] = field(default_factory=list)
    body_styles: List[BodyStyle] = field(default_factory=list)
    models: List[Model] = field(default_factory=list)
    transmissions: List[Transmission] = field(default_factory=list)
    model_hierarchy: List[Brand] = field(default_factory=list)
    retailers: List[Retailer] = field(default_factory=list)
    all_lines: List[Line] = field(default_factory=list)
    colours: List[Colour] = field(default_factory=list)
    upholsteries: List[Upholstery] = field(default_factory=list)
    packages: List[Package] = field(default_factory=list)
    delivery_time: Optional[List[DeliveryTime]] = None
    retailer_groups: List[RetailerGroup] = field(default_factory=list)
    market_areas: List[MarketArea] = field(default_factory=list)
    non_optimal_reasons: List[NonOptimalReason] = field(default_factory=list)

Python FiltersRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/filters/{vehicletype} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Filters":{"Fuels":[{"Id":0,"Description":"String"}],"Lines":[{"Id":0,"Description":"String"}],"Engines":[{"Id":0,"Description":"String","BrandId":0,"Brand":"String","Badge":"String"}],"Transmissions":[{"Id":0,"Description":"String"}],"Colours":[{"Id":0,"Description":"String"}],"Upholsteries":[{"Id":0,"Description":"String"}],"Packages":[{"Id":0,"Description":"String"}],"Brands":[{"Id":0,"Description":"String","DisplayName":"String","BodyStyles":[{"Id":0,"Description":"String","Models":[{"Id":0,"Description":"String","DisplayName":"String","ImageUrlSmall":"String","ImageUrlMedium":"String","ImageUrlLarge":"String","Specialist":false,"Priority":0,"ExcludeFromOnlineShowroomFilters":false}]}]}],"Equipment":["String"],"Retailers":[{"Gssn":"String","Description":"String","CampaignExcluded":false}],"Retailers":[{"Name":"String","Gssn":"String","IsSmart":false}],"RetailerGroups":[{"Id":0,"RetailerGroupId":"String","Description":"String","RetailerGroupName":"String","GssnIds":["String"]}],"MarketAreas":[{"Id":0,"MarketAreaName":"String","Description":"String","GssnIds":["String"]}],"CustomerLocations":[{}],"AssistanceProviders":[{}],"NonOptimalReasons":[{"Id":0,"Description":"String"}],"BodyStyles":[{"Id":0,"Description":"String","Models":[{"Id":0,"Description":"String","DisplayName":"String","ImageUrlSmall":"String","ImageUrlMedium":"String","ImageUrlLarge":"String","Specialist":false,"Priority":0,"ExcludeFromOnlineShowroomFilters":false}]}],"Models":[{"Id":0,"Description":"String","DisplayName":"String","ImageUrlSmall":"String","ImageUrlMedium":"String","ImageUrlLarge":"String","Specialist":false,"Priority":0,"ExcludeFromOnlineShowroomFilters":false}],"ModelHierarchy":[{"Id":0,"Description":"String","DisplayName":"String","BodyStyles":[{"Id":0,"Description":"String","Models":[{"Id":0,"Description":"String","DisplayName":"String","ImageUrlSmall":"String","ImageUrlMedium":"String","ImageUrlLarge":"String","Specialist":false,"Priority":0,"ExcludeFromOnlineShowroomFilters":false}]}]}],"AllLines":[{"Id":0,"Description":"String"}],"DeliveryTime":[{"Id":0,"Description":"String"}]}}