POIs Along the Route
Contents
The POIs Along the Route request retrieves the Points of Interest (POIs) along a given route.
POST /poi/alongRoute?dataset={dataset}
Resource URL
https://pcmiler.alk.com/apis/rest/v1.0/service.svc/poi/alongRoute?dataset={dataset}
Request Element
The FindPoisAlongRoute operation wraps the PoisAlongRouteRequestBody to form a JSON formatted data in the POST body. See details in PoisAlongRouteRequestBody.
Sample JSON Post Body
Example for getting POIs along the route using FuelStop search type.
{
"PoiRoute": {
"ExtendedOptions": null,
"RouteId": "PhiladelphiaToPrinceton",
"Stops": [
{
"Costs": null,
"IsViaPoint": false,
"Address": {
"StreetAddress": null,
"City": "Philadelphia",
"State": "PA",
"Zip": null,
"County": null,
"Country": null,
"SPLC": null,
"CountryPostalFilter": 0,
"AbbreviationFormat": 0
},
"Coords": null,
"Region": 4,
"Label": null,
"PlaceName": null
},
{
"Costs": null,
"IsViaPoint": false,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"Zip": "08540",
"County": null,
"Country": null,
"SPLC": null,
"CountryPostalFilter": 0,
"AbbreviationFormat": 0
},
"Coords": null,
"Region": 4,
"Label": null,
"PlaceName": null
}
],
"Options": {
"HighwayOnly": false
}
},
"RouteLegIndex": 0,
"SearchType": 1
}
Sample Response
{
"POISearchMatches": [
{
"POILocation": {
"Address": {
"StreetAddress": "3670 Richmond St",
"City": "Philadelphia",
"State": "PA",
"Zip": "19134",
"County": "",
"Country": null,
"SPLC": null,
"CountryPostalFilter": 0,
"AbbreviationFormat": 0,
"CountryAbbreviation": null
},
"Coords": {
"Lat": "39.989220",
"Lon": "-75.090200"
},
"Region": 4,
"Label": "Sak Traders Inc Dba Sunoco",
"PlaceName": "Sak Traders Inc Dba Sunoco"
},
"DistanceFromOrigin": {
"Value": 7.708,
"DistanceUnits": 0
},
"POICategory": "Truck Services (HOS)",
"TimeFromOrigin": null,
"DistanceOffRoute": {
"Value": 0.484,
"DistanceUnits": 0
}
},
{
"POILocation": {
"Address": {
"StreetAddress": "2950 State Road",
"City": "Bensalem",
"State": "PA",
"Zip": "19020",
"County": "",
"Country": null,
"SPLC": null,
"CountryPostalFilter": 0,
"AbbreviationFormat": 0,
"CountryAbbreviation": null
},
"Coords": {
"Lat": "40.075588",
"Lon": "-74.929648"
},
"Region": 4,
"Label": "Bensalem Travel Plaza Co",
"PlaceName": "Bensalem Travel Plaza Co"
},
"DistanceFromOrigin": {
"Value": 19.014,
"DistanceUnits": 0
},
"POICategory": "Truck Services (HOS)",
"TimeFromOrigin": null,
"DistanceOffRoute": {
"Value": 1.267,
"DistanceUnits": 0
}
},
{
"POILocation": {
"Address": {
"StreetAddress": "503 State Road",
"City": "Croydon",
"State": "PA",
"Zip": "19021",
"County": "",
"Country": null,
"SPLC": null,
"CountryPostalFilter": 0,
"AbbreviationFormat": 0,
"CountryAbbreviation": null
},
"Coords": {
"Lat": "40.085832",
"Lon": "-74.906384"
},
"Region": 4,
"Label": "Jai, Inc.",
"PlaceName": "Jai, Inc."
},
"DistanceFromOrigin": {
"Value": 20.296,
"DistanceUnits": 0
},
"POICategory": "Truck Services (HOS)",
"TimeFromOrigin": null,
"DistanceOffRoute": {
"Value": 3.819,
"DistanceUnits": 0
}
},
{
"POILocation": {
"Address": {
"StreetAddress": "1231 New Rodgers Road",
"City": "Bristol",
"State": "PA",
"Zip": "19007",
"County": "",
"Country": null,
"SPLC": null,
"CountryPostalFilter": 0,
"AbbreviationFormat": 0,
"CountryAbbreviation": null
},
"Coords": {
"Lat": "40.105040",
"Lon": "-74.876232"
},
"Region": 4,
"Label": "Sunoco Food Mart",
"PlaceName": "Sunoco Food Mart"
},
"DistanceFromOrigin": {
"Value": 22.633,
"DistanceUnits": 0
},
"POICategory": "Truck Services (HOS)",
"TimeFromOrigin": null,
"DistanceOffRoute": {
"Value": 2.281,
"DistanceUnits": 0
}
},
{
"POILocation": {
"Address": {
"StreetAddress": "905 4Th Ave",
"City": "Bristol",
"State": "PA",
"Zip": "19007",
"County": "",
"Country": null,
"SPLC": null,
"CountryPostalFilter": 0,
"AbbreviationFormat": 0,
"CountryAbbreviation": null
},
"Coords": {
"Lat": "40.108348",
"Lon": "-74.857560"
},
"Region": 4,
"Label": "Bristol Fuel Stop Inc.",
"PlaceName": "Bristol Fuel Stop Inc."
},
"DistanceFromOrigin": {
"Value": 24.687,
"DistanceUnits": 0
},
"POICategory": "Truck Services (HOS)",
"TimeFromOrigin": null,
"DistanceOffRoute": {
"Value": 5.922,
"DistanceUnits": 0
}
},
{
"POILocation": {
"Address": {
"StreetAddress": "236 W.Lincoln Hwy",
"City": "Fairless Hills",
"State": "PA",
"Zip": "19030",
"County": "",
"Country": null,
"SPLC": null,
"CountryPostalFilter": 0,
"AbbreviationFormat": 0,
"CountryAbbreviation": null
},
"Coords": {
"Lat": "40.165000",
"Lon": "-74.893888"
},
"Region": 4,
"Label": "Doaba Oil Corp",
"PlaceName": "Doaba Oil Corp"
},
"DistanceFromOrigin": {
"Value": 25.823,
"DistanceUnits": 0
},
"POICategory": "Truck Services (HOS)",
"TimeFromOrigin": null,
"DistanceOffRoute": {
"Value": 0.857,
"DistanceUnits": 0
}
}
],
"SearchStartCoordinates": {
"Lat": "39.961698",
"Lon": "-75.197213"
},
"SearchEndCoordinates": {
"Lat": "40.354907",
"Lon": "-74.645014"
}
}
Errors
| Data Element | Description | Data Type | Value/Example |
|---|---|---|---|
Type
| Indicates whether the error is an exception or warning |
Enum | Warning Exception |
Code
| Error code |
Enum | Please refer to Appendix for complete list |
LegacyErrorCode
| The legacy error code with is an integer valued code that would have been returned in PC*MILER Web Services v25 and earlier. |
Int | |
Description
| The detailed error description. |
string |