IService Interface Reference
Public Member Functions | |
| Response | AboutService (Request Request) |
| The AboutService operation returns the version of PC*MILER Web Services. More... | |
| GeocodeResponse | ProcessGeocode (GeocodeRequest Request) |
| The ProcessGeocode operation allows you to find the find the closest latitude and longitude for a given street/city/state/zip address location supplied in the Request object. More... | |
| GeocodeResponse | ProcessReverseGeocode (ReverseGeocodeRequest Request) |
| The ProcessReverseGeocode operation takes the latitude and longitude of location and returns address information such as street/city/state/zip. More... | |
| RadiusSearchResponse | ProcessRadiusSearch (RadiusSearchRequest Request) |
| The ProcessRadiusSearch operation returns a collection of POIs within a supplied radius distance of the supplied center point. More... | |
| GetStatesResponse | ProcessStates (GetStatesRequest Request) |
| The ProcessStates operation returns a list of states or countries in a specified region. If the region is NA (North America), the state abbreviation and the full state name are filled in, as well as the country abbreviation and the fully country name. Outside of NA, only the country abbreviation and the full country name is filled in. More... | |
| AvoidFavorResponse | GetAvoidFavor (AvoidFavorRequest Request) |
| The GetAvoidFavor is a LEGACY operation (for ASMX customers ONLY) to get a collection of AvoidFavor items that are currently associated with their account. More... | |
| Response | SetAvoidFavor (SetAvoidFavorRequest Request) |
| The SetAvoidFavor is a LEGACY operation (for ASMX customers ONLY) that allows the user to avoid/favor an entire state, or an entire road within a state. It will not be used for avoiding or favoring single strings of road segments. Any preferences set for avoiding and favoring roads will be visible at the account level. More... | |
| CustomPlaceResponse | GetCustomPlaces (CustomPlaceRequest Request) |
| The GetCustomPlaces is a LEGACY operation (for ASMX customers ONLY) which allows the user to retrieve stored custom places. User can provide a PlaceName to retrieve a particular custom place or leave it blank to retrieve all stored custom places at the account level. More... | |
| Response | SetCustomPlaces (SetCustomPlaceRequest Request) |
| The SetCustomPlaces is a LEGACY operation (for ASMX customers ONLY) which allows the user to specify custom places to be stored. More... | |
| RoadSpeedsResponse | GetRoadSpeeds (RoadSpeedsRequest Request) |
| The GetRoadSpeeds operation allows the user to retrieve previously saved road speeds or if DefaultSpeeds is set or none are saved, the default road speeds for each of the road classes within a state (within NA) or country (outside of NA). More... | |
| Response | SetRoadSpeeds (SetRoadSpeedsRequest Request) |
| The SetRoadSpeeds operation allows the user to set speeds for different road types within a state (within NA) or country (outside NA). All road speed modifications will be visible at the account level. More... | |
| ReportResponse | GetETAOutOfRouteReport (ETAOutOfRouteRequest Request) |
| The GetETAOutOfRouteReport operation returns the out of route (OoR) mileage and estimated time of arrival (ETA) for a defined route and a series a collection of out of route locations. More... | |
| ReportResponse | ReduceTrip (ReduceTripRequest Request) |
| The ReduceTrip operation will attempt to recreate a trip based upon a series of latitude/longitude pairs which are the vehicle pings. More... | |
| ReportResponse | GetReports (ReportRequest Request) |
| The GetReports operation allows a user to run a collection of routes based on input locations, routing and reporting options, with the requested type of reports. More... | |
| RoutePointsResponse | GetRoutePoints (RoutePointsRequest Request) |
| The GetRoutePoints operation allows user to run a route based on location and options, and retrieve the coordinates that make up the route path. More... | |
| ReportResponseLegacy | GetReportsLegacy (ReportRequestLegacy Request) |
| The GetReportsLegacy operation allows a user to run a collection of routes based on input locations, routing and reporting options, with the requested type of reports. This request is SAP compliant in that each input route is made up of a ALK.PCM.Model.BusinessModels.ReportRouteLegacy object which has a separate property for each kind of report desired. This is unlike the standard ALK.PCMWS.Common.Model.BusinessModels.ReportRoute which takes a collection of the base class ALK.PCMWS.Common.Model.BusinessModels.ReportType and expects an inherited type for each report. The collection of base report types causes problems with SAP and this method gets around the issue. More... | |
| CreateRouteSyncMsgResponse | CreateRouteSyncMessage (CreateRouteSyncMsgRequest Request) |
| Creates a RouteSync message body given a route. More... | |
| CreateTripInsightMsgResponse | CreateTripInsightMessage (CreateTripInsightMsgRequest request) |
| Creates a TripInsight message body given a route. More... | |
| DriveTimePolygonResponse | GenerateDriveTimePolygon (DriveTimePolygonRequest Request) |
| Generate a polygon of possible travel location within a given time. More... | |
| PoisAlongRouteResponse | GetPoisAlongRoute (PoisAlongRouteRequest Request) |
| This operation finds POIs (Places of Interest) along a given leg of a route. More... | |
| MapRoutesResponse | ProcessMap (MapRoutesRequest Request) |
| The ProcessMap operation allows the user to request a map image with various elements such as points, geometries, routes, all depending on the supplied input request properties. More... | |
| ImportAFSetResponse | ImportAvoidFavorSet (ImportAFSetRequest Request) |
| The ImportAvoidFavorSet operation allows the user to take a flattened avoid favor dat file from PC*MILER desktop and import it into the cloud to use on the server when running routes. More... | |
| AFSetResponse | GetAvoidFavorSets (GetAvoidFavorSetRequest Request) |
| The GetAvoidFavorSets operation allows the user to retrieve avoid favor set information created by the ImportAvoidFavorSet operation. More... | |
| WeatherAlertsPointsResponse | GetWeatherAlerts (WeatherAlertsPointsRequest Request) |
| The GetWeatherAlerts operation returns a collection of weather alert information for each input coordinate. More... | |
| RouteMatrixResponse | GetRouteMatrix (RouteMatrixRequest Request) |
| The GetRouteMatrix operation takes a collection consisting of origins and a collection of destinations and runs a route from every origin to every destination. The maximum number of origins and destinations is 10 each. More... | |
Detailed Description
The PC*MILER Web Services portal allows access to the geocoding, mapping and routing engine. This API Reference contains a section each of the APIs defined.
This guide is intended for developer who are building applications that will use the PC*MILER Web Services to geocode location, create maps, and create reports on routes. To use the PC*MILER Web Services, you much have an account and be signed up to use PC*MILER Web Services. Please call...
Use of this guide assumes you are familiar with XML, basic understanding of web services, and a programming language for consuming the web services. This section details the request and response elements for the inbound API operations, including examples of raw SOAP requests for each operation.
Member Function Documentation
◆ AboutService()
The AboutService operation returns the version of PC*MILER Web Services.
- Parameters
-
Request The Request contains a Header with the DataVersion that you would like the version information on. See ALK.PCM.Model.ServiceModels.Request.Example: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:v1="http://pcmiler.alk.com/APIs/v1.0"> <soapenv:Header> <alk:AuthHeader> <alk:Authorization>YOUR API KEY Here</alk:Authorization> <alk:Date> Tue, 12 Aug 2014 18:11:39 GMT</alk:Date> </alk:AuthHeader> </soapenv:Header> <soapenv:Body> <v1:AboutService> <v1:Request> <v1:Header> <v1:DataVersion>current</v1:DataVersion> <v1:RequestType>AboutMapService</v1:RequestType> </v1:Header> </v1:Request> </v1:AboutService> </soapenv:Body> </soapenv:Envelope>
- Returns
- The AboutService operation returns a ALK.PCM.Model.ServiceModels.Response containing the a Header with the information about the request.
Example of XML returned for AboutService method<s:Envelope> xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header /> <s:Body> <AboutServiceResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <AboutServiceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>AboutMapService</Type> <Success>true</Success> <DataVersion>28.0.24.5492</DataVersion> <Errors i:nil="true" /> </Header> </AboutServiceResult> </AboutServiceResponse> </s:Body> </s:Envelope>
◆ ProcessGeocode()
| GeocodeResponse ProcessGeocode | ( | GeocodeRequest | Request | ) |
The ProcessGeocode operation allows you to find the find the closest latitude and longitude for a given street/city/state/zip address location supplied in the Request object.
- Parameters
-
Request The Request object containing the collection of locations to geocode. See ALK.PCM.Model.ServiceModels.GeocodeRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <h:AuthHeader xmlns="http://www.alk.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="http://www.alk.com"> <Authorization>YOUR API KEY HERE</Authorization> <Date>Thu, 21 Aug 2014 16:23:26 GMT</Date> </h:AuthHeader> </s:Header> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ProcessGeocode xmlns="http://pcmiler.alk.com/APIs/v1.0"> <Request> <Header> <DataVersion>current</DataVersion> <RequestType>GeoCode</RequestType> </Header> <Body> <Locations> <GeocodeLocation> <Address> <StreetAddress>Herrontown Rd</StreetAddress> <City xsi:nil="true" /> <State xsi:nil="true" /> <Zip>08540</Zip> <County xsi:nil="true" /> <Country xsi:nil="true" /> <SPLC xsi:nil="true" /> </Address> <Region>NA</Region> <GeoList>true</GeoList> <MaxResults>2</MaxResults> </GeocodeLocation> </Locations> </Body> </Request> </ProcessGeocode> </s:Body> </s:Envelope>
- Returns
- Returns a collection of geocoded locations with address, latitude and longitude information for each location. See ALK.PCM.Model.ServiceModels.GeocodeResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ProcessGeocodeResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <ProcessGeocodeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>GeoCode</Type> <Success>true</Success> <DataVersion>28.2.26.3681</DataVersion> <Errors i:nil="true" /> </Header> <Body> <Locations> <GeocodeOutputLocation> <Address> <StreetAddress>1-64 Herrontown Road</StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County>Mercer</County> <Country>United States</Country> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.376874</Lat> <Lon>-74.624109</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EST</TimeZone> <Errors> <Error> <Type>Warning</Type> <Code>GEOCODE_WARN</Code> <LegacyErrorCode>1000</LegacyErrorCode> <Description>No street number input; Multiple matches; Address uncertain</Description> </Error> </Errors> <ConfidenceLevel>Uncertain</ConfidenceLevel> <DistanceFromRoad i:nil="true" /> </GeocodeOutputLocation> </Locations> </Body> </ProcessGeocodeResult> </ProcessGeocodeResponse> </s:Body> </s:Envelope>
◆ ProcessReverseGeocode()
| GeocodeResponse ProcessReverseGeocode | ( | ReverseGeocodeRequest | Request | ) |
The ProcessReverseGeocode operation takes the latitude and longitude of location and returns address information such as street/city/state/zip.
- Parameters
-
Request The Request object containing the collection of coordinates (latitude/longitude) to reverse geocode. See ALK.PCM.Model.ServiceModels.ReverseGeocodeRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <h:AuthHeader xmlns="http://www.alk.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="http://www.alk.com"> <Authorization>Your API Key here</Authorization> <Date>Tue, 24 Feb 2015 18:11:28 GMT</Date> </h:AuthHeader> </s:Header> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ProcessReverseGeocode xmlns="http://pcmiler.alk.com/APIs/v1.0"> <Request> <Header> <DataVersion>current</DataVersion> <RequestType>ReverseGeocode</RequestType> </Header> <Body> <Coords> <ReverseGeoCoord> <Lat>40.388250</Lat> <Lon>-74.654726</Lon> <Timestamp>2017-1-21 5:40PM</Timestamp> </ReverseGeoCoord> <ReverseGeoCoord> <Lat>40863263</Lat> <Lon>-74425648</Lon> <Timestamp>2017-6-21 5:40PM</Timestamp> </ReverseGeoCoord> </Coords> <IncludePostedSpeedLimit>true</IncludePostedSpeedLimit> <MatchNamedRoadsOnly>true</MatchNamedRoadsOnly> <MaxCleanupMiles>20</MaxCleanupMiles> </Body> </Request> </ProcessReverseGeocode> </s:Body> </s:Envelope>
- Returns
- Returns a collection of geocoded locations with address, latitude and longitude information for each location. See ALK.PCM.Model.ServiceModels.GeocodeResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ProcessGeocodeResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <ProcessGeocodeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>GeoCode</Type> <Success>true</Success> <DataVersion>28.2.26.3681</DataVersion> <Errors i:nil="true" /> </Header> <Body> <Locations> <GeocodeOutputLocation> <Address> <StreetAddress>1-64 Herrontown Road</StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County>Mercer</County> <Country>United States</Country> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.376874</Lat> <Lon>-74.624109</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EST</TimeZone> <Errors> <Error> <Type>Warning</Type> <Code>GEOCODE_WARN</Code> <LegacyErrorCode>1000</LegacyErrorCode> <Description>No street number input; Multiple matches; Address uncertain</Description> </Error> </Errors> <ConfidenceLevel>Uncertain</ConfidenceLevel> <DistanceFromRoad i:nil="true" /> </GeocodeOutputLocation> </Locations> </Body> </ProcessGeocodeResult> </ProcessGeocodeResponse> </s:Body> </s:Envelope>
◆ ProcessRadiusSearch()
| RadiusSearchResponse ProcessRadiusSearch | ( | RadiusSearchRequest | Request | ) |
The ProcessRadiusSearch operation returns a collection of POIs within a supplied radius distance of the supplied center point.
- Parameters
-
Request The Request object containing the center point location, the search radius, and the POI Categories to search for. See ALK.PCM.Model.ServiceModels.RadiusSearchRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://pcmiler.alk.com/APIs/v1.0/IService/CreateRouteSyncMessage</Action> <h:AuthHeader xmlns="http://www.alk.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="http://www.alk.com"> <Authorization>YOUR API KEY HERE</Authorization> <Date>Thu, 21 Aug 2014 16:23:26 GMT</Date> </h:AuthHeader> </s:Header> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ProcessRadiusSearch xmlns="http://pcmiler.alk.com/APIs/v1.0"> <Request> <Header> <DataVersion>current</DataVersion> <RequestType>RadiusSearch</RequestType> </Header> <Body> <CenterPoint> <Address> <StreetAddress xsi:nil="true" /> <City xsi:nil="true" /> <State xsi:nil="true" /> <Zip>08540</Zip> <County xsi:nil="true" /> <Country xsi:nil="true" /> <SPLC xsi:nil="true" /> </Address> <Coords xsi:nil="true" /> <Region>NA</Region> <Label xsi:nil="true" /> <PlaceName xsi:nil="true" /> </CenterPoint> <Radius> <Value>5</Value> <DistanceUnits>Miles</DistanceUnits> </Radius> <POICategories>City</POICategories> <NameFilter xsi:nil="true" /> </Body> </Request> </ProcessRadiusSearch> </s:Body> </s:Envelope>
- Returns
- Returns a collection of RadiusSearchMatch objects which contain POI locations within the search radius and the distance from the center of point provided in the request. See ALK.PCM.Model.ServiceModels.RadiusSearchResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ProcessRadiusSearchResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <ProcessRadiusSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>RadiusSearch</Type> <Success>true</Success> <DataVersion>28.3.26.9224</DataVersion> <Errors> </Header> <Body> <POISearchMatches> <RadiusSearchMatch> <DistanceFromCenter> <Value>0</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromCenter> <POICategory>City</POICategory> <POILocation> <Address> <StreetAddress> <City>Westminster Choir Clg</City> <State>NJ</State> <Zip> <County>Mercer</County> <Country i:nil="true" /> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.348727</Lat> <Lon>-74.659049</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> </POILocation> </RadiusSearchMatch> <RadiusSearchMatch> <DistanceFromCenter> <Value>0.022104250579809828</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromCenter> <POICategory>City</POICategory> <POILocation> <Address> <StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip> <County>Mercer</County> <Country i:nil="true" /> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.34861</Lat> <Lon>-74.65944</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> </POILocation> </RadiusSearchMatch> <RadiusSearchMatch> <DistanceFromCenter> <Value>0.27920742407694965</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromCenter> <POICategory>City</POICategory> <POILocation> <Address> <StreetAddress> <City>Princeton Township</City> <State>NJ</State> <Zip> <County>Mercer</County> <Country i:nil="true" /> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.348202</Lat> <Lon>-74.66431</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> </POILocation> </RadiusSearchMatch> <RadiusSearchMatch> <DistanceFromCenter> <Value>0.40228780370071504</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromCenter> <POICategory>City</POICategory> <POILocation> <Address> <StreetAddress> <City>Princeton Theo Smnry</City> <State>NJ</State> <Zip> <County>Mercer</County> <Country i:nil="true" /> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.345558</Lat> <Lon>-74.665464</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> </POILocation> </RadiusSearchMatch> </POISearchMatches> </Body> </ProcessRadiusSearchResult> </ProcessRadiusSearchResponse> </s:Body> </s:Envelope>
◆ ProcessStates()
| GetStatesResponse ProcessStates | ( | GetStatesRequest | Request | ) |
The ProcessStates operation returns a list of states or countries in a specified region. If the region is NA (North America), the state abbreviation and the full state name are filled in, as well as the country abbreviation and the fully country name. Outside of NA, only the country abbreviation and the full country name is filled in.
- Parameters
-
Request The Request will contain the Region, CountryCodeFormat, and a boolean to specify if the search if for states or countries only. See ALK.PCM.Model.ServiceModels.GetStatesRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <h:AuthHeader xmlns="http://www.alk.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="http://www.alk.com"> <Authorization>YOUR API KEY HERE</Authorization> <Date>Tue, 24 Feb 2015 18:11:28 GMT</Date> </h:AuthHeader> </s:Header> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ProcessStates xmlns="http://pcmiler.alk.com/APIs/v1.0"> <Request> <Header> <DataVersion>current</DataVersion> <RequestType>GetStates</RequestType> </Header> <Body> <Format>FIPS</Format> <Region>NA</Region> <CountryOnly>false</CountryOnly> </Body> </Request> </ProcessStates> </s:Body> </s:Envelope>
- Returns
- Returns a collection of states or countries for a region. See ALK.PCM.Model.ServiceModels.GetStatesResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header /> <s:Body> <ProcessStatesResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <ProcessStatesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>GetStates</Type> <Success>true</Success> <DataVersion>28.3.26.9224</DataVersion> <Errors i:nil="true" /> </Header> <Body> <States> <StateCountry> <StateAbbr>AL</StateAbbr> <StateName>Alabama</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>AK</StateAbbr> <StateName>Alaska</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>AZ</StateAbbr> <StateName>Arizona</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>AR</StateAbbr> <StateName>Arkansas</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>CA</StateAbbr> <StateName>California</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>CO</StateAbbr> <StateName>Colorado</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>CT</StateAbbr> <StateName>Connecticut</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>DE</StateAbbr> <StateName>Delaware</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>DC</StateAbbr> <StateName>District of Columbia</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>FL</StateAbbr> <StateName>Florida</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>GA</StateAbbr> <StateName>Georgia</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>HI</StateAbbr> <StateName>Hawaii</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>ID</StateAbbr> <StateName>Idaho</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>IL</StateAbbr> <StateName>Illinois</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>IN</StateAbbr> <StateName>Indiana</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>IA</StateAbbr> <StateName>Iowa</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>KS</StateAbbr> <StateName>Kansas</StateName> <CountryAbbr>US</CountryAbbr> <CountryName>United States</CountryName> </StateCountry> <StateCountry> <StateAbbr>SB</StateAbbr> <StateName>Saint Pierre and Miquelon</StateName> <CountryAbbr>SB</CountryAbbr> <CountryName>Saint Pierre and Mique</CountryName> </StateCountry> </States> </Body> </ProcessStatesResult> </ProcessStatesResponse> </s:Body> </s:Envelope>
◆ GetAvoidFavor()
| AvoidFavorResponse GetAvoidFavor | ( | AvoidFavorRequest | Request | ) |
The GetAvoidFavor is a LEGACY operation (for ASMX customers ONLY) to get a collection of AvoidFavor items that are currently associated with their account.
- Parameters
-
Request The ALK.PCM.Model.ServiceModels.AvoidFavorRequest contains the AFType flag to specify Avoid or Favors, and a Label.
- Returns
- Returns a ALK.PCM.Model.ServiceModels.AvoidFavorResponse which contains collection of ALK.PCM.Model.BusinessModels.AvoidFavor items.
NOTE: This operation is only for Legacy ASMX customers. Do not call this operation when using an API key.
◆ SetAvoidFavor()
| Response SetAvoidFavor | ( | SetAvoidFavorRequest | Request | ) |
The SetAvoidFavor is a LEGACY operation (for ASMX customers ONLY) that allows the user to avoid/favor an entire state, or an entire road within a state. It will not be used for avoiding or favoring single strings of road segments. Any preferences set for avoiding and favoring roads will be visible at the account level.
- Parameters
-
Request The ALK.PCM.Model.ServiceModels.SetAvoidFavorRequest contains a collection of ALK.PCM.Model.BusinessModels.AvoidFavorSet objects with the action to save or delete and the details of the preference to be saved.
- Returns
- Returns a ALK.PCM.Model.ServiceModels.Response that contains a boolean to indicate is the request was successful.
NOTE: This operation is only for Legacy ASMX customers. Do not call this operation when using an API key.
◆ GetCustomPlaces()
| CustomPlaceResponse GetCustomPlaces | ( | CustomPlaceRequest | Request | ) |
The GetCustomPlaces is a LEGACY operation (for ASMX customers ONLY) which allows the user to retrieve stored custom places. User can provide a PlaceName to retrieve a particular custom place or leave it blank to retrieve all stored custom places at the account level.
- Parameters
-
Request The ALK.PCM.Model.ServiceModels.CustomPlaceRequest contains a unique string for the PlaceName.
- Returns
- Returns one or more stored custom places for an account, see ALK.PCM.Model.ServiceModels.CustomPlaceResponse.
NOTE: This operation is only for Legacy ASMX customers. Do not call this operation when using an API key.
◆ SetCustomPlaces()
| Response SetCustomPlaces | ( | SetCustomPlaceRequest | Request | ) |
The SetCustomPlaces is a LEGACY operation (for ASMX customers ONLY) which allows the user to specify custom places to be stored.
- Parameters
-
Request The ALK.PCM.Model.ServiceModels.SetCustomPlaceRequest contains a collection of ALK.PCM.Model.BusinessModels.CustomPlaceLocation objects, which have the action (save or delete) and the ALK.Common.Model.Location information.
- Returns
- Returns a ALK.PCM.Model.ServiceModels.Response that contains a boolean to indicate is the request was successful.
NOTE: This operation is only for Legacy ASMX customers. Do not call this operation when using an API key.
◆ GetRoadSpeeds()
| RoadSpeedsResponse GetRoadSpeeds | ( | RoadSpeedsRequest | Request | ) |
The GetRoadSpeeds operation allows the user to retrieve previously saved road speeds or if DefaultSpeeds is set or none are saved, the default road speeds for each of the road classes within a state (within NA) or country (outside of NA).
- Parameters
-
Request The Request object containing the jurisdiction, vehicle type and region for which to return the road speeds. See ALK.PCM.Model.ServiceModels.RoadSpeedsRequest.
Example below will retrieve the road speeds for New Jersey for the Truck vehicle type:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:pcm="http://pcmiler.alk.com/APIs/v1.0"> <soapenv:Header> <alk:AuthHeader> <alk:Authorization>YOUR API KEY HERE</alk:Authorization> </alk:AuthHeader> </soapenv:Header> <soapenv:Body> <pcm:GetRoadSpeeds> <pcm:Request> <pcm:Header> <pcm:DataVersion>PCM_NA</pcm:DataVersion> <pcm:RequestType>GetRoadSpeeds</pcm:RequestType> </pcm:Header> <pcm:Body> <pcm:Jurisdiction>NJ</pcm:Jurisdiction> <pcm:AbbreviationFormat>FIPS</pcm:AbbreviationFormat> <pcm:Vehicle>Truck</pcm:Vehicle> <pcm:Region>NA</pcm:Region> <pcm:DefaultSpeeds>false</pcm:DefaultSpeeds> </pcm:Body> </pcm:Request> </pcm:GetRoadSpeeds> </soapenv:Body> </soapenv:Envelope>
- Returns
- Returns a collection of ALK.PCMWS.Common.Model.BusinessModels.RoadSpeed objects, where each item contains the jurisdiction, the road type/class, and the roadspeed value. See ALK.PCM.Model.ServiceModels.RoadSpeedsResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetRoadSpeedsResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <GetRoadSpeedsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>GetRoadSpeeds</Type> <Success>true</Success> <DataVersion>31.4.12.3456</DataVersion> <Errors i:nil="true"/> </Header> <Body> <RoadSpeeds> <RoadSpeed> <RoadCategory>InterStateRural</RoadCategory> <Speed>64</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>DividedRural</RoadCategory> <Speed>40</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>PrimaryRural</RoadCategory> <Speed>35</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>FerriesRural</RoadCategory> <Speed>15</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>SecondaryRural</RoadCategory> <Speed>25</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>LocalRural</RoadCategory> <Speed>23</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>InterStateUrban</RoadCategory> <Speed>54</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>DividedUrban</RoadCategory> <Speed>25</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>PrimaryUrban</RoadCategory> <Speed>20</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>FerriesUrban</RoadCategory> <Speed>15</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>SecondaryUrban</RoadCategory> <Speed>11</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> <RoadSpeed> <RoadCategory>LocalUrban</RoadCategory> <Speed>4</Speed> <Jurisdiction>NJ</Jurisdiction> </RoadSpeed> </RoadSpeeds> </Body> </GetRoadSpeedsResult> </GetRoadSpeedsResponse> </s:Body> </s:Envelope>
NOTE: For customers using a legacy login (not an API key) with user name/account/password, the vehicle type will be ignored and only road speeds in NA are supported
◆ SetRoadSpeeds()
| Response SetRoadSpeeds | ( | SetRoadSpeedsRequest | Request | ) |
The SetRoadSpeeds operation allows the user to set speeds for different road types within a state (within NA) or country (outside NA). All road speed modifications will be visible at the account level.
- Parameters
-
Request The Request object contains a collection of ALK.PCMWS.Common.Model.BusinessModels.RoadSpeed objects, to specify the jurisdiction, vehicle type, region, road type and speed value to be saved. See ALK.PCM.Model.ServiceModels.SetRoadSpeedsRequest.
Example below modifies a few of the road types, Inter State Rural/Urban and Local Urban to have custom values in New Jersey:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:pcm="http://pcmiler.alk.com/APIs/v1.0"> <soapenv:Header> <alk:AuthHeader> <alk:Authorization>YOUR API KEY HERE</alk:Authorization> </alk:AuthHeader> </soapenv:Header> <soapenv:Body> <pcm:SetRoadSpeeds> <pcm:Request> <pcm:Header> <pcm:DataVersion/> <pcm:RequestType>SetRoadSpeeds</pcm:RequestType> </pcm:Header> <pcm:Body xmlns="http://pcmiler.alk.com/APIs/v1.0"> <pcm:RoadSpeeds> <pcm:RoadSpeed> <RoadCategory>InterStateRural</RoadCategory> <Speed>65</Speed> <Jurisdiction>NJ</Jurisdiction> </pcm:RoadSpeed> <pcm:RoadSpeed> <RoadCategory>InterStateUrban</RoadCategory> <Speed>55</Speed> <Jurisdiction>NJ</Jurisdiction> </pcm:RoadSpeed> <pcm:RoadSpeed> <RoadCategory>LocalUrban</RoadCategory> <Speed>25</Speed> <Jurisdiction>NJ</Jurisdiction> </pcm:RoadSpeed> </pcm:RoadSpeeds> <pcm:AbbreviationFormat>FIPS</pcm:AbbreviationFormat> <pcm:Vehicle>Auto</pcm:Vehicle> <pcm:Region>NA</pcm:Region> </pcm:Body> </pcm:Request> </pcm:SetRoadSpeeds> </soapenv:Body> </soapenv:Envelope>
- Returns
- Returns a Response that contains a boolean to indicate if the request was successful. See ALK.PCM.Model.ServiceModels.Response.
Example below returned from setting road speeds will contain a success of true or otherwise the errors will contain an error message.<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <SetRoadSpeedsResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <SetRoadSpeedsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>SetRoadSpeeds</Type> <Success>true</Success> <DataVersion>31.4.12.3456</DataVersion> <Errors i:nil="true"/> </Header> </SetRoadSpeedsResult> </SetRoadSpeedsResponse> </s:Body> </s:Envelope>
NOTE: For customers using a legacy login (user name/account/password, not an API key), the vehicle type will be ignored and only road speeds in NA are supported
◆ GetETAOutOfRouteReport()
| ReportResponse GetETAOutOfRouteReport | ( | ETAOutOfRouteRequest | Request | ) |
The GetETAOutOfRouteReport operation returns the out of route (OoR) mileage and estimated time of arrival (ETA) for a defined route and a series a collection of out of route locations.
- Parameters
-
Request The Request object contains an origin and destination pair, collection of out of route locations and routing options. See ALK.PCM.Model.ServiceModels.ETAOutOfRouteRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <h:AuthHeader xmlns="http://www.alk.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="http://www.alk.com"> <Authorization>YOUR API KEY HERE</Authorization> <Date>Wed, 10 Sep 2014 19:35:41 GMT</Date> </h:AuthHeader> </s:Header> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <GetETAOutOfRouteReport xmlns="http://pcmiler.alk.com/APIs/v1.0"> <Request> <Header> <DataVersion>current</DataVersion> <RequestType>GetETAOutOfRouteReport</RequestType> </Header> <Body> <RouteID>ETA Out of Route Report Test</RouteID> <Origin> <Address> <City>Princeton</City> <Zip>08540</Zip> </Address> <Region>NA</Region> </Origin> <Destination> <Address> <City>Monmouth Junction</City> <Zip>08852</Zip> </Address> <Region>NA</Region> <Costs> <CostOfStop>5</CostOfStop> <HoursPerStop>1</HoursPerStop> <Loaded>true</Loaded> <OnDuty>true</OnDuty> <UseOrigin>false</UseOrigin> </Costs> </Destination> <CurrentLocations> <StopLocation> <Coords> <Lat>40353828</Lat> <Lon>-74610884</Lon> </Coords> </StopLocation> <StopLocation> <Address> <Zip>19123</Zip> </Address> <Region>NA</Region> </StopLocation> </CurrentLocations> <RoutingOptions> <ClassOverrides>FiftyThreeFoot</ClassOverrides> <HighwayOnly>true</HighwayOnly> <TruckCfg xsi:nil="true" /> <VehicleType>LightTruck</VehicleType> </RoutingOptions> <ReportingOptions> <EstimatedTimeOptions> <ETAETD>Arrival</ETAETD> <DateOption>Specific</DateOption> <DateAndTime> <CalendarDate>10/10/2014</CalendarDate> <DayOfWeek>Friday</DayOfWeek> <TimeOfDay>12:00</TimeOfDay> <TimeZone>Eastern</TimeZone> </DateAndTime> </EstimatedTimeOptions> <ExchangeRate>1.5</ExchangeRate> <FuelUnits>Gallons</FuelUnits> <IncludeFerryDistance>true</IncludeFerryDistance> <Language>DE</Language> <RouteCosts> <CostTimeEmpty>5</CostTimeEmpty> <CostTimeLoaded>15</CostTimeLoaded> <FuelEconomyEmpty>1</FuelEconomyEmpty> <FuelEconomyLoaded>16</FuelEconomyLoaded> <GreenHouseGas>1</GreenHouseGas> <OtherCostPerDistUnitLoaded>2</OtherCostPerDistUnitLoaded> <OtherCostPerDistanceUnitEmpty>5</OtherCostPerDistanceUnitEmpty> <PricePerFuelUnit>3.95</PricePerFuelUnit> <TruckStyle>FiftyThreeSemiTrailer</TruckStyle> </RouteCosts> <TollCurrency>US</TollCurrency> <TollDiscount>All</TollDiscount> <UseCustomRoadSpeeds>false</UseCustomRoadSpeeds> <UseTollData>true</UseTollData> <UseTraffic>true</UseTraffic> </ReportingOptions> </Body> </Request> </GetETAOutOfRouteReport> </s:Body> </s:Envelope>
- Returns
- Returns the new ETA for the destination based upon each out of route location(s). See ALK.PCM.Model.ServiceModels.ReportResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header /> <s:Body> <GetETAOutOfRouteReportResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <GetETAOutOfRouteReportResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>GetETAOutOfRouteReport</Type> <Success>true</Success> <DataVersion>28.0.24.5492</DataVersion> <Errors> </Header> <Body> <Reports> <Report i:type="ETAOutOfRouteReport"> <RouteID>ETA Out of Route Report Test</RouteID> <Origin> <Address> <StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County>Mercer</County> <Country i:nil="true" /> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.348727</Lat> <Lon>-74.659049</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EDT</TimeZone> <Errors> </Origin> <Destination> <Address> <StreetAddress> <City>Monmouth Junction</City> <State>NJ</State> <Zip>08852</Zip> <County>Middlesex</County> <Country i:nil="true" /> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.378999</Lat> <Lon>-74.546541</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EDT</TimeZone> <Errors> </Destination> <ReportLines> <OutOfRouteReportLine> <CurrentLocation> <Address> <StreetAddress>Brunswick Pike</StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County>Mercer</County> <Country i:nil="true" /> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.353828</Lat> <Lon>-74.610884</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EDT</TimeZone> <Errors> </CurrentLocation> <LMiles>5.5</LMiles> <TMiles>5.5</TMiles> <LCostMile>50.57</LCostMile> <TCostMile>50.57</TCostMile> <LHours>1:08</LHours> <THours>1:08</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <OORMILE>12.56</OORMILE> </OutOfRouteReportLine> <OutOfRouteReportLine> <CurrentLocation> <Address> <StreetAddress> <City>Philadelphia</City> <State>PA</State> <Zip>19123</Zip> <County>Philadelphia</County> <Country i:nil="true" /> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Pennsylvania</StateName> <StateAbbreviation>PA</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.965177</Lat> <Lon>-75.152564</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EDT</TimeZone> <Errors> </CurrentLocation> <LMiles>53.8</LMiles> <TMiles>53.8</TMiles> <LCostMile>125.81</LCostMile> <TCostMile>125.81</TCostMile> <LHours>2:05</LHours> <THours>2:05</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <OORMILE>89.394</OORMILE> </OutOfRouteReportLine> </ReportLines> </Report> </Reports> </Body> </GetETAOutOfRouteReportResult> </GetETAOutOfRouteReportResponse> </s:Body> </s:Envelope>
◆ ReduceTrip()
| ReportResponse ReduceTrip | ( | ReduceTripRequest | Request | ) |
The ReduceTrip operation will attempt to recreate a trip based upon a series of latitude/longitude pairs which are the vehicle pings.
- Parameters
-
Request The Request contains a collection of Coordinates (vehicle pings), OffRouteMiles which is the number of miles to be used in calculating the "window" or tolerance for the latitude/longitude pings and the ReportType desired. The route can be run based on highway routes or non highway route. See ALK.PCM.Model.ServiceModels.ReduceTripRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <h:AuthHeader xmlns="http://www.alk.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="http://www.alk.com"> <Authorization>YOUR API KEY HERE</Authorization> <Date>Tue, 24 Feb 2015 21:34:46 GMT</Date> </h:AuthHeader> </s:Header> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ReduceTrip xmlns="http://pcmiler.alk.com/APIs/v1.0"> <Request> <Header> <DataVersion>current</DataVersion> <RequestType>Reduce Trip</RequestType> </Header> <Body> <OffRouteMiles>0.2</OffRouteMiles> <ReportType xsi:type="MileageReportType" /> <RoutePings> <Coordinates> <Lat>42.149700</Lat> <Lon>-74.938400</Lon> </Coordinates> <Coordinates> <Lat>40.348727</Lat> <Lon>-74.659049</Lon> </Coordinates> </RoutePings> <RoutingOptions> <BordersOpen>false</BordersOpen> <ClassOverrides>FiftyThreeFoot</ClassOverrides> <RouteOptimization>DestinationFixed</RouteOptimization> <TruckCfg xsi:nil="true" /> </RoutingOptions> </Body> </Request> </ReduceTrip> </s:Body> </s:Envelope>
- Returns
- Returns the requested Report (usually Mileage or Detailed) generated for the recreated route. See ALK.PCM.Model.ServiceModels.ReportResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReduceTripResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <ReduceTripResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>Reduce Trip</Type> <Success>true</Success> <DataVersion>28.3.26.9224</DataVersion> <Errors> </Header> <Body> <Reports> <Report i:type="MileageReport"> <RouteID i:nil="true" /> <ReportLines> <StopReportLine> <Stop> <Address> <StreetAddress> <City>Walton</City> <State>NY</State> <Zip> <County>Delaware</County> <Country i:nil="true" /> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New York</StateName> <StateAbbreviation>NY</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>42.1497</Lat> <Lon>-74.9384</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone i:nil="true" /> <Errors i:nil="true" /> </Stop> <LMiles>0.0</LMiles> <TMiles>0.0</TMiles> <LCostMile>0.00</LCostMile> <TCostMile>0.00</TCostMile> <LHours>0:00</LHours> <THours>0:00</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <LEstghg>0.0</LEstghg> <TEstghg>0.0</TEstghg> <EtaEtd i:nil="true" /> </StopReportLine> <StopReportLine> <Stop> <Address> <StreetAddress> <City>Westminster Choir Clg</City> <State>NJ</State> <Zip> <County>Mercer</County> <Country i:nil="true" /> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.348727</Lat> <Lon>-74.659049</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone i:nil="true" /> <Errors i:nil="true" /> </Stop> <LMiles>173.1</LMiles> <TMiles>173.1</TMiles> <LCostMile>238.92</LCostMile> <TCostMile>238.92</TCostMile> <LHours>3:07</LHours> <THours>3:07</THours> <LTolls>3.50</LTolls> <TTolls>3.50</TTolls> <LEstghg>592.9</LEstghg> <TEstghg>592.9</TEstghg> <EtaEtd i:nil="true" /> </StopReportLine> </ReportLines> <TrafficDataUsed>false</TrafficDataUsed> </Report> </Reports> </Body> </ReduceTripResult> </ReduceTripResponse> </s:Body> </s:Envelope>
◆ GetReports()
| ReportResponse GetReports | ( | ReportRequest | Request | ) |
The GetReports operation allows a user to run a collection of routes based on input locations, routing and reporting options, with the requested type of reports.
- Parameters
-
Request The Request contains a collection of routes to run, each with the origins destination, intermediate stops, and various routing and reporting options. See ALK.PCM.Model.ServiceModels.ReportRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <h:AuthHeader xmlns="http://www.alk.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="http://www.alk.com"> <Authorization>YOUR API KEY HERE</Authorization> <Date>Wed, 24 Sep 2014 16:54:53 GMT</Date> </h:AuthHeader> </s:Header> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <GetReports xmlns="http://pcmiler.alk.com/APIs/v1.0"> <Request> <Header> <DataVersion>current</DataVersion> <RequestType>GetReports</RequestType> </Header> <Body> <ReportRoutes> <ReportRoute> <RouteId>Test Route</RouteId> <Stops> <StopLocation> <Address> <StreetAddress xsi:nil="true" /> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County xsi:nil="true" /> <Country xsi:nil="true" /> <SPLC xsi:nil="true" /> </Address> <Coords xsi:nil="true" /> <Region>NA</Region> <Label>Princeton, NJ</Label> <PlaceName xsi:nil="true" /> <Costs xsi:nil="true" /> </StopLocation> <StopLocation> <Address> <StreetAddress xsi:nil="true" /> <City>Beverly Hills</City> <State>CA</State> <Zip>90210</Zip> <County xsi:nil="true" /> <Country xsi:nil="true" /> <SPLC xsi:nil="true" /> </Address> <Coords xsi:nil="true" /> <Region>NA</Region> <Label>Beverly Hills, CA</Label> <PlaceName xsi:nil="true" /> <Costs xsi:nil="true" /> </StopLocation> </Stops> <Options> <DistanceUnits>Miles</DistanceUnits> <HighwayOnly>true</HighwayOnly> <HubRouting>false</HubRouting> <TruckCfg> <Axles>2</Axles> <Height>13'6</Height> <Length>53'0</Length> <Units>English</Units> <Weight>132000</Weight> <Width>102"</Width> </TruckCfg> <VehicleType>Truck</VehicleType> </Options> <FuelOptions xsi:nil="true" /> <AFOptions xsi:nil="true" /> <ReportingOptions> <EstimatedTimeOptions xsi:nil="true" /> <RouteCosts xsi:nil="true" /> <TimeCosts xsi:nil="true" /> <TollDiscount>ALL</TollDiscount> <UseTollData>true</UseTollData> </ReportingOptions> <ReportTypes> <ReportType xsi:type="DirectionsReportType"> <CondenseDirections>true</CondenseDirections> </ReportType> <ReportType xsi:type="DetailReportType"> <SeparateHeadingFromRoute>true</SeparateHeadingFromRoute> </ReportType> <ReportType xsi:type="MileageReportType" /> <ReportType xsi:type="StateReportType"> <SortByRoute>true</SortByRoute> </ReportType> </ReportTypes> </ReportRoute> </ReportRoutes> </Body> </Request> </GetReports> </s:Body> </s:Envelope>
- Returns
- The GetReports operation will return the reports run for each of the input routes. See ALK.PCM.Model.ServiceModels.ReportResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header /> <s:Body> <GetReportsResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <GetReportsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>GetReports</Type> <Success>true</Success> <DataVersion>28.0.25.2830</DataVersion> <Errors> </Header> <Body> <Reports> <Report i:type="DirectionsReport"> <RouteID>Test Route</RouteID> <Origin> <Address> <StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County>Mercer</County> <Country>United States</Country> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.348727</Lat> <Lon>-74.659049</Lon> </Coords> <Region>NA</Region> <Label>Princeton, NJ</Label> <PlaceName>Princeton, NJ</PlaceName> <TimeZone>EDT</TimeZone> <Errors> </Origin> <Destination> <Address> <StreetAddress> <City>Beverly Hills</City> <State>CA</State> <Zip>90210</Zip> <County>Los Angeles</County> <Country>United States</Country> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>California</StateName> <StateAbbreviation>CA</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>34.079799</Lat> <Lon>-118.412935</Lon> </Coords> <Region>NA</Region> <Label>Beverly Hills, CA</Label> <PlaceName>Beverly Hills, CA</PlaceName> <TimeZone>PDT</TimeZone> <Errors> </Destination> <ReportLegs> <DirectionsReportLeg> <Origin> <Address> <StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County>Mercer</County> <Country>United States</Country> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.348727</Lat> <Lon>-74.659049</Lon> </Coords> <Region>NA</Region> <Label>Princeton, NJ</Label> <PlaceName>Princeton, NJ</PlaceName> <TimeZone>EDT</TimeZone> <Errors> </Origin> <ReportLines> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>N Local</Direction> <Dist>0.1</Dist> <Time>0:00</Time> <InterCh>+ Local NJ-27</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S NJ-27</Direction> <Dist>0.2</Dist> <Time>0:00</Time> <InterCh>+ NJ-27 Route 583</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S Route 583</Direction> <Dist>4.9</Dist> <Time>0:07</Time> <InterCh>+ Route 583 Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S I-95</Direction> <Dist>13.3</Dist> <Time>0:12</Time> <InterCh>+ I-95 X 46B</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 46B</Direction> <Dist>0.6</Dist> <Time>0:02</Time> <InterCh>+ X 46B US-1</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S US-1</Direction> <Dist>6.0</Dist> <Time>0:05</Time> <InterCh>+ US-1 Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-276</Direction> <Dist>24.8</Dist> <Time>0:23</Time> <InterCh>+ I-276 I-76</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-76</Direction> <Dist>251.5</Dist> <Time>3:52</Time> <InterCh>+ I-76 X 75</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 75</Direction> <Dist>0.6</Dist> <Time>0:02</Time> <InterCh>+ X 75 I-70</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-70</Direction> <Dist>39.5</Dist> <Time>0:37</Time> <InterCh>+ I-70 </InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-70</Direction> <Dist>27.0</Dist> <Time>0:25</Time> <InterCh>+ I-70 X 5A</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BL X 5A</Direction> <Dist>0.0</Dist> <Time>0:00</Time> <InterCh>+ X 5A I-470</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-470</Direction> <Dist>10.5</Dist> <Time>0:10</Time> <InterCh>+ I-470 Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-70</Direction> <Dist>32.4</Dist> <Time>0:30</Time> <InterCh>+ I-70 </InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-70</Direction> <Dist>145.1</Dist> <Time>2:15</Time> <InterCh>+ I-70 US-40</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-70</Direction> <Dist>17.1</Dist> <Time>0:16</Time> <InterCh>+ I-70 OH-4</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-70</Direction> <Dist>31.4</Dist> <Time>0:29</Time> <InterCh>+ I-70 OH-49</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-70</Direction> <Dist>58.9</Dist> <Time>0:54</Time> <InterCh>+ I-70 X 90</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 90</Direction> <Dist>0.3</Dist> <Time>0:01</Time> <InterCh>+ X 90 Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S I-465</Direction> <Dist>17.6</Dist> <Time>0:16</Time> <InterCh>+ I-465 X 9</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 9</Direction> <Dist>1.0</Dist> <Time>0:03</Time> <InterCh>+ X 9 I-70</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-70</Direction> <Dist>74.0</Dist> <Time>1:08</Time> <InterCh>+ I-70 </InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-70</Direction> <Dist>61.7</Dist> <Time>0:57</Time> <InterCh>+ I-70 I-70</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-70</Direction> <Dist>76.7</Dist> <Time>1:11</Time> <InterCh>+ I-70 Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S I-55</Direction> <Dist>8.1</Dist> <Time>0:07</Time> <InterCh>+ I-55 X 10</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 10</Direction> <Dist>1.4</Dist> <Time>0:04</Time> <InterCh>+ X 10 I-255</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S I-255</Direction> <Dist>17.5</Dist> <Time>0:16</Time> <InterCh>+ I-255 </InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S I-255</Direction> <Dist>5.4</Dist> <Time>0:05</Time> <InterCh>+ I-255 IL-3</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-255</Direction> <Dist>1.2</Dist> <Time>0:01</Time> <InterCh>+ I-255 I-270</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>N I-270</Direction> <Dist>5.8</Dist> <Time>0:05</Time> <InterCh>+ I-270 X 5B</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 5B</Direction> <Dist>0.7</Dist> <Time>0:02</Time> <InterCh>+ X 5B I-44</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-44</Direction> <Dist>28.6</Dist> <Time>0:25</Time> <InterCh>+ I-44 </InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-44</Direction> <Dist>234.5</Dist> <Time>3:27</Time> <InterCh>+ I-44 US-50</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-44</Direction> <Dist>8.2</Dist> <Time>0:07</Time> <InterCh>+ I-44 I-49</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-44</Direction> <Dist>91.7</Dist> <Time>1:21</Time> <InterCh>+ I-44 X 34</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 34</Direction> <Dist>0.6</Dist> <Time>0:02</Time> <InterCh>+ X 34 I-44</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-44</Direction> <Dist>4.6</Dist> <Time>0:04</Time> <InterCh>+ I-44 </InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-44</Direction> <Dist>15.3</Dist> <Time>0:13</Time> <InterCh>+ I-44 US-412</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-44</Direction> <Dist>86.2</Dist> <Time>1:16</Time> <InterCh>+ I-44 Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S I-35</Direction> <Dist>4.1</Dist> <Time>0:04</Time> <InterCh>+ I-35 X 133</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 133</Direction> <Dist>0.1</Dist> <Time>0:00</Time> <InterCh>+ X 133 I-44</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-44</Direction> <Dist>7.7</Dist> <Time>0:07</Time> <InterCh>+ I-44 Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-44</Direction> <Dist>2.9</Dist> <Time>0:03</Time> <InterCh>+ I-44 X 120A</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 120A</Direction> <Dist>0.2</Dist> <Time>0:01</Time> <InterCh>+ X 120A I-40</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>31.0</Dist> <Time>0:27</Time> <InterCh>+ I-40 </InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>82.2</Dist> <Time>1:13</Time> <InterCh>+ I-40 US-270</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>88.6</Dist> <Time>1:18</Time> <InterCh>+ I-40 OK-34</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>23.2</Dist> <Time>0:20</Time> <InterCh>+ I-40 TX-70</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>12.5</Dist> <Time>0:11</Time> <InterCh>+ I-40 Old US-66</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>14.9</Dist> <Time>0:13</Time> <InterCh>+ I-40 Old US-66</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>79.7</Dist> <Time>1:10</Time> <InterCh>+ I-40 I-40</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>86.9</Dist> <Time>1:17</Time> <InterCh>+ I-40 </InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>20.4</Dist> <Time>0:18</Time> <InterCh>+ I-40 US-54</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>328.2</Dist> <Time>4:50</Time> <InterCh>+ I-40 US-84</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>41.5</Dist> <Time>0:37</Time> <InterCh>+ I-40 AZ-77</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>44.2</Dist> <Time>0:39</Time> <InterCh>+ I-40 AZ-99</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>152.2</Dist> <Time>2:14</Time> <InterCh>+ I-40 US-180</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>53.8</Dist> <Time>0:49</Time> <InterCh>+ I-40 Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>Str Needles Inspection Station</Direction> <Dist>0.0</Dist> <Time>0:00</Time> <InterCh>+ Needles Inspection Station </InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BL Local roads</Direction> <Dist>0.2</Dist> <Time>0:00</Time> <InterCh>+ Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>16.5</Dist> <Time>0:18</Time> <InterCh>+ I-40 </InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W I-40</Direction> <Dist>132.3</Dist> <Time>2:24</Time> <InterCh>+ I-40 I-15</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S I-15</Direction> <Dist>58.6</Dist> <Time>1:04</Time> <InterCh>+ I-15 I-15</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S I-15</Direction> <Dist>7.8</Dist> <Time>0:09</Time> <InterCh>+ I-15 X 115A</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 115A</Direction> <Dist>1.1</Dist> <Time>0:03</Time> <InterCh>+ X 115A CA-210</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W CA-210</Direction> <Dist>37.6</Dist> <Time>0:41</Time> <InterCh>+ CA-210 CA-134</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W CA-134</Direction> <Dist>4.6</Dist> <Time>0:05</Time> <InterCh>+ CA-134 Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>S CA-2</Direction> <Dist>5.5</Dist> <Time>0:07</Time> <InterCh>+ CA-2 Ramp</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>N US-101</Direction> <Dist>2.4</Dist> <Time>0:03</Time> <InterCh>+ US-101 X 7</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>BR X 7</Direction> <Dist>0.2</Dist> <Time>0:00</Time> <InterCh>+ X 7 CA-2</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>W CA-2</Direction> <Dist>6.0</Dist> <Time>0:09</Time> <InterCh>+ CA-2 N Beverly Dr</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>R N Beverly Dr</Direction> <Dist>0.7</Dist> <Time>0:01</Time> <InterCh>+ N Beverly Dr Local</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> <DirectionsReportLine> <Warn i:nil="true" /> <Direction>L Local</Direction> <Dist>0.1</Dist> <Time>0:00</Time> <InterCh>Beverly Hills, CA, Beverly Hills, CA 90210</InterCh> <Delay i:nil="true" /> </DirectionsReportLine> </ReportLines> <Dest> <Address> <StreetAddress> <City>Beverly Hills</City> <State>CA</State> <Zip>90210</Zip> <County>Los Angeles</County> <Country>United States</Country> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>California</StateName> <StateAbbreviation>CA</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>34.079799</Lat> <Lon>-118.412935</Lon> </Coords> <Region>NA</Region> <Label>Beverly Hills, CA</Label> <PlaceName>Beverly Hills, CA</PlaceName> <TimeZone>PDT</TimeZone> <Errors> </Dest> </DirectionsReportLeg> </ReportLegs> </Report> <Report i:type="MileageReport"> <RouteID>Test Route</RouteID> <ReportLines> <StopReportLine> <Stop> <Address> <StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County>Mercer</County> <Country>United States</Country> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.348727</Lat> <Lon>-74.659049</Lon> </Coords> <Region>NA</Region> <Label>Princeton, NJ</Label> <PlaceName>Princeton, NJ</PlaceName> <TimeZone>EDT</TimeZone> <Errors> </Stop> <LMiles>0.0</LMiles> <TMiles>0.0</TMiles> <LCostMile>0.00</LCostMile> <TCostMile>0.00</TCostMile> <LHours>0:00</LHours> <THours>0:00</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <LEstghg>0.0</LEstghg> <TEstghg>0.0</TEstghg> <EtaEtd i:nil="true" /> </StopReportLine> <StopReportLine> <Stop> <Address> <StreetAddress> <City>Beverly Hills</City> <State>CA</State> <Zip>90210</Zip> <County>Los Angeles</County> <Country>United States</Country> <SPLC i:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>California</StateName> <StateAbbreviation>CA</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>34.079799</Lat> <Lon>-118.412935</Lon> </Coords> <Region>NA</Region> <Label>Beverly Hills, CA</Label> <PlaceName>Beverly Hills, CA</PlaceName> <TimeZone>PDT</TimeZone> <Errors> </Stop> <LMiles>2758.5</LMiles> <TMiles>2758.5</TMiles> <LCostMile>3558.74</LCostMile> <TCostMile>3558.74</TCostMile> <LHours>42:43</LHours> <THours>42:43</THours> <LTolls>30.22</LTolls> <TTolls>30.22</TTolls> <LEstghg>9450.5</LEstghg> <TEstghg>9450.5</TEstghg> <EtaEtd i:nil="true" /> </StopReportLine> </ReportLines> <TrafficDataUsed>false</TrafficDataUsed> </Report> </Reports> </Body> </GetReportsResult> </GetReportsResponse> </s:Body> </s:Envelope>
◆ GetRoutePoints()
| RoutePointsResponse GetRoutePoints | ( | RoutePointsRequest | Request | ) |
The GetRoutePoints operation allows user to run a route based on location and options, and retrieve the coordinates that make up the route path.
Only one route is currently supported due to amount of data returned. If multiple routes are supplied, they will be ignored.
- Parameters
-
Request The RoutePointsRequest contains the origins, destinations, intermediate stops, and various routing options. See ALK.PCM.Model.ServiceModels.RoutePointsRequest.
Example:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:v1="http://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/> </alk:AuthHeader> </soapenv:Header> <soapenv:Body> <v1:GetRoutePoints> <v1:Request> <v1:Header> <v1:DataVersion>pcm_na</v1:DataVersion> <v1:RequestType>route points example</v1:RequestType> </v1:Header> <v1:Body> <v1:Routes> <v1:ExtendedRoute> <v1:RouteId>MyRoute</v1:RouteId> <v1:Stops> <v1:StopLocation> <v1:Address> <v1:StreetAddress>1 Independence Way</v1:StreetAddress> <v1:City>Princeton</v1:City> <v1:State>NJ</v1:State> <v1:Zip>08540</v1:Zip> <v1:County/> <v1:Country/> <v1:SPLC/> <v1:CountryPostalFilter>US</v1:CountryPostalFilter> <v1:AbbreviationFormat>FIPS</v1:AbbreviationFormat> </v1:Address> <v1:Coords/> <v1:Region>NA</v1:Region> <v1:Label>Origin</v1:Label> <v1:PlaceName/> </v1:StopLocation> <v1:StopLocation> <v1:Address/> <v1:Coords> <v1:Lat>40.367274</v1:Lat> <v1:Lon>-74.655365</v1:Lon> </v1:Coords> <v1:Region>NA</v1:Region> <v1:Label>Destination</v1:Label> <v1:PlaceName/> </v1:StopLocation> </v1:Stops> <v1:Options> <v1:RoutingType>Shortest</v1:RoutingType> <v1:TollDiscourage>true</v1:TollDiscourage> </v1:Options> <v1:ExtendedOptions> <v1:EstimatedTimeOptions> <v1:ETAETD>Depart</v1:ETAETD> <v1:DateOption>Specific</v1:DateOption> <v1:DateAndTime> <v1:CalendarDate>5/24/2018</v1:CalendarDate> <v1:TimeOfDay>8:00 am</v1:TimeOfDay> <v1:TimeZone>Eastern</v1:TimeZone> </v1:DateAndTime> </v1:EstimatedTimeOptions> <v1:TruckStyle>FiftyThreeSemiTrailer</v1:TruckStyle> <v1:UseTraffic>true</v1:UseTraffic> </v1:ExtendedOptions> </v1:ExtendedRoute> </v1:Routes> <v1:ReduceResponsePoints>false</v1:ReduceResponsePoints> </v1:Body> </v1:Request> </v1:GetRoutePoints> </soapenv:Body> </soapenv:Envelope>
- Returns
- The GetRoutePoints operation will return the coordinates of the route path. See ALK.PCM.Model.ServiceModels.RoutePointsResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetRoutePointsResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <GetRoutePointsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>route points example</Type> <Success>true</Success> <DataVersion>32.0.25.2830</DataVersion> <Errors> </Header> <Body> <RoutePoints> <ArrayOfCoordinates> <Coordinates> <Lat>40.360399</Lat> <Lon>-74.59927</Lon> </Coordinates> <Coordinates> <Lat>40.361646</Lat> <Lon>-74.601519</Lon> </Coordinates> <Coordinates> <Lat>40.357852</Lat> <Lon>-74.606119</Lon> </Coordinates> <Coordinates> <Lat>40.356573</Lat> <Lon>-74.607668</Lon> </Coordinates> <Coordinates> <Lat>40.349954</Lat> <Lon>-74.615748</Lon> </Coordinates> <Coordinates> <Lat>40.348289</Lat> <Lon>-74.617771</Lon> </Coordinates> <Coordinates> <Lat>40.343748</Lat> <Lon>-74.623286</Lon> </Coordinates> <Coordinates> <Lat>40.34195</Lat> <Lon>-74.625475</Lon> </Coordinates> <Coordinates> <Lat>40.341731</Lat> <Lon>-74.62575</Lon> </Coordinates> <Coordinates> <Lat>40.338949</Lat> <Lon>-74.629127</Lon> </Coordinates> <Coordinates> <Lat>40.338621</Lat> <Lon>-74.629514</Lon> </Coordinates> <Coordinates> <Lat>40.3374</Lat> <Lon>-74.630982</Lon> </Coordinates> <Coordinates> <Lat>40.338087</Lat> <Lon>-74.632051</Lon> </Coordinates> <Coordinates> <Lat>40.338989</Lat> <Lon>-74.6325</Lon> </Coordinates> <Coordinates> <Lat>40.339777</Lat> <Lon>-74.633133</Lon> </Coordinates> <Coordinates> <Lat>40.341238</Lat> <Lon>-74.635552</Lon> </Coordinates> <Coordinates> <Lat>40.341935</Lat> <Lon>-74.637153</Lon> </Coordinates> <Coordinates> <Lat>40.343124</Lat> <Lon>-74.637611</Lon> </Coordinates> <Coordinates> <Lat>40.343875</Lat> <Lon>-74.63791</Lon> </Coordinates> <Coordinates> <Lat>40.345461</Lat> <Lon>-74.639041</Lon> </Coordinates> <Coordinates> <Lat>40.350534</Lat> <Lon>-74.642887</Lon> </Coordinates> <Coordinates> <Lat>40.353977</Lat> <Lon>-74.645503</Lon> </Coordinates> <Coordinates> <Lat>40.355497</Lat> <Lon>-74.646775</Lon> </Coordinates> <Coordinates> <Lat>40.360182</Lat> <Lon>-74.650278</Lon> </Coordinates> <Coordinates> <Lat>40.361386</Lat> <Lon>-74.651001</Lon> </Coordinates> <Coordinates> <Lat>40.362028</Lat> <Lon>-74.651478</Lon> </Coordinates> <Coordinates> <Lat>40.365854</Lat> <Lon>-74.654265</Lon> </Coordinates> <Coordinates> <Lat>40.367071</Lat> <Lon>-74.655274</Lon> </Coordinates> <Coordinates> <Lat>40.367245</Lat> <Lon>-74.65541</Lon> </Coordinates> <Coordinates> <Lat>40.367274</Lat> <Lon>-74.655365</Lon> </Coordinates> </ArrayOfCoordinates> </RoutePoints> <TMinutes>15</TMinutes> <TDistance>4.926</TDistance> <PLIDs i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <VehicleRestrictedRoutePoints> <ArrayOfCoordinates> <Coordinates> <Lat>40.360399</Lat> <Lon>-74.59927</Lon> </Coordinates> <Coordinates> <Lat>40.361646</Lat> <Lon>-74.601519</Lon> </Coordinates> </ArrayOfCoordinates> </VehicleRestrictedRoutePoints> </Body> </GetRoutePointsResult> </GetRoutePointsResponse> </s:Body> </s:Envelope>
◆ GetReportsLegacy()
| ReportResponseLegacy GetReportsLegacy | ( | ReportRequestLegacy | Request | ) |
The GetReportsLegacy operation allows a user to run a collection of routes based on input locations, routing and reporting options, with the requested type of reports. This request is SAP compliant in that each input route is made up of a ALK.PCM.Model.BusinessModels.ReportRouteLegacy object which has a separate property for each kind of report desired. This is unlike the standard ALK.PCMWS.Common.Model.BusinessModels.ReportRoute which takes a collection of the base class ALK.PCMWS.Common.Model.BusinessModels.ReportType and expects an inherited type for each report. The collection of base report types causes problems with SAP and this method gets around the issue.
- Parameters
-
Request The ReportRequestLegacy contains the origins, destinations, intermediate stops, and various routing options. See ALK.PCM.Model.ServiceModels.ReportRequestLegacy.
Example:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:v1="http://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, 13 Sep 2016 20:16:52 GMT</alk:Date> </alk:AuthHeader> </soapenv:Header> <soapenv:Body> <v1:GetReportsLegacy> <v1:Request> <v1:Header> <v1:DataVersion>Current</v1:DataVersion> <v1:RequestType>SAP Compliant Test</v1:RequestType> </v1:Header> <v1:Body> <v1:ReportRoutesLegacy> <v1:ReportRouteLegacy> <v1:RouteId>test</v1:RouteId> <v1:Stops> <v1:StopLocation> <v1:Address> <v1:Zip>19123</v1:Zip> </v1:Address> <v1:Region>NA</v1:Region> </v1:StopLocation> <v1:StopLocation> <v1:Address> <v1:Zip>08540</v1:Zip> </v1:Address> <v1:Region>NA</v1:Region> </v1:StopLocation> </v1:Stops> <v1:MileageReportRequest> <v1:THoursWithSeconds>true</v1:THoursWithSeconds> </v1:MileageReportRequest> </v1:ReportRouteLegacy> </v1:ReportRoutesLegacy> </v1:Body> </v1:Request> </v1:GetReportsLegacy> </soapenv:Body> </soapenv:Envelope>
- Returns
- Returns the desired reports for each of the input routes. Note that the ALK.PCM.Model.BusinessModels.ReportRouteLegacy object which is returned for each route will contain a property for each possible report type, but it will only have a value if that report type was requested. See ALK.PCM.Model.ServiceModels.ReportResponseLegacy.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetReportsLegacyResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <GetReportsLegacyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>SAP Compliant Test</Type> <Success>true</Success> <DataVersion>31.3.42.6662</DataVersion> <Errors> </Header> <Body> <MileageReportsResponse> <MileageReport> <RouteID>test</RouteID> <ReportLines> <StopReportLine> <Stop> <Address> <StreetAddress> <City>Philadelphia</City> <State>PA</State> <Zip>19123</Zip> <County>Philadelphia</County> <Country>United States</Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Pennsylvania</StateName> <StateAbbreviation>PA</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.965177</Lat> <Lon>-75.152564</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EST</TimeZone> <Errors> <SpeedLimitInfo i:nil="true"/> <ConfidenceLevel>Exact</ConfidenceLevel> <DistanceFromRoad i:nil="true"/> <CrossStreet i:nil="true"/> </Stop> <LMiles>0.000</LMiles> <TMiles>0.000</TMiles> <LCostMile>0.00</LCostMile> <TCostMile>0.00</TCostMile> <LHours>0:00</LHours> <THours>0:00:00</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <LEstghg>0.0</LEstghg> <TEstghg>0.0</TEstghg> <EtaEtd i:nil="true"/> </StopReportLine> <StopReportLine> <Stop> <Address> <StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County>Mercer</County> <Country>United States</Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.354907</Lat> <Lon>-74.645014</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EST</TimeZone> <Errors> <SpeedLimitInfo i:nil="true"/> <ConfidenceLevel>Exact</ConfidenceLevel> <DistanceFromRoad i:nil="true"/> <CrossStreet i:nil="true"/> </Stop> <LMiles>45.528</LMiles> <TMiles>45.528</TMiles> <LCostMile>63.40</LCostMile> <TCostMile>63.40</TCostMile> <LHours>0:56</LHours> <THours>0:56:06</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <LEstghg>156.0</LEstghg> <TEstghg>156.0</TEstghg> <EtaEtd i:nil="true"/> </StopReportLine> </ReportLines> <TrafficDataUsed>false</TrafficDataUsed> </MileageReport> </MileageReportsResponse> <DetailReportsResponse> <DirectionsReportsResponse> <RoadReportsResponse> <StateReportsResponse> <LeastCostReportsResponse> <GeoTunnelReportsResponse> <WeatherAlertsReportsResponse> <CalculateMilesReportsResponse> </Body> </GetReportsLegacyResult> </GetReportsLegacyResponse> </s:Body> </s:Envelope>
◆ CreateRouteSyncMessage()
| CreateRouteSyncMsgResponse CreateRouteSyncMessage | ( | CreateRouteSyncMsgRequest | Request | ) |
Creates a RouteSync message body given a route.
- Parameters
-
Request The Request containing the route and desired routing options needed to build the route sync message body. See ALK.PCM.Model.ServiceModels.CreateRouteSyncMsgRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <h:AuthHeader xmlns="http://www.alk.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="http://www.alk.com"> <Authorization>YOUR API KEY HERE</Authorization> <Date>Thu, 21 Aug 2014 16:23:26 GMT</Date> </h:AuthHeader> </s:Header> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <CreateRouteSyncMessage xmlns="http://pcmiler.alk.com/APIs/v1.0"> <Request> <Header> <DataVersion>current</DataVersion> <RequestType>CreateRouteSyncMessage</RequestType> </Header> <Body> <Compliance>Moderate</Compliance> <IsFirstLegManaged>true</IsFirstLegManaged> <ManagedRoute> <RouteId>routeSync</RouteId> <Stops> <StopLocation> <Address> <StreetAddress xsi:nil="true" /> <City xsi:nil="true" /> <State xsi:nil="true" /> <Zip>19123</Zip> <County xsi:nil="true" /> <Country xsi:nil="true" /> <SPLC xsi:nil="true" /> </Address> <Coords xsi:nil="true" /> <Region>NA</Region> <Label xsi:nil="true" /> <PlaceName xsi:nil="true" /> <Costs xsi:nil="true" /> </StopLocation> <StopLocation> <Address> <StreetAddress xsi:nil="true" /> <City xsi:nil="true" /> <State xsi:nil="true" /> <Zip>08540</Zip> <County xsi:nil="true" /> <Country xsi:nil="true" /> <SPLC xsi:nil="true" /> </Address> <Coords xsi:nil="true" /> <Region>NA</Region> <Label xsi:nil="true" /> <PlaceName xsi:nil="true" /> <Costs xsi:nil="true" /> </StopLocation> </Stops> <Options> <BordersOpen>true</BordersOpen> <HighwayOnly>true</HighwayOnly> <TruckCfg xsi:nil="true" /> </Options> <FuelOptions xsi:nil="true" /> <AFOptions xsi:nil="true" /> </ManagedRoute> </Body> </Request> </CreateRouteSyncMessage> </s:Body> </s:Envelope>
- Returns
- The RouteSync message body bytes. See ALK.PCM.Model.ServiceModels.CreateRouteSyncMsgResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header /> <s:Body> <CreateRouteSyncMessageResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <CreateRouteSyncMessageResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>CreateRouteSyncMessage</Type> <Success>true</Success> <DataVersion>28.0.24.5492</DataVersion> <Errors> </Header> <Body> <MessageBytes>ACAA8f//////////AAAAANUFAAAUAFRNYW5hZ2VkUm91dGVEYXRhX3YyAAAAALz+5UEBABAAAAAAAIWdMwoBAIwOAAAAAIs25AkBAHwOAAAAAKmphw4BANAAAAAAALsWvMoCACwAAAAAAOWtCCYBAAgAAAAAALsWvMoCACwAAAAAAOWJpTQBABAAAAAAAIn5GhQBACAAAAAAALsWvMoCACwAAAAAAIn5GhQBACAAAAAAALsWvMoCACwAAAAAAIn5GhQBACAAAAAAALK/N1YCAMgEAAAAALsWvMoCACwAAAAAALK/N1YCAMgEAAAAAIn5GhQBACwAAAAAAIn5GhQBACwAAAAAAKHcmisBAAgACQAAAP//////////AABTCgAAAAEIAAAAAAwOAAC6BAAACAAAAAAAtdZ9TFV1GAfw330uKAiJXpmAVxFNVEyRVwFx8mo2inYt1LZqec7lHLiNRG6YuXxtneO9wMo2e9NAt+ZwmhmzdOlW9iY4X8hcpuV8WZlZxir7R5/p7Xc4XxAoV636sed89jw75/ec8+N3zq4QQjgi5EE8KmOOuDUcMpwyCLkThsFwOAgOhhEwEg6BUZgzFXk0vAP1oTAG9WFwOOou5COQx+LeRqIeB+NhAs4bhdwNR8NZcIyMXTISkY+VcTMUCpVg/iQZa2STcdIDchHGSyvkQ98pLZQnT5DK00PJ6DcR80yCk2W8LCMF+RTrWWVyF/KpcJqw13Q68jTMly7sNc9APVNG7kYhsqQRctGz4QzpzyfCRA7MtebwOkWe9Qw3hJgJZ2OeAlgIi2AxLEV/a0+EZNyN+lzUrWHvnAjc4RDxYL3ir0+q8PuWWP/HBVq1z1ujJXn8tbqvRrNOKteeqLW2QqmmK0tr6q0zSdxfhImsLWFtm8qecatHNGLAmY6iommJMQmJrr9bz89PccfEuYf9X/Xb9B3SMwbUnT0D9d7xp+kfu/zl+uTkJMbGxMQO7PuP6xkZblfMUFfkv63fZv7/eH16u1hJ94fKOlDfCxz2BZ5qX41SqdUsqfYpJDxF/SvhIj0vPSPzvhKDrx1XyJog+inXolCfcVnYr3/PuC76j7L4wAjrz2nt8s8H062Xp/cuIoXH71vs1eprF8uXoWyQfEv8Xs0fLtJys7PS4g43cc6bVXbzGVGLesJqtkBev1BGmcO+iTJhf2taMH9jvCEv69fc0We9rEOfu0G1AOEuNvjCxwo9V2HwjY8U+uUZg795X6F5KwxO2aPQ/OUGx7Up9NlSgxNbFVruN/iSNFBncGCvQjeeNLjrgEL5ywyuOKTQBHndlk6FmkyDJ36pUPOrBl88o1D7GwavPa+Q/z2DqUuhxZ8Y3HZVoezvDNbCVRpzzeDOKJUOO0w+O1SlnYNMjh6u0tZIkzWXSnkjTZ4ar9KVBJPPJagUNtnk55NUWlBo8sLpKh0rMbk9U6VL95jsnqXSs/NMvjhXpaUPm/zCfJXufdzkST6VfvObPKdOpbErTe5YptLqV0yuXa1Sa4vJ29eqtGuHyeUBleJK1/Gqkyq9tXUd30zwEk0NcJvPS9vWBvihF73UcDHA4095ad+sIHeEVdLJ0UFe01lJ+x8L8oZ8jS6oQd42W6MILciXCjWqWxnkTU0afVgf5CNunVbvD/LlHJ2mnAjy2AKdkr8N8qm5OlFXkJvLdTpf3MA/Nut09WgDbzqo0/KzDdzeodOK2EbefVSnRyob+el9Ou3e0sjH9+j0685Gdkk3v9vInW06uWX+wTs6ZaU1cVlxFV17u4kdrVWUvLeJw3ZUUf/dUIiQ+94T7mgfZxkJT5PtF/Ak7II/wXOwEx6BR+Ex+BLcAFvhdtgMX4ctcDOc5LSdDFPgROgSluTJJ9uZMAtmwgyYBtNhDsyFed2K9VecttnCNstyhli/02m7C34KD8J22AEfCLMth+dRPwdPw6/g1/AM/B5ehj/AK/A6ZBiCI9AvAY7qNsqz0mG7Sjrgs9b93YgUeanpGanpWanyR4lj42vWOFTwOw==</MessageBytes> </Body> </CreateRouteSyncMessageResult> </CreateRouteSyncMessageResponse> </s:Body> </s:Envelope>
◆ CreateTripInsightMessage()
| CreateTripInsightMsgResponse CreateTripInsightMessage | ( | CreateTripInsightMsgRequest | request | ) |
Creates a TripInsight message body given a route.
- Parameters
-
request The request containing the route and other properties needed to build the message.
- Returns
- The TripInsight message body bytes.
This operation is for internal use only.
◆ GenerateDriveTimePolygon()
| DriveTimePolygonResponse GenerateDriveTimePolygon | ( | DriveTimePolygonRequest | Request | ) |
Generate a polygon of possible travel location within a given time.
- Parameters
-
Request The Request containing the center point, number of minutes and routing options See ALK.PCM.Model.ServiceModels.DriveTimePolygonRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <h:AuthHeader xmlns="http://www.alk.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="http://www.alk.com"> <Authorization>YOUR API KEY HERE</Authorization> <Date>Tue, 24 Feb 2015 21:34:46 GMT</Date> </h:AuthHeader> </s:Header> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <GenerateDriveTimePolygon xmlns="http://pcmiler.alk.com/APIs/v1.0"> <Request> <Header> <DataVersion>current</DataVersion> <RequestType>DriveTimePolygonRequest</RequestType> </Header> <Body> <Center> <Lat>42149700</Lat> <Lon>-74938400</Lon> </Center> <Minutes>10</Minutes> <RouteOptions> <HighwayOnly>true</HighwayOnly> <TollDiscourage>true</TollDiscourage> <TruckCfg xsi:nil="true" /> </RouteOptions> <Region>NA</Region> </Body> </Request> </GenerateDriveTimePolygon></s:Body> </s:Envelope>
- Returns
- The collection of coordinates that makes up the polygon. See ALK.PCM.Model.ServiceModels.DriveTimePolygonRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header /> <s:Body> <GenerateDriveTimePolygonResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <GenerateDriveTimePolygonResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>DriveTimePolygonRequest</Type> <Success>true</Success> <DataVersion>28.3.26.9224</DataVersion> <Errors> </Header> <Body> <PolygonPoints> <Coordinates> <Lat>42.167703</Lat> <Lon>-75.128571</Lon> </Coordinates> <Coordinates> <Lat>42.167703</Lat> <Lon>-75.128571</Lon> </Coordinates> <Coordinates> <Lat>42.167703</Lat> <Lon>-75.128571</Lon> </Coordinates> <Coordinates> <Lat>42.167703</Lat> <Lon>-75.128571</Lon> </Coordinates> </PolygonPoints> </Body> </GenerateDriveTimePolygonResult> </GenerateDriveTimePolygonResponse> </s:Body> </s:Envelope></s:Envelope>
◆ GetPoisAlongRoute()
| PoisAlongRouteResponse GetPoisAlongRoute | ( | PoisAlongRouteRequest | Request | ) |
This operation finds POIs (Places of Interest) along a given leg of a route.
- Parameters
-
Request The Request containing the route to run, the route leg index to search and the type of POI search and associated POI categories. See ALK.PCM.Model.ServiceModels.PoisAlongRouteRequest.
Example:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:v1="http://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> <v1:Request> <v1:Header> <v1:DataVersion/> <v1:RequestType/> </v1:Header> <v1:Body> <v1:PoiRoute> <v1:RouteId>PrincetonToMiami</v1:RouteId> <v1:Stops> <v1:StopLocation> <v1:Address> <v1:StreetAddress/> <v1:City/> <v1:State/> <v1:Zip>08540</v1:Zip> <v1:County/> <v1:Country/> <v1:SPLC/> </v1:Address> <v1:Region>NA</v1:Region> <v1:Label/> <v1:PlaceName/> </v1:StopLocation> <v1:StopLocation> <v1:Address> <v1:StreetAddress/> <v1:City>Charleston</v1:City> <v1:State>SC</v1:State> <v1:Zip/> <v1:County/> <v1:Country/> <v1:SPLC/> </v1:Address> <v1:Region>NA</v1:Region> <v1:Label/> <v1:PlaceName/> </v1:StopLocation> <v1:StopLocation> <v1:Address> <v1:StreetAddress/> <v1:City>Miami</v1:City> <v1:State>FL</v1:State> <v1:Zip/> <v1:County/> <v1:Country/> <v1:SPLC/> </v1:Address> <v1:Region>NA</v1:Region> <v1:Label/> <v1:PlaceName/> </v1:StopLocation> </v1:Stops> <v1:Options> <v1:HighwayOnly>false</v1:HighwayOnly> </v1:Options> </v1:PoiRoute> <v1:RouteLegIndex>0</v1:RouteLegIndex> <v1:SearchType>HoS</v1:SearchType> <v1:HoSPOICategories> <v1:POIHosType>All</v1:POIHosType> </v1:HoSPOICategories> <v1:SearchWindowUnits>Minutes</v1:SearchWindowUnits> <v1:SearchWindowStart>50</v1:SearchWindowStart> <v1:SearchWindowEnd>150</v1:SearchWindowEnd> <v1:AirDistanceThreshold>2.0</v1:AirDistanceThreshold> </v1:Body> </v1:Request> </v1:GetPoisAlongRoute> </soapenv:Body> </soapenv:Envelope>
- Returns
- Returns a collection of POIs along the route in the given search window. See ALK.PCM.Model.ServiceModels.PoisAlongRouteResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetPoisAlongRouteResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <GetPoisAlongRouteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type> <Success>true</Success> <DataVersion>31.3.42.6662</DataVersion> <Errors> </Header> <Body> <POISearchMatches> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>3670 Richmond St</StreetAddress> <City>Philadelphia</City> <State>PA</State> <Zip>19134</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Pennsylvania</StateName> <StateAbbreviation>PA</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.989182</Lat> <Lon>-75.090001</Lon> </Coords> <Region>NA</Region> <Label>Sunoco</Label> <PlaceName>Sunoco</PlaceName> </POILocation> <DistanceFromOrigin> <Value>40.682</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Truck Services (HOS)</POICategory> <TimeFromOrigin>00:52:00</TimeFromOrigin> <DistanceOffRoute> <Value>0.942</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>59 E Oregon Ave</StreetAddress> <City>Philadelphia</City> <State>PA</State> <Zip>19148</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Pennsylvania</StateName> <StateAbbreviation>PA</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.914303</Lat> <Lon>-75.149458</Lon> </Coords> <Region>NA</Region> <Label>Sunoco 'A' Plus</Label> <PlaceName>Sunoco 'A' Plus</PlaceName> </POILocation> <DistanceFromOrigin> <Value>47.136</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Truck Services (HOS)</POICategory> <TimeFromOrigin>00:56:00</TimeFromOrigin> <DistanceOffRoute> <Value>0.753</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>2200 W 2nd St</StreetAddress> <City>Chester</City> <State>PA</State> <Zip>19013</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Pennsylvania</StateName> <StateAbbreviation>PA</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.834095</Lat> <Lon>-75.384100</Lon> </Coords> <Region>NA</Region> <Label>B & S Sunoco</Label> <PlaceName>B & S Sunoco</PlaceName> </POILocation> <DistanceFromOrigin> <Value>62.762</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Truck Services (HOS)</POICategory> <TimeFromOrigin>01:12:00</TimeFromOrigin> <DistanceOffRoute> <Value>3.027</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress> <City>Boothwyn</City> <State>PA</State> <Zip>19061</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Pennsylvania</StateName> <StateAbbreviation>PA</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.823997</Lat> <Lon>-75.437452</Lon> </Coords> <Region>NA</Region> <Label>Pennsylvania Welcome Center, I-95 North</Label> <PlaceName>Pennsylvania Welcome Center, I-95 North</PlaceName> </POILocation> <DistanceFromOrigin> <Value>66.968</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Rest Area (HOS)</POICategory> <TimeFromOrigin>01:16:00</TimeFromOrigin> <DistanceOffRoute> <Value>3.642</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>520 Terminal Ave</StreetAddress> <City>New Castle</City> <State>DE</State> <Zip>19720</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Delaware</StateName> <StateAbbreviation>DE</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.719558</Lat> <Lon>-75.538246</Lon> </Coords> <Region>NA</Region> <Label>Christiana Truck Stop</Label> <PlaceName>Christiana Truck Stop</PlaceName> </POILocation> <DistanceFromOrigin> <Value>74.48</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Truck Services (HOS)</POICategory> <TimeFromOrigin>01:23:00</TimeFromOrigin> <DistanceOffRoute> <Value>0.457</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>530 JFK Memorial Hwy</StreetAddress> <City>Newark</City> <State>DE</State> <Zip>19711</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Delaware</StateName> <StateAbbreviation>DE</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.661736</Lat> <Lon>-75.691708</Lon> </Coords> <Region>NA</Region> <Label>Delaware House Service Plaza, I-95 North/South</Label> <PlaceName>Delaware House Service Plaza, I-95 North/South</PlaceName> </POILocation> <DistanceFromOrigin> <Value>83.692</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Rest Area (HOS)</POICategory> <TimeFromOrigin>01:33:00</TimeFromOrigin> <DistanceOffRoute> <Value>0.744</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>1400 Elkton Rd.</StreetAddress> <City>Elkton</City> <State>MD</State> <Zip>21921</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Maryland</StateName> <StateAbbreviation>MD</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.644182</Lat> <Lon>-75.796991</Lon> </Coords> <Region>NA</Region> <Label>TA-Elkton #19</Label> <PlaceName>TA-Elkton #19</PlaceName> </POILocation> <DistanceFromOrigin> <Value>89.982</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Truck Services (HOS)</POICategory> <TimeFromOrigin>01:40:00</TimeFromOrigin> <DistanceOffRoute> <Value>1.224</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>221 Belle Hill Road</StreetAddress> <City>Elkton</City> <State>MD</State> <Zip>21921</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Maryland</StateName> <StateAbbreviation>MD</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.638285</Lat> <Lon>-75.807571</Lon> </Coords> <Region>NA</Region> <Label>Flying J #875</Label> <PlaceName>Flying J #875</PlaceName> </POILocation> <DistanceFromOrigin> <Value>90.452</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Truck Services (HOS)</POICategory> <TimeFromOrigin>01:41:00</TimeFromOrigin> <DistanceOffRoute> <Value>2.069</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>1 Center Drive</StreetAddress> <City>North East</City> <State>MD</State> <Zip>21901</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Maryland</StateName> <StateAbbreviation>MD</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.625329</Lat> <Lon>-75.949376</Lon> </Coords> <Region>NA</Region> <Label>Flying J #784</Label> <PlaceName>Flying J #784</PlaceName> </POILocation> <DistanceFromOrigin> <Value>99.499</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Truck Services (HOS)</POICategory> <TimeFromOrigin>01:51:00</TimeFromOrigin> <DistanceOffRoute> <Value>2.431</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>JFK Memorial Hwy</StreetAddress> <City>North East</City> <State>MD</State> <Zip>21901</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Maryland</StateName> <StateAbbreviation>MD</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.611131</Lat> <Lon>-76.010318</Lon> </Coords> <Region>NA</Region> <Label>Chesapeake House Service Plaza, I-95 North</Label> <PlaceName>Chesapeake House Service Plaza, I-95 North</PlaceName> </POILocation> <DistanceFromOrigin> <Value>101.696</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Rest Area (HOS)</POICategory> <TimeFromOrigin>01:52:00</TimeFromOrigin> <DistanceOffRoute> <Value>0.141</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>31 Heather Ln</StreetAddress> <City>Perryville</City> <State>MD</State> <Zip>21903</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Maryland</StateName> <StateAbbreviation>MD</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.589705</Lat> <Lon>-76.065451</Lon> </Coords> <Region>NA</Region> <Label>Pilot Travel Center #290</Label> <PlaceName>Pilot Travel Center #290</PlaceName> </POILocation> <DistanceFromOrigin> <Value>105.604</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Truck Services (HOS)</POICategory> <TimeFromOrigin>01:57:00</TimeFromOrigin> <DistanceOffRoute> <Value>1.821</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress> <City>Aberdeen</City> <State>MD</State> <Zip>21001</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Maryland</StateName> <StateAbbreviation>MD</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.497891</Lat> <Lon>-76.231462</Lon> </Coords> <Region>NA</Region> <Label>Maryland House Service Plaza, I-95 South</Label> <PlaceName>Maryland House Service Plaza, I-95 South</PlaceName> </POILocation> <DistanceFromOrigin> <Value>116.375</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Rest Area (HOS)</POICategory> <TimeFromOrigin>02:08:00</TimeFromOrigin> <DistanceOffRoute> <Value>0.003</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> <POIAlongRouteMatch> <POILocation> <Address> <StreetAddress>6201 Pulaski Hwy</StreetAddress> <City>Baltimore</City> <State>MD</State> <Zip>21205</Zip> <County> <Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Maryland</StateName> <StateAbbreviation>MD</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>39.302106</Lat> <Lon>-76.543262</Lon> </Coords> <Region>NA</Region> <Label>Royal Farms #169</Label> <PlaceName>Royal Farms #169</PlaceName> </POILocation> <DistanceFromOrigin> <Value>139.649</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceFromOrigin> <POICategory>Truck Services (HOS)</POICategory> <TimeFromOrigin>02:36:00</TimeFromOrigin> <DistanceOffRoute> <Value>3.587</Value> <DistanceUnits>Miles</DistanceUnits> </DistanceOffRoute> </POIAlongRouteMatch> </POISearchMatches> <SearchStartCoordinates> <Lat>39.967694</Lat> <Lon>-75.131928</Lon> </SearchStartCoordinates> <SearchEndCoordinates> <Lat>39.320827</Lat> <Lon>-76.532191</Lon> </SearchEndCoordinates> </Body> </GetPoisAlongRouteResult> </GetPoisAlongRouteResponse> </s:Body> </s:Envelope>
◆ ProcessMap()
| MapRoutesResponse ProcessMap | ( | MapRoutesRequest | Request | ) |
The ProcessMap operation allows the user to request a map image with various elements such as points, geometries, routes, all depending on the supplied input request properties.
- Parameters
-
Request The Request consists of the MapSettings and can also include a collection of MapRoute objects. See ALK.PCM.Model.ServiceModels.MapRoutesRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <h:AuthHeader xmlns="http://www.alk.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:h="http://www.alk.com"> <Authorization>YOUR API KEY HERE</Authorization> <Date>Thu, 21 Aug 2014 16:23:26 GMT</Date> </h:AuthHeader> </s:Header> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ProcessMap xmlns="http://pcmiler.alk.com/APIs/v1.0"> <Request> <Header> <DataVersion>current</DataVersion> <RequestType>MapRoute</RequestType> </Header> <Body> <Map> <Viewport> <Center> <Lat>32.859577</Lat> <Lon>-115.606428</Lon> </Center> <ScreenCenter> <X>594</X> <Y>594</Y> </ScreenCenter> <ZoomRadius>650</ZoomRadius> <CornerA xsi:nil="true" /> <CornerB xsi:nil="true" /> <Region>NA</Region> </Viewport> <Projection>FixedLat</Projection> <Style>Default</Style> <Width>1094</Width> <Height>1094</Height> <Drawers xsi:nil="true" /> <LegendDrawer> <Legend> <Type>ScaleOfMiles</Type> <DrawOnMap>true</DrawOnMap> </Legend> </LegendDrawer> <GeometryDrawer> <Geometry xsi:type="RegionGeometry"> <Color> <Red>200</Red> </Color> <Name>NA</Name> </Geometry> <Geometry xsi:type="ShapeGeometry"> <Color> <Green>200</Green> </Color> <Type>Circle</Type> <Coordinates>34066401,-118466694</Coordinates> <Fill>false</Fill> <RadiusHorizontal>100</RadiusHorizontal> </Geometry> </GeometryDrawer> <PinDrawer> <PointGroupDensity>Average</PointGroupDensity> <PointSpreadInGroup>Average</PointSpreadInGroup> <DrawOnMap>true</DrawOnMap> <Pins> <Pin> <ID>1</ID> <Point> <Lat>34.420831</Lat> <Lon>-119.698190</Lon> </Point> <Image>ltruck_g</Image> <Category xsi:nil="true" /> <Label>point1</Label> </Pin> <Pin> <ID>0</ID> <Point> <Lat>33.448377</Lat> <Lon>-112.074037</Lon> </Point> <Image>ltruck_r</Image> <Category xsi:nil="true" /> <Label>point2</Label> </Pin> </Pins> </PinDrawer> <PinCategories xsi:nil="true" /> <TrafficDrawer xsi:nil="true" /> <MapLayering>MapAndPointsTwoLayers</MapLayering> </Map> <Routes> <MapRoute> <RouteId xsi:nil="true" /> <Stops> <StopLocation> <Address> <StreetAddress xsi:nil="true" /> <City xsi:nil="true" /> <State xsi:nil="true" /> <Zip>93101</Zip> <County xsi:nil="true" /> <Country xsi:nil="true" /> <SPLC xsi:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> </Address> <Coords xsi:nil="true" /> <Region>NA</Region> <Label>Santa Barbara</Label> <PlaceName xsi:nil="true" /> <Costs xsi:nil="true" /> </StopLocation> <StopLocation> <Address> <StreetAddress xsi:nil="true" /> <City>Las Vegas</City> <State>NV</State> <Zip xsi:nil="true" /> <County xsi:nil="true" /> <Country xsi:nil="true" /> <SPLC xsi:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> </Address> <Coords xsi:nil="true" /> <Region>NA</Region> <Label>Las Vegas</Label> <PlaceName xsi:nil="true" /> <Costs xsi:nil="true" /> </StopLocation> <StopLocation> <Address> <StreetAddress xsi:nil="true" /> <City>Phoenix</City> <State xsi:nil="true" /> <Zip>85003</Zip> <County xsi:nil="true" /> <Country xsi:nil="true" /> <SPLC xsi:nil="true" /> <CountryPostalFilter>US</CountryPostalFilter> </Address> <Coords xsi:nil="true" /> <Region>NA</Region> <Label>Phoenix</Label> <PlaceName xsi:nil="true" /> <Costs xsi:nil="true" /> </StopLocation> </Stops> <Options> <BordersOpen>false</BordersOpen> <DistanceUnits>Miles</DistanceUnits> <TruckCfg xsi:nil="true" /> </Options> <FuelOptions xsi:nil="true" /> <AFOptions xsi:nil="true" /> <RouteLegOptions xsi:nil="true" /> <StopLabelDrawer>Name</StopLabelDrawer> </MapRoute> </Routes> </Body> </Request> </ProcessMap> </s:Body> </s:Envelope>
- Returns
- Returns a map image with desired elements such as points, traffic, geometry, and routes that were specified in the request. See ALK.PCM.Model.ServiceModels.MapRoutesResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ProcessMapResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <ProcessMapResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>MapRoute</Type> <Success>true</Success> <DataVersion>28.3.26.9224</DataVersion> <Errors> </Header> <Body> <Map> <Center> <Lat>32.86137</Lat> <Lon>-115.605258</Lon> </Center> <CornerA> <Lat>44.067835</Lat> <Lon>-126.812361</Lon> </CornerA> <CornerB> <Lat>21.654906</Lat> <Lon>-104.398156</Lon> </CornerB> <Groups i:nil="true" /> <Height>1094</Height> <Layers> <Layer> <Buffer>iVBORw0KGgoAAAANSUhEUgAABEYAAARGCAYAAAA1uLUVAAAgAElEQVR4nOy9eXhb5Zn//TlH0tFiS95jO46z2Fkc2yUkGEhCCQlhJwyQQqZsfVOWlsK0tC+/KZSB6bTT6TBlOi+lQ6F0mZSWTn+ZNi0DCVtDNrIAAROSmCzY2UjsxHYcW7LWo3PeP+QjS7JkS7ZsSbY+15Ur1lkfSUfnPM/3ue/vLbzT0qOSJQugW3U5F/72S7x/14tMe/t3STlmLiVJOU4sfF5f8O9/+t4P+OY3v0VVVVVwWUtLCz/5/vf4/gXzADDO1OE7//P4pCnBbYx6Gb3jAHp7U2BBwTwoWgiCrv88Pjc+nyfudjloD/4d7TMIXZ8JPHTPE6xdu5ZVq1YF/3/+uZ9idu5B6j2It2gJsqlyTNs0Gp/hcT/XTmK6iIS/eebbJlCXSl+yR1tYgxSNLshprqt5EFomdQdLfb8pTVR09wg+/fg8A8xYu4ryL0tfHKCgqIr+oiP/4v9+jrTUIQFNDA2MmTMTj8fL4rx9mzvkL+L//8XO8Ph9Olyvt+HPOPY9YNEbV0SPs2bUzcb7dO3YQi0b51+98K3HO6mPHmDFnzoBdK3R0rDl06AgLF57PyJFFGcf29HteW3uK4uLM+58pTpciq9nOQ/eMg8JLcdVtRu9jC1+15yFCCCGEEEKIdPz++LfHkUi4h5GDz1S9GP5p8ZvlbswuiiX+E303EBk5diHP5Do12YrmzkvUl8mpeoKcqif6NAfLssgvLKKpoQE9FmPM+AmsfGY9Fy25Coi3mDWNrrVuXvnzevbs3MkP7/8lK59ZD4BpGBSOHMm//OrXzF+4kG1vvM4/3fNlQq2tGcerqsq8hYvYvWMHu3fs4NyLLo4XXzUM8vLzWfnM+sR/V12/PKu6O70xffrU9hbFFm+++U7aMdkWXH3rrW2JQMuZ6nQIikSjYVpaGno1Dzs4qIUr+3ROCYwIIYQQQgjRD3bWyOnAUjT0QPdLAnp7Qy9BlO4lPz/Jz1M2z3N/C3lGc+fRNubWRMFWO0DSm5tD09QpnzWbgqIi1jz0Sxrq6qg7eZITx+LHGFlaSiwaZe+unRzevz+xPRaL4nTFr/HV5/6cON6Wl17gv37wT8w5fwE33nY7TQ0NNDU2ZBxvWSYXXHop2996k7bWIFNnVGCaBhVz59LU0MCWl14g2NLMe1vf6NQdZ6CUl09l2bLPUFRUwMIL5qUdk+3rZJomRUWFBIOtAzrHoXI6BEWgo65JIJDfq3nYgcK+BEccd977f37Y672EEEIIIYQ4y5TkdO0uA+ByuWkNBhPZI8PF1bwdrWU30cJLsBQnJTkmNW2OtGNr2hwZH0tlX3e2488Ws4tind4Tqe+PkhyTD085M75vIH7DnTdiYDqcxHJnE8udjYKBs3EbzpadWK58TC2v2/1M08TpcjN/4YVsf+tNnl7zGK9ueI6xEyfxt3f+PaPGjqWlqYk//u4xDn2ylxEFheQXFHLF0qV88O47PPvUkxQWF1NTdZyy8nIWLb6CQ5/s4/FfP8y2N97gms9+jvmLLmTUmDFpx4+bNJmRpaP5w2OruXDxFcyYM5totI3C4lHkFxbylz/8nr/84fe0NDVxzrx5uNyuAQ+OAIwfP5bWYJDWYBCn00k4HKKhvp7WYJDaUw3s3LmbmpqTnDxZi9vtJiena/Hb8vKpjBs3BrfbleYMp7fTJShiz8Xr9fV6P8Ndmnj/Z/PeT6a8frBZmpYLIYQQQgjRg9lFsYw1JOzCjMNRa8QOiEDXYpwDsdyjt1kQZ7vU90d3dUdqTlQP2numI1DWcw2SeCtdLw5H59dX16NYlonT2bW4cLx1b9fWrfE2vo5O43Q9jKo629vxdhaLRdA0Z6ItbywWJhaL4HBouFw5nc5hGDGi0RCWNXi3sMFgC63BeA0Ur9dLbt6ItMtjli+/dtDmMJRyqp6gJjd+LYMdFFFVFUVRMU0j42toB2gCgb4HDO33frj0xqy7N0nxVSGEEEIIIbKU6Qa3ZFRpIjgylHpz8yuGRnLwqLtlSNnWreirRJvfus24gJu/vyXtuFWrfoVlWUQibSiKgqo6sCwLyzITN6+6Hk1stwMVhqEnbnQty0wENgxDR1GUxL87jhPNOF7XI4nj29kghqETCjWjqg4URen2Znog2ZlfrcEguXkjALjkkkUcOnSUSCRCNBrF43EP+jyGUiCQn3jt00l+XfrK4dBwu33txzMJhdK//+2slf6w3/tacE/i555IYEQIIYQQQogs9dR1JBIJD0nr3u6yRJLZWS790ZdOKyKuuza+rcEgVa0OsutH0zfJHWxgC2vXru30+IoVKzr927KstK1wM203TROwlwqZncZbVtcb6e7GZ2rBOxjLZtKpra1j69a3gXg2SPLSuIKCfAoKBmbJ0+kk/r6I83j8iWBVOpFIG4bR988BVdU4fuQwG9ev49Z77k0EyFL1J1MkWW+7dElgRAghhBBCiCx1FyAYita9qhnCU/000H1AJJk95/4ESGQJTf8kP39v7a1p/ymedbDtRH3isS9cVDAo50/+1twOhqQGSc52b70V70hTVFQ4zDMZOlrLbvRARSLD58mHHqC2umvm2w133Mmo8ePaM306sndSM4BSs3qSs31SqaoD07Q6Hcfe3+HQElkq6bKPsjqvI4CROzPR0trwjk+TxZT0XAzIMyqEEEIIIcRZoLvsCb8/QGswOKhZI1pwD3qgIuv08GQDkT0i+s4OiNjBjw9POXlrb023wZDuMk4GihauPOuXYb388iZMM36jXFY2aZhnM3Qsd1F8KV7uPCzL5OavfA2AAx/v5oM3t3LjnX/fMdaycDrtJUQWuh5D07oWmY3FIpimjsvlTcpAsTBSWj673TlAvCuSqmrt5zAxDD1xXMPQcTgcgJI4Tqbz6noUw4h1Pm/JpaC5ccVqoGBm4jiWZRKNhjplKUlgRAghhBBCiCz1dIM6mFkjyQUF+2ogskdE73RkiMDC6SVAR2vft/Zmdww7INfXQElyPZPUTBFX3WbUQAW6vzzrQpWfNldeuZh16/7C9OlTGDVq5HBPZ0i4mrejRE4RLbwUgHA4iKo6ugQdotEQLpeXA7s/YvNfnsPQY8xasJCFS67k+JHDvPHC85imQX1tLWUVM7nqhs+iON3s/2hXl/EARkznhd//Pw7u+ZjSceNZdtvtHDtykC0bnuPmr3wNh8PJa8+tx+ +/mgze3cuOdf584bsyEse3fYOsmNIYN6EX2uV1U8kRlJX9avYovfe/7zB6VmmKtMf/i+LeLPpfK5IKO+dpcDoX5Y7w4U7afbDXIdXcEUXQTDjdEOdXaNWr0+vMbuPVr03A4+ +z43K5At9dLheOiPBOjKhlubnD+eMf/4TJZCIyMrJV5/S/qR+LFn/A6jVrGTp0CHv27GXo0JtZu3YdK1as4lcvPEdqajdefPFlKisqCQsNw6xeuaqRel7d1exkrAAWi4UpUybTs2cGANnZmRw/XkZCwuAGfRcR4Wh3LI2maiY98nMcUTE4K86yaskCHFHRZPS/mTUfv0tqZj9G3vMQ506XsW7pQsIjo6g77yQyOg6z1capkkMAhEV0AaCmqgKv24XF5i9zKSnagyMqul3B1sdVr67GGbT9dOkR1v7tfWKTUolPzQgcd6xoD4Xb8rlj2pOYzGaWL5pHbFIqUfFJ7NiwgrEPPIYjKobli+ZRtGMzWYNzA+dqXk+T952UntWu+2iJPTKKIePubff5m1csZdTkGY0mRtbnLcLu6MLE6U9jC7NztuwoW1Yu5eZx9wY9s4sd3rMdW5idI4UFgcRIa+g+jbX/8z6Jab2CkiIAd818Bl3XKdyaT3FhAXfOfAYAs8Xahju9Nlxuf9Vr6ncal5LOxq8+ZvSUmTiiYvj6r/OJiksiNbMfn7/7JkCj/6eOFe3h2IE9KKoUhgkhhBBCCHGp3tmZOKur2bp1G8nJSezcuZt/nDmjs8NqVmxMLF6vl1tzR7T6nLTu3XniiVksXbqMhQsXk9mrF9m9ezNq1Ej27dvPz37+SywWC1On3k9SUhIAmq50SHLEMC60oep16Goo4B9SoxnuJidjrVdZWcmLL77ECy88R3JyEoWFBxgzZhTZ2VlUVzuD+m7mzOntjrPRxIjJbMFssRIVl0RcShrnTpUR5ijCXVfD4NF3oZrMJKVn0Tsnl7rzTlRVZevqPCrPnGTnxtX0veW2QFtJPbIoPbg38EJ9dN9OUnr24WzZ0TYHWx9XU9uT0rOwOyI5d7os6CXfFmrn5nGTA5UI4ZFdOV9VQUxydxRVxWQyY7FYUVUVs8UW1PaJ4qbvG+BAwXfs3rQGn08LVNeUHixk66o8IqPjOFN2lMS0Xoy852HW/u19rC </Buffer> <Image i:nil="true" /> <Size>426750</Size> <Type>BaseMap</Type> </Layer> </Layers> <Points> <MapPointInfo> <ClassName>ltruck_r</ClassName> <DevX>-112074037</DevX> <DevY>33448377</DevY> <GroupID>-1</GroupID> <ID>0</ID> <Latitude>33448377</Latitude> <Longitude>-112074037</Longitude> </MapPointInfo> <MapPointInfo> <ClassName>ltruck_g</ClassName> <DevX>-119698190</DevX> <DevY>34420831</DevY> <GroupID>-1</GroupID> <ID>1</ID> <Latitude>34420831</Latitude> <Longitude>-119698190</Longitude> </MapPointInfo> </Points> <Region>NA</Region> <Width>1094</Width> </Map> </Body> </ProcessMapResult> </ProcessMapResponse> </s:Body> </s:Envelope>
NOTE: A maximum of 8 routes is supported if the account has premium access.
◆ ImportAvoidFavorSet()
| ImportAFSetResponse ImportAvoidFavorSet | ( | ImportAFSetRequest | Request | ) |
The ImportAvoidFavorSet operation allows the user to take a flattened avoid favor dat file from PC*MILER desktop and import it into the cloud to use on the server when running routes.
- Parameters
-
Request The Request contains the byte array of the flattened avoid favor dat file along with the set name, tag and set id if there's a desire to overwrite an existing set. See ALK.PCM.Model.ServiceModels.ImportAFSetRequest.
Example:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:v1="http://pcmiler.alk.com/APIs/v1.0"> <soapenv:Header> <alk:AuthHeader> <alk:Authorization>YOUR API KEY HERE</alk:Authorization> <alk:Date/> </alk:AuthHeader> </soapenv:Header> <soapenv:Body> <v1:ImportAvoidFavorSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <v1:Request> <v1:Header> <v1:DataVersion/> <v1:RequestType>importAFTest</v1:RequestType> </v1:Header> <v1:Body> <v1:SetName>TestImportAFSet</v1:SetName> <v1:SetTag>FlattnedFileTest</v1:SetTag> <v1:SetID i:nil="true"/> <v1:FileBytes>AAAAALz+5UEBABAAAAAAALqx5CoCADgACAA3LjEwLjguMQAAAAAAAAAAAQgAAAAACAAAAAEAAAABTkEACQBEZWZhdWx0TkELAEF2b2lkTkEuZGF0AAAAALrmAgAAAAAAAQgAAAAACAAAAAQAAAABAAAAAQAAABkAQnVubiBEcml2ZSwgUHJpbmNldG9uLCBOSrrmAgABDDZrAHMDAAAAAAEIAAAAAAgAAAABAAAADDZrAHMDAQAAAAAAAAAAAAAAAAgAydaM+zn5ZwJc5Yz7DxhoAngAAAD5AAAAAQoAQnVubiBEcml2ZRAAYXZvaWQgYnVubiBkcml2ZTGKAQACAAAAAQAAAB8ATW91bnQgTHVjYXMgUm9hZCwgUHJpbmNldG9uLCBOSrrmAgABDDZrADsAAAAAAAEIAAAAAAgAAAABAAAADDZrADsAAQAAAAAAAAAAAAAAAAYAL8iM+wcEaAInyoz7rQhoAiwBAACOAQAAARAATW91bnQgTHVjYXMgUm9hZBoAQXZvaWQgbW91bnQgbHVjYXMgYXQgZXdpbmcxigEAAwAAAAIAAAAiAFVTLTIwNiAoU3RhdGUgUm9hZCksIFByaW5jZXRvbiwgTkq65gIAAQw2awAZAwAAAAABCAAAAAApAAAAJgAAAAw2KwAOAAHuTgAAAAAAAAAAAAAEAGDOjPu/Q2gC7tWM+yhLaAL2AgAAHwMAAAEKAFN0YXRlIFJvYWQMNisAEAAB7k4AAAAAAAAAAAAABAA42oz7pk1oArLejPtwUWgCIAMAAIMDAAABCgBTdGF0ZSBSb2FkDDYrADsAAe5OAAAAAAAAAAAAAAQAONqM+6ZNaALu1Yz7KEtoAgAAAAAAAAAAAQoAU3RhdGUgUm9hZAw2KwDhAAHuTgAAAAAAAAAAAAAEACjwjPt2gGgCpPCM+zuMaALxBAAATQUAAAAAAAw2KwDiAAHuTgAAAAAAAAAAAAAEAKTwjPs7jGgCW/CM+zqTaAJPBQAAYgUAAAAAAAw2KwAqAQHuTgAAAAAAAAAAAAAEAAfwjPvCmmgC1O+M+0OeaALdBQAA3wUAAAAAAAw2KwArAQHuTgAAAAAAAAAAAAAEANTvjPtDnmgCPO6M+x6raAIAAAAAAAAAAAAAAAw2KwA7AQHuTgAAAAAAAAAAAAAEALLejPtwUWgCreCM+zJVaAIAAAAAAAAAAAAAAAw2KwBcAQHuTgAAAAAAAAAAAAAEAFvwjPs6k2gCB/CM+8KaaAIAAAAAAAAAAAAAAAw2KwCxAQHuTgAAAAAAAAAAAAAEAMDmjPt3aGgCnOmM+1JzaAIAAAAAAAAAAAAAAAw2KwCyAQHuTgAAAAAAAAAAAAAEAJHtjPsVfGgCKPCM+3aAaALMBAAAdwUAAAAAAAw2KwCzAQHuTgAAAAAAAAAAAAAEAOvjjPttX2gCwOaM+3doaAIAAAAAAAAAAAAAAAw2KwAlAgHuTgAAAAAAAAAAAAAEAJzpjPtSc2gCweqM+9d2aAKEAwAAFQQAAAAAAAw2KwBOAgHuTgAAAAAAAAAAAAAEAPPgjPvyVWgCyeOM+wFfaAIAAAAAAAAAAAAAAAw2KwBPAgHuTgAAAAAAAAAAAAAEAK3gjPsyVWgC8+CM+/JVaAIAAAAAAAAAAAAAAAw2KwCNAgHuTgAAAAAAAAAAAAAEAMHqjPvXdmgCke2M+xV8aAIEBAAA0QQAAAAAAAw2KwCZAgHuTgAAAAAAAAAAAAAEAMnjjPsBX2gC6+OM+21faAIAAAAAAAAAAAAAAAw2awA3AAHuTgAAAAAAAAAAAAAEAH28jPtDBGgCU72M+5cHaAIKAQAAKwEAAAEKAFN0YXRlIFJvYWQMNmsAPwAB7k4AAAAAAAAAAAAABAAQuoz7UPpnAn28jPtDBGgCyAAAAAkBAAABCgBTdGF0ZSBSb2FkDDZrAEYAAe5OAAAAAAAAAAAAAAQAbrSM+9jiZwLruIz7OvZnAgEAAABjAAAAAQoAU3RhdGUgUm9hZAw2awBMAAHuTgAAAAAAAAAAAAAEAGKyjPuR3GcCAaOM+8vPZwIAAAAAAAAAAAEKAFN0YXRlIFJvYWQMNmsATgAB7k4AAAAAAAAAAAAABABisoz7kdxnAoizjPus32cCAAAAAAAAAAABCgBTdGF0ZSBSb2FkDDZrABUDAe5OAAAAAAAAAAAAAAQAVMCM+xstaAJgzoz7v0NoArwCAAD1AgAAAQoAU3RhdGUgUm9hZAw2awAZAwHuTgAAAAAAAAAAAAAEAFO9jPuXB2gCVMCM+xstaAIsAQAAuwIAAAEKAFN0YXRlIFJvYWQMNmsAGQMB7k4AAAAAAAAAAAAABABTvYz7lwdoAlTAjPsbLWgCLAEAALsCAAABCgBTdGF0ZSBSb2FkDDZrAGYDAe5OAAAAAAAAAAAAAAQANaGM+/LLZwJ4oYz7NsdnAgAAAAAAAAAAAQoAU3RhdGUgUm9hZAw2awBnAwHuTgAAAAAAAAAAAAAEAHihjPs2x2cCB6KM+3jGZwK0AAAAxwAAAAELAEJheWFyZCBMYW5lDDZrAIoDAe5OAAAAAAAAAAAAAAQANaGM+/LLZwIBo4z7y89nAgAAAAAAAAAAAQoAU3RhdGUgUm9hZAw2awCsAwHuTgAAAAAAAAAAAAAEAIizjPus32cCbrSM+9jiZwIAAAAAAAAAAAEKAFN0YXRlIFJvYWQMNmsA0gMB7k4AAAAAAAAAAAAABADruIz7OvZnAhy5jPsx92cCZAAAAHsAAAABCgBTdGF0ZSBSb2FkDDZrANUDAe5OAAAAAAAAAAAAAAQAHLmM+zH3ZwIQuoz7UPpnAnwAAADHAAAAAQoAU3RhdGUgUm9hZAw2C1AsAQHuTgAAAAAAAAAAAAAEADzujPseq2gCKPCM+3aAaAIAAAAAAAAAAAAAAAw2C1AzAQHuTgAAAAAAAAAAAAAEACjwjPt2gGgCYM6M+79DaAIAAAAAAAAAAAAAAAw2C1A0AQHuTgAAAAAAAAAAAAAEAGDOjPu/Q2gCU72M+5cHaAIAAAAAAAAAAAAAAAw2C1A0AQHuTgAAAAAAAAAAAAAEAGDOjPu/Q2gCU72M+5cHaAIAAAAAAAAAAAAAAAw2C1BBAQHuTgAAAAAAAAAAAAAEAFO9jPuXB2gCB6KM+3jGZwIAAAAAAAAAAAAAAAw2AJAFAgHuTgAAAAAAAAAAAAAEADzujPseq2gCB6KM+3jGZwIAAAAAAAAAAAAAAAw2AJAFAgHuTgAAAAAAAAAAAAAEADzujPseq2gCB6KM+3jGZwIAAAAAAAAAAAAAABIARmF2b3IgMjA2IGF0IGV3aW5nMYoBAAUAAAABAAAAJABOb3J0aCBIYXJyaXNvbiBTdHJlZXQsIFByaW5jZXRvbiwgTkq65gIAAQw2awDSAAAAAAABCAAAAAAIAAAAAgAAAAw2awDSAAEAAAAAAAAAAAAAAAAGAGrijPul6GcCq92M+xXvZwIsAQAAjwEAAAEVAE5vcnRoIEhhcnJpc29uIFN0cmVldAw2C1BAAQEAAAAAAAAAAAAAAAAGALnPjPvW+WcCAQCN+7nAZwIAAAAAAAAAAAEVAE5vcnRoIEhhcnJpc29uIFN0cmVldBYAQXJvdW5kIEFMSyBvbiBIYXJyaXNvbjGKAQA=</v1:FileBytes> </v1:Body> </v1:Request> </v1:ImportAvoidFavorSet> </soapenv:Body> </soapenv:Envelope>
- Returns
- Returns the set id of the Avoid Favor set created from importing the flattened file. See ALK.PCM.Model.ServiceModels.ImportAFSetResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ImportAvoidFavorSetResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <ImportAvoidFavorSetResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>importAFTest</Type> <Success>true</Success> <DataVersion>31.3.42.6888</DataVersion> <Errors i:nil="true"/> </Header> <Body> <SetID>1221602</SetID> </Body> </ImportAvoidFavorSetResult> </ImportAvoidFavorSetResponse> </s:Body> </s:Envelope>
◆ GetAvoidFavorSets()
| AFSetResponse GetAvoidFavorSets | ( | GetAvoidFavorSetRequest | Request | ) |
The GetAvoidFavorSets operation allows the user to retrieve avoid favor set information created by the ImportAvoidFavorSet operation.
- Parameters
-
Request The Request contains information to narrow down what sets are returned, such as by spatial bounds, SetID, SetName, SetTag, etc. See ALK.PCM.Model.ServiceModels.GetAvoidFavorSetRequest.
Example:
This particular example simply gets the avoid favor sets by set name with an inexact name match. Optionally one could specify, the spatial corners, or set id/tag, etc.<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:v1="http://pcmiler.alk.com/APIs/v1.0"> <soapenv:Header> <alk:AuthHeader> <alk:Authorization>YOUR API KEY HERE</alk:Authorization> <alk:Date/> </alk:AuthHeader> </soapenv:Header> <soapenv:Body> <v1:GetAvoidFavorSets> <v1:Request> <v1:Header> <v1:DataVersion>current</v1:DataVersion> <v1:RequestType>GetAFSets Sample</v1:RequestType> </v1:Header> <v1:Body> <v1:SetName>import</v1:SetName> <!--<v1:SetTag></v1:SetTag>--> <!--<v1:SetID />--> <v1:Detail>false</v1:Detail> <!--<v1:Corner1>--> <!--<v1:Lat/>--> <!--<v1:Lon/>--> <!--</v1:Corner1>--> <!--<v1:Corner2>--> <!--<v1:Lat/>--> <!--<v1:Lon/>--> <!--</v1:Corner2>--> <v1:PLIDOnly>true</v1:PLIDOnly> <v1:InexactNameMatch>true</v1:InexactNameMatch> </v1:Body> </v1:Request> </v1:GetAvoidFavorSets> </soapenv:Body> </soapenv:Envelope>
- Returns
- Returns the avoid favor set collection. See ALK.PCM.Model.ServiceModels.GetAvoidFavorSetRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetAvoidFavorSetsResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <GetAvoidFavorSetsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>GetAFSets Sample</Type> <Success>true</Success> <DataVersion>31.3.42.6888</DataVersion> <Errors i:nil="true"/> </Header> <Body> <AvoidFavorSets> <AFSet> <DataVersion i:nil="true"/> <Links> <AFLink> <AFGroupID>847119</AFGroupID> <AvoidFavorID>41992662</AvoidFavorID> <AvoidFavorType>Avoid</AvoidFavorType> <Comment i:nil="true"/> <ExtraInfo i:nil="true" xmlns:a="http://schemas.datacontract.org/2004/07/ALK.Common.Model"/> <Geometries i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <GridID>0</GridID> <GridLevel>0</GridLevel> <LinkID>0</LinkID> <LinkPoints i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <PLIDs xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:int>72370748</a:int> <a:int>72370751</a:int> <a:int>72474495</a:int> </PLIDs> </AFLink> <AFLink> <AFGroupID>847120</AFGroupID> <AvoidFavorID>41992665</AvoidFavorID> <AvoidFavorType>Avoid</AvoidFavorType> <Comment i:nil="true"/> <ExtraInfo i:nil="true" xmlns:a="http://schemas.datacontract.org/2004/07/ALK.Common.Model"/> <Geometries i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <GridID>0</GridID> <GridLevel>0</GridLevel> <LinkID>0</LinkID> <LinkPoints i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <PLIDs xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:int>72370655</a:int> </PLIDs> </AFLink> <AFLink> <AFGroupID>847121</AFGroupID> <AvoidFavorID>41992666</AvoidFavorID> <AvoidFavorType>Favor</AvoidFavorType> <Comment i:nil="true"/> <ExtraInfo i:nil="true" xmlns:a="http://schemas.datacontract.org/2004/07/ALK.Common.Model"/> <Geometries i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <GridID>0</GridID> <GridLevel>0</GridLevel> <LinkID>0</LinkID> <LinkPoints i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <PLIDs xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:int>72199918</a:int> <a:int>72199917</a:int> <a:int>72185628</a:int> <a:int>72185622</a:int> <a:int>72185630</a:int> <a:int>72199932</a:int> <a:int>72185620</a:int> <a:int>72185624</a:int> <a:int>72185626</a:int> <a:int>72185619</a:int> <a:int>72185625</a:int> <a:int>72185621</a:int> <a:int>72199953</a:int> <a:int>72199962</a:int> <a:int>72199959</a:int> <a:int>72199958</a:int> <a:int>72199968</a:int> <a:int>72199945</a:int> <a:int>72199947</a:int> <a:int>72199949</a:int> <a:int>72199951</a:int> <a:int>72185655</a:int> <a:int>72185657</a:int> <a:int>72185661</a:int> <a:int>72199963</a:int> <a:int>72185635</a:int> <a:int>72185651</a:int> <a:int>72185509</a:int> <a:int>72185506</a:int> <a:int>72185507</a:int> <a:int>72185510</a:int> <a:int>72185688</a:int> <a:int>72473653</a:int> <a:int>72198825</a:int> <a:int>72373216</a:int> <a:int>72185689</a:int> <a:int>72198823</a:int> <a:int>72198829</a:int> <a:int>72198827</a:int> <a:int>72198826</a:int> <a:int>72185687</a:int> <a:int>72198828</a:int> <a:int>72185618</a:int> </PLIDs> </AFLink> <AFLink> <AFGroupID>847122</AFGroupID> <AvoidFavorID>41992705</AvoidFavorID> <AvoidFavorType>Avoid</AvoidFavorType> <Comment i:nil="true"/> <ExtraInfo i:nil="true" xmlns:a="http://schemas.datacontract.org/2004/07/ALK.Common.Model"/> <Geometries i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <GridID>0</GridID> <GridLevel>0</GridLevel> <LinkID>0</LinkID> <LinkPoints i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/> <PLIDs xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:int>74434116</a:int> <a:int>74434115</a:int> </PLIDs> </AFLink> </Links> <Name>TestImportAFSet</Name> <SetID>1221679</SetID> <Tag>FlattnedFileTest</Tag> </AFSet> </AvoidFavorSets> </Body> </GetAvoidFavorSetsResult> </GetAvoidFavorSetsResponse> </s:Body> </s:Envelope>
◆ GetWeatherAlerts()
| WeatherAlertsPointsResponse GetWeatherAlerts | ( | WeatherAlertsPointsRequest | Request | ) |
The GetWeatherAlerts operation returns a collection of weather alert information for each input coordinate.
- Parameters
-
Request The Request consists of a collection of coodinates, for which weather alerts are desired and certain properties to filter alerts. These points are typically vehicle locations or the route path captured through the geotunnel report, but can be any coordinates desired. See ALK.PCM.Model.ServiceModels.WeatherAlertsPointsRequest.
Example:
This particular example simply gets weather alerts for a given point and restricts the alerts to only those that are minor and likely to occur. The event names and start/end times are commented out.<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:v1="http://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/> </alk:AuthHeader> </soapenv:Header> <soapenv:Body> <v1:GetWeatherAlerts> <v1:Request> <v1:Header> <v1:DataVersion/> <v1:RequestType>WeatherAlertsSample</v1:RequestType> </v1:Header> <v1:Body> <v1:Urgency>Expected</v1:Urgency> <v1:Severity>Minor</v1:Severity> <v1:Certainty>Likely</v1:Certainty> <!--<v1:EventNames>--> <!--<arr:string>Flood Advisory</arr:string>--> <!--</v1:EventNames>--> <!--<v1:StartTime/>--> <!--<v1:EndTime/>--> <v1:Points> <v1:Coordinates> <v1:Lat>42.842169</v1:Lat> <v1:Lon>-84.569603</v1:Lon> </v1:Coordinates> </v1:Points> </v1:Body> </v1:Request> </v1:GetWeatherAlerts> </soapenv:Body> </soapenv:Envelope>
- Returns
- Returns a collection of a collection of weather alerts. The inner collection is for each input coordinate passed in. See ALK.PCM.Model.ServiceModels.WeatherAlertsPointsRequest.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetWeatherAlertsResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <GetWeatherAlertsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>WeatherAlertsSample</Type> <Success>true</Success> <DataVersion>31.3.42.6888</DataVersion> <Errors> </Header> <Body> <WeatherAlerts> <ArrayOfWeatherAlertEvent> <WeatherAlertEvent> <AlertEvent>Flood Advisory</AlertEvent> <AreaDesc>Clinton</AreaDesc> <Certainty>Likely</Certainty> <CountryCode>US</CountryCode> <DispEffective>2018-01-31T11:09:00-05:00</DispEffective> <DispExpires>2018-02-01T13:09:00-05:00</DispExpires> <DispPublished>2018-01-31T11:09:00-05:00</DispPublished> <DispUpdated>2018-01-31T11:09:00-05:00</DispUpdated> <Effective>2018-01-31T16:09:00</Effective> <Expires>2018-02-01T18:09:00</Expires> <FipsCodes>026037</FipsCodes> <LanguageCode>en-us</LanguageCode> <Polygon>POLYGON ((-84.74 42.79, -84.55 42.81, -84.55 42.87, -84.74 42.86, -84.89 42.9, -84.89 42.83, -84.74 42.79))</Polygon> <Published>2018-01-31T16:09:00</Published> <Severity>Minor</Severity> <Summary>...The flood advisory continues for the following rivers in Southwest Lower Michigan... Maple River At Maple Rapids affecting Clinton County Looking Glass River Near Eagle affecting Clinton County .The Looking Glass River continues to fluctuate slightly above action stage due to the affects of ice. The advisory will go until</Summary> <Title>Flood Advisory issued January 31 at 11:09AM EST until further notice by NWS</Title> <Updated>2018-01-31T16:09:00</Updated> <Urgency>Expected</Urgency> <ID>https://alerts.weather.gov/cap/wwacapget.php?x=MI125A8D8CA344.FloodAdvisory.125A91B90EE4MI.GRRFLSGRR.728106a10bd291278c83c8ecb62c22aa</ID> </WeatherAlertEvent> <WeatherAlertEvent> <AlertEvent>Flood Advisory</AlertEvent> <AreaDesc>Clinton</AreaDesc> <Certainty>Likely</Certainty> <CountryCode>US</CountryCode> <DispEffective>2018-01-31T11:09:00-05:00</DispEffective> <DispExpires>2018-02-02T13:00:00-05:00</DispExpires> <DispPublished>2018-01-31T11:09:00-05:00</DispPublished> <DispUpdated>2018-01-31T11:09:00-05:00</DispUpdated> <Effective>2018-01-31T16:09:00</Effective> <Expires>2018-02-02T18:00:00</Expires> <FipsCodes>026037</FipsCodes> <LanguageCode>en-us</LanguageCode> <Polygon>POLYGON ((-84.93 42.98, -84.68 43.08, -84.57 43.1, -84.56 43.17, -84.71 43.14, -84.95 43.02, -84.93 42.98))</Polygon> <Published>2018-01-31T16:09:00</Published> <Severity>Minor</Severity> <Summary>...The flood advisory continues for the following rivers in Southwest Lower Michigan... Maple River At Maple Rapids affecting Clinton County Looking Glass River Near Eagle affecting Clinton County .The Looking Glass River continues to fluctuate slightly above action stage due to the affects of ice. The advisory will go until</Summary> <Title>Flood Advisory issued January 31 at 11:09AM EST until February 02 at 1:00PM EST by NWS</Title> <Updated>2018-01-31T16:09:00</Updated> <Urgency>Expected</Urgency> <ID>https://alerts.weather.gov/cap/wwacapget.php?x=MI125A8D8CA344.FloodAdvisory.125A91C84DA0MI.GRRFLSGRR.9d16a6b1a18764d6541bd757cd7dca79</ID> </WeatherAlertEvent> </ArrayOfWeatherAlertEvent> </WeatherAlerts> </Body> </GetWeatherAlertsResult> </GetWeatherAlertsResponse> </s:Body> </s:Envelope>
◆ GetRouteMatrix()
| RouteMatrixResponse GetRouteMatrix | ( | RouteMatrixRequest | Request | ) |
The GetRouteMatrix operation takes a collection consisting of origins and a collection of destinations and runs a route from every origin to every destination. The maximum number of origins and destinations is 10 each.
- Parameters
-
Request The Request contains the collection of Origin and Destination locations and routing options. See ALK.PCM.Model.ServiceModels.RouteMatrixRequest.
Example:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:alk="http://www.alk.com" xmlns:v1="http://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/> </alk:AuthHeader> </soapenv:Header> <soapenv:Body> <v1:GetRouteMatrix> <v1:Request> <v1:Header> <v1:DataVersion/> <v1:RequestType>RouteMatrixRequestSample</v1:RequestType> </v1:Header> <v1:Body> <v1:Origins> <v1:Location> <v1:Address> <v1:City>East Lansing</v1:City> <v1:State>MI</v1:State> </v1:Address> <v1:Region>NA</v1:Region> </v1:Location> <v1:Location> <v1:Coords> <v1:Lat>40.361211</v1:Lat> <v1:Lon>-74.599466</v1:Lon> </v1:Coords> <v1:Region>NA</v1:Region> </v1:Location> </v1:Origins> <v1:Destinations> <v1:Location> <v1:Address> <v1:Zip>08540</v1:Zip> </v1:Address> <v1:Region>NA</v1:Region> </v1:Location> <v1:Location> <v1:Address> <v1:Zip>90210</v1:Zip> </v1:Address> <v1:Region>NA</v1:Region> </v1:Location> </v1:Destinations> <v1:Options> <v1:HighwayOnly>false</v1:HighwayOnly> </v1:Options> </v1:Body> </v1:Request> </v1:GetRouteMatrix> </soapenv:Body> </soapenv:Envelope>
- Returns
- Returns a list of all locations geocoded, followed by the matrix table of distance and time for each origin to each destination. See ALK.PCM.Model.ServiceModels.RouteMatrixResponse.
Example:<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <GetRouteMatrixResponse xmlns="http://pcmiler.alk.com/APIs/v1.0"> <GetRouteMatrixResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Header> <Type>RouteMatrixRequestSample</Type> <Success>true</Success> <DataVersion>31.3.42.6888</DataVersion> <Errors> </Header> <Body> <Origins> <GeocodeOutputLocation> <Address> <StreetAddress> <City>East Lansing</City> <State>MI</State> <Zip>48826</Zip> <County>Ingham</County> <Country>United States</Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>Michigan</StateName> <StateAbbreviation>MI</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation </Address> <Coords> <Lat>42.734265</Lat> <Lon>-84.490753</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EST</TimeZone> <Errors> <SpeedLimitInfo i:nil="true"/> <ConfidenceLevel>Exact</ConfidenceLevel> <DistanceFromRoad i:nil="true"/> <CrossStreet i:nil="true"/> </GeocodeOutputLocation> <GeocodeOutputLocation> <Address> <StreetAddress>Independence Way</StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County>Mercer</County> <Country>United States</Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.361211</Lat> <Lon>-74.599466</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EST</TimeZone> <Errors> <SpeedLimitInfo i:nil="true"/> <ConfidenceLevel>Exact</ConfidenceLevel> <DistanceFromRoad>0.044</DistanceFromRoad> <CrossStreet i:nil="true"/> </GeocodeOutputLocation> </Origins> <Destinations> <GeocodeOutputLocation> <Address> <StreetAddress> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <County>Mercer</County> <Country>United States</Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>New Jersey</StateName> <StateAbbreviation>NJ</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>40.354907</Lat> <Lon>-74.645014</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>EST</TimeZone> <Errors> <SpeedLimitInfo i:nil="true"/> <ConfidenceLevel>Exact</ConfidenceLevel> <DistanceFromRoad i:nil="true"/> <CrossStreet i:nil="true"/> </GeocodeOutputLocation> <GeocodeOutputLocation> <Address> <StreetAddress> <City>Beverly Hills</City> <State>CA</State> <Zip>90210</Zip> <County>Los Angeles</County> <Country>United States</Country> <SPLC i:nil="true"/> <CountryPostalFilter>US</CountryPostalFilter> <AbbreviationFormat>FIPS</AbbreviationFormat> <StateName>California</StateName> <StateAbbreviation>CA</StateAbbreviation> <CountryAbbreviation>US</CountryAbbreviation> </Address> <Coords> <Lat>34.079799</Lat> <Lon>-118.412935</Lon> </Coords> <Region>NA</Region> <Label> <PlaceName> <TimeZone>PST</TimeZone> <Errors> <SpeedLimitInfo i:nil="true"/> <ConfidenceLevel>Exact</ConfidenceLevel> <DistanceFromRoad i:nil="true"/> <CrossStreet i:nil="true"/> </GeocodeOutputLocation> </Destinations> <MatrixInfo> <ArrayOfRouteMatrixInfo> <RouteMatrixInfo> <Success>true</Success> <Errors> <Time>12:21:21</Time> <Distance>675.44</Distance> </RouteMatrixInfo> <RouteMatrixInfo> <Success>true</Success> <Errors> <Time>38:01:33</Time> <Distance>2230.68</Distance> </RouteMatrixInfo> </ArrayOfRouteMatrixInfo> <ArrayOfRouteMatrixInfo> <RouteMatrixInfo> <Success>true</Success> <Errors> <Time>00:07:26</Time> <Distance>3.95</Distance> </RouteMatrixInfo> <RouteMatrixInfo> <Success>true</Success> <Errors> <Time>47:41:06</Time> <Distance>2766.55</Distance> </RouteMatrixInfo> </ArrayOfRouteMatrixInfo> </MatrixInfo> </Body> </GetRouteMatrixResult> </GetRouteMatrixResponse> </s:Body> </s:Envelope>