XRouteWSService Web Service

XRouteWSService

Click here for a complete list of operations.

calculateRouteInfo

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /0.1/xroute/ws/xroute.asmx HTTP/1.1
Host: soap.locatienet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://soap.locatienet.com/calculateRouteInfo"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ServiceAuthenticateInformation xmlns="http://soap.locatienet.com">
      <UserName>string</UserName>
      <Password>string</Password>
      <ConfigFilePath>string</ConfigFilePath>
      <OverrideLinkType>boolean</OverrideLinkType>
      <ClientId>int</ClientId>
    </ServiceAuthenticateInformation>
  </soap:Header>
  <soap:Body>
    <calculateRouteInfo xmlns="http://soap.locatienet.com">
      <waypointDescs>
        <WaypointDesc combinedTransportID="string" fuzzyRadius="int" heading="int" linkType="NEXT_NODE or NEXT_SEGMENT or NEXT_MAIN_NODE or FUZZY_LINKING or AUTO_LINKING or NEXT_MAIN_TOLL_NODE or TOLL_STATION or TI_LINKING" street="string">
          <wrappedCoords xmlns="http://xroute.xserver.ptvag.com">
            <Point xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
            <Point xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </wrappedCoords>
          <nodeID iuCode="int" n="int" tID="long" xOff="int" yOff="int" xmlns="http://xroute.xserver.ptvag.com" />
          <wrappedRoutingOptions xmlns="http://xroute.xserver.ptvag.com">
            <RoutingOption xsi:nil="true" />
            <RoutingOption xsi:nil="true" />
          </wrappedRoutingOptions>
          <wrappedSegmentID xmlns="http://xroute.xserver.ptvag.com">
            <UniqueGeoID xsi:nil="true" />
            <UniqueGeoID xsi:nil="true" />
          </wrappedSegmentID>
          <wrappedVehicleOptions xmlns="http://xroute.xserver.ptvag.com">
            <VehicleOption xsi:nil="true" />
            <VehicleOption xsi:nil="true" />
          </wrappedVehicleOptions>
          <viaType viaType="VIA or VIA_STOP or FUZZY or COMBINED_TRANSPORT" xmlns="http://xroute.xserver.ptvag.com" />
        </WaypointDesc>
        <WaypointDesc combinedTransportID="string" fuzzyRadius="int" heading="int" linkType="NEXT_NODE or NEXT_SEGMENT or NEXT_MAIN_NODE or FUZZY_LINKING or AUTO_LINKING or NEXT_MAIN_TOLL_NODE or TOLL_STATION or TI_LINKING" street="string">
          <wrappedCoords xmlns="http://xroute.xserver.ptvag.com">
            <Point xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
            <Point xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </wrappedCoords>
          <nodeID iuCode="int" n="int" tID="long" xOff="int" yOff="int" xmlns="http://xroute.xserver.ptvag.com" />
          <wrappedRoutingOptions xmlns="http://xroute.xserver.ptvag.com">
            <RoutingOption xsi:nil="true" />
            <RoutingOption xsi:nil="true" />
          </wrappedRoutingOptions>
          <wrappedSegmentID xmlns="http://xroute.xserver.ptvag.com">
            <UniqueGeoID xsi:nil="true" />
            <UniqueGeoID xsi:nil="true" />
          </wrappedSegmentID>
          <wrappedVehicleOptions xmlns="http://xroute.xserver.ptvag.com">
            <VehicleOption xsi:nil="true" />
            <VehicleOption xsi:nil="true" />
          </wrappedVehicleOptions>
          <viaType viaType="VIA or VIA_STOP or FUZZY or COMBINED_TRANSPORT" xmlns="http://xroute.xserver.ptvag.com" />
        </WaypointDesc>
      </waypointDescs>
      <routingOptions>
        <RoutingOption parameter="OPTIMIZATION or SPEED_PROFILE or AVOID_NATIONALNAMEDTOLL_ROADS or AVOID_TOLLROADS or AVOID_VIGNETTEROADS or AVOID_HIGHWAYS or AVOID_FERRIES or AVOID_RESIDENTS_ONLY or AVOID_URBAN_AREAS or AVOID_RAMPS or AVOID_LOW_EMISSION_ZONES or ALLOW_SEGMENT_VIOLATIONS or COST_OF_SEGMENT_VIOLATIONS or EXCLUDE_COUNTRIES or ROUTING_COUNTRIES or ROUTING_RECTANGLE or ROUTE_LANGUAGE or START_TIME or IS_DESTTIME or DYNAMIC_PROFILE or ENABLE_DYNAMIC or ENABLE_ROADEDITOR or START_TIME_ROADEDITOR or ROADEDITOR_LAYERNAME or ROADEDITOR_ATTRIBUTESET or ROADEDITOR_ADDITIONAL_OPTIONS or DISTANCE_MEASURE or COUNTRY_ENCODING or GENERATE_EXTWAYPOINTS or EXPERT_OPTIONS or REQUEST_VERSION or LOW_EMISSION_ZONE_TYPE or DYNAMIC_TIME_ON_STATICROUTE or DYNAMIC_TRAVEL_TIME_STEP_SIZE or DYNAMIC_TRAVEL_TIME_STEP_COUNT or SPEED_INFOS or ENABLE_DYNAMIC_WITH_FREE_FLOW_SPEED or GEODATASOURCE_LAYER or REMAINING_DRIVING_TIMES" value="string" />
        <RoutingOption parameter="OPTIMIZATION or SPEED_PROFILE or AVOID_NATIONALNAMEDTOLL_ROADS or AVOID_TOLLROADS or AVOID_VIGNETTEROADS or AVOID_HIGHWAYS or AVOID_FERRIES or AVOID_RESIDENTS_ONLY or AVOID_URBAN_AREAS or AVOID_RAMPS or AVOID_LOW_EMISSION_ZONES or ALLOW_SEGMENT_VIOLATIONS or COST_OF_SEGMENT_VIOLATIONS or EXCLUDE_COUNTRIES or ROUTING_COUNTRIES or ROUTING_RECTANGLE or ROUTE_LANGUAGE or START_TIME or IS_DESTTIME or DYNAMIC_PROFILE or ENABLE_DYNAMIC or ENABLE_ROADEDITOR or START_TIME_ROADEDITOR or ROADEDITOR_LAYERNAME or ROADEDITOR_ATTRIBUTESET or ROADEDITOR_ADDITIONAL_OPTIONS or DISTANCE_MEASURE or COUNTRY_ENCODING or GENERATE_EXTWAYPOINTS or EXPERT_OPTIONS or REQUEST_VERSION or LOW_EMISSION_ZONE_TYPE or DYNAMIC_TIME_ON_STATICROUTE or DYNAMIC_TRAVEL_TIME_STEP_SIZE or DYNAMIC_TRAVEL_TIME_STEP_COUNT or SPEED_INFOS or ENABLE_DYNAMIC_WITH_FREE_FLOW_SPEED or GEODATASOURCE_LAYER or REMAINING_DRIVING_TIMES" value="string" />
      </routingOptions>
      <exceptionPaths>
        <ExceptionPath absTimeMalus="int" binaryPathDesc="string" extSegments="string" relMalus="int" street="string">
          <intersectingLine xmlns="http://xroute.xserver.ptvag.com">
            <lineString xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </intersectingLine>
          <wrappedNodes xmlns="http://xroute.xserver.ptvag.com">
            <UniqueGeoID xsi:nil="true" />
            <UniqueGeoID xsi:nil="true" />
          </wrappedNodes>
          <polyline xmlns="http://xroute.xserver.ptvag.com">
            <lineString xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </polyline>
        </ExceptionPath>
        <ExceptionPath absTimeMalus="int" binaryPathDesc="string" extSegments="string" relMalus="int" street="string">
          <intersectingLine xmlns="http://xroute.xserver.ptvag.com">
            <lineString xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </intersectingLine>
          <wrappedNodes xmlns="http://xroute.xserver.ptvag.com">
            <UniqueGeoID xsi:nil="true" />
            <UniqueGeoID xsi:nil="true" />
          </wrappedNodes>
          <polyline xmlns="http://xroute.xserver.ptvag.com">
            <lineString xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </polyline>
        </ExceptionPath>
      </exceptionPaths>
      <callerContext log1="string" log2="string" log3="string">
        <wrappedProperties xmlns="http://baseservices.service.jabba.ptvag.com">
          <CallerContextProperty key="string" value="string" />
          <CallerContextProperty key="string" value="string" />
        </wrappedProperties>
      </callerContext>
    </calculateRouteInfo>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <calculateRouteInfoResponse xmlns="http://soap.locatienet.com">
      <calculateRouteInfoResult cost="int" distance="int" hasViolations="boolean" time="int">
        <wrappedTravelTrend xmlns="http://xroute.xserver.ptvag.com">
          <CommuterTravelTrend departureTime="dateTime" travelTime="int" />
          <CommuterTravelTrend departureTime="dateTime" travelTime="int" />
        </wrappedTravelTrend>
      </calculateRouteInfoResult>
    </calculateRouteInfoResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /0.1/xroute/ws/xroute.asmx HTTP/1.1
Host: soap.locatienet.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <ServiceAuthenticateInformation xmlns="http://soap.locatienet.com">
      <UserName>string</UserName>
      <Password>string</Password>
      <ConfigFilePath>string</ConfigFilePath>
      <OverrideLinkType>boolean</OverrideLinkType>
      <ClientId>int</ClientId>
    </ServiceAuthenticateInformation>
  </soap12:Header>
  <soap12:Body>
    <calculateRouteInfo xmlns="http://soap.locatienet.com">
      <waypointDescs>
        <WaypointDesc combinedTransportID="string" fuzzyRadius="int" heading="int" linkType="NEXT_NODE or NEXT_SEGMENT or NEXT_MAIN_NODE or FUZZY_LINKING or AUTO_LINKING or NEXT_MAIN_TOLL_NODE or TOLL_STATION or TI_LINKING" street="string">
          <wrappedCoords xmlns="http://xroute.xserver.ptvag.com">
            <Point xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
            <Point xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </wrappedCoords>
          <nodeID iuCode="int" n="int" tID="long" xOff="int" yOff="int" xmlns="http://xroute.xserver.ptvag.com" />
          <wrappedRoutingOptions xmlns="http://xroute.xserver.ptvag.com">
            <RoutingOption xsi:nil="true" />
            <RoutingOption xsi:nil="true" />
          </wrappedRoutingOptions>
          <wrappedSegmentID xmlns="http://xroute.xserver.ptvag.com">
            <UniqueGeoID xsi:nil="true" />
            <UniqueGeoID xsi:nil="true" />
          </wrappedSegmentID>
          <wrappedVehicleOptions xmlns="http://xroute.xserver.ptvag.com">
            <VehicleOption xsi:nil="true" />
            <VehicleOption xsi:nil="true" />
          </wrappedVehicleOptions>
          <viaType viaType="VIA or VIA_STOP or FUZZY or COMBINED_TRANSPORT" xmlns="http://xroute.xserver.ptvag.com" />
        </WaypointDesc>
        <WaypointDesc combinedTransportID="string" fuzzyRadius="int" heading="int" linkType="NEXT_NODE or NEXT_SEGMENT or NEXT_MAIN_NODE or FUZZY_LINKING or AUTO_LINKING or NEXT_MAIN_TOLL_NODE or TOLL_STATION or TI_LINKING" street="string">
          <wrappedCoords xmlns="http://xroute.xserver.ptvag.com">
            <Point xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
            <Point xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </wrappedCoords>
          <nodeID iuCode="int" n="int" tID="long" xOff="int" yOff="int" xmlns="http://xroute.xserver.ptvag.com" />
          <wrappedRoutingOptions xmlns="http://xroute.xserver.ptvag.com">
            <RoutingOption xsi:nil="true" />
            <RoutingOption xsi:nil="true" />
          </wrappedRoutingOptions>
          <wrappedSegmentID xmlns="http://xroute.xserver.ptvag.com">
            <UniqueGeoID xsi:nil="true" />
            <UniqueGeoID xsi:nil="true" />
          </wrappedSegmentID>
          <wrappedVehicleOptions xmlns="http://xroute.xserver.ptvag.com">
            <VehicleOption xsi:nil="true" />
            <VehicleOption xsi:nil="true" />
          </wrappedVehicleOptions>
          <viaType viaType="VIA or VIA_STOP or FUZZY or COMBINED_TRANSPORT" xmlns="http://xroute.xserver.ptvag.com" />
        </WaypointDesc>
      </waypointDescs>
      <routingOptions>
        <RoutingOption parameter="OPTIMIZATION or SPEED_PROFILE or AVOID_NATIONALNAMEDTOLL_ROADS or AVOID_TOLLROADS or AVOID_VIGNETTEROADS or AVOID_HIGHWAYS or AVOID_FERRIES or AVOID_RESIDENTS_ONLY or AVOID_URBAN_AREAS or AVOID_RAMPS or AVOID_LOW_EMISSION_ZONES or ALLOW_SEGMENT_VIOLATIONS or COST_OF_SEGMENT_VIOLATIONS or EXCLUDE_COUNTRIES or ROUTING_COUNTRIES or ROUTING_RECTANGLE or ROUTE_LANGUAGE or START_TIME or IS_DESTTIME or DYNAMIC_PROFILE or ENABLE_DYNAMIC or ENABLE_ROADEDITOR or START_TIME_ROADEDITOR or ROADEDITOR_LAYERNAME or ROADEDITOR_ATTRIBUTESET or ROADEDITOR_ADDITIONAL_OPTIONS or DISTANCE_MEASURE or COUNTRY_ENCODING or GENERATE_EXTWAYPOINTS or EXPERT_OPTIONS or REQUEST_VERSION or LOW_EMISSION_ZONE_TYPE or DYNAMIC_TIME_ON_STATICROUTE or DYNAMIC_TRAVEL_TIME_STEP_SIZE or DYNAMIC_TRAVEL_TIME_STEP_COUNT or SPEED_INFOS or ENABLE_DYNAMIC_WITH_FREE_FLOW_SPEED or GEODATASOURCE_LAYER or REMAINING_DRIVING_TIMES" value="string" />
        <RoutingOption parameter="OPTIMIZATION or SPEED_PROFILE or AVOID_NATIONALNAMEDTOLL_ROADS or AVOID_TOLLROADS or AVOID_VIGNETTEROADS or AVOID_HIGHWAYS or AVOID_FERRIES or AVOID_RESIDENTS_ONLY or AVOID_URBAN_AREAS or AVOID_RAMPS or AVOID_LOW_EMISSION_ZONES or ALLOW_SEGMENT_VIOLATIONS or COST_OF_SEGMENT_VIOLATIONS or EXCLUDE_COUNTRIES or ROUTING_COUNTRIES or ROUTING_RECTANGLE or ROUTE_LANGUAGE or START_TIME or IS_DESTTIME or DYNAMIC_PROFILE or ENABLE_DYNAMIC or ENABLE_ROADEDITOR or START_TIME_ROADEDITOR or ROADEDITOR_LAYERNAME or ROADEDITOR_ATTRIBUTESET or ROADEDITOR_ADDITIONAL_OPTIONS or DISTANCE_MEASURE or COUNTRY_ENCODING or GENERATE_EXTWAYPOINTS or EXPERT_OPTIONS or REQUEST_VERSION or LOW_EMISSION_ZONE_TYPE or DYNAMIC_TIME_ON_STATICROUTE or DYNAMIC_TRAVEL_TIME_STEP_SIZE or DYNAMIC_TRAVEL_TIME_STEP_COUNT or SPEED_INFOS or ENABLE_DYNAMIC_WITH_FREE_FLOW_SPEED or GEODATASOURCE_LAYER or REMAINING_DRIVING_TIMES" value="string" />
      </routingOptions>
      <exceptionPaths>
        <ExceptionPath absTimeMalus="int" binaryPathDesc="string" extSegments="string" relMalus="int" street="string">
          <intersectingLine xmlns="http://xroute.xserver.ptvag.com">
            <lineString xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </intersectingLine>
          <wrappedNodes xmlns="http://xroute.xserver.ptvag.com">
            <UniqueGeoID xsi:nil="true" />
            <UniqueGeoID xsi:nil="true" />
          </wrappedNodes>
          <polyline xmlns="http://xroute.xserver.ptvag.com">
            <lineString xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </polyline>
        </ExceptionPath>
        <ExceptionPath absTimeMalus="int" binaryPathDesc="string" extSegments="string" relMalus="int" street="string">
          <intersectingLine xmlns="http://xroute.xserver.ptvag.com">
            <lineString xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </intersectingLine>
          <wrappedNodes xmlns="http://xroute.xserver.ptvag.com">
            <UniqueGeoID xsi:nil="true" />
            <UniqueGeoID xsi:nil="true" />
          </wrappedNodes>
          <polyline xmlns="http://xroute.xserver.ptvag.com">
            <lineString xsi:nil="true" xmlns="http://common.xserver.ptvag.com" />
          </polyline>
        </ExceptionPath>
      </exceptionPaths>
      <callerContext log1="string" log2="string" log3="string">
        <wrappedProperties xmlns="http://baseservices.service.jabba.ptvag.com">
          <CallerContextProperty key="string" value="string" />
          <CallerContextProperty key="string" value="string" />
        </wrappedProperties>
      </callerContext>
    </calculateRouteInfo>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <calculateRouteInfoResponse xmlns="http://soap.locatienet.com">
      <calculateRouteInfoResult cost="int" distance="int" hasViolations="boolean" time="int">
        <wrappedTravelTrend xmlns="http://xroute.xserver.ptvag.com">
          <CommuterTravelTrend departureTime="dateTime" travelTime="int" />
          <CommuterTravelTrend departureTime="dateTime" travelTime="int" />
        </wrappedTravelTrend>
      </calculateRouteInfoResult>
    </calculateRouteInfoResponse>
  </soap12:Body>
</soap12:Envelope>