Get POIs Along Route

The getPoisAlongRoute operation allows the user to search for point of interest, including fuel stops, along a route. It’s required that at least one of the stops on the route must be within US borders.

Schema

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:v1="https://pcmiler.alk.com/APIs/v1.0" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <soapenv:Header>
    <alk:AuthHeader>
      <alk:Authorization>YOUR API KEY HERE</alk:Authorization>
      <alk:Date>Tue, 25 Aug 02015 22:57:03 GMT</alk:Date>
    </alk:AuthHeader>
  </soapenv:Header>
  <soapenv:Body>
    <v1:GetPoisAlongRoute>
      <!--Optional:-->
      <v1:Request>
        <!--Optional:-->
        <v1:Header>
          <!--Optional:-->
          <v1:DataVersion/>
          <!--Optional:-->
          <v1:RequestType/>
        </v1:Header>
        <!--Optional:-->
        <v1:Body>
          <!--Optional:-->
          <v1:PoiRoute>
            <!--Optional:-->
            <v1:RouteId>PrincetonToMiami</v1:RouteId>
            <!--Optional:-->
            <v1:Stops>
              <!--Zero or more repetitions:-->
              <v1:StopLocation>
                <!--Optional:-->
                <v1:Address>
                  <!--Optional:-->
                  <v1:StreetAddress/>
                  <!--Optional:-->
                  <v1:City/>
                  <!--Optional:-->
                  <v1:State/>
                  <!--Optional:-->
                  <v1:Zip>08540</v1:Zip>
                  <!--Optional:-->
                  <v1:County/>
                  <!--Optional:-->
                  <v1:Country/>
                  <!--Optional:-->
                  <v1:SPLC/>
                  <!--Optional:-->
                  <!--<v1:CountryPostalFilter></v1:CountryPostalFilter>-->
                  <!--Optional:-->
                  <!--<v1:AbbreviationFormat></v1:AbbreviationFormat>-->
                </v1:Address>
                <!--Optional:-->
                <!--<v1:Coords>-->
                <!--Optional:-->
                <!--<v1:Lat></v1:Lat>-->
                <!--Optional:-->
                <!--<v1:Lon></v1:Lon>-->
                <!--</v1:Coords>-->
                <!--Optional:-->
                <v1:Region>NA</v1:Region>
                <!--Optional:-->
                <v1:Label/>
                <!--Optional:-->
                <v1:PlaceName/>
                <!--Optional:-->
              </v1:StopLocation>
              <v1:StopLocation>
                <!--Optional:-->
                <v1:Address>
                  <!--Optional:-->
                  <v1:StreetAddress/>
                  <!--Optional:-->
                  <v1:City>Charleston</v1:City>
                  <!--Optional:-->
                  <v1:State>SC</v1:State>
                  <!--Optional:-->
                  <v1:Zip/>
                  <!--Optional:-->
                  <v1:County/>
                  <!--Optional:-->
                  <v1:Country/>
                  <!--Optional:-->
                  <v1:SPLC/>
                  <!--Optional:-->
                  <!--<v1:CountryPostalFilter></v1:CountryPostalFilter>-->
                  <!--Optional:-->
                  <!--<v1:AbbreviationFormat></v1:AbbreviationFormat>-->
                </v1:Address>
                <!--Optional:-->
                <!--<v1:Coords>-->
                <!--Optional:-->
                <!--<v1:Lat></v1:Lat>-->
                <!--Optional:-->
                <!--<v1:Lon></v1:Lon>-->
                <!--</v1:Coords>-->
                <!--Optional:-->
                <v1:Region>NA</v1:Region>
                <!--Optional:-->
                <v1:Label/>
                <!--Optional:-->
                <v1:PlaceName/>
                <!--Optional:-->
              </v1:StopLocation>
              <v1:StopLocation>
                <!--Optional:-->
                <v1:Address>
                  <!--Optional:-->
                  <v1:StreetAddress/>
                  <!--Optional:-->
                  <v1:City>Miami</v1:City>
                  <!--Optional:-->
                  <v1:State>FL</v1:State>
                  <!--Optional:-->
                  <v1:Zip/>
                  <!--Optional:-->
                  <v1:County/>
                  <!--Optional:-->
                  <v1:Country/>
                  <!--Optional:-->
                  <v1:SPLC/>
                  <!--Optional:-->
                  <!--<v1:CountryPostalFilter></v1:CountryPostalFilter>-->
                  <!--Optional:-->
                  <!--<v1:AbbreviationFormat></v1:AbbreviationFormat>-->
                </v1:Address>
                <!--Optional:-->
                <!--<v1:Coords>-->
                <!--Optional:-->
                <!--<v1:Lat></v1:Lat>-->
                <!--Optional:-->
                <!--<v1:Lon></v1:Lon>-->
                <!--</v1:Coords>-->
                <!--Optional:-->
                <v1:Region>NA</v1:Region>
                <!--Optional:-->
                <v1:Label/>
                <!--Optional:-->
                <v1:PlaceName/>
                <!--Optional:-->
              </v1:StopLocation>
            </v1:Stops>
            <!--Optional:-->
            <v1:Options>
              <!--Optional:-->
              <v1:HighwayOnly>false</v1:HighwayOnly>
              <!--Optional:-->
            </v1:Options>
          </v1:PoiRoute>
          <!--Optional:-->
          <v1:RouteLegIndex>0</v1:RouteLegIndex>
          <v1:SearchType>HoS</v1:SearchType>
          <!--Optional:-->
          <!--<v1:GenericPOICategories>-->
          <!--Zero or more repetitions:-->
          <!--<v1:POIGenericType>All</v1:POIGenericType>-->
          <!--<v1:POIGenericType>VehicleRepair</v1:POIGenericType>-->
          <!--</v1:GenericPOICategories>-->
          <!--Optional:-->
          <v1:HoSPOICategories>
            <!--Zero or more repetitions:-->
            <v1:POIHosType>All</v1:POIHosType>
          </v1:HoSPOICategories>
          <!--Optional:-->
          <v1:SearchWindowUnits>Minutes</v1:SearchWindowUnits>
          <!--Optional:-->
          <v1:SearchWindowStart>50</v1:SearchWindowStart>
          <!--Optional:-->
          <v1:SearchWindowEnd>150</v1:SearchWindowEnd>
          <!--Optional:-->
          <v1:AirDistanceThreshold>2.0</v1:AirDistanceThreshold>
        </v1:Body>
      </v1:Request>
    </v1:GetPoisAlongRoute>
  </soapenv:Body>
</soapenv:Envelope>

GetPoisAlongRoute Request

PoisAlongRouteRequestBody Members

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

ElementDefinitionRequired
PoiRouteA ExtendedRoute System Object. Indicate the route to search for POIs.
Usage:
ExtendedRoute extRoute = new ExtendedRoute();
extRoute.Stops = new List<​Stop​Location​>();
extRoute.Stops.Add(new StopLocation()
  { Address = new Address() { City = "Philadelphia", State = "PA" } });
extRoute.Stops.Add(new StopLocation()
  { Address = new Address() { Zip = "08540" } });
extRoute.Options = new RouteOptions() { HighwayOnly = false };
Y
RouteLegIndexAn Integer value. Indicate the route leg index to search.Y
SearchTypeAn enumeration of POISearchType. Indicate the type of search to perform. If you choose Generic, fill in the array of GenericPOICategories, if you choose HoS, fill the in the array of HosPOICategories. For a Fuel search, we just return everything.
Values:
Member nameValueDescription
FuelStop1Represents that search type is fuel stop.
HoS2Represents that search type is HoS.
Generic4Represents that search type is Generic.
Y
GenericPOICategoriesList of enumerations of POIGenericType. Indicate the list POI categories for a generic POI search.
Values:
Member nameValueDescription
All0All POI categories
WeightStation146Weight Station category
CatScale110Cat Scale location category
LCVLot149LCV Lot category
Hotel25Hotel category
IntermodalRamp52IntermodalRamp category
Parking34Parking category
RestAreaHoS1510Rest area of HoS category
TruckStop151Truck stop category
TruckServiceHoS1600Truck service of HoS category
HighwayExit1607Highway Exit category
MajorAirport101Major airport category
EventFacility18Event facility category
DistributionCenter1800Distribution category
HoSPOICategoriesList of enumerations of POIHosType. Indicate the list HoS categories for a HoS POI search.
Values:
Member nameValueDescription
All0All POI Hos type
TruckServiceHoS1600Truck Service HoS type
RestAreaHoS1510Rest Area HoS type
SearchWindowUnitsAn enumeration of PoiSearchWindowUnits. Indicate the search window units.
Values:
Member nameValueDescription
Miles0Use Miles for Search Windows units
Minutes1Use Minutes for Search Windows units
SearchWindowStartA Double value. Indicate the route leg mileage to begin the search at. For longer routes on generic POI searches, the search window will automatically be trimmed to be the maximum allowed length.
SearchWindowEndA Double value. Indicate the route leg mileage to end the search at. Set to null to automatically select the end of the leg or the maximum allowed length, whichever is smaller
AirDistanceThresholdA Double value. The maximum air distance between the POI and the nearest intersection on the route. Default and maximum allowed is 2.5 miles.

ExtendedRoute Members

ExtendedRoute System class inherited from Route class. It has a SharedOption System class member named ExtendedOptions. It contains:

ElementDefinitionRequired
EstimatedTimeOptionsA EstimatedTimeOptions System object contains:
ETAETD, an enumeration of ETAETDType.
Values:
Member nameValueDescription
Arrival0Indicates the time is an estimated time of arrival.
Depart1Indicates the time is an estimated time of departure.

DateOption, an enumeration of DateOption.
Values:
Member nameValueDescription
Current0Indicates that the current system time should be used.
Specific1Indicates that a specific supplied time should be used.
DayOfWeek2Indicates that a day of the week should be used.

DateAndTime, an Object of DateTimeType class.
UseTrafficA Boolean value. Indicate whether or not to use traffic data when calculating transit times, or when using fastest routing.
TruckStyleAn enumeration of TruckStyle. Indicate the truck style which includes vehicle dimensions and route costs.
Values:
Member nameValueDescription
None0Represents standard style.
TwentyEightDoubleTrailer1Represents 28 Double Trailer style.
FortyStraightTruck2Represents 40 Straight Truck style.
FortyEightSemiTrailer3Represents 48 Semi Trailer style.
FiftyThreeSemiTrailer4Represents 53 Semi Trailer style.
FullSizeVan5Represents Full Size Van style.

GetPoisAlongRoute Response

PoisAlongRouteResponseBody Members