PoisAlongRouteRequestBody Class Reference

Properties
ExtendedRoute	PoiRoute [get, set]
	Gets or sets the route to search for POIs. More...
int	RouteLegIndex [get, set]
	Gets or sets the route leg index to search. More...
POISearchType	SearchType [get, set]
	Gets or sets the type of search to perform. More...
List< POIGenericType >	GenericPOICategories [get, set]
	Gets or sets the list poi categories for a generic POI search. More...
List< POIHosType >	HoSPOICategories [get, set]
	Gets or sets the list HoS categories for a HoS POI search. More...
PoiSearchWindowUnits	SearchWindowUnits [get, set]
	Gets or sets the search window units. More...
double	SearchWindowStart [get, set]
	Gets or sets the miles/minutes (based on SearchWindowUnits) on the route leg at which to begin the search at. More...
double	SearchWindowEnd [get, set]
	Gets or sets the miles/minutes (based on SearchWindowUnits) on the route leg at which to end the search at. More...
double	AirDistanceThreshold [get, set]
	Gets or sets the maximum air distance between the POI and the nearest intersection on the route. Default and maximum is 2.5 miles. More...

Detailed Description

Represents the request body of a PoisAlongRouteRequest allowing to user to control various settings relevant to finding POIs a given route leg.

Property Documentation

PoiRoute

ExtendedRoute PoiRoute

getset

Gets or sets the route to search for POIs.

RouteLegIndex

int RouteLegIndex

getset

Gets or sets the route leg index to search.

SearchType

POISearchType SearchType

getset

Gets or sets the type of search to perform.

GenericPOICategories

List<POIGenericType> GenericPOICategories

getset

Gets or sets the list poi categories for a generic POI search.

HoSPOICategories

List<POIHosType> HoSPOICategories

getset

Gets or sets the list HoS categories for a HoS POI search.

SearchWindowUnits

PoiSearchWindowUnits SearchWindowUnits

getset

Gets or sets the search window units.

SearchWindowStart

double SearchWindowStart

getset

Gets or sets the miles/minutes (based on SearchWindowUnits) on the route leg at which to begin the search at.

Note: For longer routes when the SearchType is POISearchType.Generic, the search window will automatically be trimmed to be the maximum allowed length which is currently 100 miles or minutes.

Set to 0 or null to search at the beginning of the leg

SearchWindowEnd

double SearchWindowEnd

getset

Gets or sets the miles/minutes (based on SearchWindowUnits) on the route leg at which to end the search at.

Note: For longer routes when the SearchType is POISearchType.Generic, the search window will automatically be trimmed to be the maximum allowed length which is currently 100 miles or minutes.

Set to null to automatically select the end of the leg or the maximum allowed length, whichever is smaller.

AirDistanceThreshold

double AirDistanceThreshold

getset

Gets or sets the maximum air distance between the POI and the nearest intersection on the route. Default and maximum is 2.5 miles.