source: trunk/npemap.org.uk/static/api/geocoder.shtml @ 378

Last change on this file since 378 was 378, checked in by David Sheldon, 14 years ago

Documentation for the geocoder.

File size: 1.5 KB
Line 
1
2<!--#set var="title" value="Geocoder" -->
3<!--#set var="shownav" value="yes" -->
4<!--#include virtual="../inc/header.shtml" -->
5
6<div id="api">
7
8<h4>Geocoder</h4>
9
10<p>Look up the location that we have for a postcode. If we don't have an exact
11match for the postcode you request, then we will do our best. If we don't have
12an exact match, we will return #s where we don't have exact matches.
13</p>
14
15<p> If you request the response with the format of 'js', then you can specify
16the name of a funtion call to wrap around the JSON response. This will call
17that method with the JSON as a parameter. </p>
18
19<h4>Arguments</h4>
20<dl>
21<dt>postcode (required)</dt>
22<dd>The postcode that you wish the location of. You can enter just the outward part if you wish.</dd>
23
24</dl>
25
26<h4>Example response</h4>
27
28<pre>
29# Easting,Northing,Matched Postcode
30434807,219133,'OX7 3##'
31</pre>
32
33
34<h4>Explorer</h4>
35<p>Try out this method without writing any code.</p>
36
37<form method="get" action="/cgi/geocoder.fcgi" target="iframe">
38
39<p>
40postcode: <input type="text" name="postcode" value="" size="30"> <br/>
41
42format:
43<input id="format_text" type="radio" name="format" value="text"> <label for="format_text">Text</label>
44<input id="format_js" type="radio" name="format" value="js" checked> <label for="format_js">JS</label>
45<input id="format_xml" type="radio" name="format" value="xml"> <label for="format_xml">XML</label
46
47<input type="submit" value="Go" />
48</p>
49</form>
50<iframe name="iframe" style="width: 40em; height: 20em">Output here</iframe
51
52</div>
53
54<!--#include virtual="../inc/footer.shtml" -->
Note: See TracBrowser for help on using the repository browser.