MDSRouteServiceSoap Web Service

MDSRouteServiceSoap

Click here for a complete list of operations.

CalculateSimpleRoute

Calculate a route according to the specified settings

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 /mdsservicesr2/MDSrouteServiceSoap.asmx HTTP/1.1
Host: apps.nowwhere.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://mapds.com.au/MDSServices/MDSRouteServiceSoap/CalculateSimpleRoute"

<?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>
    <AuthHeader xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
      <Username>string</Username>
      <Password>string</Password>
      <CallerID>string</CallerID>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <CalculateSimpleRoute xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
      <latLongs>
        <LatLong>
          <Latitude>double</Latitude>
          <Longitude>double</Longitude>
        </LatLong>
        <LatLong>
          <Latitude>double</Latitude>
          <Longitude>double</Longitude>
        </LatLong>
      </latLongs>
      <dataSourceName>string</dataSourceName>
      <preference>
        <buildPreference>Quickest or Shortest or Simplest</buildPreference>
        <avoidPreference>NoAvoid or PBSUNCLASSIFIED or Ferries or Tollways or Tunnels or UnsealedRoads or PBS1A or PBS2A or PBS3A or PBS4A</avoidPreference>
        <buildDetailLevel>mainRoads or streets or tracks</buildDetailLevel>
        <outputDetail>AllPermitted or DistanceTimeOnly</outputDetail>
        <retentionPeriod>Session or Permanent</retentionPeriod>
        <retentionName>string</retentionName>
        <BreakDown>Single or Multiple</BreakDown>
      </preference>
    </CalculateSimpleRoute>
  </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>
    <CalculateSimpleRouteResponse xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
      <CalculateSimpleRouteResult>
        <Specification>
          <Segments>
            <SegmentSpecification xsi:nil="true" />
            <SegmentSpecification xsi:nil="true" />
          </Segments>
          <ReturnResult>
            <resultCode>int</resultCode>
            <resultExplanation>string</resultExplanation>
            <retentionTypeBuilt>Session or Permanent</retentionTypeBuilt>
          </ReturnResult>
          <DataSourceName>string</DataSourceName>
        </Specification>
        <Itinerary>
          <Segments>
            <Segment xsi:nil="true" />
            <Segment xsi:nil="true" />
          </Segments>
          <TripTime>long</TripTime>
          <DrivingTime>long</DrivingTime>
          <Distance>double</Distance>
          <View>
            <ByHeightWidth xsi:nil="true" />
            <ByBoundingRectangle xsi:nil="true" />
            <ByLevelCentreSize xsi:nil="true" />
          </View>
          <Towns>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </Towns>
          <Points>
            <LatLong xsi:nil="true" />
            <LatLong xsi:nil="true" />
          </Points>
        </Itinerary>
        <CalculatedRepresentation>
          <DrawLine>
            <MapFileName>string</MapFileName>
            <Opacity>double</Opacity>
            <Width>int</Width>
            <LineStyle>int</LineStyle>
            <InnerCol>int</InnerCol>
            <OuterCol>int</OuterCol>
          </DrawLine>
        </CalculatedRepresentation>
      </CalculateSimpleRouteResult>
    </CalculateSimpleRouteResponse>
  </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 /mdsservicesr2/MDSrouteServiceSoap.asmx HTTP/1.1
Host: apps.nowwhere.com.au
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>
    <AuthHeader xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
      <Username>string</Username>
      <Password>string</Password>
      <CallerID>string</CallerID>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <CalculateSimpleRoute xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
      <latLongs>
        <LatLong>
          <Latitude>double</Latitude>
          <Longitude>double</Longitude>
        </LatLong>
        <LatLong>
          <Latitude>double</Latitude>
          <Longitude>double</Longitude>
        </LatLong>
      </latLongs>
      <dataSourceName>string</dataSourceName>
      <preference>
        <buildPreference>Quickest or Shortest or Simplest</buildPreference>
        <avoidPreference>NoAvoid or PBSUNCLASSIFIED or Ferries or Tollways or Tunnels or UnsealedRoads or PBS1A or PBS2A or PBS3A or PBS4A</avoidPreference>
        <buildDetailLevel>mainRoads or streets or tracks</buildDetailLevel>
        <outputDetail>AllPermitted or DistanceTimeOnly</outputDetail>
        <retentionPeriod>Session or Permanent</retentionPeriod>
        <retentionName>string</retentionName>
        <BreakDown>Single or Multiple</BreakDown>
      </preference>
    </CalculateSimpleRoute>
  </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>
    <CalculateSimpleRouteResponse xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
      <CalculateSimpleRouteResult>
        <Specification>
          <Segments>
            <SegmentSpecification xsi:nil="true" />
            <SegmentSpecification xsi:nil="true" />
          </Segments>
          <ReturnResult>
            <resultCode>int</resultCode>
            <resultExplanation>string</resultExplanation>
            <retentionTypeBuilt>Session or Permanent</retentionTypeBuilt>
          </ReturnResult>
          <DataSourceName>string</DataSourceName>
        </Specification>
        <Itinerary>
          <Segments>
            <Segment xsi:nil="true" />
            <Segment xsi:nil="true" />
          </Segments>
          <TripTime>long</TripTime>
          <DrivingTime>long</DrivingTime>
          <Distance>double</Distance>
          <View>
            <ByHeightWidth xsi:nil="true" />
            <ByBoundingRectangle xsi:nil="true" />
            <ByLevelCentreSize xsi:nil="true" />
          </View>
          <Towns>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </Towns>
          <Points>
            <LatLong xsi:nil="true" />
            <LatLong xsi:nil="true" />
          </Points>
        </Itinerary>
        <CalculatedRepresentation>
          <DrawLine>
            <MapFileName>string</MapFileName>
            <Opacity>double</Opacity>
            <Width>int</Width>
            <LineStyle>int</LineStyle>
            <InnerCol>int</InnerCol>
            <OuterCol>int</OuterCol>
          </DrawLine>
        </CalculatedRepresentation>
      </CalculateSimpleRouteResult>
    </CalculateSimpleRouteResponse>
  </soap12:Body>
</soap12:Envelope>