Description Usage Arguments Value Author(s) Examples
The base URL for the RESTful services is:
https://data.nbn.org.uk/api/
Parameters can be added, depending on the service called.
The following services are available at the time of writing:
taxonObservations?ptvk=<tvk>&datasetKey=<dataset>&startYear=<year>
&endYear=<year>&featureID=<feature>
- get observations for the given
(list of) Taxon Version Keys (TVKs) for the given (list of) dataset keys
optionally with dates between startYear and endYear and within the spatial
feature, featureID (e.g. a vice-county). If no dataset keys are given then all
publically available data for the taxa will be returned
features/<featureID>
- get details about a particular location given
its <featureID>
taxa/<tvk>
- get details about a taxon given its <tvk>
1 2 3 4 |
service |
the service you want to call. One of |
tvks |
a list of TVKs which are strings of 16 alphanumeric characters |
datasets |
a list of dataset keys which are strings of 8 alphanumeric characters |
feature |
a featureID an integer number |
startYear |
a 4 digit year |
endYear |
a 4 digit year |
list |
url segment as a string as required to append to the base url to
give the list required as a part of the |
VC |
a string giving a vice-county name (see |
group |
a string giving the name of a group (see |
query |
a string used to search for taxa |
gridRef |
a string giving a gridreference in which to search for occurrences |
polygon |
A WKT (Well-Known Text) polygon string. Note that polygons containing many verticies (>100) are likely to create queries that exceed the NBN character limit |
attributes |
if |
the URL to call - a character string
Stuart Ball, JNCC stuart.ball@jncc.gov.uk
1 2 3 4 5 6 | makenbnurl(service="obs", tvks="NBNSYS0000007073")
makenbnurl(service="obs", tvks="NBNSYS0000007073", datasets="SGB00001")
makenbnurl(service="obs", tvks="NBNSYS0000007073", datasets="SGB00001",
startYear="1990", endYear="2010")
makenbnurl(service="feature", feature="284443")
makenbnurl(service="taxon", tvks="NBNSYS0000007073")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.