EMS : Appendix 7 - v1 SOAP to v2 JSON Data Types

Created and last modified by Pierce, Todd on Jan 15, 2015

[ Whereis® API Home ] [ Appendices ]

The following table shows changes to data types between v1 SOAP and v2 JSON:

Type

v1 SOAP API

v2 JSON API

Reference

Geocode request

<address>
<street>222 lonsdale street</street>
<suburb>melbourne</suburb>
<state>vic</state>

</address>
{
    "display":<string>,
    "number":<string>,
    "street":<street>,
    "property":<string>,
    "intersection":[<street>],
    "suburb":<string>,
    "region":<string>,
    "type":<string>,
    "postcode":<string>,
    "state":<string>,
    "regions":[<string>]
}

 

 

 

 

v1 SOAP Geocode

v2 Structured Geocode

 

See also:

v2 Unstructured Geocode

 

Geocode response

<geocodedAddress>

<coordinates>

<latitude>-37.81113</latitude>
<longitude>144.9652</longitude>

</coordinates>
<number>222-226</number>
<postcode>3000</postcode>
<state>VIC</state>
<street>

<directionalPrefix/>
<directionalSuffix/>
<fullName>LONSDALE ST</fullName>
<name>LONSDALE</name>
<type>ST</type>

</street>
<suburb>MELBOURNE</suburb>

</geocodedAddress>

 

 

{

  "id": <string>,

  "centrePoint":<point>,

  "streetPoint":<point>,

  "approximated": <Boolean>,

  "granularity": "PROPERTY",

  "address": <address>

}

 

 

 

Reverse geocode request

<point>

<latitude>-37.81267</latitude> <longitude>144.99362</longitude>
</point>
{

    "location":<point>,

    "granularity":[<string>],

    "radius":<int>

}

 

 
 

 

SOAP Reverse Geocode

v2 Reverse Geocode

 

Reverse geocode response

<return>

<coordinates>

<latitude>-37.81267</latitude>
<longitude>144.99362</longitude>

</coordinates>
<number>8</number>
<postcode>3121</postcode>
<state>VIC</state>
<street>

<directionalPrefix/>
<directionalSuffix/>
<fullName>SMITH ST</fullName>
<name>SMITH</name>
<type>ST</type>

</street>
<streetCoordinates>

<latitude>-37.81267</latitude>
<longitude>144.99362</longitude>

</streetCoordinates>
<suburb>RICHMOND</suburb>

</return>

See geocode response address, above

JSON geocode response:

http://api.ems.sensis.com.au/v2/docs/api/64395124.html

 

Rank request

<reference>

<latitude>-37.81267</latitude>
<longitude>144.99362</longitude>

</reference>
<points>

<latitude>-37.81244</latitude>
<longitude>144.96636</longitude>

</points>
<points>

<latitude>-37.81742</latitude>
<longitude>144.96681</longitude>

</points>
<rankType>5</rankType>
<tolls>false</tolls>

{
    "startPoint":<point>,
    "tolls":<Boolean>,
    "method":<string>,
    "mode":<string>,
    "endPoints":[{<point>}]
}

 

SOAP rank operations

http://ems.whereis.com/v1/web/documentation/soap/SoapGuide.htm#rankoperations

 

JSON rank

http://api.ems.sensis.com.au/v2/docs/api/Rank_64395002.html

 
 

Rank response

<return>

<distanceMetres>2771</distanceMetres>
<point>

<latitude>-37.81244</latitude>
<longitude>144.96636</longitude>

</point>
<rank>1</rank>
<travelTimeSeconds>360</travelTimeSeconds>

</return>
...

 

{
  "rankedPoints": [
    {
      "rankMethod": <string>,
      "coordinates": <point>,
      "distanceMetres": <int>,
      "sourceIndex": <int>,
      "travTimeSeconds": <int>
    },
    ...

}

 

SOAP rank operations

http://ems.whereis.com/v1/web/documentation/soap/SoapGuide.htm#rankoperations

 

JSON rankedPoint

http://api.ems.sensis.com.au/v2/docs/api/64395126.html

 

Route request

<wayPoints>

<latitude>-37.98838</latitude>
<longitude>145.21514</longitude>

</wayPoints>
<wayPoints>

<latitude>-37.81113</latitude>
<longitude>144.9652</longitude>

</wayPoints>
<routeType>

<fastest>false</fastest>
<tolls>false</tolls>
<transport>road</transport>

</routeType>

{
    "mode":<string>,
    "method":<string>,
    "tolls": <Boolean>,
    "imageformat":<string>,
    "waypoints":[<waypoint>,
          <waypoint>],
    "avoidPoints":[<point>]
}

 

SOAP route operations

http://ems.whereis.com/v1/web/documentation/soap/SoapGuide.htm#soaprouteop

 

JSON route request

http://api.ems.sensis.com.au/v2/docs/api/Route_64395008.html

 

 

Route response

 

{
  "route": {
    "startPoint": <point>,
    "endPoint": <point>,
    "handle": <routeHandle>,
    "routes": [<leg>,...],
    "bounds": <bounds>,
    "duration": <int>,
    "distance": <double>
}

SOAP route operations

http://ems.whereis.com/v1/web/documentation/soap/SoapGuide.htm#soaprouteop

 

JSON route response

http://api.ems.sensis.com.au/v2/docs/api/64395131.html