MDSRouteServiceSoap Web Service

MDSRouteServiceSoap

Click here for a complete list of operations.

RetrievePermanentRoutes

Allows the reuse of previously created, purpose built, stored routes.

Test

The test form is only available for methods with primitive types as parameters.

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/RetrievePermanentRoutes"

<?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>
    <RetrievePermanentRoutes xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
      <RouteNames>
        <string>string</string>
        <string>string</string>
      </RouteNames>
    </RetrievePermanentRoutes>
  </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>
    <RetrievePermanentRoutesResponse xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
      <RetrievePermanentRoutesResult>
        <Route>
          <Specification>
            <Segments xsi:nil="true" />
            <ReturnResult xsi:nil="true" />
            <DataSourceName>string</DataSourceName>
          </Specification>
          <Itinerary>
            <Segments xsi:nil="true" />
            <TripTime>long</TripTime>
            <DrivingTime>long</DrivingTime>
            <Distance>double</Distance>
            <View xsi:nil="true" />
            <Towns xsi:nil="true" />
            <Points xsi:nil="true" />
          </Itinerary>
          <CalculatedRepresentation>
            <DrawLine xsi:nil="true" />
          </CalculatedRepresentation>
        </Route>
        <Route>
          <Specification>
            <Segments xsi:nil="true" />
            <ReturnResult xsi:nil="true" />
            <DataSourceName>string</DataSourceName>
          </Specification>
          <Itinerary>
            <Segments xsi:nil="true" />
            <TripTime>long</TripTime>
            <DrivingTime>long</DrivingTime>
            <Distance>double</Distance>
            <View xsi:nil="true" />
            <Towns xsi:nil="true" />
            <Points xsi:nil="true" />
          </Itinerary>
          <CalculatedRepresentation>
            <DrawLine xsi:nil="true" />
          </CalculatedRepresentation>
        </Route>
      </RetrievePermanentRoutesResult>
    </RetrievePermanentRoutesResponse>
  </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>
    <RetrievePermanentRoutes xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
      <RouteNames>
        <string>string</string>
        <string>string</string>
      </RouteNames>
    </RetrievePermanentRoutes>
  </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>
    <RetrievePermanentRoutesResponse xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
      <RetrievePermanentRoutesResult>
        <Route>
          <Specification>
            <Segments xsi:nil="true" />
            <ReturnResult xsi:nil="true" />
            <DataSourceName>string</DataSourceName>
          </Specification>
          <Itinerary>
            <Segments xsi:nil="true" />
            <TripTime>long</TripTime>
            <DrivingTime>long</DrivingTime>
            <Distance>double</Distance>
            <View xsi:nil="true" />
            <Towns xsi:nil="true" />
            <Points xsi:nil="true" />
          </Itinerary>
          <CalculatedRepresentation>
            <DrawLine xsi:nil="true" />
          </CalculatedRepresentation>
        </Route>
        <Route>
          <Specification>
            <Segments xsi:nil="true" />
            <ReturnResult xsi:nil="true" />
            <DataSourceName>string</DataSourceName>
          </Specification>
          <Itinerary>
            <Segments xsi:nil="true" />
            <TripTime>long</TripTime>
            <DrivingTime>long</DrivingTime>
            <Distance>double</Distance>
            <View xsi:nil="true" />
            <Towns xsi:nil="true" />
            <Points xsi:nil="true" />
          </Itinerary>
          <CalculatedRepresentation>
            <DrawLine xsi:nil="true" />
          </CalculatedRepresentation>
        </Route>
      </RetrievePermanentRoutesResult>
    </RetrievePermanentRoutesResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /mdsservicesr2/MDSrouteServiceSoap.asmx/RetrievePermanentRoutes?RouteNames=string&RouteNames=string HTTP/1.1
Host: apps.nowwhere.com.au

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfRoute xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
  <Route>
    <Specification>
      <Segments>
        <SegmentSpecification d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SegmentSpecification d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Segments>
      <ReturnResult>
        <resultCode>int</resultCode>
        <resultExplanation>string</resultExplanation>
        <retentionTypeBuilt>Session or Permanent</retentionTypeBuilt>
      </ReturnResult>
      <DataSourceName>string</DataSourceName>
    </Specification>
    <Itinerary>
      <Segments>
        <Segment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Segment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Segments>
      <TripTime>long</TripTime>
      <DrivingTime>long</DrivingTime>
      <Distance>double</Distance>
      <View>
        <ByHeightWidth d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ByBoundingRectangle d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ByLevelCentreSize d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </View>
      <Towns>
        <Location d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Location d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Towns>
      <Points>
        <LatLong d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LatLong d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Points>
    </Itinerary>
    <CalculatedRepresentation>
      <DrawLine>
        <MapFileName>string</MapFileName>
        <Opacity>double</Opacity>
        <Width>int</Width>
        <LineStyle>int</LineStyle>
        <InnerCol>int</InnerCol>
        <OuterCol>int</OuterCol>
      </DrawLine>
    </CalculatedRepresentation>
  </Route>
  <Route>
    <Specification>
      <Segments>
        <SegmentSpecification d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SegmentSpecification d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Segments>
      <ReturnResult>
        <resultCode>int</resultCode>
        <resultExplanation>string</resultExplanation>
        <retentionTypeBuilt>Session or Permanent</retentionTypeBuilt>
      </ReturnResult>
      <DataSourceName>string</DataSourceName>
    </Specification>
    <Itinerary>
      <Segments>
        <Segment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Segment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Segments>
      <TripTime>long</TripTime>
      <DrivingTime>long</DrivingTime>
      <Distance>double</Distance>
      <View>
        <ByHeightWidth d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ByBoundingRectangle d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ByLevelCentreSize d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </View>
      <Towns>
        <Location d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Location d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Towns>
      <Points>
        <LatLong d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LatLong d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Points>
    </Itinerary>
    <CalculatedRepresentation>
      <DrawLine>
        <MapFileName>string</MapFileName>
        <Opacity>double</Opacity>
        <Width>int</Width>
        <LineStyle>int</LineStyle>
        <InnerCol>int</InnerCol>
        <OuterCol>int</OuterCol>
      </DrawLine>
    </CalculatedRepresentation>
  </Route>
</ArrayOfRoute>

HTTP POST

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

POST /mdsservicesr2/MDSrouteServiceSoap.asmx/RetrievePermanentRoutes HTTP/1.1
Host: apps.nowwhere.com.au
Content-Type: application/x-www-form-urlencoded
Content-Length: length

RouteNames=string&RouteNames=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfRoute xmlns="http://mapds.com.au/MDSServices/MDSRouteServiceSoap">
  <Route>
    <Specification>
      <Segments>
        <SegmentSpecification d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SegmentSpecification d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Segments>
      <ReturnResult>
        <resultCode>int</resultCode>
        <resultExplanation>string</resultExplanation>
        <retentionTypeBuilt>Session or Permanent</retentionTypeBuilt>
      </ReturnResult>
      <DataSourceName>string</DataSourceName>
    </Specification>
    <Itinerary>
      <Segments>
        <Segment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Segment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Segments>
      <TripTime>long</TripTime>
      <DrivingTime>long</DrivingTime>
      <Distance>double</Distance>
      <View>
        <ByHeightWidth d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ByBoundingRectangle d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ByLevelCentreSize d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </View>
      <Towns>
        <Location d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Location d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Towns>
      <Points>
        <LatLong d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LatLong d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Points>
    </Itinerary>
    <CalculatedRepresentation>
      <DrawLine>
        <MapFileName>string</MapFileName>
        <Opacity>double</Opacity>
        <Width>int</Width>
        <LineStyle>int</LineStyle>
        <InnerCol>int</InnerCol>
        <OuterCol>int</OuterCol>
      </DrawLine>
    </CalculatedRepresentation>
  </Route>
  <Route>
    <Specification>
      <Segments>
        <SegmentSpecification d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SegmentSpecification d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Segments>
      <ReturnResult>
        <resultCode>int</resultCode>
        <resultExplanation>string</resultExplanation>
        <retentionTypeBuilt>Session or Permanent</retentionTypeBuilt>
      </ReturnResult>
      <DataSourceName>string</DataSourceName>
    </Specification>
    <Itinerary>
      <Segments>
        <Segment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Segment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Segments>
      <TripTime>long</TripTime>
      <DrivingTime>long</DrivingTime>
      <Distance>double</Distance>
      <View>
        <ByHeightWidth d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ByBoundingRectangle d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ByLevelCentreSize d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </View>
      <Towns>
        <Location d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Location d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Towns>
      <Points>
        <LatLong d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LatLong d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Points>
    </Itinerary>
    <CalculatedRepresentation>
      <DrawLine>
        <MapFileName>string</MapFileName>
        <Opacity>double</Opacity>
        <Width>int</Width>
        <LineStyle>int</LineStyle>
        <InnerCol>int</InnerCol>
        <OuterCol>int</OuterCol>
      </DrawLine>
    </CalculatedRepresentation>
  </Route>
</ArrayOfRoute>