Mercedes.Agency.Orchestration.API

FiltersRequest

Filters

The following routes are available for this service:
GET	/v1/filters/{vehicletype}	Get filters by vehicle type	Get filters by vehicle type

**FiltersRequest** Parameters:
Name	Parameter	Data Type	Required	Description
vehicleType	path	string	Yes

**FiltersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Filters	form	Filters	Yes

**Filters** Parameters:
Name	Parameter	Data Type	Required
Fuels	form	List<Fuel>	Yes
Lines	form	List<Line>	Yes
Engines	form	List<Engine>	Yes
Transmissions	form	List<Transmission>	Yes
Colours	form	List<Colour>	Yes
Upholsteries	form	List<Upholstery>	Yes
Packages	form	List<Package>	Yes
Brands	form	List<Brand>	Yes
Equipment	form	List<string>	Yes
Retailers	form	List<Retailer>	Yes
AccountRetailers	form	List<AccountRetailer>	Yes
RetailerGroups	form	List<RetailerGroup>	Yes
MarketAreas	form	List<MarketArea>	Yes
CustomerLocations	form	List<LookupValue>	Yes
AssistanceProviders	form	List<LookupValue>	Yes
NonOptimalReasons	form	List<NonOptimalReason>	Yes

**Filters** Parameters:
Name	Parameter	Data Type	Required
Brands	form	List<Brand>	Yes
Fuels	form	List<Fuel>	Yes
Lines	form	List<Line>	Yes
Engines	form	List<Engine>	Yes
BodyStyles	form	List<BodyStyle>	Yes
Models	form	List<Model>	Yes
Transmissions	form	List<Transmission>	Yes
ModelHierarchy	form	List<Brand>	Yes
Retailers	form	List<Retailer>	Yes
AllLines	form	List<Line>	Yes
Colours	form	List<Colour>	Yes
Upholsteries	form	List<Upholstery>	Yes
Packages	form	List<Package>	Yes
DeliveryTime	form	List<DeliveryTime>	No
RetailerGroups	form	List<RetailerGroup>	Yes
MarketAreas	form	List<MarketArea>	Yes
NonOptimalReasons	form	List<NonOptimalReason>	Yes

**Brand** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	No
DisplayName	form	string	No
BodyStyles	form	List<BodyStyle>	No

**BodyStyle** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	No
Models	form	List<Model>	No

**Model** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	No
DisplayName	form	string	No
ImageUrlSmall	form	string	No
ImageUrlMedium	form	string	No
ImageUrlLarge	form	string	No
Specialist	form	bool	No
Priority	form	int?	No
ExcludeFromOnlineShowroomFilters	form	bool?	No

**Fuel** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Description	form	string	No

**Line** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Description	form	string	No

**Engine** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	No
BrandId	form	int?	No
Brand	form	string	No
Badge	form	string	No

**Transmission** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Description	form	string	No

**Retailer** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
GssnId	form	string	Yes
Description	form	string	Yes
Street	form	string	Yes
City	form	string	Yes
Postcode	form	string	Yes
GoogleMapPostcode	form	string	Yes
Phone	form	string	Yes
Fax	form	string	Yes
Email	form	string	Yes
Website	form	string	Yes
RetailerGroupId	form	string	Yes
RetailerGroupName	form	string	Yes
IsOnline	form	bool	No
IsNewCarRetailer	form	bool	No
IsUsedCarRetailer	form	bool	No
IsCentralRetailer	form	bool	No
ChatEnabled	form	bool	No
TradeInEnabled	form	bool	No
smart	form	bool	No
DisplayPhoneNumberNew	form	string	Yes
DisplayPhoneNumberUsed	form	string	Yes
Latitude	form	decimal	No
Longitude	form	decimal	No
smartDescription	form	string	Yes
smartWebsite	form	string	Yes
smartPhone	form	string	Yes
LegacyId	form	string	Yes
Agent	form	bool	No
MarketAreaId	form	int	No
DigitalLoungeParentGssnId	form	string	No
SendLeadsToDigitalLoungeParent	form	bool	No
OpeningTimes	form	RetailerOpeningTimes	No

**RetailerOpeningTimes** Parameters:
Name	Parameter	Data Type	Required	Description
New	form	List<RetailerOpeningTime>	Yes
Used	form	List<RetailerOpeningTime>	Yes

**RetailerOpeningTime** Parameters:
Name	Parameter	Data Type	Required
Day	form	string	Yes
OpenFrom	form	string	Yes
OpenTo	form	string	Yes
Special	form	string	Yes

**Colour** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Description	form	string	No

**Upholstery** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Description	form	string	No

**Package** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Description	form	string	No

**DeliveryTime** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Description	form	string	No

**RetailerGroup** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
RetailerGroupId	form	string	No
Description	form	string	Yes
RetailerGroupName	form	string	No
GssnIds	form	List<string>	No

**MarketArea** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
MarketAreaName	form	string	No
Description	form	string	Yes
GssnIds	form	List<string>	No

**NonOptimalReason** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Description	form	string	No

**AccountRetailer** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Gssn	form	string	No
IsSmart	form	bool	No

**LookupValue** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int?	No
Label	form	string	Yes

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

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
			}
		]
	}
}