GetTravelBoundary - web_services - 23.1

Spectrum Web Services Guide

Product type
Software
Portfolio
Integrate
Product family
Spectrum
Product
Spectrum > Web Services
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Web Services Guide
First publish date
2007
Last updated
2024-10-17
Published on
2024-10-17T00:33:46.811413

Description

GetTravelBoundary determines a drive/walk time or distance boundary from a location. This operation returns polygons corresponding to an isochrone or isodistance calculation. An isochrone is a polygon or set of points representing an area that can be traversed in a network from a starting point in a given amount of time. An isodistance is a polygon or set of points representing the area that is a certain distance from the starting point. The GetTravelBoundary operation (also known as an iso definition) takes a starting point, a unit (linear or time), and one or more costs as input and returns the resulting travel boundary. Costs refer to the amount of time or distance to use in calculating an iso.

Service URL Formats

The URL endpoint for the Routing SOAP service has the following general form:

http://<server>:<port>/soap/RoutingService

The URL for the Routing WSDL has the following general form:

http://<server>:<port>/soap/RoutingService?wsdl

Messages

The following table lists the request and response messages for the GetTravelBoundary operation.

Click on a message name to get more information about the message.

Message Description
GetTravelBoundaryRequest The request message for the GetTravelBoundary operation.
GetTravelBoundaryResponse The response message for the GetTravelBoundary operation.

Single Cost Example

Request for a Travel boundary with a single cost.

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.mapinfo.com/routing/service/v1" xmlns:v11="http://www.mapinfo.com/midev/service/geometries/v1" xmlns:v12="http://www.mapinfo.com/midev/service/units/v1">
 
   <soapenv:Header/>
   <soapenv:Body>
      <v1:GetTravelBoundaryRequest id="">
      <v1:DatasetResourceName>US</v1:DatasetResourceName>
         <v1:Point srsName="epsg:4326">
         <v1:Point srsName="epsg:4326">
            <v11:Pos>
               <v11:X>-74.099876</v11:X>
               <v11:Y>40.814618</v11:Y>
             </v11:Pos>
         </v1:Point>
         <v1:Costs>            
         <v1:Cost xsi:type="v1:IsoChrone" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <v1:Time uom="Minute" xmlns:v1="http://www.mapinfo.com/midev/service/units/v1">5</v1:Time>
         </v1:Cost>      
         </v1:Costs>
         <!--optionals-->
        <v1:BandingStyle>Donut</v1:BandingStyle>
           <v1:MaxOffroadDistance uom="Mile">1</v1:MaxOffroadDistance>
           <v1:ReturnHoles>false</v1:ReturnHoles>
           <v1:ReturnIslands>false</v1:ReturnIslands>
           <v1:SimplificationFactor>0.5</v1:SimplificationFactor>
           <v1:DestinationSrs>epsg:4326</v1:DestinationSrs>
           <v1:MajorRoads>true</v1:MajorRoads>
           <v1:HistoricTrafficTimeBucket>none</v1:HistoricTrafficTimeBucket>

         <v1:AmbientSpeeds>
            <v1:AmbientCostEntry>
<v1:AmbientSpeedRoadType>AmbientSpeed.RoadType.LimitedAccessSuburban</v1:AmbientSpeedRoadType>
               <v1:AmbientSpeedCost xsi:type="v1:AmbientSpeedCost">
               	<v12:Speed uom="KPH">30</v12:Speed>
               </v1:AmbientSpeedCost>
            </v1:AmbientCostEntry>
            <v1:AmbientCostEntry>
<v1:AmbientSpeedRoadType>AmbientSpeed.RoadType.LimitedAccessRural</v1:AmbientSpeedRoadType>
               <v1:AmbientSpeedCost xsi:type="v1:AmbientSpeedCost">
               	<v12:Speed uom="MPH">30</v12:Speed>
               </v1:AmbientSpeedCost>
            </v1:AmbientCostEntry>  
	</v1:AmbientSpeeds>
	<!--optionals-->
      </v1:GetTravelBoundaryRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response for a Travel boundary with a single cost.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <GetTravelBoundaryResponse xmlns="http://www.mapinfo.com/routing/service/v1" xmlns:ns2="http://www.mapinfo.com/midev/service/geometries/v1" xmlns:ns3="http://www.mapinfo.com/midev/service/units/v1" xmlns:ns4="http://www.mapinfo.com/midev/service/common/v1" xmlns:ns5="http://www.mapinfo.com/routing/service/common/v1">
         <TravelBoundary xsi:type="IsoChroneTravelBoundary" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ns2:MultiPolygon srsName="epsg:4326">
               <ns2:Polygon srsName="epsg:4326">
                  <ns2:Exterior>
                     <ns2:LineString>
                        <ns2:Pos>
                           <ns2:X>-74.12239074707031</ns2:X>
                           <ns2:Y>40.78827667236328</ns2:Y>
                        </ns2:Pos>
                        <ns2:Pos>
                           <ns2:X>-74.1226806640625</ns2:X>
                           <ns2:Y>40.788719177246094</ns2:Y>
                        </ns2:Pos>
                        	…….
                        <ns2:Pos>
                           <ns2:X>-74.1220932006836</ns2:X>
                           <ns2:Y>40.78827667236328</ns2:Y>
                        </ns2:Pos>
                        <ns2:Pos>
                           <ns2:X>-74.12239074707031</ns2:X>
                           <ns2:Y>40.78827667236328</ns2:Y>
                        </ns2:Pos>
                     </ns2:LineString>
                  </ns2:Exterior>
               </ns2:Polygon>
            </ns2:MultiPolygon>
            <IsoChroneCost>
               <ns3:Time uom="Minute">5.0</ns3:Time>
            </IsoChroneCost>
         </TravelBoundary>
      </GetTravelBoundaryResponse>
   </soap:Body>
</soap:Envelope>

Multiple Cost Example

Request for a Travel boundary with multiple costs.

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.mapinfo.com/routing/service/v1" xmlns:v11="http://www.mapinfo.com/midev/service/geometries/v1" xmlns:v12="http://www.mapinfo.com/midev/service/units/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:GetTravelBoundaryRequest id="" lang="">
      <v1:DatasetResourceName>US</v1:DatasetResourceName>
         <v1:Point srsName="epsg:4326">
        <v1:Point srsName="epsg:4326">
            <v11:Pos>
               <v11:X>-74.099876</v11:X>
               <v11:Y>40.814618</v11:Y>
             </v11:Pos>
         </v1:Point>
         <v1:Costs>            
         <v1:Cost xsi:type="v1:IsoChrone" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <v1:Time uom="Minute" xmlns:v1="http://www.mapinfo.com/midev/service/units/v1">5</v1:Time>
         </v1:Cost>
         <v1:Cost xsi:type="v1:IsoChrone" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <v1:Time uom="Minute" xmlns:v1="http://www.mapinfo.com/midev/service/units/v1">15</v1:Time>
        </v1:Cost>
        <v1:Cost xsi:type="v1:IsoChrone" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <v1:Time uom="Minute" xmlns:v1="http://www.mapinfo.com/midev/service/units/v1">20</v1:Time>
        </v1:Cost>
        <v1:Cost xsi:type="v1:IsoChrone" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <v1:Time uom="Minute" xmlns:v1="http://www.mapinfo.com/midev/service/units/v1">13</v1:Time>         
        </v1:Cost>
        </v1:Costs>
<!--optionals-->
        <v1:BandingStyle>Donut</v1:BandingStyle>
        <v1:MaxOffroadDistance uom="Mile">1</v1:MaxOffroadDistance>
        <v1:ReturnHoles>false</v1:ReturnHoles>
        <v1:ReturnIslands>false</v1:ReturnIslands>
        <v1:SimplificationFactor>0.5</v1:SimplificationFactor>
        <v1:DestinationSrs>epsg:4326</v1:DestinationSrs>
        <v1:MajorRoads>true</v1:MajorRoads>
        <v1:HistoricTrafficTimeBucket>none</v1:HistoricTrafficTimeBucket>

        <v1:AmbientSpeeds>
           <v1:AmbientCostEntry>
<v1:AmbientSpeedRoadType>AmbientSpeed.RoadType.LimitedAccessSuburban</v1:AmbientSpeedRoadType>
           <v1:AmbientSpeedCost xsi:type="v1:AmbientSpeedCost">
               	<v12:Speed uom="KPH">30</v12:Speed>
           </v1:AmbientSpeedCost>
          </v1:AmbientCostEntry>

          <v1:AmbientCostEntry>
<v1:AmbientSpeedRoadType>AmbientSpeed.RoadType.LimitedAccessRural</v1:AmbientSpeedRoadType>
          <v1:AmbientSpeedCost xsi:type="v1:AmbientSpeedCost">
               	<v12:Speed uom="MPH">30</v12:Speed>
             </v1:AmbientSpeedCost>
            </v1:AmbientCostEntry>
         </v1:AmbientSpeeds>
<!--optionals-->
       </v1:GetTravelBoundaryRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response for a Travel boundary with multiple costs.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <GetTravelBoundaryResponse xmlns="http://www.mapinfo.com/routing/service/v1" xmlns:ns2="http://www.mapinfo.com/midev/service/geometries/v1" xmlns:ns3="http://www.mapinfo.com/midev/service/units/v1" xmlns:ns4="http://www.mapinfo.com/midev/service/common/v1" xmlns:ns5="http://www.mapinfo.com/routing/service/common/v1">
         <TravelBoundary xsi:type="IsoChroneTravelBoundary" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ns2:MultiPolygon srsName="epsg:4326">
               <ns2:Polygon srsName="epsg:4326">
                  <ns2:Exterior>
                     <ns2:LineString>
                        <ns2:Pos>
                           <ns2:X>-74.12239074707031</ns2:X>
                           <ns2:Y>40.78827667236328</ns2:Y>
                        </ns2:Pos>
                        <ns2:Pos>
                           <ns2:X>-74.1226806640625</ns2:X>
                           <ns2:Y>40.788719177246094</ns2:Y>
                        </ns2:Pos>
                       		......
	
                           <ns2:Pos>
                              <ns2:X>-74.1853168033443</ns2:X>
                              <ns2:Y>40.65807664011055</ns2:Y>
                           </ns2:Pos>
                           <ns2:Pos>
                              <ns2:X>-74.18765315676006</ns2:X>
                              <ns2:Y>40.65807664011055</ns2:Y>
                           </ns2:Pos>
                        </ns2:LineString>
                     </ns2:Ring>
                  </ns2:InteriorList>
               </ns2:Polygon>
            </ns2:MultiPolygon>
            <IsoChroneCost>
               <ns3:Time uom="Minute">20.0</ns3:Time>
            </IsoChroneCost>
         </TravelBoundary>
         <TravelBoundary xsi:type="IsoChroneTravelBoundary" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ns2:MultiPolygon srsName="epsg:4326">
               <ns2:Polygon srsName="epsg:4326">
                  <ns2:Exterior>
                     <ns2:LineString>
                        <ns2:Pos>
                           <ns2:X>-74.1646741097915</ns2:X>
                           <ns2:Y>40.686006605152414</ns2:Y>
                        </ns2:Pos>
                        <ns2:Pos>
                           <ns2:X>-74.1646741097915</ns2:X>
                           <ns2:Y>40.68675357686172</ns2:Y>
                        </ns2:Pos>
                       		.......
		
                           <ns2:Pos>
                              <ns2:X>-74.1220932006836</ns2:X>
                              <ns2:Y>40.78827667236328</ns2:Y>
                           </ns2:Pos>
                           <ns2:Pos>
                              <ns2:X>-74.12239074707031</ns2:X>
                              <ns2:Y>40.78827667236328</ns2:Y>
                           </ns2:Pos>
                        </ns2:LineString>
                     </ns2:Ring>
                  </ns2:InteriorList>
               </ns2:Polygon>
            </ns2:MultiPolygon>
            <IsoChroneCost>
               <ns3:Time uom="Minute">13.0</ns3:Time>
            </IsoChroneCost>
         </TravelBoundary>
      </GetTravelBoundaryResponse>
   </soap:Body>
</soap:Envelope>