Dev: SM: XML - Reverse Geocode Lookup

From AAT Wiki
Jump to: navigation, search

Usage

https://www.streetmaps.co.za/lookup.asp?x=X_COORD&y=Y_COORD[&x2=X&y2=Y[&x2=X&y2=Y...]][&range=METERS][&xml=1]
x, y The x and y coordinates of the point to reverse geocode
x2, y2, ... The x and y coordinates of further points to reverse geocode
range (optional) The search range, in meters; if this is not specified then you might only find a road a very long distance from the point
xml (optional) If specified, results will be returned as XML, otherwise it will be a comma-delimited list.

Returns

The format of the returned data depends on whether XML=1 was specified in the call or not. Some notes about the returned data

  • If range is specified, then "-" will be returned if it's not within the range, and ExtraInfo will be filled int
  • If Suburb or City aren't available, "-" will be returned in that field
  • If Suburb AND City aren't available, then ExtraInfo will have a description of a position, otherwise it will be "-"

XML

<?xml version="1.0" encoding="ISO-8859-1" ?> 
<results>
<location id=X>
  <road speedlimit="60">Old Main Road</road> 
  <suburb>Gillits</suburb> 
  <closenumber present="yes" number="19" distance="11" units="m"/>
  <city>Kloof</city> 
  <province>KwaZulu-Natal</province> 
  <xy>30.792006,-29.796091</xy> 
  <extrainfo>-</extrainfo> 
</location>
</results>
road The name of the nearest road, including the suffix. If speed limit information is present for this, it will be reflected in the "speedlimit" tag, otherwise this will be set to 0.
closenumber If there is road number information present for the area, and the point is within 250m of a geocoded road number, it will reflect here, the property number and the distance to this number. Note because determining the position of a road number is not an exact process (plot sizes, shapes, etc) this will be an approximation to where the center of the road-facing property intersects with the road. If no nearby property could be determined, the "present" tag will be set to "no" and all other fields set to "0".
suburb Name of the suburb the point is in
city Name of the city the point is in
province The province the point appears in
xy The average position of the entire road segment, which is calculated in finding the nearest road point.
extraInfo If no match could be found in other fields, this is used as descriptive text to give an indication of where the point is located.

Comma-Delimited list

Road_Full_Name,Suburb,City,Province,Avg_Pos_X,Avg_Pos_Y,ExtraInfo
Road_Full_Name The name of the nearest road, including the suffix
Suburb Name of the suburb the point is in
City Name of the city the point is in
Province The province the point appears in
Avg_Pos_X, Avg_Pos_Y The average position of the entire road segment, which is calculated in finding the nearest road point.
extraInfo If no match could be found in other fields, this is used as descriptive text to give an indication of where the point is located.