Web service API | NBN Atlas

<!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> <meta name="app.version" content="1.1-SNAPSHOT"/> <meta name="app.build" content=""/> <meta name="description" content="NBN Atlas"/> <meta name="author" content="NBN Atlas"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Web service API | NBN Atlas</title> <script src="/static/UGoJGyG3j2UCffTg3vnOdi0FsnS2OvrmrsZD6WxaXGy.js" type="text/javascript" ></script> <link href="/static/fHwsF6fF43QhqIyKpTHhpPrHHyzWEeEkLGoWRKI89Ps.css" type="text/css" rel="stylesheet" media="all" /> <link href="/static/B2rPzmBurPqCSvvGYKFhjLcHQCRBWDOFKbpUKGGtIhM.css" type="text/css" rel="stylesheet" media="all" /> <link href="https://layout.nbnatlas.org/uk/commonui-bs2/css/bootstrap.min.css" type="text/css" rel="stylesheet" media="all" /> <link href="https://layout.nbnatlas.org/uk/commonui-bs2/css/bootstrap-responsive.min.css" type="text/css" rel="stylesheet" media="all" /> <link href="/static/8QnKvW1SXiMUn9bkCLBMbnYMr8LkNycW6VCjSu4fjdX.css" type="text/css" rel="stylesheet" media="screen, projection" /> <meta name="layout" content="generic"/> <style type="text/css"> .editorFunctions { display:none; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=GT-K48F5BB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'GT-K48F5BB'); </script> <link href="https://fonts.googleapis.com/css?family=Pontano+Sans|PT+Sans:400,700" rel="stylesheet" type="text/css"> <link href="https://nbnatlas.org/shared/css-bs2/" type="text/css" rel="stylesheet" media="screen, projection, print" />  <link href="https://layout.nbnatlas.org/uk/commonui-bs2/workarounds.css" type="text/css" rel="stylesheet" media="screen, projection, print" /> <link href="https://layout.nbnatlas.org/uk/commonui-bs2/css/pagination.css" type="text/css" rel="stylesheet" media="screen, projection, print" />    <script type="text/javascript"> $(document).ready(function() { var now = (new Date()).getTime(); $('head').append( $('<link rel="stylesheet" type="text/css" />').attr('href', '/assets/nbn.css') ); $('head').append( $('<link rel="stylesheet" type="text/css" />').attr('href', 'https://layout.nbnatlas.org/status_base.css') ); $('head').append( $('<link rel="stylesheet" type="text/css" />').attr('href', 'https://layout.nbnatlas.org/status.css?'+now) ); $.getScript( 'https://layout.nbnatlas.org/status.js'); $.getScript( '/assets/nbn.js' ); }); </script> </head> <body class="" id="" onload="">  <header class="banner bs2" role="banner"> <div class=""> <div class="navbar"> <div class="navbar-inner"> <div id="navbar-global" class="navbar-global row"> <ul id="menu-global-navigation" class="nav"><li class="menu-item menu-national-biodiversity-network-trust"><a target="_blank" rel="noopener" href="https://nbn.org.uk">National Biodiversity Network Trust</a></li> <li class="menu-item menu-nbn-forum"><a target="_blank" rel="noopener" href="http://forums.nbn.org.uk">NBN Forum</a></li> <li class="menu-item menu-nbn-atlas"><a href="https://nbnatlas.org">NBN Atlas</a></li> <li class="menu-item menu-log-in"><a href="https://auth.nbnatlas.org/cas/login?service=https://nbnatlas.org/">Log In</a></li> </ul> </div> </div> </div> <div class="navbar"> <div class="navbar-inner"> <div id="navbar-apex" class="navbar-apex row"> <form method="get" action="https://species.nbnatlas.org/search/" role="search" class="navbar-form navbar-left"> <div class="form-group"> <input type="text" autocomplete="off" placeholder="SEARCH" name="q" title="Search" class="autocomplete ac_input" id="navbar-search"> </div> <button class="btn btn-link" type="submit"><i class="fa fa-search"></i></button> </form> <ul id="menu-apex-navigation" class="nav"><li class="menu-item menu-join-or-donate"><a target="_blank" rel="noopener" href="https://nbn.org.uk/join-or-donate/join-the-nbn/">Join or Donate</a></li> <li class="menu-item menu-nbn-atlas-news"><a target="_blank" rel="noopener" href="https://nbn.org.uk/news-events-publications/latest-stories-from-our-network/nbn-atlas-news/">NBN Atlas News</a></li> <li class="menu-item menu-contact-us"><a href="https://nbnatlas.org/contact-us/">Contact us</a></li> <li class="menu-item menu-log-in-register"><a target="_blank" rel="noopener" href="https://auth.nbnatlas.org/userdetails/myprofile/">Log in / Register</a></li> <li class="dropdown menu-item menu-item-has-children menu-choose-nbn-atlas"><a href="#" class="dropdown-toggle" data-toggle="dropdown" data-target="#">Choose NBN Atlas</a> <ul class="dropdown-menu"> <li class="menu-item menu-nbn-atlas"><a href="https://nbnatlas.org/">NBN Atlas</a></li> <li class="menu-item menu-nbn-atlas-isle-of-man"><a href="https://isleofman.nbnatlas.org/">NBN Atlas Isle of Man</a></li> <li class="menu-item menu-nbn-atlas-northern-ireland"><a href="https://northernireland.nbnatlas.org/">NBN Atlas Northern Ireland</a></li> <li class="menu-item menu-nbn-atlas-scotland"><a href="https://scotland.nbnatlas.org/">NBN Atlas Scotland</a></li> <li class="menu-item menu-nbn-atlas-wales"><a href="https://wales.nbnatlas.org/">NBN Atlas Wales</a></li> <li class="menu-item menu-beautiful-burial-ground-portal"><a target="_blank" rel="noopener" href="https://burialgrounds.nbnatlas.org/">Beautiful Burial Ground Portal</a></li> </ul> </li> </ul> </div> </div> </div> <div class="navbar"> <div class="navbar-inner"> <div id="navbar-primary" class="navbar-collapse collapse navbar-primary row"> <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".navbar-collapse"> <span class="icn-bar"></span> <span class="icn-bar"></span> <span class="icn-bar"></span> </button> <a class="brand" href="https://nbnatlas.org/"><img src="https://nbnatlas.org/wp-content/uploads/2017/01/AL_Logo-15.png" alt="NBN Atlas"></a> <ul id="menu-primary-navigation" class="nav"><li class="menu-item menu-species"><a href="https://species.nbnatlas.org/">Species</a></li> <li class="dropdown menu-item menu-item-has-children menu-locations"><a href="#" class="dropdown-toggle" data-toggle="dropdown" data-target="#">Locations</a> <ul class="dropdown-menu"> <li class="menu-item menu-search-by-polygon"><a href="https://records.nbnatlas.org/search#tab_spatialSearch">Search by polygon</a></li> <li class="menu-item menu-explore-by-address-postcode-or-location"><a href="https://records.nbnatlas.org/explore/your-area">Explore by address, postcode or location</a></li> <li class="menu-item menu-explore-by-pre-defined-area"><a href="https://regions.nbnatlas.org/">Explore by pre-defined area</a></li> </ul> </li> <li class="menu-item menu-analyse"><a href="https://spatial.nbnatlas.org/">Analyse</a></li> <li class="dropdown menu-item menu-item-has-children menu-get-involved"><a href="#" class="dropdown-toggle" data-toggle="dropdown" data-target="#">Get Involved</a> <ul class="dropdown-menu"> <li class="menu-item menu-find-a-wildlife-survey-or-recording-scheme"><a target="_blank" rel="noopener" href="https://nbn.org.uk/tools-and-resources/useful-websites/database-of-wildlife-surveys-and-recording-schemes/">Find a wildlife survey or recording scheme</a></li> <li class="menu-item menu-share-data-on-the-nbn-atlas"><a target="_blank" rel="noopener" href="https://nbn.org.uk/record-share-explore-data/share-your-data/">Share data on the NBN Atlas</a></li> <li class="menu-item menu-nbn-atlas-citations"><a target="_blank" rel="noopener" href="https://nbn.org.uk/tools-and-resources/nbn-atlas-citations/">NBN Atlas Citations</a></li> <li class="menu-item menu-donate-support-the-nbn-atlas-and-the-nbn-trust"><a href="https://nbnatlas.org/support-the-nbn/">Donate / Support the NBN Atlas and the NBN Trust</a></li> <li class="menu-item menu-sign-up-for-our-newsletter"><a target="_blank" rel="noopener" href="https://nbn.org.uk/news-events-publications/latest-stories-from-our-network/enews-sign-up/">Sign up for our Newsletter</a></li> <li class="menu-item menu-nbn-conference"><a target="_blank" rel="noopener" href="https://nbn.org.uk/news-events-publications/nbn-conference-2/">NBN Conference</a></li> </ul> </li> <li class="dropdown menu-item menu-item-has-children menu-data-and-partners"><a href="#" class="dropdown-toggle" data-toggle="dropdown" data-target="#">Data and Partners</a> <ul class="dropdown-menu"> <li class="menu-item menu-search-for-a-data-partner"><a href="https://registry.nbnatlas.org">Search for a Data Partner</a></li> <li class="menu-item menu-search-nbn-atlas-datasets"><a href="https://registry.nbnatlas.org/datasets">Search NBN Atlas datasets</a></li> <li class="menu-item menu-advanced-record-search"><a href="https://records.nbnatlas.org/search#advanceSearch">Advanced record search</a></li> <li class="menu-item menu-species-lists"><a target="_blank" rel="noopener" href="https://lists.nbnatlas.org/public/speciesLists">Species lists</a></li> <li class="menu-item menu-nbn-atlas-data-processing-schedule"><a href="https://nbnatlas.org/nbn-atlas-data-processing-schedule/">NBN Atlas data processing schedule</a></li> <li class="menu-item menu-global-biodiversity-information-facility-gbif"><a target="_blank" rel="noopener" href="https://www.gbif.org/">Global Biodiversity Information Facility (GBIF)</a></li> </ul> </li> <li class="dropdown menu-item menu-item-has-children menu-about"><a href="#" class="dropdown-toggle" data-toggle="dropdown" data-target="#">About</a> <ul class="dropdown-menu"> <li class="menu-item menu-about-nbn-atlas"><a href="http://nbnatlas.org/about-nbn-atlas/">About NBN Atlas</a></li> <li class="menu-item menu-fit-for-the-future-project"><a href="https://nbnatlas.org/about-nbn-atlas/fit-for-the-future-project/">Fit for the Future Project</a></li> <li class="menu-item menu-join-or-donate"><a target="_blank" rel="noopener" href="https://nbn.org.uk/join-or-donate/join-the-nbn/">Join or Donate</a></li> </ul> </li> <li class="menu-item menu-help"><a target="_blank" rel="noopener" href="https://docs.nbnatlas.org/">Help</a></li> </ul> </div> </div> </div> </div> </header>   <div class="container-fluid" id="main"> <a href="#page-body" class="skip">Skip to content…</a> <div class="pull-right editorFunctions"> <ul class="nav nav-pills"> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="#"> Admin <b class="caret"></b> </a> <ul class="dropdown-menu"> <li><a href="/admin/webService/create">Add Webservice</a></li> <li><a href="/admin/app/index">Apps</a></li> <li><a href="/admin/format/index">Output formats</a></li> <li><a href="/admin/webService/index">Webservices</a></li> <li><a href="/admin/category/index">Categories</a></li> <li><a href="/admin/example/index">Examples</a></li> <li><a href="/admin/example/lastRuns">Latest heart beats</a> </li> <li><a href="/admin/webserviceList/sendHeartbeat">Send heart beat</a></li> <li><a href="/admin/webserviceList/clearCache">Clear page cache</a></li> </ul> </li> </ul> </div> <div role="main"> <h1>Web service API</h1> <p> The webservices are listed by category. To list by application, <a href="/apps">click here</a>. </p> <div class="pull-right"><div class="btn" onclick="expandApis()"><i class="icon-plus"></i> Expand All</div> <div class="btn" onclick="collapseApis()"><i class="icon-minus"></i> Collapse All</div></div> <h2 class="categoryHdr">Species profile <span class="hidden-phone"><small> - Taxonomic name, concept lookups services</small></span></h2> <p> <p><a href="https://atlasoflivingaustralia.github.io/bie-api-changes/">Webservices change log</a></p> </p> <ul style="list-style: none; margin:0;"> <li id="webService-100" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/100?returnTo=" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/100?returnTo=" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/100?returnTo=" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws100" id="ws100" name="ws100" style="text-decoration: none; color:black;">Get higher classifications for GUID</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://species-ws.nbnatlas.org/classification/{guid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://species-ws.nbnatlas.org/classification/{guid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-100" class="webServiceDetails hide"> <p><p>Provides a list of higher taxa for the requested taxon.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/58?returnTo=%2F%23ws100" class="btn btn-small">Edit</a> </span> <h5>List higher classifications for GUID</h5> <p><p>Higher taxa for Homo Sapiens</p></p> <p> URL: <a href="https://species-ws.nbnatlas.org/classification/NHMSYS0000376773">https://species-ws.nbnatlas.org/classification/NHMSYS0000376773</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-1" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/1?returnTo=%2F%23ws100" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/1?returnTo=%2F%23ws100" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/1?returnTo=%2F%23ws100" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws1" id="ws1" name="ws1" style="text-decoration: none; color:black;">Species search</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://species-ws.nbnatlas.org/search?q={q}&fq={fq}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://species-ws.nbnatlas.org/search?q={q}&fq={fq}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-1" class="webServiceDetails hide"> <p><p>Species text search services.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=rk_genus:Macropus or a free text search e.g. q=Macropus </p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=rank:kingdom. See <a href="https://species-ws.nbnatlas.org/indexFields">https://species-ws.nbnatlas.org/indexFields</a> for all the fields that are queryable.</p> </span> </td> </tr> <tr> <td>start </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Record offset, to enable paging</p> </span> </td> </tr> <tr> <td>pageSize </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Number of records to return</p> </span> </td> </tr> <tr> <td>sort </td> <td>String</td> <td> <span class="paramDescription"> <p>Field to sort on</p> </span> </td> </tr> <tr> <td>dir </td> <td>String</td> <td> <span class="paramDescription"> <p>Sort direction "asc" or "desc"</p> </span> </td> </tr> <tr> <td>facets </td> <td>String</td> <td> <span class="paramDescription"> <p>comma separated list of fields to display facets for. Available fields listed <a href="https://species-ws.nbnatlas.org/indexFields">https://species-ws.nbnatlas.org/indexFields</a>.</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/7?returnTo=%2F%23ws1" class="btn btn-small">Edit</a> </span> <h5>Search for facets</h5> <p><p>Find the different phylum in the animalia kingdom and count records in each.</p></p> <p> URL: <a href="https://species-ws.nbnatlas.org/search?q=&fq=rk_kingdom:Animalia&facets=rk_phylum&pageSize=0">https://species-ws.nbnatlas.org/search?q=&fq=rk_kingdom:Animalia&facets=rk_phylum&pageSize=0</a> <br/> </p> </li> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/87?returnTo=%2F%23ws1" class="btn btn-small">Edit</a> </span> <h5>Taxonomy Explorer</h5> <p><p>Many of the queries use SOLR search terms. For a primer on this topic, with specific with regard to the NBN Atlas, please see: <a href="https://docs.google.com/document/d/1FiVasGGZ3kRPnu5347GPAef7Tr5LvvghCS6x82xnfu4">Query Primer</a></p></p> <p> URL: <a href="https://species-ws.nbnatlas.org/search">https://species-ws.nbnatlas.org/search</a> <br/> Online demo: <a href="https://duncanrowland.github.io/taxa/">https://duncanrowland.github.io/taxa/</a> <br/> </p> </li> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/73?returnTo=%2F%23ws1" class="btn btn-small">Edit</a> </span> <h5>Species record 'Man'</h5> <p><p>Find the species record for commonNameSingle = Man</p></p> <p> URL: <a href="https://species-ws.nbnatlas.org/search?q=&fq=commonNameSingle:Man">https://species-ws.nbnatlas.org/search?q=&fq=commonNameSingle:Man</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-110" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/110?returnTo=%2F%23ws1" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/110?returnTo=%2F%23ws1" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/110?returnTo=%2F%23ws1" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws110" id="ws110" name="ws110" style="text-decoration: none; color:black;">Bulk lookup by GUID</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://species-ws.nbnatlas.org/species/guids/bulklookup</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://species-ws.nbnatlas.org/species/guids/bulklookup</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-110" class="webServiceDetails hide"> <p><p>.Requires a JSON post body.</p><p><code>["NHMSYS0000376773"]</code> or <code>["NHMSYS0000376773","NHMSYS0000080188"]</code></p></p> <div class="exampleOutput"> <h4>Example output</h4> <pre><code>{ "searchDTOList":[ { "guid":"NHMSYS0000376773", "name":"Homo sapiens", "scientificName":"Homo sapiens", "author":"Linnaeus, 1758", "nameComplete":"Homo sapiens Linnaeus, 1758", "rank":"species", "kingdom":"Animalia", "phylum":"Chordata", "classs":"Mammalia", "order":"Primates", "family":"Hominidae", "genus":"Homo", "datasetName":null, "datasetID":null, "commonNameSingle":"Man" } ] }</code></pre> </div> <div class="examples"> View : <a href="https://species-ws.nbnatlas.org/species/guids/bulklookup">https://species-ws.nbnatlas.org/species/guids/bulklookup</a> </div> </div> </li> <li id="webService-2" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/2?returnTo=%2F%23ws110" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/2?returnTo=%2F%23ws110" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/2?returnTo=%2F%23ws110" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws2" id="ws2" name="ws2" style="text-decoration: none; color:black;">Species download</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://species-ws.nbnatlas.org/download?q={q}&fq={fq}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://species-ws.nbnatlas.org/download?q={q}&fq={fq}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in CSV format"> CSV </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">CSV</li> </ul> </span> </div> </h4> <div id="webService-details-2" class="webServiceDetails hide"> <p><p>CSV species record field download</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus </p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=rk_kingdom:Fungi. See <a href="https://species-ws.nbnatlas.org/indexFields">https://species-ws.nbnatlas.org/indexFields</a> for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>fields </td> <td>String</td> <td> <span class="paramDescription"> <p>A comma separated list of SOLR fields to include in the download. Fields can be included in the download if they have been stored. Default fields: taxonConceptID, rank, scientificName, establishmentMeans, rk_genus, rk_family, rk_order, rk_class, rk_phylum, rk_kingdom, datasetName</p> </span> </td> </tr> <tr> <td>file </td> <td>String</td> <td> <span class="paramDescription"> <p>The name of the file to be downloaded. Default: 'species.csv'</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/50?returnTo=%2F%23ws2" class="btn btn-small">Edit</a> </span> <h5>Download data for 'Homo Sapiens'</h5> <p><p>Download specific fields for the Homo Sapiens species record</p></p> <p> URL: <a href="https://species-ws.nbnatlas.org/download?q=&fq=scientificName:*sapiens&fields=guid,scientificName">https://species-ws.nbnatlas.org/download?q=&fq=scientificName:*sapiens&fields=guid,scientificName</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-80" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/80?returnTo=%2F%23ws2" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/80?returnTo=%2F%23ws2" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/80?returnTo=%2F%23ws2" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws80" id="ws80" name="ws80" style="text-decoration: none; color:black;">Species lookup with GUID</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://species-ws.nbnatlas.org/species/{guid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://species-ws.nbnatlas.org/species/{guid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSONP format"> JSONP </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> <li class="label">JSONP</li> </ul> </span> </div> </h4> <div id="webService-details-80" class="webServiceDetails hide"> <p><p>Species lookup with GUID</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>guid <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The guid for the taxon concept</p> </span> </td> </tr> <tr> <td>callback </td> <td>String</td> <td> <span class="paramDescription"> <p>JSONP callback</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/72?returnTo=%2F%23ws80" class="btn btn-small">Edit</a> </span> <h5>Red Fox (JSONP)</h5> <p><p>Lookup Red Fox with GUID returning JSONP</p></p> <p> URL: <a href="https://species-ws.nbnatlas.org/species/NHMSYS0000080188?callback=myJsonpCallback">https://species-ws.nbnatlas.org/species/NHMSYS0000080188?callback=myJsonpCallback</a> <br/> </p> </li> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/71?returnTo=%2F%23ws80" class="btn btn-small">Edit</a> </span> <h5>Red Fox (JSON)</h5> <p><p>Lookup Red Fox with GUID returning JSON</p></p> <p> URL: <a href="https://species-ws.nbnatlas.org/species/NHMSYS0000080188">https://species-ws.nbnatlas.org/species/NHMSYS0000080188</a> <br/> <a href="/heartbeat/71">History</a> </p> </li> </ul> </div> </div> </li> <li id="webService-87" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/87?returnTo=%2F%23ws80" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/87?returnTo=%2F%23ws80" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/87?returnTo=%2F%23ws80" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws87" id="ws87" name="ws87" style="text-decoration: none; color:black;">Bulk species lookup</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://species-ws.nbnatlas.org/species/lookup/bulk</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://species-ws.nbnatlas.org/species/lookup/bulk</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-87" class="webServiceDetails hide"> <p><p>Requires a JSON map as a post body. The JSON map must contain a "names" key that is the list of scientific names.</p><p><code>{"names":["Man"]}</code> or <code>{"names":["Man","Fox"]}</code></p></p> <div class="exampleOutput"> <h4>Example output</h4> <pre><code>[ { "identifier":"NHMSYS0000376773", "guid":"NHMSYS0000376773", "parentGuid":"NHMSYS0000376769", "name":"Homo sapiens", "nameComplete":"Homo sapiens Linnaeus, 1758", "commonName":[ "Man" ], "commonNameSingle":"Man", "rank":"species", "rankId":7000, "acceptedConceptGuid":"NHMSYS0000376773", "acceptedConceptName":"Homo sapiens", "taxonomicStatus":"accepted", "imageId":null, "imageUrl":"", "thumbnailUrl":"", "largeImageUrl":"", "smallImageUrl":"", "imageMetadataUrl":"", "kingdom":"Animalia", "phylum":"Chordata", "classs":"Mammalia", "order":"Primates", "family":"Hominidae", "genus":"Homo", "author":"Linnaeus, 1758", "linkIdentifier":null } ]</code></pre> </div> <div class="examples"> View : <a href="https://species-ws.nbnatlas.org/species/lookup/bulk">https://species-ws.nbnatlas.org/species/lookup/bulk</a> </div> </div> </li> <li id="webService-88" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/88?returnTo=%2F%23ws87" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/88?returnTo=%2F%23ws87" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/88?returnTo=%2F%23ws87" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws88" id="ws88" name="ws88" style="text-decoration: none; color:black;">Species indexed fields</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://species-ws.nbnatlas.org/admin/indexFields</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://species-ws.nbnatlas.org/admin/indexFields</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-88" class="webServiceDetails hide"> <p><p>List in JSON the index fields within the species datasets (N.B. Not the same as the records datasets).<br> Notes when using these fields in search queries:<br> - Only stored values will be returned.<br> - Text fields will be fuzzy matched.<br> (See <a href="https://docs.google.com/document/d/1FiVasGGZ3kRPnu5347GPAef7Tr5LvvghCS6x82xnfu4">Query Primer</a> documentation).<br></p></p> <div class="examples"> View : <a href="https://species-ws.nbnatlas.org/admin/indexFields">https://species-ws.nbnatlas.org/admin/indexFields</a> </div> </div> </li> <li id="webService-96" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/96?returnTo=%2F%23ws88" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/96?returnTo=%2F%23ws88" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/96?returnTo=%2F%23ws88" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws96" id="ws96" name="ws96" style="text-decoration: none; color:black;">Bulk species lookup</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://species-ws.nbnatlas.org/guid/batch?q={q}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://species-ws.nbnatlas.org/guid/batch?q={q}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSONP format"> JSONP </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> <li class="label">JSONP</li> </ul> </span> </div> </h4> <div id="webService-details-96" class="webServiceDetails hide"> <p><p>Lookup one or more "name" queries for matching taxon concepts in the species datasets.<br> Multiple names can be specified with repeating q params. E.g. ?q=fox&q=man</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Query string</p> </span> </td> </tr> <tr> <td>callback </td> <td>String</td> <td> <span class="paramDescription"> <p>Name of callback function to wrap JSON output in. Provided for JSONP cross-domain requests.</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/74?returnTo=%2F%23ws96" class="btn btn-small">Edit</a> </span> <h5>Bulk species lookup</h5> <p><p>Queries for taxon concepts matching "Fox"</p></p> <p> URL: <a href="https://species-ws.nbnatlas.org/guid/batch?q=Fox">https://species-ws.nbnatlas.org/guid/batch?q=Fox</a> <br/> </p> </li> </ul> </div> </div> </li> </ul> <h2 class="categoryHdr">Occurrence <span class="hidden-phone"><small> - Specimen & observation data searching</small></span></h2> <ul style="list-style: none; margin:0;"> <li id="webService-102" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/102?returnTo=%2F%23ws96" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/102?returnTo=%2F%23ws96" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/102?returnTo=%2F%23ws96" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws102" id="ws102" name="ws102" style="text-decoration: none; color:black;">Occurrence details</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/occurrence/{uuid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/occurrence/{uuid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-102" class="webServiceDetails hide"> <p><p>Retrieve the full details of a record.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/60?returnTo=%2F%23ws102" class="btn btn-small">Edit</a> </span> <h5>Example record full details</h5> <p><p>"Vulpes vulpes" record full details</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/occurrences/00e11378-510a-41e4-beea-d8e4d1d9a001">https://records-ws.nbnatlas.org/occurrences/00e11378-510a-41e4-beea-d8e4d1d9a001</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-106" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/106?returnTo=%2F%23ws102" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/106?returnTo=%2F%23ws102" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/106?returnTo=%2F%23ws102" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws106" id="ws106" name="ws106" style="text-decoration: none; color:black;">Occurrence Facet Download</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/occurrences/facets/download?q={q}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/occurrences/facets/download?q={q}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in CSV format"> CSV </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">CSV</li> </ul> </span> </div> </h4> <div id="webService-details-106" class="webServiceDetails hide"> <p><p>CSV download of a single facet.<br> Tip: range based faceting is supported by using the SOLR parameters.</p><p>The facets, q and fq values support the stored & indexed <a href="https://records-ws.nbnatlas.org/index/fields">fields</a></p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>facets </td> <td>String</td> <td> <span class="paramDescription"> <p>eg. species_guid</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>additional filters. eg. fq=state_conservation:Endangered</p> </span> </td> </tr> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/81?returnTo=%2F%23ws106" class="btn btn-small">Edit</a> </span> <h5>Species facet</h5> <p><p>Download a list of species recorded on a specific date</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/occurrences/facets/download?q=*:*&fq=occurrence_date:1626-01-01T00:00:00Z&facets=species">https://records-ws.nbnatlas.org/occurrences/facets/download?q=*:*&fq=occurrence_date:1626-01-01T00:00:00Z&facets=species</a> <br/> </p> </li> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/80?returnTo=%2F%23ws106" class="btn btn-small">Edit</a> </span> <h5>Download historic sample dates</h5> <p><p>Download a list of dates from the 1600s in which a recording occurred.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/occurrences/facets/download?q=*:*&fq=occurrence_date:[1600-01-01T00:00:00Z TO 1699-12-31T00:00:00Z]&facets=occurrence_date">https://records-ws.nbnatlas.org/occurrences/facets/download?q=*:*&fq=occurrence_date:[1600-01-01T00:00:00Z TO 1699-12-31T00:00:00Z]&facets=occurrence_date</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-3" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/3?returnTo=%2F%23ws106" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/3?returnTo=%2F%23ws106" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/3?returnTo=%2F%23ws106" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws3" id="ws3" name="ws3" style="text-decoration: none; color:black;">Occurrence search</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/occurrences/search?q={q}&fq={fq}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/occurrences/search?q={q}&fq={fq}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-3" class="webServiceDetails hide"> <p><p>JSON occurrence search. In addition to the parameters listed, range based faceting is supported by using the SOLR parameters. </p><p>The facets, q and fq values support the stored & indexed <a href="https://records-ws.nbnatlas.org/index/fields">fields</a></p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See <a href="https://records-ws.nbnatlas.org/index/fields">https://records-ws.nbnatlas.org/index/fields</a> for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>facet </td> <td>String</td> <td> <span class="paramDescription"> <p>Supported values are "off" or "on". By default, its "on". This is worth switching off if facetting is not required, to reduce the JSON being sent.</p> </span> </td> </tr> <tr> <td>facets </td> <td>String</td> <td> <span class="paramDescription"> <p>Comma separated list of the fields to create facets on e.g. facets=basis_of_record.</p> </span> </td> </tr> <tr> <td>pageSize </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Number of records to return (default=10)</p> </span> </td> </tr> <tr> <td>startIndex </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Record offset, to enable paging</p> </span> </td> </tr> <tr> <td>sort </td> <td>String</td> <td> <span class="paramDescription"> <p>The indexed field to sort by</p> </span> </td> </tr> <tr> <td>dir </td> <td>String</td> <td> <span class="paramDescription"> <p>Supports "asc" or "desc" </p> </span> </td> </tr> <tr> <td>flimit </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Maximum number of facet values to return (default=30)</p> </span> </td> </tr> <tr> <td>fsort </td> <td>String</td> <td> <span class="paramDescription"> <p>Method in which to sort the facets either "count" or "index" </p> </span> </td> </tr> <tr> <td>foffset </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Facet offset, to enable paging</p> </span> </td> </tr> <tr> <td>fprefix </td> <td>String</td> <td> <span class="paramDescription"> <p>Limits facets to values that start with the supplied value</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>The radius in which to limit records (relative to the lat, lon point). Use with lat and lon to specify a "search" circle.</p> </span> </td> </tr> <tr> <td>wkt </td> <td>String</td> <td> <span class="paramDescription"> <p>The polygon area in which to limit records. For information on Well known text see <a href="http://en.wikipedia.org/wiki/Well-known_text">this</a></p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/1?returnTo=%2F%23ws3" class="btn btn-small">Edit</a> </span> <h5>Search for the records for the genus Vulpes</h5> <p><p>Search for the records for the genus Vulpes returning taxonomic, geospatial, temporal information for occurrences, returning only the first ten.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/occurrences/search?q=*:*&fq=genus:Vulpes">https://records-ws.nbnatlas.org/occurrences/search?q=*:*&fq=genus:Vulpes</a> <br/> </p> </li> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/88?returnTo=%2F%23ws3" class="btn btn-small">Edit</a> </span> <h5>Peter Neish's Visualisation</h5> <p><p>Adapted from ALA example</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/occurrences/search">https://records-ws.nbnatlas.org/occurrences/search</a> <br/> Online demo: <a href="https://duncanrowland.github.io/NBNQueryExample/">https://duncanrowland.github.io/NBNQueryExample/</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-38" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/38?returnTo=%2F%23ws3" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/38?returnTo=%2F%23ws3" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/38?returnTo=%2F%23ws3" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws38" id="ws38" name="ws38" style="text-decoration: none; color:black;">Occurrence query cache</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/webportal/params</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/webportal/params</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in TEXT format"> TEXT </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">TEXT</li> </ul> </span> </div> </h4> <div id="webService-details-38" class="webServiceDetails hide"> <p><p>Add query details to a cache to reduce the size of the query params that are being passed around. This is particularly useful if you requests are too large for a GET.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>wkt </td> <td>String</td> <td> <span class="paramDescription"> <p>The polygon area in which to limit records. For information on Well known text see <a href="http://en.wikipedia.org/wiki/Well-known_text">this</a></p> </span> </td> </tr> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See <a href="https://records-ws.nbnatlas.org/index/fields">https://records-ws.nbnatlas.org/index/fields</a> for all the fields that a queryable.</p> </span> </td> </tr> </table> <div class="exampleOutput"> <h4>Example output</h4> <pre><code>POST: https://records-ws.nbnatlas.org/webportal/params?q=*:*&fq=genus:Vulpes Will return an integer value 'ID' that can then be used in occurrences searches. e.g. GET: https://records-ws.nbnatlas.org/occurrences/search?q=qid:'ID'</code></pre> </div> </div> </li> <li id="webService-4" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/4?returnTo=%2F%23ws38" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/4?returnTo=%2F%23ws38" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/4?returnTo=%2F%23ws38" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws4" id="ws4" name="ws4" style="text-decoration: none; color:black;">Occurrence download</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/occurrences/index/download</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/occurrences/index/download</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in SHP format"> SHP </a> </span> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in CSV format"> CSV </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">SHP</li> <li class="label">CSV</li> </ul> </span> </div> </h4> <div id="webService-details-4" class="webServiceDetails hide"> <p><p>Occurrence download - limited to first 500,00 records.<br/>Downloads of the following formats are supported: <ul> <li>CSV</li> <li>TSV</li> <li>SHAPE</li> </ul></p><p>The output format is determined based on the fileType param. <p> The download will return a ZIP file that contains the data in the requested format and a Readme and citataion.csv.<br/>Please be aware that a shape file download will be large. Each of the <b>fields</b> is included as a feature. It is advised to select a subset of information to be included.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See https://records-ws.nbnatlas.org/index/fields for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>The radius in which to limit records (relative to the lat, lon point). Use with lat and lon to specify a "search" circle.</p> </span> </td> </tr> <tr> <td>wkt </td> <td>String</td> <td> <span class="paramDescription"> <p>The polygon area in which to limit records. For information on Well known text</p> </span> </td> </tr> <tr> <td>file </td> <td>String</td> <td> <span class="paramDescription"> <p>The name of the file to produce. This will default to data. </p> </span> </td> </tr> <tr> <td>email </td> <td>String</td> <td> <span class="paramDescription"> <p>The email address of the user performing the download.</p> </span> </td> </tr> <tr> <td>reason </td> <td>String</td> <td> <span class="paramDescription"> <p>A user supplied description of the reason for the download</p> </span> </td> </tr> <tr> <td>fields </td> <td>String</td> <td> <span class="paramDescription"> <p>A CSV list of fields to include in the download. This can be a stored index field name OR a Darwin Core Field name that is also a stored index field. There is a <i>default list</i> (documented in a <a href="https://docs.google.com/spreadsheets/d/1XGpZUMuJIpCHDOkdtqy0q-_wLlxa_HMc2p1J2wtdYks">Google Doc</a>) that is included if no value is supplied. A list of index fields can be found here: <a href="https://records-ws.nbnatlas.org/index/fields">https://records-ws.nbnatlas.org/index/fields</a>.</p> </span> </td> </tr> <tr> <td>extra </td> <td>String</td> <td> <span class="paramDescription"> <p>a CSV list of fields in include in addition to the "fields". This is useful if you would like to make use of the default fields and include extra fields.</p> </span> </td> </tr> <tr> <td>reasonTypeId <span class="required-indicator">*</span> </td> <td>Integer</td> <td> <span class="paramDescription"> <p>A reason code for the download. See <a href="https://logger.nbnatlas.org/service/logger/reasons">reasons</a> for valid values.</p> </span> </td> </tr> <tr> <td>fileType </td> <td>String</td> <td> <span class="paramDescription"> <p>The file format for the download. One of csv, tsv or shp. When no value is supplied csv is assumed. </p> </span> </td> </tr> <tr> <td>sourceTypeId </td> <td>Integer</td> <td> <span class="paramDescription"> <p>A source type code for the download. This indicates which system requested the download. See <a href="https://logger.nbnatlas.org/service/logger/sources">sources</a> for valid values.</p> </span> </td> </tr> <tr> <td>qa </td> <td>String</td> <td> <span class="paramDescription"> <p>A CSV list of record issues to include in the download. See <a href="https://records-ws.nbnatlas.org/occurrences/search?q=*:*&facets=assertions&pageSize=0&flimit=500">assertions</a> for possible values to include. When no value is supplied all the record issues are included. To include NO record issues set this value to "none". To include ALL INCLUDING EMPTY record issue columns set this value to "includeall".</p> </span> </td> </tr> <tr> <td>esc </td> <td>String</td> <td> <span class="paramDescription"> <p>The Escape character to use for a CSV file. This will default to " in order to produce an Excel compliant CSV file.</p> </span> </td> </tr> <tr> <td>sep </td> <td>String</td> <td> <span class="paramDescription"> <p>The separator character to use for a CSV file. This will default to , .</p> </span> </td> </tr> <tr> <td>dwcHeaders </td> <td>Boolean</td> <td> <span class="paramDescription"> <p>Use DwC field names in the download where available. The default value is "false".</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/14?returnTo=%2F%23ws4" class="btn btn-small">Edit</a> </span> <h5>Disable Record Issues in download</h5> <p><p>A "test" (recordings of genus Vulpes recording from a 10k radius in London) in a download that does not include record assertions.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/occurrences/index/download?reasonTypeId=10&q=*:*&fq=genus:Vulpes&lat=51.5074&lon=0.1278&radius=10.0&qa=none">https://records-ws.nbnatlas.org/occurrences/index/download?reasonTypeId=10&q=*:*&fq=genus:Vulpes&lat=51.5074&lon=0.1278&radius=10.0&qa=none</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-70" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/70?returnTo=%2F%23ws4" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/70?returnTo=%2F%23ws4" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/70?returnTo=%2F%23ws4" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws70" id="ws70" name="ws70" style="text-decoration: none; color:black;">Compare original vs processed</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/occurrence/compare/{uuid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/occurrence/compare/{uuid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-70" class="webServiceDetails hide"> <p><p>Compare the original record to the processed (interpreted) version of the record.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>UUID </td> <td>String</td> <td> <span class="paramDescription"> <p>The identifier for the record.</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/54?returnTo=%2F%23ws70" class="btn btn-small">Edit</a> </span> <h5>Fox record</h5> <p><p>Compare original vs processed fox record.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/occurrence/compare/00e11378-510a-41e4-beea-d8e4d1d9a001">https://records-ws.nbnatlas.org/occurrence/compare/00e11378-510a-41e4-beea-d8e4d1d9a001</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-72" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/72?returnTo=%2F%23ws70" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/72?returnTo=%2F%23ws70" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/72?returnTo=%2F%23ws70" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws72" id="ws72" name="ws72" style="text-decoration: none; color:black;">Occurrence indexed fields</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/index/fields</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/index/fields</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-72" class="webServiceDetails hide"> <p><p>List in JSON the index fields within the occurrence store.<br> Notes when using these fields in search queries:<br> - Only stored values will be returned.<br> - Text fields will be fuzzy matched.<br> (See <a href="https://docs.google.com/document/d/1FiVasGGZ3kRPnu5347GPAef7Tr5LvvghCS6x82xnfu4">Query Primer</a> documentation).<br></p></p> <div class="examples"> View : <a href="https://records-ws.nbnatlas.org/index/fields">https://records-ws.nbnatlas.org/index/fields</a> </div> </div> </li> <li id="webService-75" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/75?returnTo=%2F%23ws72" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/75?returnTo=%2F%23ws72" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/75?returnTo=%2F%23ws72" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws75" id="ws75" name="ws75" style="text-decoration: none; color:black;">Retrieve all species groups and counts</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/explore/groups</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/explore/groups</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-75" class="webServiceDetails hide"> <p><p>Given search and optionally a filter, location and radius, it returns: a list of groups and how many records are in each.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The latitude to limit the query by (must be used with lon and radius)</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The longitude to limit the query by (must be used with lat and radius)</p> </span> </td> </tr> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>The query which defaults to *:* when not supplied</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>The filter query</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>Radius (km) (for use with lat, lon)</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/75?returnTo=%2F%23ws75" class="btn btn-small">Edit</a> </span> <h5>Species groups</h5> <p><p>Counts for species groups for records of genus:Vulpes?</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/explore/groups?q=*:*&fq=genus:Vulpes">https://records-ws.nbnatlas.org/explore/groups?q=*:*&fq=genus:Vulpes</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-76" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/76?returnTo=%2F%23ws75" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/76?returnTo=%2F%23ws75" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/76?returnTo=%2F%23ws75" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws76" id="ws76" name="ws76" style="text-decoration: none; color:black;">Retrieve the counts for a specific group</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/explore/counts/group/{group}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/explore/counts/group/{group}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-76" class="webServiceDetails hide"> <p><p>Given a group (e.g. Mammals) and optionally a filter, location and radius, it returns:<br> [number of species records in the group, number of species in that group]</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The longitude to limit the query by (must be used with lat and radius)</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>The filter query</p> </span> </td> </tr> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>The query which defaults to *:* when not supplied</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The latitude to limit the query by (must be used with lon and radius)</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>Radius (km) (for use with lat, lon)</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/76?returnTo=%2F%23ws76" class="btn btn-small">Edit</a> </span> <h5>Specific species group</h5> <p><p>How many of the records returned from the filter genus:Vulpes that are within 10km of the center of London are in the Mammals species group? (and how many different species is that?)</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/explore/counts/group/Mammals?q=*:*&fq=genus:Vulpes&lat=51.5074&lon=0.1278&radius=10.0">https://records-ws.nbnatlas.org/explore/counts/group/Mammals?q=*:*&fq=genus:Vulpes&lat=51.5074&lon=0.1278&radius=10.0</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-77" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/77?returnTo=%2F%23ws76" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/77?returnTo=%2F%23ws76" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/77?returnTo=%2F%23ws76" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws77" id="ws77" name="ws77" style="text-decoration: none; color:black;">Download a list of species in a group</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/explore/group/{group}/download</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/explore/group/{group}/download</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in ZIP format"> ZIP </a> </span> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in CSV format"> CSV </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">ZIP</li> <li class="label">CSV</li> </ul> </span> </div> </h4> <div id="webService-details-77" class="webServiceDetails hide"> <p><p>Download a list of species that contribute to a group (e.g. Birds) and their counts (optionally in a specific area).</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>The query which defaults to *:* when not supplied</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The latitude to limit the query by (must be used with lon and radius)</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The longitude to limit the query by (must be used with lat and radius)</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>The filter query</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>Radius (km) (for use with lat, lon)</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/77?returnTo=%2F%23ws77" class="btn btn-small">Edit</a> </span> <h5>Birds in Central London</h5> <p><p>Download a list of species and their counts that contribute to the Birds group from a 1km radius in the center of London.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/explore/group/Birds/download?lat=51.5074&lon=0.1278&radius=1.0">https://records-ws.nbnatlas.org/explore/group/Birds/download?lat=51.5074&lon=0.1278&radius=1.0</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-78" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/78?returnTo=%2F%23ws77" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/78?returnTo=%2F%23ws77" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/78?returnTo=%2F%23ws77" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws78" id="ws78" name="ws78" style="text-decoration: none; color:black;">Retrieve list of species and counts for a group</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/explore/group/{group}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/explore/group/{group}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-78" class="webServiceDetails hide"> <p><p>Retreive a list of species that contribute to a group (e.g. Birds) and their counts (optionally in a specific area).<br> Supports the additional parameters pageSize, start, sort, dir - to allow paging through the results, and location.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>The query which defaults to <em>:</em> when not supplied</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The latitude to limit the query by (must be used with lon and radius)</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>The filter query</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The longitude to limit the query by (must be used with lat and radius)</p> </span> </td> </tr> <tr> <td>pageSize </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Number of records to return</p> </span> </td> </tr> <tr> <td>start </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Record offset, to enable paging</p> </span> </td> </tr> <tr> <td>sort </td> <td>String</td> <td> <span class="paramDescription"> </span> </td> </tr> <tr> <td>dir </td> <td>String</td> <td> <span class="paramDescription"> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/78?returnTo=%2F%23ws78" class="btn btn-small">Edit</a> </span> <h5>Birds in Central London (json)</h5> <p><p>Retrieve a paged list (default size 10) of species and their counts that contribute to the Birds group from a 1km radius in the center of London.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/explore/group/Birds?lat=51.5074&lon=0.1278&radius=1.0&start=0">https://records-ws.nbnatlas.org/explore/group/Birds?lat=51.5074&lon=0.1278&radius=1.0&start=0</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-79" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/79?returnTo=%2F%23ws78" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/79?returnTo=%2F%23ws78" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/79?returnTo=%2F%23ws78" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws79" id="ws79" name="ws79" style="text-decoration: none; color:black;">Retrieve geojson cluster for group</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/geojson/radius-points</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/geojson/radius-points</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in GEOJSON format"> GEOJSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">GEOJSON</li> </ul> </span> </div> </h4> <div id="webService-details-79" class="webServiceDetails hide"> <p><p>Download geojson, i.e. coordinates points for localise group (e.g. can be viewed http://geojson.io)<br> Supports the additional parameters pageSize, start, sort, dir - to allow paging through the results.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>The query which defaults to <em>:</em> when not supplied</p> </span> </td> </tr> <tr> <td>start </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Record offset, to enable paging</p> </span> </td> </tr> <tr> <td>pageSize </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Number of records to return</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>The filter query</p> </span> </td> </tr> <tr> <td>sort </td> <td>String</td> <td> <span class="paramDescription"> </span> </td> </tr> <tr> <td>dir </td> <td>String</td> <td> <span class="paramDescription"> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The latitude to limit the query by (must be used with lon and radius)</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The longitude to limit the query by (must be used with lat and radius)</p> </span> </td> </tr> <tr> <td>group </td> <td>String</td> <td> <span class="paramDescription"> <p>Species group</p> </span> </td> </tr> <tr> <td>zoom </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Zoom level</p> </span> </td> </tr> <tr> <td>callback </td> <td>String</td> <td> <span class="paramDescription"> <p>JSONP callback</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/86?returnTo=%2F%23ws79" class="btn btn-small">Edit</a> </span> <h5>GeoJSON cluster for Grassington</h5> <p><p>Returns location of records for map display.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/geojson/radius-points?lat=54.079&lon=-1.988&radius=5&fq=geospatial_kosher%3Atrue&qc=&zoom=14&group=ALL_SPECIES">https://records-ws.nbnatlas.org/geojson/radius-points?lat=54.079&lon=-1.988&radius=5&fq=geospatial_kosher%3Atrue&qc=&zoom=14&group=ALL_SPECIES</a> <br/> Online demo: <a href="http://geojson.io/#map=12/54.0732/-1.9889">http://geojson.io/#map=12/54.0732/-1.9889</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-98" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/98?returnTo=%2F%23ws79" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/98?returnTo=%2F%23ws79" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/98?returnTo=%2F%23ws79" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws98" id="ws98" name="ws98" style="text-decoration: none; color:black;">Occurrence Facet Search</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/occurrence/facets?q={q}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/occurrence/facets?q={q}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-98" class="webServiceDetails hide"> <p><p>Use this service to retrieve counts for facets e.g. the number of taxa matching a query.<br> N.B. The fq parameter is ignored for this web service. If required, include any filters into the q param with an AND clause.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>foffset </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Facet offset, to enable paging</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>The radius in which to limit records (relative to the lat, lon point). Use with lat and lon to specify a "search" circle.</p> </span> </td> </tr> <tr> <td>fsort </td> <td>String</td> <td> <span class="paramDescription"> <p>Method in which to sort the facets either "count" or "index"</p> </span> </td> </tr> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> <tr> <td>sort </td> <td>String</td> <td> <span class="paramDescription"> <p>The indexed field to sort by</p> </span> </td> </tr> <tr> <td>startIndex </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Record offset, to enable paging</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>dir </td> <td>String</td> <td> <span class="paramDescription"> <p>Supports "asc" or "desc"</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>flimit </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Maximum number of facet values to return</p> </span> </td> </tr> <tr> <td>fprefix </td> <td>String</td> <td> <span class="paramDescription"> <p>Limits facets to values that start with the supplied value</p> </span> </td> </tr> <tr> <td>facets </td> <td>String</td> <td> <span class="paramDescription"> <p>Comma separated list of the fields to create facets on e.g. facets=basis_of_record.</p> </span> </td> </tr> <tr> <td>wkt </td> <td>String</td> <td> <span class="paramDescription"> <p>The polygon area in which to limit records. For information on Well known text see <a href="http://en.wikipedia.org/wiki/Well-known_text">this</a></p> </span> </td> </tr> <tr> <td>lookup </td> <td>Boolean</td> <td> <span class="paramDescription"> <p>Only suitable for facets that are returning taxon GUIDs (e.g.species_guid) If set to true this will try to perform a taxon lookup against the guid and will return additional taxon information</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/79?returnTo=%2F%23ws98" class="btn btn-small">Edit</a> </span> <h5>Top ten data resources</h5> <p><p>Return the top ten data resources by number of records</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/occurrence/facets?flimit=10&facets=data_resource_uid">https://records-ws.nbnatlas.org/occurrence/facets?flimit=10&facets=data_resource_uid</a> <br/> </p> </li> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/56?returnTo=%2F%23ws98" class="btn btn-small">Edit</a> </span> <h5>Retrieve historic bird counts</h5> <p><p>Retrieve a count of species of Birds in the UK using the "RSPB Big Garden Birdwatch winter sightings in the UK in 2009" (i.e. data_resource_uid:dr477) and return the top 10.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/occurrence/facets?facets=taxon_name,common_name&q=data_resource_uid:dr477&flimit=10">https://records-ws.nbnatlas.org/occurrence/facets?facets=taxon_name,common_name&q=data_resource_uid:dr477&flimit=10</a> <br/> </p> </li> </ul> </div> </div> </li> </ul> <h2 class="categoryHdr">Geospatial <span class="hidden-phone"><small> - Including intersection services and gazetteer information</small></span></h2> <ul style="list-style: none; margin:0;"> <li id="webService-11" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/11?returnTo=%2F%23ws98" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/11?returnTo=%2F%23ws98" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/11?returnTo=%2F%23ws98" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws11" id="ws11" name="ws11" style="text-decoration: none; color:black;">Layers listing</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/layers</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/layers</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-11" class="webServiceDetails hide"> <p><p>Get a list of all layers</p></p> <div class="examples"> View : <a href="https://layers.nbnatlas.org/ws/layers">https://layers.nbnatlas.org/ws/layers</a> </div> </div> </li> <li id="webService-12" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/12?returnTo=%2F%23ws11" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/12?returnTo=%2F%23ws11" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/12?returnTo=%2F%23ws11" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws12" id="ws12" name="ws12" style="text-decoration: none; color:black;">Gridded layers listing</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/layers/grids</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/layers/grids</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-12" class="webServiceDetails hide"> <p><p>Get a list of all environmental/gridded layers</p></p> <div class="examples"> View : <a href="https://layers.nbnatlas.org/ws/layers/grids">https://layers.nbnatlas.org/ws/layers/grids</a> </div> </div> </li> <li id="webService-13" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/13?returnTo=%2F%23ws12" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/13?returnTo=%2F%23ws12" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/13?returnTo=%2F%23ws12" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws13" id="ws13" name="ws13" style="text-decoration: none; color:black;">Shape layers listing</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/layers/shapes</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/layers/shapes</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-13" class="webServiceDetails hide"> <p><p>Get a list of all contextual layers (e.g. political boundaries)</p></p> <div class="examples"> View : <a href="https://layers.nbnatlas.org/ws/layers/shapes">https://layers.nbnatlas.org/ws/layers/shapes</a> </div> </div> </li> <li id="webService-39" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/39?returnTo=%2F%23ws13" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/39?returnTo=%2F%23ws13" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/39?returnTo=%2F%23ws13" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws39" id="ws39" name="ws39" style="text-decoration: none; color:black;">List of geospatial fields</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/fields</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/fields</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-39" class="webServiceDetails hide"> <p><p>Return a list of fields: name, id, description, etc.</p></p> <div class="examples"> View : <a href="https://layers.nbnatlas.org/ws/fields">https://layers.nbnatlas.org/ws/fields</a> </div> </div> </li> <li id="webService-40" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/40?returnTo=%2F%23ws39" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/40?returnTo=%2F%23ws39" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/40?returnTo=%2F%23ws39" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws40" id="ws40" name="ws40" style="text-decoration: none; color:black;">Details of a specific geospatial field</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/field/{fid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/field/{fid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-40" class="webServiceDetails hide"> <p><p>Return the details on a specific field using its field ID <code>fid</code> the results contains: name, ID, description, bounding box, area, etc.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/17?returnTo=%2F%23ws40" class="btn btn-small">Edit</a> </span> <h5>Fetch Watsonian Vice Counties object</h5> <p><p>Fetch the JSON describing Watsonian Vice Counties (field ID "cl14").</p></p> <p> URL: <a href="https://layers.nbnatlas.org/ws/field/cl14">https://layers.nbnatlas.org/ws/field/cl14</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-41" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/41?returnTo=%2F%23ws40" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/41?returnTo=%2F%23ws40" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/41?returnTo=%2F%23ws40" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws41" id="ws41" name="ws41" style="text-decoration: none; color:black;">Fetch an array of objects belonging to a specific field</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/objects/{fid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/objects/{fid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-41" class="webServiceDetails hide"> <p><p>Return an array of objects that are members of the specified field ID <code>fid</code>. This does not return any information for the field, only its children.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/18?returnTo=%2F%23ws41" class="btn btn-small">Edit</a> </span> <h5>Fetch Watsonian Vice Counties</h5> <p><p>Fetch an array of objects that are members of the Watsonian Vice Counties.</p></p> <p> URL: <a href="https://layers.nbnatlas.org/ws/objects/cl14">https://layers.nbnatlas.org/ws/objects/cl14</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-42" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/42?returnTo=%2F%23ws41" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/42?returnTo=%2F%23ws41" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/42?returnTo=%2F%23ws41" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws42" id="ws42" name="ws42" style="text-decoration: none; color:black;">Fetch the details for a specific geospatial object</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/object/{pid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/object/{pid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-42" class="webServiceDetails hide"> <p><p>Fetch the details for a specific object using its primary ID <code>pid</code>. The results include name, description, bounding box, area, etc.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/19?returnTo=%2F%23ws42" class="btn btn-small">Edit</a> </span> <h5>The ACT object for West Norfolk</h5> <p><p>Fetch the details for object pid=2628 (e.g. from fid=cl14)</p></p> <p> URL: <a href="https://layers.nbnatlas.org/ws/object/2628">https://layers.nbnatlas.org/ws/object/2628</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-43" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/43?returnTo=%2F%23ws42" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/43?returnTo=%2F%23ws42" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/43?returnTo=%2F%23ws42" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws43" id="ws43" name="ws43" style="text-decoration: none; color:black;">Download a shape object as KML</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/kml/{pid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/kml/{pid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in XML format"> XML </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">XML</li> </ul> </span> </div> </h4> <div id="webService-details-43" class="webServiceDetails hide"> <p><p>Download the object as KML using its primary ID <code>pid</code>.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/20?returnTo=%2F%23ws43" class="btn btn-small">Edit</a> </span> <h5>KML for Glamorganshire</h5> <p><p>Fetch the KML for Glamorganshire using the pid.</p></p> <p> URL: <a href="https://layers.nbnatlas.org/ws/shape/kml/2730.kml">https://layers.nbnatlas.org/ws/shape/kml/2730.kml</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-44" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/44?returnTo=%2F%23ws43" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/44?returnTo=%2F%23ws43" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/44?returnTo=%2F%23ws43" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws44" id="ws44" name="ws44" style="text-decoration: none; color:black;">Download a shape object as WKT</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/wkt/{pid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/wkt/{pid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-44" class="webServiceDetails hide"> <p><p>Download a shape object as <a href="http://en.wikipedia.org/wiki/Well-known_text">well-known text</a> (WKT) using its primary ID <code>pid</code>.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/21?returnTo=%2F%23ws44" class="btn btn-small">Edit</a> </span> <h5>WKT shape for Glamorganshire</h5> <p><p>Download the WKT shape for Glamorganshire using its pid.</p></p> <p> URL: <a href="https://layers.nbnatlas.org/ws/shape/wkt/2730.wkt">https://layers.nbnatlas.org/ws/shape/wkt/2730.wkt</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-45" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/45?returnTo=%2F%23ws44" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/45?returnTo=%2F%23ws44" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/45?returnTo=%2F%23ws44" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws45" id="ws45" name="ws45" style="text-decoration: none; color:black;">Download a shape object as GeoJSON</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/geojson/{pid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/geojson/{pid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-45" class="webServiceDetails hide"> <p><p>Download a shape object as <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> using its primary ID <code>pid</code>.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/22?returnTo=%2F%23ws45" class="btn btn-small">Edit</a> </span> <h5>GeoJSON shape for Glamorganshire</h5> <p><p>Download the GeoJSON shape for Glamorganshire using its pid.</p></p> <p> URL: <a href="https://layers.nbnatlas.org/ws/shape/geojson/2730">https://layers.nbnatlas.org/ws/shape/geojson/2730</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-46" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/46?returnTo=%2F%23ws45" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/46?returnTo=%2F%23ws45" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/46?returnTo=%2F%23ws45" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws46" id="ws46" name="ws46" style="text-decoration: none; color:black;">Download a shape object as a ESRI Shape file</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/shp/{pid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/shp/{pid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in ZIP format"> ZIP </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">ZIP</li> </ul> </span> </div> </h4> <div id="webService-details-46" class="webServiceDetails hide"> <p><p>Download a shape object as an ESRI Shape file. Note that the data is packaged in a <strong>zip file</strong> that contains all of the separate files to support a "shape file."</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/23?returnTo=%2F%23ws46" class="btn btn-small">Edit</a> </span> <h5>Shape file for Glamorganshire</h5> <p><p>Download the a shape (zip) file for Glamorganshire using its pid. The zip file contains the 6 individual component files that make a "shape" file.</p></p> <p> URL: <a href="https://layers.nbnatlas.org/ws/shape/shp/2730.zip">https://layers.nbnatlas.org/ws/shape/shp/2730.zip</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-48" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/48?returnTo=%2F%23ws46" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/48?returnTo=%2F%23ws46" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/48?returnTo=%2F%23ws46" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws48" id="ws48" name="ws48" style="text-decoration: none; color:black;">Upload geometry as WKT</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/upload/wkt</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/upload/wkt</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-48" class="webServiceDetails hide"> <p><p>Upload a geometry object formatted in WKT. A JSON object with the new primary ID (pid) is returned if successful.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>wkt <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The WKT string describing the shape</p> </span> </td> </tr> <tr> <td>name </td> <td>String</td> <td> <span class="paramDescription"> <p>The name of the object</p> </span> </td> </tr> <tr> <td>description </td> <td>String</td> <td> <span class="paramDescription"> <p>The description of the object</p> </span> </td> </tr> <tr> <td>user_id </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The User ID associated with the API key</p> </span> </td> </tr> <tr> <td>api_key </td> <td>String</td> <td> <span class="paramDescription"> <p>Spatial portal's <a href="https://auth.nbnatlas.org/apikey/">API key</a></p> </span> </td> </tr> </table> </div> </li> <li id="webService-49" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/49?returnTo=%2F%23ws48" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/49?returnTo=%2F%23ws48" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/49?returnTo=%2F%23ws48" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws49" id="ws49" name="ws49" style="text-decoration: none; color:black;">Upload geometry as GeoJSON</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/upload/geojson</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/upload/geojson</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-49" class="webServiceDetails hide"> <p><p>Upload a geometry object as a GeoJSON string. A JSON object with the new primary ID (pid) is returned if successful.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>description </td> <td>String</td> <td> <span class="paramDescription"> <p>The description of the object</p> </span> </td> </tr> <tr> <td>name </td> <td>String</td> <td> <span class="paramDescription"> <p>The name of the object</p> </span> </td> </tr> <tr> <td>geojson <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The GeoJSON string describing the shape</p> </span> </td> </tr> <tr> <td>api_key </td> <td>String</td> <td> <span class="paramDescription"> <p>Spatial portal's <a href="https://auth.nbnatlas.org/apikey/">API key</a></p> </span> </td> </tr> <tr> <td>user_id </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The User ID associated with the API key</p> </span> </td> </tr> </table> </div> </li> <li id="webService-50" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/50?returnTo=%2F%23ws49" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/50?returnTo=%2F%23ws49" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/50?returnTo=%2F%23ws49" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws50" id="ws50" name="ws50" style="text-decoration: none; color:black;">Upload geometry as a point and radius</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/upload/{lat}/{lng}/{radius}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/upload/{lat}/{lng}/{radius}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-50" class="webServiceDetails hide"> <p><p>Upload/create a geometry object as a circle: a point <code>(lat, lng)</code> and <code>radius</code>. A JSON object with the new primary ID <code>pid</code> is returned if successful.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>user_id </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The User ID associated with the API key</p> </span> </td> </tr> <tr> <td>name </td> <td>String</td> <td> <span class="paramDescription"> <p>The name of the object</p> </span> </td> </tr> <tr> <td>api_key </td> <td>String</td> <td> <span class="paramDescription"> <p>Spatial portal's <a href="https://auth.nbnatlas.org/apikey/">API key</a></p> </span> </td> </tr> <tr> <td>description </td> <td>String</td> <td> <span class="paramDescription"> <p>The description of the object</p> </span> </td> </tr> </table> </div> </li> <li id="webService-51" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/51?returnTo=%2F%23ws50" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/51?returnTo=%2F%23ws50" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/51?returnTo=%2F%23ws50" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws51" id="ws51" name="ws51" style="text-decoration: none; color:black;">Upload shapefile (Multipart)</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/upload/shp</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/upload/shp</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-51" class="webServiceDetails hide"> <p><p>Upload a shapefile into the Atlas. The shapefile (archived as a <strong>zip</strong> file) is sent as the multipart form data. If successful a JSON object is returned with the ID of the shapefile (shp_id) and an array of features (id, name).</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>user_id <span class="required-indicator">*</span> </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The User ID associated with the API key</p> </span> </td> </tr> <tr> <td>api_key <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Spatial portal's <a href="https://auth.nbnatlas.org/apikey/">API key</a></p> </span> </td> </tr> </table> </div> </li> <li id="webService-52" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/52?returnTo=%2F%23ws51" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/52?returnTo=%2F%23ws51" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/52?returnTo=%2F%23ws51" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws52" id="ws52" name="ws52" style="text-decoration: none; color:black;">Upload shapefile (Regular)</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/upload/shp</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/upload/shp</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-52" class="webServiceDetails hide"> <p><p>Upload a shapefile into the Atlas. The shapefile (archived as a <strong>zip</strong> file) is sent as the multipart form data. If successful a JSON object is returned with the ID of the shapefile (shp_id) and an array of features (id, name).</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>user_id <span class="required-indicator">*</span> </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The User ID associated with the API key</p> </span> </td> </tr> <tr> <td>api_key <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Spatial portal's <a href="https://auth.nbnatlas.org/apikey/">API key</a></p> </span> </td> </tr> <tr> <td>shp_file_url </td> <td>String</td> <td> <span class="paramDescription"> <p>Url</p> </span> </td> </tr> </table> </div> </li> <li id="webService-53" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/53?returnTo=%2F%23ws52" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/53?returnTo=%2F%23ws52" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/53?returnTo=%2F%23ws52" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws53" id="ws53" name="ws53" style="text-decoration: none; color:black;">Create object from shapefile feature</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/upload/shp/{shp_id}/{feature_id}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/upload/shp/{shp_id}/{feature_id}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-53" class="webServiceDetails hide"> <p><p>The second step of adding shapefile to the Atlas: once a shapefile ( <code>shp_id</code> ) has been uploaded, the features ( <code>feature_id</code> ) in the file can be converted into spatial objects. If successful return a Upload a shapefile into the Atlas. If successful a JSON object is returned with the primary ID of the object: <code>{ "id" : 3742602}</code></p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>api_key <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Spatial portal's <a href="https://auth.nbnatlas.org/apikey/">API key</a></p> </span> </td> </tr> <tr> <td>shp_id <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The ID returned when uploading a shapefile</p> </span> </td> </tr> <tr> <td>user_id <span class="required-indicator">*</span> </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The User ID associated with the API key</p> </span> </td> </tr> <tr> <td>feature_id <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The ID number of the shapefile's feature to import into the Atlas. The IDs are returned when the shapefile is uploaded</p> </span> </td> </tr> <tr> <td>name <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The name of the geometry object</p> </span> </td> </tr> <tr> <td>description <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The description of the object</p> </span> </td> </tr> </table> </div> </li> <li id="webService-59" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/59?returnTo=%2F%23ws53" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/59?returnTo=%2F%23ws53" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/59?returnTo=%2F%23ws53" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws59" id="ws59" name="ws59" style="text-decoration: none; color:black;">Update object from shapefile feature</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/shape/upload/shp/{pid}/{shp_id}/{feature_id}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/shape/upload/shp/{pid}/{shp_id}/{feature_id}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-59" class="webServiceDetails hide"> <p><p>Update an existing geospatial object ( <code>pid</code> ) from a feature in a shapefile ( <code>shp_id/feature_id</code> ). If successful, a JSON object will be returned: <code>{ 'updated' : true}</code></p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>user_id <span class="required-indicator">*</span> </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The User ID associated with the API key</p> </span> </td> </tr> <tr> <td>feature_id <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The ID number of the shapefile's feature to import into the Atlas. The IDs are returned when the shapefile is uploaded</p> </span> </td> </tr> <tr> <td>shp_id <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The ID returned when uploading a shapefile</p> </span> </td> </tr> <tr> <td>description <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The description of the object</p> </span> </td> </tr> <tr> <td>name <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The name of the geometry object</p> </span> </td> </tr> <tr> <td>api_key <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Spatial portal's <a href="https://auth.nbnatlas.org/apikey/">API key</a></p> </span> </td> </tr> <tr> <td>pid </td> <td>String</td> <td> <span class="paramDescription"> <p>The primary ID of the object to be updated</p> </span> </td> </tr> </table> </div> </li> <li id="webService-83" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/83?returnTo=%2F%23ws59" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/83?returnTo=%2F%23ws59" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/83?returnTo=%2F%23ws59" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws83" id="ws83" name="ws83" style="text-decoration: none; color:black;">Intersect a layer(s) at a given set of coordinates</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/intersect/{id}/{latitude}/{longitude}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/intersect/{id}/{latitude}/{longitude}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-83" class="webServiceDetails hide"> <p><p>Multiple field ids or layer names can be specified separated by a comma (e.g. cl22,cl23):</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/39?returnTo=%2F%23ws83" class="btn btn-small">Edit</a> </span> <h5>Reverse geocode Watsonian Vice County</h5> <p><p>Lookup Watsonian Vice County from GPS</p></p> <p> URL: <a href="https://layers.nbnatlas.org/ws/intersect/cl14/51.5074/0.1278">https://layers.nbnatlas.org/ws/intersect/cl14/51.5074/0.1278</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-84" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/84?returnTo=%2F%23ws83" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/84?returnTo=%2F%23ws83" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/84?returnTo=%2F%23ws83" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws84" id="ws84" name="ws84" style="text-decoration: none; color:black;">Batch intersect a layer(s) at given coordinates</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/intersect/batch</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/intersect/batch</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-84" class="webServiceDetails hide"> <p><p>Multiple field ids or layer names can be specified separated by a comma (e.g. cl22,cl23). Limited to 1000 coordinates</p></p> <div class="exampleOutput"> <h4>Example output</h4> <pre><code>POST: https://layers.nbnatlas.org/ws/intersect/batch Body: fids=cl14&points=51.5074,0.1278,52.5074,0.1278 {"progress":0,"status":"waiting","waiting":"In queue","batchId":"1489494775565","statusUrl":"https://layers.nbnatlas.org/ws/intersect/batch/1489494775565","points":2,"fields":1} GET: https://layers.nbnatlas.org/ws/intersect/batch/1489494775565 {"progress":2,"progressMessage":"Finished sampling layer: county_coastal_terrestrial_region. Points processed: 1","status":"finished","downloadUrl":"https://layers.nbnatlas.org/ws/intersect/batch/download/1489494775565","finished":"14/03/17 12:32:55:860","points":2,"started":"14/03/17 12:32:55:565","fields":1} GET: https://layers.nbnatlas.org/ws/intersect/batch/download/1489494775565.zip unzip 1489494775565.zip Returns: latitude,longitude,cl14 51.5074,0.1278,West Kent 52.5074,0.1278,Cambridgeshire</code></pre> </div> <div class="examples"> View : <a href="https://layers.nbnatlas.org/ws/intersect/batch">https://layers.nbnatlas.org/ws/intersect/batch</a> </div> </div> </li> <li id="webService-85" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/85?returnTo=%2F%23ws84" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/85?returnTo=%2F%23ws84" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/85?returnTo=%2F%23ws84" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws85" id="ws85" name="ws85" style="text-decoration: none; color:black;">Check batch intersect status with a batchId</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/intersect/batch/{batchId} </span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/intersect/batch/{batchId} </span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-85" class="webServiceDetails hide"> <p><p>Multiple field ids or layer names can be specified separated by a comma (e.g. cl22,cl23). Limited to 1000 coordinates</p></p> <div class="examples"> View : <a href="https://layers.nbnatlas.org/ws/intersect/batch/{batchId} ">https://layers.nbnatlas.org/ws/intersect/batch/{batchId} </a> </div> </div> </li> <li id="webService-86" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/86?returnTo=%2F%23ws85" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/86?returnTo=%2F%23ws85" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/86?returnTo=%2F%23ws85" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws86" id="ws86" name="ws86" style="text-decoration: none; color:black;">Download a finished batch intersect</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://layers.nbnatlas.org/ws/intersect/batch/download/{batchId}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://layers.nbnatlas.org/ws/intersect/batch/download/{batchId}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in CSV format"> CSV </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">CSV</li> </ul> </span> </div> </h4> <div id="webService-details-86" class="webServiceDetails hide"> <p><p>Download a finished batch intersect with a batchId as zipped file</p></p> <div class="examples"> View : <a href="https://layers.nbnatlas.org/ws/intersect/batch/download/{batchId}">https://layers.nbnatlas.org/ws/intersect/batch/download/{batchId}</a> </div> </div> </li> </ul> <h2 class="categoryHdr">Mapping <span class="hidden-phone"><small> - Creating maps with WMS services, static heat maps</small></span></h2> <ul style="list-style: none; margin:0;"> <li id="webService-10" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/10?returnTo=%2F%23ws86" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/10?returnTo=%2F%23ws86" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/10?returnTo=%2F%23ws86" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws10" id="ws10" name="ws10" style="text-decoration: none; color:black;">WMS Legend</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/mapping/legend</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/mapping/legend</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in CSV format"> CSV </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">CSV</li> </ul> </span> </div> </h4> <div id="webService-details-10" class="webServiceDetails hide"> <p><p>Returns a table of values to allow a legend to be generated by the client.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See <a href="https://records-ws.nbnatlas.org/index/fields">https://records-ws.nbnatlas.org/index/fields</a> for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>The radius in which to limit records (relative to the lat, lon point). Use with lat and lon to specify a "search" circle.</p> </span> </td> </tr> <tr> <td>wkt </td> <td>String</td> <td> <span class="paramDescription"> <p>The polygon area in which to limit records. For information on Well known text</p> </span> </td> </tr> <tr> <td>cm <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Colour mode - facet to use for generating the colour gradations</p> </span> </td> </tr> <tr> <td>type </td> <td>String</td> <td> <span class="paramDescription"> <p>Response type. "application/csv" (default), or "application/json".</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/64?returnTo=%2F%23ws10" class="btn btn-small">Edit</a> </span> <h5>Species legend for macropus.</h5> <p><p>Legend for WMS q=macropus with cm=species as JSON.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/mapping/legend?q=macropus&cm=species&type=application/json">https://records-ws.nbnatlas.org/mapping/legend?q=macropus&cm=species&type=application/json</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-6" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/6?returnTo=%2F%23ws10" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/6?returnTo=%2F%23ws10" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/6?returnTo=%2F%23ws10" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws6" id="ws6" name="ws6" style="text-decoration: none; color:black;">WMS GetCapabilities</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/ogc/ows</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/ogc/ows</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in XML format"> XML </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">XML</li> </ul> </span> </div> </h4> <div id="webService-details-6" class="webServiceDetails hide"> <p><p><code>[Attention: WMS Calls are currently under review - 14/3/2017]</code><br> <a href="http://schemas.opengis.net/wms/">Web Mapping Service GetCapabilities</a>. This is an OGC service that can be used to retrieve a listing of layers for taxa in a hierarchical format in XML.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See https://records-ws.nbnatlas.org/index/fields for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>facet </td> <td>String</td> <td> <span class="paramDescription"> <p>Supported values are "off" or "on". By default, its "on". This is worth switching off if facetting is not required, to reduce the JSON being sent.</p> </span> </td> </tr> <tr> <td>facets </td> <td>String</td> <td> <span class="paramDescription"> <p>Comma separated list of the fields to create facets on e.g. facets=basis_of_record.</p> </span> </td> </tr> <tr> <td>pageSize </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Number of records to return</p> </span> </td> </tr> <tr> <td>startIndex </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Record offset, to enable paging</p> </span> </td> </tr> <tr> <td>sort </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The indexed field to sort by</p> </span> </td> </tr> <tr> <td>dir </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Supports "asc" or "desc" </p> </span> </td> </tr> <tr> <td>flimit </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Maximum number of facet values to return</p> </span> </td> </tr> <tr> <td>fsort </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Method in which to sort the facets either "count" or "index" </p> </span> </td> </tr> <tr> <td>foffset </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Facet offset, to enable paging</p> </span> </td> </tr> <tr> <td>fprefix </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Limits facets to values that start with the supplied value</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>The radius in which to limit records (relative to the lat, lon point). Use with lat and lon to specify a "search" circle.</p> </span> </td> </tr> <tr> <td>wkt </td> <td>String</td> <td> <span class="paramDescription"> <p>The polygon area in which to limit records. For information on Well known text</p> </span> </td> </tr> </table> </div> </li> <li id="webService-7" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/7?returnTo=%2F%23ws6" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/7?returnTo=%2F%23ws6" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/7?returnTo=%2F%23ws6" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws7" id="ws7" name="ws7" style="text-decoration: none; color:black;">WMS GetMetadata</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/ogc/getMetadata</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/ogc/getMetadata</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in XML format"> XML </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">XML</li> </ul> </span> </div> </h4> <div id="webService-details-7" class="webServiceDetails hide"> <p><p><code>[Attention: WMS Calls are currently under review - 14/3/2017]</code><br></p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See https://records-ws.nbnatlas.org/index/fields for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>facet </td> <td>String</td> <td> <span class="paramDescription"> <p>Supported values are "off" or "on". By default, its "on". This is worth switching off if facetting is not required, to reduce the JSON being sent.</p> </span> </td> </tr> <tr> <td>facets </td> <td>String</td> <td> <span class="paramDescription"> <p>Comma separated list of the fields to create facets on e.g. facets=basis_of_record.</p> </span> </td> </tr> <tr> <td>pageSize </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Number of records to return</p> </span> </td> </tr> <tr> <td>startIndex </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Record offset, to enable paging</p> </span> </td> </tr> <tr> <td>sort </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The indexed field to sort by</p> </span> </td> </tr> <tr> <td>dir </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Supports "asc" or "desc" </p> </span> </td> </tr> <tr> <td>flimit </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Maximum number of facet values to return</p> </span> </td> </tr> <tr> <td>fsort </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Method in which to sort the facets either "count" or "index" </p> </span> </td> </tr> <tr> <td>foffset </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Facet offset, to enable paging</p> </span> </td> </tr> <tr> <td>fprefix </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Limits facets to values that start with the supplied value</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>The radius in which to limit records (relative to the lat, lon point). Use with lat and lon to specify a "search" circle.</p> </span> </td> </tr> <tr> <td>wkt </td> <td>String</td> <td> <span class="paramDescription"> <p>The polygon area in which to limit records. For information on Well known text</p> </span> </td> </tr> </table> </div> </li> <li id="webService-74" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/74?returnTo=%2F%23ws7" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/74?returnTo=%2F%23ws7" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/74?returnTo=%2F%23ws7" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws74" id="ws74" name="ws74" style="text-decoration: none; color:black;">Generate static map</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/mapping/wms/image</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/mapping/wms/image</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in PNG format"> PNG </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">PNG</li> </ul> </span> </div> </h4> <div id="webService-details-74" class="webServiceDetails hide"> <p><p>Generate a static image with various formatting options.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See https://records-ws.nbnatlas.org/index/fields for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> <tr> <td>format </td> <td>String</td> <td> <span class="paramDescription"> <p>Default 'jpg'</p> </span> </td> </tr> <tr> <td>widthmm </td> <td>String</td> <td> <span class="paramDescription"> <p>Image width in mm</p> </span> </td> </tr> <tr> <td>pradiusmm </td> <td>String</td> <td> <span class="paramDescription"> <p>Species point radius in mm, integer</p> </span> </td> </tr> <tr> <td>pradiuspx </td> <td>String</td> <td> <span class="paramDescription"> <p>Species point radius in pixels, integer. Only pradiuspx or pradiusmm need be supplied. If both supplied, pradiuspx takes precendence.</p> </span> </td> </tr> <tr> <td>pcolour </td> <td>String</td> <td> <span class="paramDescription"> <p>Point colour in hex. Default is FF0000</p> </span> </td> </tr> <tr> <td>popacity </td> <td>String</td> <td> <span class="paramDescription"> <p>Point opacity. Default is 0.8</p> </span> </td> </tr> <tr> <td>baselayer </td> <td>String</td> <td> <span class="paramDescription"> <p>Base layer to use from http://spatial.ala.org.au/geoserver</p> </span> </td> </tr> <tr> <td>baselayerPrefix </td> <td>String</td> <td> <span class="paramDescription"> <p>Default "ALA:"</p> </span> </td> </tr> <tr> <td>scale </td> <td>String</td> <td> <span class="paramDescription"> <p>Include a scale. DefaultValue = "off".</p> </span> </td> </tr> <tr> <td>dpi </td> <td>String</td> <td> <span class="paramDescription"> <p>Dots per inch. Default is 300.</p> </span> </td> </tr> <tr> <td>outline </td> <td>String</td> <td> <span class="paramDescription"> <p>Point outline. Default is false</p> </span> </td> </tr> <tr> <td>outlineColour </td> <td>String</td> <td> <span class="paramDescription"> <p>Default #000000</p> </span> </td> </tr> <tr> <td>fileName </td> <td>String</td> <td> <span class="paramDescription"> <p>File name to use</p> </span> </td> </tr> <tr> <td>extents </td> <td>String</td> <td> <span class="paramDescription"> <p>minx,miny,maxx,maxy (EPSG:4326) e.g. -11.2538,48.6754,3.0270,60.7995</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/36?returnTo=%2F%23ws74" class="btn btn-small">Edit</a> </span> <h5>Download Black Redstart static map</h5> <p><p>Map on the UK showing sighting of Black Redstart</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/mapping/wms/image?baselayer=world&format=jpg&pcolour=3531FF&scale=on&popacity=1&q=*:*&fq=lsid:NHMSYS0000530744&extents=-11.2538,48.6754,3.0270,60.7995&outline=true&outlineColour=0x000000&pradiusmm=1&dpi=300">https://records-ws.nbnatlas.org/mapping/wms/image?baselayer=world&format=jpg&pcolour=3531FF&scale=on&popacity=1&q=*:*&fq=lsid:NHMSYS0000530744&extents=-11.2538,48.6754,3.0270,60.7995&outline=true&outlineColour=0x000000&pradiusmm=1&dpi=300</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-8" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/8?returnTo=%2F%23ws74" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/8?returnTo=%2F%23ws74" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/8?returnTo=%2F%23ws74" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws8" id="ws8" name="ws8" style="text-decoration: none; color:black;">WMS GetFeatureInfo</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/ogc/getFeatureInfo</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/ogc/getFeatureInfo</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in XML format"> XML </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">XML</li> </ul> </span> </div> </h4> <div id="webService-details-8" class="webServiceDetails hide"> <p><p><code>[Attention: WMS Calls are currently under review - 14/3/2017]</code></p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See https://records-ws.nbnatlas.org/index/fields for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>facet </td> <td>String</td> <td> <span class="paramDescription"> <p>Supported values are "off" or "on". By default, its "on". This is worth switching off if facetting is not required, to reduce the JSON being sent.</p> </span> </td> </tr> <tr> <td>facets </td> <td>String</td> <td> <span class="paramDescription"> <p>Comma separated list of the fields to create facets on e.g. facets=basis_of_record.</p> </span> </td> </tr> <tr> <td>pageSize </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Number of records to return</p> </span> </td> </tr> <tr> <td>startIndex </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Record offset, to enable paging</p> </span> </td> </tr> <tr> <td>sort </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The indexed field to sort by</p> </span> </td> </tr> <tr> <td>dir </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Supports "asc" or "desc" </p> </span> </td> </tr> <tr> <td>flimit </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Maximum number of facet values to return</p> </span> </td> </tr> <tr> <td>fsort </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Method in which to sort the facets either "count" or "index" </p> </span> </td> </tr> <tr> <td>foffset </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Facet offset, to enable paging</p> </span> </td> </tr> <tr> <td>fprefix </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Limits facets to values that start with the supplied value</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>The radius in which to limit records (relative to the lat, lon point). Use with lat and lon to specify a "search" circle.</p> </span> </td> </tr> <tr> <td>wkt </td> <td>String</td> <td> <span class="paramDescription"> <p>The polygon area in which to limit records. For information on Well known text</p> </span> </td> </tr> </table> </div> </li> <li id="webService-9" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/9?returnTo=%2F%23ws8" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/9?returnTo=%2F%23ws8" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/9?returnTo=%2F%23ws8" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws9" id="ws9" name="ws9" style="text-decoration: none; color:black;">WMS GetMap</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/ogc/wms/reflect</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/ogc/wms/reflect</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in PNG format"> PNG </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">PNG</li> </ul> </span> </div> </h4> <div id="webService-details-9" class="webServiceDetails hide"> <p><p>WMS services for point occurrence data</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>Query of the form field:value e.g. q=genus:Macropus or a free text search e.g. q=Macropus</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See https://records-ws.nbnatlas.org/index/fields for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>facet </td> <td>String</td> <td> <span class="paramDescription"> <p>Supported values are "off" or "on". By default, its "on". This is worth switching off if facetting is not required, to reduce the JSON being sent.</p> </span> </td> </tr> <tr> <td>facets </td> <td>String</td> <td> <span class="paramDescription"> <p>Comma separated list of the fields to create facets on e.g. facets=basis_of_record.</p> </span> </td> </tr> <tr> <td>pageSize </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Number of records to return</p> </span> </td> </tr> <tr> <td>startIndex </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Record offset, to enable paging</p> </span> </td> </tr> <tr> <td>sort </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The indexed field to sort by</p> </span> </td> </tr> <tr> <td>dir </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Supports "asc" or "desc" </p> </span> </td> </tr> <tr> <td>flimit </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Maximum number of facet values to return</p> </span> </td> </tr> <tr> <td>fsort </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Method in which to sort the facets either "count" or "index" </p> </span> </td> </tr> <tr> <td>foffset </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Facet offset, to enable paging</p> </span> </td> </tr> <tr> <td>fprefix </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Limits facets to values that start with the supplied value</p> </span> </td> </tr> <tr> <td>lat </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>lon </td> <td>Double</td> <td> <span class="paramDescription"> <p>The decimal latitude to limit records to. Use with lon and radius to specify a "search" circle</p> </span> </td> </tr> <tr> <td>radius </td> <td>Double</td> <td> <span class="paramDescription"> <p>The radius in which to limit records (relative to the lat, lon point). Use with lat and lon to specify a "search" circle.</p> </span> </td> </tr> <tr> <td>wkt </td> <td>String</td> <td> <span class="paramDescription"> <p>The polygon area in which to limit records. For information on Well known text</p> </span> </td> </tr> <tr> <td>ENV </td> <td>String</td> <td> <span class="paramDescription"> <p>Additional parameters. e.g. <code>ENV=color%3Acd3844%3Bsize%3A3%3Bopacity%3A0.8</code>.</p> <ul> <li><strong>color</strong> - hex RGB values. e.g. colour:cd3844.</li> <li><strong>size</strong> - radius of points in pixels.</li> <li><strong>opacity</strong> - opacity value 0 - 1.</li> <li><strong>sel</strong> - fq parameter applied to CQL_FILTER. Matching occurrences will be highlighted on the map in a Red circle.</li> <li><strong>uncertainty</strong> - presence of the uncertainty parameter draws uncertainty circles to a fixed maximum of 30km.</li> <li><strong>colormode</strong> - facet colouring type. <ul> <li><code>-1</code> (default) use color value.</li> <li><code>grid</code> map as density grid. Grid cells drawn are not restricted to within any query WKT parameters.</li> <li><code>facetname</code> colour as categories in a facet.</li> <li><code>facetname,cutpoints</code> colour as range in a facet using the supplied comma separated cutpoints. 4 to 10 values are required. Include minimum and maximum. Minimum and maximum values do not need to be accurate. e.g. colormode:year,1800,1900,1950,1970,1990,2010</li> </ul></li> </ul><p><br> Please see the examples for more available ENV parameters</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/89?returnTo=%2F%23ws9" class="btn btn-small">Edit</a> </span> <h5>OSGB36 (ESPG:27700) Leaflet map with multiple grid displays (Vice County Layer)</h5> <p><p>Standalone leaflet JS example that displays maps and grids in the OSGB36 projection.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/ogc/wms/reflect">https://records-ws.nbnatlas.org/ogc/wms/reflect</a> <br/> Online demo: <a href="https://duncanrowland.github.io/NBNMapOverlayExamples/leaflet3.html">https://duncanrowland.github.io/NBNMapOverlayExamples/leaflet3.html</a> <br/> </p> </li> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/26?returnTo=%2F%23ws9" class="btn btn-small">Edit</a> </span> <h5>Single Species Layer with LeafletJS</h5> <p><p>An example showing one layer overlay using leafletjs.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/ogc/wms/reflect">https://records-ws.nbnatlas.org/ogc/wms/reflect</a> <br/> Online demo: <a href="https://duncanrowland.github.io/NBNMapOverlayExamples/leaflet1.html">https://duncanrowland.github.io/NBNMapOverlayExamples/leaflet1.html</a> <br/> </p> </li> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/91?returnTo=%2F%23ws9" class="btn btn-small">Edit</a> </span> <h5>OSGB36 (ESPG:27700) Leaflet map with multiple grid displays (OS Layer)</h5> <p><p>Standalone leaflet JS example that displays maps and grids in the OSGB36 projection.</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/ogc/wms/reflect">https://records-ws.nbnatlas.org/ogc/wms/reflect</a> <br/> Online demo: <a href="https://s3.eu-west-2.amazonaws.com/nbnatlas-dev/map-test-OS-variants.html">https://s3.eu-west-2.amazonaws.com/nbnatlas-dev/map-test-OS-variants.html</a> <br/> </p> </li> </ul> </div> </div> </li> </ul> <h2 class="categoryHdr">Endemism <span class="hidden-phone"><small> - Services for reports on endemism for an area</small></span></h2> <ul style="list-style: none; margin:0;"> <li id="webService-14" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/14?returnTo=%2F%23ws9" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/14?returnTo=%2F%23ws9" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/14?returnTo=%2F%23ws9" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws14" id="ws14" name="ws14" style="text-decoration: none; color:black;">Count endemic species</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/explore/counts/endemic</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/explore/counts/endemic</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-14" class="webServiceDetails hide"> <p><p>Count of distinct endemic species within an area (* indicates required params)</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The initial query. q=<em>:</em> will query anything, q=macropus will do a free text search for macropus, q=kingdom:Fungi will search for records with a kingdom of Fungi. For a listing of the fields that can be queried in a q=INDEXEDFIELD:VALUE fashion, see /index/fields. This will restrict the records that are considered in then region. For example this could allow people to restrict the service to endemic birds.</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See https://records-ws.nbnatlas.org/index/fields for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>wkt <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The Well Known Text Area in which to provide the endemic species.</p> </span> </td> </tr> <tr> <td>facets <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The field on which to based the species list. This can be taxon_concept_lsid or species_guid</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/62?returnTo=%2F%23ws14" class="btn btn-small">Edit</a> </span> <h5>Count endemics</h5> <p><p>Count all the endemic species recorded within a small area in London.<br> (Note, wkt POLYGON=lon,lat and not lat,lon).</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/explore/counts/endemic?wkt=POLYGON((0.12+51.50,0.13+51.50,0.13+51.51,0.12+51.51,0.12+51.50))&q=*:*&facets=species_guid">https://records-ws.nbnatlas.org/explore/counts/endemic?wkt=POLYGON((0.12+51.50,0.13+51.50,0.13+51.51,0.12+51.51,0.12+51.50))&q=*:*&facets=species_guid</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-15" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/15?returnTo=%2F%23ws14" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/15?returnTo=%2F%23ws14" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/15?returnTo=%2F%23ws14" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws15" id="ws15" name="ws15" style="text-decoration: none; color:black;">Endemic Species list</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/explore/endemic/species</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/explore/endemic/species</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-15" class="webServiceDetails hide"> <p><p>List endemic species within an area (* indicates required params)</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The initial query. q=<em>:</em> will query anything, q=macropus will do a free text search for macropus, q=kingdom:Fungi will search for records with a kingdom of Fungi. For a listing of the fields that can be queried in a q=INDEXEDFIELD:VALUE fashion, see /index/fields. This will restrict the records that are considered in then region. For example this could allow people to restrict the service to endemic birds.</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See https://records-ws.nbnatlas.org/index/fields for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>wkt <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The <a href="http://en.wikipedia.org/wiki/Well-known_text]">Well Known Text</a> Area in which to provide the endemic species.</p> </span> </td> </tr> <tr> <td>facets <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The field on which to based the species list. This can be taxon_concept_lsid or species_guid</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/63?returnTo=%2F%23ws15" class="btn btn-small">Edit</a> </span> <h5>List endemics (JSON)</h5> <p><p>List (in JSON) all the endemic species recorded within a small area in London. (Note, wkt POLYGON=lon,lat and not lat,lon).</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/explore/endemic/species?wkt=POLYGON((0.12+51.50,0.13+51.50,0.13+51.51,0.12+51.51,0.12+51.50))&q=*:*&facets=species_guid">https://records-ws.nbnatlas.org/explore/endemic/species?wkt=POLYGON((0.12+51.50,0.13+51.50,0.13+51.51,0.12+51.51,0.12+51.50))&q=*:*&facets=species_guid</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-16" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/16?returnTo=%2F%23ws15" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/16?returnTo=%2F%23ws15" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/16?returnTo=%2F%23ws15" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws16" id="ws16" name="ws16" style="text-decoration: none; color:black;">Endemic Species list (CSV)</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/explore/endemic/species.csv</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/explore/endemic/species.csv</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in CSV format"> CSV </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">CSV</li> </ul> </span> </div> </h4> <div id="webService-details-16" class="webServiceDetails hide"> <p><p>List endemic species within an area</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q </td> <td>String</td> <td> <span class="paramDescription"> <p>The initial query. q=<em>:</em> will query anything, q=macropus will do a free text search for macropus, q=kingdom:Fungi will search for records with a kingdom of Fungi. For a listing of the fields that can be queried in a q=INDEXEDFIELD:VALUE fashion, see /index/fields. This will restrict the records that are considered in then region. For example this could allow people to restrict the service to endemic birds.</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi. See https://records-ws.nbnatlas.org/index/fields for all the fields that a queryable.</p> </span> </td> </tr> <tr> <td>wkt </td> <td>String</td> <td> <span class="paramDescription"> <p>The Well Known Text Area in which to provide the endemic species.</p> </span> </td> </tr> <tr> <td>facets </td> <td>String</td> <td> <span class="paramDescription"> <p>The field on which to based the species list. This can be taxon_concept_lsid or species_guid</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/82?returnTo=%2F%23ws16" class="btn btn-small">Edit</a> </span> <h5>List endemics (CSV)</h5> <p><p>List (in a CSV file) all the endemic species recorded within a small area in London. (Note, wkt POLYGON=lon,lat and not lat,lon).</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/explore/endemic/species.csv?wkt=POLYGON((0.12+51.50,0.13+51.50,0.13+51.51,0.12+51.51,0.12+51.50))&q=*:*&facets=species_guid">https://records-ws.nbnatlas.org/explore/endemic/species.csv?wkt=POLYGON((0.12+51.50,0.13+51.50,0.13+51.51,0.12+51.51,0.12+51.50))&q=*:*&facets=species_guid</a> <br/> </p> </li> </ul> </div> </div> </li> </ul> <h2 class="categoryHdr">Parsing <span class="hidden-phone"><small> - Services for parsing ad hoc occurrence data</small></span></h2> <ul style="list-style: none; margin:0;"> <li id="webService-66" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/66?returnTo=%2F%23ws16" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/66?returnTo=%2F%23ws16" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/66?returnTo=%2F%23ws16" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws66" id="ws66" name="ws66" style="text-decoration: none; color:black;">Match darwin core terms</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/parser/matchTerms</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/parser/matchTerms</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-66" class="webServiceDetails hide"> <p><p>Accepts a POST JSON body.</p><h3>Example 1:</h3> <pre><code> ["scientific name", "latitude"] </code></pre><p>Will return the following darwin core terms in JSON <pre><code> ["scientificName", "decimalLatitude"] </code></pre></p><h3>Example 2:</h3> <pre><code> ["Robin", "12.2", "149.0"] </code></pre><p>Will return the following darwin core terms in JSON <pre><code> ["vernacularName", "decimalLatitude","decimalLongitude"] </code></pre></p></p> <div class="examples"> View : <a href="https://records-ws.nbnatlas.org/parser/matchTerms">https://records-ws.nbnatlas.org/parser/matchTerms</a> </div> </div> </li> <li id="webService-67" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/67?returnTo=%2F%23ws66" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/67?returnTo=%2F%23ws66" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/67?returnTo=%2F%23ws66" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws67" id="ws67" name="ws67" style="text-decoration: none; color:black;">Test darwin core terms</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/parser/areDwcTerms</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/parser/areDwcTerms</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-67" class="webServiceDetails hide"> <p><p>Accepts a POST JSON body.</p><h3>Example 1:</h3> <pre><code> ["scientific name"] </code></pre><p>Will return: <em>true</em></p><h3>Example 2:</h3> <pre><code> ["Robin"] </code></pre><p>Will return: <em>false</em></p></p> <div class="examples"> View : <a href="https://records-ws.nbnatlas.org/parser/areDwcTerms">https://records-ws.nbnatlas.org/parser/areDwcTerms</a> </div> </div> </li> <li id="webService-68" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/68?returnTo=%2F%23ws67" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/68?returnTo=%2F%23ws67" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/68?returnTo=%2F%23ws67" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws68" id="ws68" name="ws68" style="text-decoration: none; color:black;">Ad hoc processing</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/process/adhoc</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/process/adhoc</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-68" class="webServiceDetails hide"> <p><p>Accepts a POST JSON body.</p><h3>Example 1:</h3> <pre><code> { "vernacularName": "Robin" } </code></pre><p>Will return the following darwin core terms in JSON <pre><code> {"values":[{"processed":"None","raw":"None","name":"originalSensitiveValues"},{"processed":"present","raw":"","name":"occurrenceStatus"},{"processed":"UNKNOWN","raw":"","name":"nameParseType"},{"processed":"Erithacus rubecula","raw":"","name":"species"},{"processed":"vernacularMatch","raw":"","name":"nameMatchMetric"},{"processed":"Continental Robin","raw":"Robin","name":"vernacularName"}...etc.. </code></pre></p></p> <div class="examples"> View : <a href="https://records-ws.nbnatlas.org/process/adhoc">https://records-ws.nbnatlas.org/process/adhoc</a> </div> </div> </li> <li id="webService-71" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/71?returnTo=%2F%23ws68" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/71?returnTo=%2F%23ws68" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/71?returnTo=%2F%23ws68" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws71" id="ws71" name="ws71" style="text-decoration: none; color:black;">Map darwin core terms</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/parser/mapTerms</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/parser/mapTerms</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-71" class="webServiceDetails hide"> <p><p>Maps supplied terms to darwin core terms. Returns a map in JSON format with the supplied values as keys and matched terms as values.<br></p><p>Sent: <pre><code> ["lat","long","sci name"] </code></pre></p><p>Received: <pre><code> { "lat":"decimalLatitude", "long":"decimalLongitude", "sci name":"scientificName" } </code></pre></p></p> <div class="examples"> View : <a href="https://records-ws.nbnatlas.org/parser/mapTerms">https://records-ws.nbnatlas.org/parser/mapTerms</a> </div> </div> </li> </ul> <h2 class="categoryHdr">Data resources <span class="hidden-phone"><small> - Data resource metadata including taxonomic scope, attribution</small></span></h2> <ul style="list-style: none; margin:0;"> <li id="webService-107" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/107?returnTo=%2F%23ws71" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/107?returnTo=%2F%23ws71" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/107?returnTo=%2F%23ws71" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws107" id="ws107" name="ws107" style="text-decoration: none; color:black;">Data licences</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://registry.nbnatlas.org/ws/licence</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://registry.nbnatlas.org/ws/licence</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-107" class="webServiceDetails hide"> <p><p>Returns a JSON list of licences recognised by the Atlas.</p></p> <div class="examples"> View : <a href="https://registry.nbnatlas.org/ws/licence">https://registry.nbnatlas.org/ws/licence</a> </div> </div> </li> <li id="webService-54" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/54?returnTo=%2F%23ws107" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/54?returnTo=%2F%23ws107" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/54?returnTo=%2F%23ws107" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws54" id="ws54" name="ws54" style="text-decoration: none; color:black;">List data resources</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://registry.nbnatlas.org/ws/dataResource</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://registry.nbnatlas.org/ws/dataResource</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-54" class="webServiceDetails hide"> <p><p>List data resources in JSON</p></p> <div class="examples"> View : <a href="https://registry.nbnatlas.org/ws/dataResource">https://registry.nbnatlas.org/ws/dataResource</a> </div> </div> </li> <li id="webService-55" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/55?returnTo=%2F%23ws54" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/55?returnTo=%2F%23ws54" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/55?returnTo=%2F%23ws54" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws55" id="ws55" name="ws55" style="text-decoration: none; color:black;">Data resource metadata</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://registry.nbnatlas.org/ws/dataResource/{uid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://registry.nbnatlas.org/ws/dataResource/{uid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-55" class="webServiceDetails hide"> <p><p>Data resource metadata</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>uid </td> <td>String</td> <td> <span class="paramDescription"> <p>The UID of the institution. </p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/83?returnTo=%2F%23ws55" class="btn btn-small">Edit</a> </span> <h5>Show metadata</h5> <p><p>Metadata for "A Conservation Evaluation of British Lichens and Lichenicolous Fungi" (i.e. data resource dr559)</p></p> <p> URL: <a href="https://registry.nbnatlas.org/ws/dataResource/dr559">https://registry.nbnatlas.org/ws/dataResource/dr559</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-89" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/89?returnTo=%2F%23ws55" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/89?returnTo=%2F%23ws55" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/89?returnTo=%2F%23ws55" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws89" id="ws89" name="ws89" style="text-decoration: none; color:black;">Get List Metadata</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://lists.nbnatlas.org/ws/speciesList/{druid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://lists.nbnatlas.org/ws/speciesList/{druid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-89" class="webServiceDetails hide"> <p><p>Returns the metadata associated with a species list.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/42?returnTo=%2F%23ws89" class="btn btn-small">Edit</a> </span> <h5>Metadata for list</h5> <p><p>Metadata for list with druid dr577</p></p> <p> URL: <a href="https://lists.nbnatlas.org/ws/speciesList/dr577">https://lists.nbnatlas.org/ws/speciesList/dr577</a> <br/> </p> </li> </ul> </div> </div> </li> </ul> <h2 class="categoryHdr">Data providers <span class="hidden-phone"><small> - Data provider metadata including taxonomic scope, attribution</small></span></h2> <ul style="list-style: none; margin:0;"> <li id="webService-56" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/56?returnTo=%2F%23ws89" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/56?returnTo=%2F%23ws89" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/56?returnTo=%2F%23ws89" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws56" id="ws56" name="ws56" style="text-decoration: none; color:black;">List data providers</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://registry.nbnatlas.org/ws/dataProvider</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://registry.nbnatlas.org/ws/dataProvider</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-56" class="webServiceDetails hide"> <p><p>List data providers</p></p> <div class="examples"> View : <a href="https://registry.nbnatlas.org/ws/dataProvider">https://registry.nbnatlas.org/ws/dataProvider</a> </div> </div> </li> </ul> <h2 class="categoryHdr">Auto complete <span class="hidden-phone"><small> - Services that support autocomplete text boxes</small></span></h2> <ul style="list-style: none; margin:0;"> <li id="webService-112" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/112?returnTo=%2F%23ws56" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/112?returnTo=%2F%23ws56" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/112?returnTo=%2F%23ws56" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws112" id="ws112" name="ws112" style="text-decoration: none; color:black;">Auto complete Search (occurrence based names)</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/autocomplete/search</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/autocomplete/search</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-112" class="webServiceDetails hide"> <p><p>Used to provide a list of scientific names that can be used to automatically complete a supplied partial name for use in searching for records in the occurrence records system.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>Input query</p> </span> </td> </tr> <tr> <td>fq </td> <td>String</td> <td> <span class="paramDescription"> <p>Filter query that is used to determine occurrence counts</p> </span> </td> </tr> <tr> <td>pageSize </td> <td>Integer</td> <td> <span class="paramDescription"> <p>Max number of results to return</p> </span> </td> </tr> <tr> <td>all </td> <td>Boolean</td> <td> <span class="paramDescription"> <p>Set this to true to include matches with 0 occurrences found</p> </span> </td> </tr> <tr> <td>counts </td> <td>Boolean</td> <td> <span class="paramDescription"> <p>Set this to false to exclude occurrence counts</p> </span> </td> </tr> <tr> <td>synonyms </td> <td>Boolean</td> <td> <span class="paramDescription"> <p>Set this to false to exclude synonym matches</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/65?returnTo=%2F%23ws112" class="btn btn-small">Edit</a> </span> <h5>Search for vulpe...</h5> <p><p>Return matches with no occurences</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/autocomplete/search?q=vulpe&all=true">https://records-ws.nbnatlas.org/autocomplete/search?q=vulpe&all=true</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-25" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/25?returnTo=%2F%23ws112" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/25?returnTo=%2F%23ws112" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/25?returnTo=%2F%23ws112" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws25" id="ws25" name="ws25" style="text-decoration: none; color:black;">Auto Complete Search</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://species-ws.nbnatlas.org/search/auto</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://species-ws.nbnatlas.org/search/auto</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-25" class="webServiceDetails hide"> <p><p>Used to provide a list of scientific and common names that can be used to automatically complete a supplied partial name.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>q <span class="required-indicator">*</span> </td> <td>String</td> <td> <span class="paramDescription"> <p>The value to auto complete e.g. <em>q=Mac</em></p> </span> </td> </tr> <tr> <td>geoOnly </td> <td>String</td> <td> <span class="paramDescription"> <p>When "true" only include results that have some geospatial occurrence records</p> </span> </td> </tr> <tr> <td>idxType </td> <td>String</td> <td> <span class="paramDescription"> <p>The index type to limit . Values include: * TAXON * REGION * COLLECTION * INSTITUTION * DATASET</p> </span> </td> </tr> <tr> <td>limit </td> <td>String</td> <td> <span class="paramDescription"> <p>The maximum number of results to return (default = 10)</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/3?returnTo=%2F%23ws25" class="btn btn-small">Edit</a> </span> <h5>Search taxa starts for autocomplete</h5> <p><p>Search for taxa starting with "Mac"</p></p> <p> URL: <a href="https://species-ws.nbnatlas.org/search/auto?q=Mac">https://species-ws.nbnatlas.org/search/auto?q=Mac</a> <br/> </p> </li> </ul> </div> </div> </li> </ul> <h2 class="categoryHdr">General data <span class="hidden-phone"><small> - General data</small></span></h2> <ul style="list-style: none; margin:0;"> <li id="webService-107" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/107?returnTo=%2F%23ws25" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/107?returnTo=%2F%23ws25" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/107?returnTo=%2F%23ws25" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws107" id="ws107" name="ws107" style="text-decoration: none; color:black;">Data licences</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://registry.nbnatlas.org/ws/licence</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://registry.nbnatlas.org/ws/licence</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-107" class="webServiceDetails hide"> <p><p>Returns a JSON list of licences recognised by the Atlas.</p></p> <div class="examples"> View : <a href="https://registry.nbnatlas.org/ws/licence">https://registry.nbnatlas.org/ws/licence</a> </div> </div> </li> <li id="webService-58" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/58?returnTo=%2F%23ws107" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/58?returnTo=%2F%23ws107" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/58?returnTo=%2F%23ws107" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws58" id="ws58" name="ws58" style="text-decoration: none; color:black;">Get a summary for an entity</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://registry.nbnatlas.org/ws/lookup/summary/{uid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://registry.nbnatlas.org/ws/lookup/summary/{uid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-58" class="webServiceDetails hide"> <p><p>Get a summary information for an entity</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/84?returnTo=%2F%23ws58" class="btn btn-small">Edit</a> </span> <h5>Lookup entity</h5> <p><p>Entity with uid dp58</p></p> <p> URL: <a href="https://registry.nbnatlas.org/ws/lookup/summary/dp58">https://registry.nbnatlas.org/ws/lookup/summary/dp58</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-89" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/89?returnTo=%2F%23ws58" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/89?returnTo=%2F%23ws58" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/89?returnTo=%2F%23ws58" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws89" id="ws89" name="ws89" style="text-decoration: none; color:black;">Get List Metadata</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://lists.nbnatlas.org/ws/speciesList/{druid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://lists.nbnatlas.org/ws/speciesList/{druid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-89" class="webServiceDetails hide"> <p><p>Returns the metadata associated with a species list.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/42?returnTo=%2F%23ws89" class="btn btn-small">Edit</a> </span> <h5>Metadata for list</h5> <p><p>Metadata for list with druid dr577</p></p> <p> URL: <a href="https://lists.nbnatlas.org/ws/speciesList/dr577">https://lists.nbnatlas.org/ws/speciesList/dr577</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-107" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/107?returnTo=%2F%23ws89" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/107?returnTo=%2F%23ws89" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/107?returnTo=%2F%23ws89" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws107" id="ws107" name="ws107" style="text-decoration: none; color:black;">Data licences</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://registry.nbnatlas.org/ws/licence</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://registry.nbnatlas.org/ws/licence</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-107" class="webServiceDetails hide"> <p><p>Returns a JSON list of licences recognised by the Atlas.</p></p> <div class="examples"> View : <a href="https://registry.nbnatlas.org/ws/licence">https://registry.nbnatlas.org/ws/licence</a> </div> </div> </li> </ul> <h2 class="categoryHdr">Breakdowns <span class="hidden-phone"><small> - Supplies breakdown information about records.</small></span></h2> <ul style="list-style: none; margin:0;"> <li id="webService-36" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/36?returnTo=%2F%23ws107" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/36?returnTo=%2F%23ws107" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/36?returnTo=%2F%23ws107" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws36" id="ws36" name="ws36" style="text-decoration: none; color:black;">Collectory breakdown</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://records-ws.nbnatlas.org/breakdown/{collectorytype}/{uid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://records-ws.nbnatlas.org/breakdown/{collectorytype}/{uid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-36" class="webServiceDetails hide"> <p><p>Performs a breakdown of the supplied collectory type.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>max </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The maximum number of names to include in the breakdown. When this value is supplied the breakdown will traverse up the taxonomic hierarchy until a maximum of <i>max</i> names is discovered. Thus the rank of the breakdown is calculated by this service and should not be provided.</p> </span> </td> </tr> <tr> <td>name </td> <td>String</td> <td> <span class="paramDescription"> <p>The scientific name to limit the breakdown to - needs a valid rank to be supplied</p> </span> </td> </tr> <tr> <td>rank </td> <td>String</td> <td> <span class="paramDescription"> <p>The rank at which to perform the breakdown. If a name is specified in conjunction to this the breakdown will be performed at the next level further limiting the query.</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/15?returnTo=%2F%23ws36" class="btn btn-small">Edit</a> </span> <h5>Breakdown collectory and return counts</h5> <p><p>Breakdown collectory by phylum</p></p> <p> URL: <a href="https://records-ws.nbnatlas.org/breakdown/dataResources/dr495?rank=phylum">https://records-ws.nbnatlas.org/breakdown/dataResources/dr495?rank=phylum</a> <br/> </p> </li> </ul> </div> </div> </li> </ul> <h2 class="categoryHdr">Species lists <span class="hidden-phone"><small> - Species lists webservices</small></span></h2> <p> <p>Webservices for storage and creation and querying of lists</p> </p> <ul style="list-style: none; margin:0;"> <li id="webService-90" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/90?returnTo=%2F%23ws36" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/90?returnTo=%2F%23ws36" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/90?returnTo=%2F%23ws36" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws90" id="ws90" name="ws90" style="text-decoration: none; color:black;">Retrieve metadata for all lists</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://lists.nbnatlas.org/ws/speciesList</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://lists.nbnatlas.org/ws/speciesList</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-90" class="webServiceDetails hide"> <p><p>Service to retrieve the metadata for all lists. This includes parameters to page through the lists.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>user </td> <td>String</td> <td> <span class="paramDescription"> <p>The CAS username. This will allow the list to be order in a manner that places all the lists owed by the supplied user first.</p> </span> </td> </tr> <tr> <td>sort </td> <td>String</td> <td> <span class="paramDescription"> <p>The list metadata on which to sort the lists. Use one of the following: listName, username, listType, count</p> </span> </td> </tr> <tr> <td>order </td> <td>String</td> <td> <span class="paramDescription"> <p>The order in which to perform the sort. Either asc or desc</p> </span> </td> </tr> <tr> <td>offset </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The offset at which to start the page. This parameter along with the max param supplies the support for paging. The default value is 0.</p> </span> </td> </tr> <tr> <td>max </td> <td>Integer</td> <td> <span class="paramDescription"> <p>The maximum number of records to return in a page of results. The default value is 25</p> </span> </td> </tr> </table> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/85?returnTo=%2F%23ws90" class="btn btn-small">Edit</a> </span> <h5>Metadata for all lists</h5> <p><p>Default parameters</p></p> <p> URL: <a href="https://lists.nbnatlas.org/ws/speciesList">https://lists.nbnatlas.org/ws/speciesList</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-91" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/91?returnTo=%2F%23ws90" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/91?returnTo=%2F%23ws90" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/91?returnTo=%2F%23ws90" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws91" id="ws91" name="ws91" style="text-decoration: none; color:black;">Create List</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://lists.nbnatlas.org/ws/speciesList</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://lists.nbnatlas.org/ws/speciesList</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-POST"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP POST request"> POST </a> </span> </span> <span class="outputLabels webServiceShowDetails"> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-POST">POST</li> </ul> </span> </div> </h4> <div id="webService-details-91" class="webServiceDetails hide"> <p><p>Creates a new species list with the information supplied in the JSON body of the post. At the moment this service does not accept properties for list items. This will probably need to be implement as a different service.</p></p> <table class="table table-bordered table-striped table-condensed"> <tr> <td>listName </td> <td>String</td> <td> <span class="paramDescription"> <p>The name for the list</p> </span> </td> </tr> <tr> <td>listItems </td> <td>String</td> <td> <span class="paramDescription"> <p>A comma separated list of species to include on the list</p> </span> </td> </tr> <tr> <td>listType </td> <td>String</td> <td> <span class="paramDescription"> <p>The type of list: SPECIES_CHARACTERS, CONSERVATION_LIST, SENSITIVE_LIST, LOCAL_LIST, COMMON_TRAIT, COMMON_HABITAT, SPATIAL_PORTAL, TEST, OTHER</p> </span> </td> </tr> <tr> <td>description </td> <td>String</td> <td> <span class="paramDescription"> <p>A description of the list</p> </span> </td> </tr> </table> <div class="exampleOutput"> <h4>Example output</h4> <pre><code>Returns the druid for the newly created list in the response header.</code></pre> </div> </div> </li> <li id="webService-92" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/92?returnTo=%2F%23ws91" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/92?returnTo=%2F%23ws91" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/92?returnTo=%2F%23ws91" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws92" id="ws92" name="ws92" style="text-decoration: none; color:black;">Species List Items</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://lists.nbnatlas.org/ws/speciesListItems/{dataResourceUid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://lists.nbnatlas.org/ws/speciesListItems/{dataResourceUid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-92" class="webServiceDetails hide"> <p><p>Returns all the items that are on the supplied species list.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/43?returnTo=%2F%23ws92" class="btn btn-small">Edit</a> </span> <h5>List items for species list</h5> <p><p>Retrieve all the scientific names and matched lsids for species list dr633</p></p> <p> URL: <a href="https://lists.nbnatlas.org/ws/speciesListItems/dr633">https://lists.nbnatlas.org/ws/speciesListItems/dr633</a> <br/> </p> </li> </ul> </div> </div> </li> <li id="webService-93" class="webService"> <h4> <span class="editorFunctions"> <span class="pull-right" style="padding-right:10px;"> <a href="/admin/webService/edit/93?returnTo=%2F%23ws92" class="btn btn-small" title="Edit the definition of this webservice"> <i class="icon-edit"></i> <span class="hidden-phone">Edit</span> </a> <a href="/admin/example/createForWS/93?returnTo=%2F%23ws92" class="btn btn-small" title="Add an example usage of this webservice"> <i class="icon-plus"></i> <span class="hidden-phone">Example</span> </a> <a href="/admin/webService/create/93?returnTo=%2F%23ws92" title="Create a webservice based on this webservice" class="btn btn-small"> <i class="icon-cog"></i> <span class="hidden-phone">Copy</span> </a> </span> </span> <div class="row-fluid" style="margin-bottom:10px;"> <div class="webserviceName webServiceShowDetails"> <span><a href="#ws93" id="ws93" name="ws93" style="text-decoration: none; color:black;">Species Lists for Species</a></span> <span class="separator hidden-phone hidden-tablet"> - </span> <span class="urlLarge hidden-phone hidden-tablet">https://lists.nbnatlas.org/ws/species/{guid}</span> <span class="hidden-phone"> </span> <span class="urlSmall visible-phone visible-tablet">https://lists.nbnatlas.org/ws/species/{guid}</span> </div> </div> <div class="row-fluid"> <span class="hidden-phone"> <span class="httpMethods webServiceShowDetails"> <span class="httpMethod httpMethod-GET"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service supports HTTP GET request"> GET </a> </span> </span> <span class="outputLabels webServiceShowDetails"> <span class="outputFormat"> <a href="#" class="wsLabel" data-toggle="tooltip" data-placement="top" title="" data-original-title="This service returns data in JSON format"> JSON </a> </span> </span> </span> <span class="visible-phone"> <ul class="inline"> <li class="label label-http-GET">GET</li> <li class="label">JSON</li> </ul> </span> </div> </h4> <div id="webService-details-93" class="webServiceDetails hide"> <p><p>Returns all the lists and supplied properties for the species of the supplied guid.</p></p> <div class="examples"> <h4>Examples</h4> <ul> <li> <span class="pull-right editorFunctions" style="padding-right:10px;"> <a href="/admin/example/edit/44?returnTo=%2F%23ws93" class="btn btn-small">Edit</a> </span> <h5>Species list for Homo Sapies</h5> <p><p>All the list and key value pairs (KVP) for Homo Sapies</p></p> <p> URL: <a href="https://lists.nbnatlas.org/ws/species/NHMSYS0000376773">https://lists.nbnatlas.org/ws/species/NHMSYS0000376773</a> <br/> </p> </li> </ul> </div> </div> </li> </ul> </div> </div>  <footer class="content-info" role="contentinfo"> <div class=""> <div class="row-fluid sponsors"> <h4 class="h3">NBN Atlas Partnership</h4> <div class="sponsor-links"> <a href="https://nbn.org.uk" target="_blank" rel="nofollow"><img src="https://nbnatlas.org/wp-content/uploads/2017/01/NBNTrust_Logo_Colour_with-padding-730x235.jpg" alt="National Biodiversity Network" class="img-responsive"/></a><a href="http://www.ala.org.au/" target="_blank" rel="nofollow"><img src="https://nbnatlas.org/wp-content/uploads/2017/01/logo-full-iteration-91.jpg" alt="Atlas of Living Australia" class="img-responsive"/></a><a href="https://www.gov.uk/government/organisations/natural-england" target="_blank" rel="nofollow"><img src="https://nbnatlas.org/wp-content/uploads/2017/03/NatEng_logo_New-Green-2016.jpg" alt="Natural England" class="img-responsive"/></a><a href="https://naturalresources.wales/splash?orig=/" target="_blank" rel="nofollow"><img src="https://nbnatlas.org/wp-content/uploads/2017/03/Natural-Resources-Wales.jpg" alt="Natural Resources Wales" class="img-responsive"/></a><a href="http://sepa.gov.uk/" target="_blank" rel="nofollow"><img src="https://nbnatlas.org/wp-content/uploads/2017/03/SEPA-logo-small.jpg" alt="Scottish Environment Protection Agency" class="img-responsive"/></a><a href="http://gov.wales/?lang=en" target="_blank" rel="nofollow"><img src="https://nbnatlas.org/wp-content/uploads/2017/03/WG_positive_40mm.jpg" alt="Welsh Government" class="img-responsive"/></a><a href="http://www.snh.gov.uk/" target="_blank" rel="nofollow"><img src="https://nbnatlas.org/wp-content/uploads/2020/08/NatureScot-Master-colour-RGB-JPEG-448x343-1.jpg" alt="Scottish Natural Heritage" class="img-responsive"/></a><a href="https://www.daera-ni.gov.uk/" target="_blank" rel="nofollow"><img src="https://nbnatlas.org/wp-content/uploads/2019/04/DAERA-NIEA-Logo-CMYK-002-730x213.jpg" alt="Northern Ireland Environment Agency" class="img-responsive"/></a> </div> </div> <div class="row footer-top"> <a class="icn-link icn-top" href="#top">back to top</a> </div> <div class="row-fluid footer-bottom"> <div class="span9"> <ul id="menu-primary-navigation" class="footer-nav"><li class="menu-item menu-species"><a href="https://species.nbnatlas.org/">Species</a></li> <li class="menu-item menu-item-has-children menu-locations"><a href="#" class="dropdown-toggle" data-toggle="dropdown" data-target="#">Locations</a> <ul > <li class="menu-item menu-search-by-polygon"><a href="https://records.nbnatlas.org/search#tab_spatialSearch">Search by polygon</a></li> <li class="menu-item menu-explore-by-address-postcode-or-location"><a href="https://records.nbnatlas.org/explore/your-area">Explore by address, postcode or location</a></li> <li class="menu-item menu-explore-by-pre-defined-area"><a href="https://regions.nbnatlas.org/">Explore by pre-defined area</a></li> <div class="clearfix"></div></ul> </li> <li class="menu-item menu-analyse"><a href="https://spatial.nbnatlas.org/">Analyse</a></li> <li class="menu-item menu-item-has-children menu-get-involved"><a href="#" class="dropdown-toggle" data-toggle="dropdown" data-target="#">Get Involved</a> <ul > <li class="menu-item menu-find-a-wildlife-survey-or-recording-scheme"><a target="_blank" rel="noopener" href="https://nbn.org.uk/tools-and-resources/useful-websites/database-of-wildlife-surveys-and-recording-schemes/">Find a wildlife survey or recording scheme</a></li> <li class="menu-item menu-share-data-on-the-nbn-atlas"><a target="_blank" rel="noopener" href="https://nbn.org.uk/record-share-explore-data/share-your-data/">Share data on the NBN Atlas</a></li> <li class="menu-item menu-nbn-atlas-citations"><a target="_blank" rel="noopener" href="https://nbn.org.uk/tools-and-resources/nbn-atlas-citations/">NBN Atlas Citations</a></li> <li class="menu-item menu-donate-support-the-nbn-atlas-and-the-nbn-trust"><a href="https://nbnatlas.org/support-the-nbn/">Donate / Support the NBN Atlas and the NBN Trust</a></li> <li class="menu-item menu-sign-up-for-our-newsletter"><a target="_blank" rel="noopener" href="https://nbn.org.uk/news-events-publications/latest-stories-from-our-network/enews-sign-up/">Sign up for our Newsletter</a></li> <li class="menu-item menu-nbn-conference"><a target="_blank" rel="noopener" href="https://nbn.org.uk/news-events-publications/nbn-conference-2/">NBN Conference</a></li> <div class="clearfix"></div></ul> </li> <li class="menu-item menu-item-has-children menu-data-and-partners"><a href="#" class="dropdown-toggle" data-toggle="dropdown" data-target="#">Data and Partners</a> <ul > <li class="menu-item menu-search-for-a-data-partner"><a href="https://registry.nbnatlas.org">Search for a Data Partner</a></li> <li class="menu-item menu-search-nbn-atlas-datasets"><a href="https://registry.nbnatlas.org/datasets">Search NBN Atlas datasets</a></li> <li class="menu-item menu-advanced-record-search"><a href="https://records.nbnatlas.org/search#advanceSearch">Advanced record search</a></li> <li class="menu-item menu-species-lists"><a target="_blank" rel="noopener" href="https://lists.nbnatlas.org/public/speciesLists">Species lists</a></li> <li class="menu-item menu-nbn-atlas-data-processing-schedule"><a href="https://nbnatlas.org/nbn-atlas-data-processing-schedule/">NBN Atlas data processing schedule</a></li> <li class="menu-item menu-global-biodiversity-information-facility-gbif"><a target="_blank" rel="noopener" href="https://www.gbif.org/">Global Biodiversity Information Facility (GBIF)</a></li> <div class="clearfix"></div></ul> </li> <li class="menu-item menu-item-has-children menu-about"><a href="#" class="dropdown-toggle" data-toggle="dropdown" data-target="#">About</a> <ul > <li class="menu-item menu-about-nbn-atlas"><a href="http://nbnatlas.org/about-nbn-atlas/">About NBN Atlas</a></li> <li class="menu-item menu-fit-for-the-future-project"><a href="https://nbnatlas.org/about-nbn-atlas/fit-for-the-future-project/">Fit for the Future Project</a></li> <li class="menu-item menu-join-or-donate"><a target="_blank" rel="noopener" href="https://nbn.org.uk/join-or-donate/join-the-nbn/">Join or Donate</a></li> <div class="clearfix"></div></ul> </li> <li class="menu-item menu-help"><a target="_blank" rel="noopener" href="https://docs.nbnatlas.org/">Help</a></li> <div class="clearfix"></div></ul> <div class="copyright"> <a class="brand" href="https://nbnatlas.org/"><img src="https://nbnatlas.org/wp-content/uploads/2017/01/AL_Logo-15-1440x363.png" class="img-responsive" alt="NBN Atlas"></a> <p>漏 NBN Atlas Partnership 2024.</p> <ul id="menu-footer-navigation" class="footer-nav2"><li class="menu-item menu-terms-of-use"><a href="https://docs.nbnatlas.org/nbn-atlas-terms-of-use/">Terms of use</a></li> <li class="menu-item menu-privacy-policy"><a target="_blank" rel="noopener" href="https://docs.nbnatlas.org/privacy-policy/">Privacy policy</a></li> <div class="clearfix"></div></ul> </div> </div> <div class="span3"> <div class="social-links"> <h4>Join the conversation</h4> <a href="https://twitter.com/NBNTrust" target="_blank" rel="nofollow" title="Twitter"><i class="fa fa-fw fa-2x fa-twitter"></i><span>Twitter</span></a> </div> <div class="footer-extra"> <h4>Ask a question</h4> <p>Use our online forum to join the conversation about nature in the UK.</p> <p><a href="https://forums.nbn.org.uk/" target="_blank" rel="noopener">Go to the NBN Forum</a></p> <div style="display: flex;"><a><img decoding="async" class="img-responsive" src="https://nbnatlas.org/wp-content/uploads/2019/03/TNLHF_English_Ack-logo-White-002-reversed-730x433.png" alt="Supported by the heritage fund" /></a><a href="https://www.fairsfair.eu/"><img decoding="async" class="img-responsive" src="https://nbnatlas.org/wp-content/uploads/2020/05/FAIRsFAIR-logo-300x300.png" alt="Fairs Fair" /></a></div> </div> </div> </div> </div> </footer> <script src="https://layout.nbnatlas.org/auth.js" type="text/javascript" ></script>   <script src="/static/hnbQRQpYmXB6aSpR2hFr3vtCEgr0bYmKO6QhRRVFZ5B.js" type="text/javascript" ></script> <script src="/static/rr2DTJnnLdifHKQ1JirYberwUPnW5tmDp61pBk0CA1K.js" type="text/javascript" ></script>  <script src="https://layout.nbnatlas.org/uk/commonui-bs2/js/application.js" type="text/javascript" ></script> <script src="https://layout.nbnatlas.org/uk/commonui-bs2/js/bootstrap.js" type="text/javascript" ></script> <script src="/static/fbzysCfupgGlGAVsGW9XAZnCDNjdqGil8mIxWCLMU8k.js" type="text/javascript" ></script> <script type="text/javascript"> $(function() { //add click events for links $( ".webServiceShowDetails" ).click(function() { $( this).parent().parent().parent().children( ".webServiceDetails" ).toggle( "slow", function() { // Animation complete. }); }); $('.wsLabel').tooltip({}); }); function expandApis(){ $('.webServiceDetails').attr('style','display:block') } function collapseApis(){ $('.webServiceDetails').attr('style','display:none') } </script> </body> </html>

CINXE.COM

Web service API | NBN Atlas