NBN Web Services

Example PHP Implementations

• Direct calls using PHP
• Simple .NET wrapper calls

Get Site Data

View datasets with records of Zostera (Eel Grass, NHMSYS0000465247) recorded in Vice County: West Cornwall & Scillies (1) East Cornwall (2) South Devon (3) North Devon (4) South Somerset (5) North Somerset (6) North Wiltshire (7) South Wiltshire (8) Dorset (9) Isle of Wight (10)

The green squares on the map indicate where Zostera has been recorded in 10km squares.
To get a list of all vice counties, click here.

Click here to view the source code.

Click here to view the request to the server.

Click here to view the returned XML file.

Results

---

Data Providers with Zostera records

Click on the Dataset Key to filter records by Dataset Providers, or click here to remove Dataset Providers from the query.

Dataset Key	Title	Provider	Abstract
GA000197	Marine Data from Northern Ireland	Centre for Environmental Data and Recording	Description Marine data from Northern Ireland Method Purpose Geographical Coverage Geographical Coverage Temporal Coverage Data Quality Additional Information

---

Request to Server

POST /ws/webservice HTTP/1.0 Host: www.nbnws.net User-Agent: NuSOAP/0.7.2 (1.94) Content-Type: text/xml; charset=UTF-8 SOAPAction: "http://webservices.searchnbn.net/service/GetGridMap" Content-Length: 794 <?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:nbnq="http://webservices.searchnbn.net/query"><SOAP-ENV:Body><GridMapRequest xmlns="http://webservices.searchnbn.net/query"> <TaxonVersionKey>NHMSYS0000465247</TaxonVersionKey> <Resolution>_10km</Resolution> <DatasetList><DatasetKey>GA000197</DatasetKey></DatasetList> <GridMapSettings> <Width>400</Width> <Height>400</Height> <Background>OSMap</Background> <ViceCounty>1</ViceCounty> <Region>GB</Region> </GridMapSettings> </GridMapRequest></SOAP-ENV:Body></SOAP-ENV:Envelope>

---

Back to the top

---

The Returned XML File

<?xml version="1.0" encoding="utf-8"?><GridMap xmlns="http://webservices.searchnbn.net/data" xmlns:xsd="http://www.w3.org/2001/XMLSchema" NBNLogo="http://data.nbn.org.uk/images/NBNPower.gif" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://webservices.searchnbn.net/data" termsAndConditions="http://data.nbn.org.uk/help/popups/generalTerms.jsp" version="1.1">
<Map>
<Url>http://data.nbn.org.uk/output/gridGBv4_nbnims-2486848404098.gif</Url>
<Width>400</Width>
<Height>400</Height>
<Format>image/gif</Format>
<BoundingBox maxx="199100.15" maxy="100173.275" minx="82643.5999999996" miny="-16283.2750000002" srs="osgb_BNG"/>
</Map>
<Species taxonVersionKey="NHMSYS0000465247"><ScientificName>Zostera</ScientificName><CommonName>Eelgrass</CommonName><Authority>L.</Authority><TaxonReportingCategory>flowering plant</TaxonReportingCategory></Species>
<DatasetSummaryList><DatasetSummary id="GA000197">
<ProviderMetadata datestamp="" exchangeFormatVersion="1.0">
<DatasetTitle><![CDATA[Marine Data from Northern Ireland]]></DatasetTitle>
<DatasetProvider><![CDATA[Centre for Environmental Data and Recording]]></DatasetProvider>
<Abstract>
<Description><![CDATA[ Marine data from Northern Ireland]]></Description>
<DataCaptureMethod><![CDATA[ ]]></DataCaptureMethod>
<Purpose><![CDATA[ ]]></Purpose>
<GeographicalCoverage><![CDATA[ ]]></GeographicalCoverage>
<TemporalCoverage><![CDATA[ ]]></TemporalCoverage>
<DataQuality><![CDATA[ ]]></DataQuality>
<AdditionalInformation><![CDATA[ ]]></AdditionalInformation>
</Abstract>
<AccessConstraints><![CDATA[ There are no access constraints]]></AccessConstraints>
<UseConstraints><![CDATA[ ]]></UseConstraints></ProviderMetadata></DatasetSummary></DatasetSummaryList></GridMap>

---

Source code for this page

/* * NBN Gateway SOAP Client Sample: * Author: James Perrins, * exeGesIS SDM * 3rd March 2006 */ $client = new soapclient("http://212.219.37.104/NBNWebServices/ws/WSDL", 'true', $proxyhost, $proxyport, $proxyusername, $proxypassword); // Set timeouts, nusoap default is 30 $client->timeout = 500; $client->response_timeout = 500; $err = $client->getError(); if ($err) { echo '<h2>Constructor error</h2><pre>' . $err . '</pre>'; }?> <form action="<? echo $_SERVER['PHP_SELF']; ?>" method="post"> View datasets with records of <em>Zostera</em> (Eel Grass, NHMSYS0000465247) recorded in Vice County: <SELECT NAME="vice"> <option VALUE=1>West Cornwall & Scillies (1)</option> <option VALUE=2>East Cornwall (2)</option> <option VALUE=3>South Devon (3)</option> <option VALUE=4>North Devon (4)</option> <option VALUE=5>South Somerset (5)</option> <option VALUE=6>North Somerset (6)</option> <option VALUE=7>North Wiltshire (7)</option> <option VALUE=8>South Wiltshire (8)</option> <option VALUE=9>Dorset (9)</option> <option VALUE=10>Isle of Wight (10)</option> </SELECT> <input name="x" type="submit"> </form> <? //Check to see if a vice county has been selected from the form or in the query string. if(isset($_GET["vice"])){ $_POST["vice"]=$_GET["vice"]; } if(isset($_POST["vice"])){ $vc = $_POST["vice"]; }else{ $vc="1"; } if(isset($_GET["gid"])){ $gid="<DatasetList><DatasetKey>".$_GET["gid"]."</DatasetKey></DatasetList>"; }else{ $gid=""; } $query1 = '<GridMapRequest xmlns="http://webservices.searchnbn.net/query"> <TaxonVersionKey>NHMSYS0000465247</TaxonVersionKey> <Resolution>Any</Resolution> '.$gid.' <GridMapSettings> <Width>400</Width> <Height>400</Height> <Background>OSMap</Background> <ViceCounty>'.$vc.'</ViceCounty> <Region>GB</Region> </GridMapSettings> </GridMapRequest>'; $result = $client->call("GetGridMap", $query1); $debug = $client->getDebug(); print '<h2>Results</h2>'; //the xml returned from the gateway appears to be missing the xml header which upsets PHP - so fix it first $obj = simplexml_load_string(fixupxml($client->response)); //drop in returned values as image source echo '<img src="',$obj->Map->Url,'"</>'; print ("<hr>"); echo "<h2>Data Providers with <em>Zostera</em> records</h2>"; echo "<p>Click on the Dataset Key to filter records by Dataset Providers, or <a href=\"/NBNServices/GetGridMapExample.php\">click here to remove Dataset Providers</a> from the query.</p>"; echo "<table><thead><tr><th>Dataset Key</th><th>Title</th><th>Provider</th><th>Description</th></tr></thead>"; foreach ($obj->DatasetSummary as $DataSet) { echo '<tr><td valign="top"><a href="?gid='.$DataSet->ProviderMetadata["gatewayId"].'&vice='.$vc.'">', $DataSet->ProviderMetadata["gatewayId"],'</a></td><td valign="top">', $DataSet->ProviderMetadata->DatasetTitle,'</td><td valign="top">',$DataSet->ProviderMetadata->DatasetProvider, '</td><td>',$DataSet->ProviderMetadata->Abstract->Description, '</td></tr>'; } echo "</table>"; print ("<hr>"); print '<a name="req"></a><h2>Request to Server</h2>'; echo '<xmp>'.$client->request.'</xmp>'; print "<hr><a href=\"#top\">Back to the top</a><hr>"; echo "<a name='xml'></a><h2>The Returned XML File</h2><pre>"; print htmlspecialchars(fixupxml($client->response)); echo "</pre>";