Welcome to NatureServe. NatureServe Web Services

n Home?

About NatureServe Web Services
Literature
News Archive

Browse Web Services
Name Search
Get Species Data
Get Ecological Systems
Get Species Location Data
Species Presence Indicator

Technical Resources
Code Samples
Species Schemas
Species Occurrence Schemas
Technical Library

Provide Feedback
Taxonomic Reconciliation
User Registration
Security Administration
Submit User Stories
Contact Us

For NatureServe Data Providers
EO Service
Support Resources

Home

 

arrow For Data Providers

 

arrow Technical Resources

bBrowse Web Services
bSpecies Schemas
bSpecies Occurrence Schemas

 

National Species Name Search (public)

Description: This is a service that returns basic information about species found using a name search for a particular nation, using the official names for the nation. The search will return zero, one, or many results. The typical reason for running this search is to obtain the species UID which can be used in a subsequent call to retrieve more information about that species.

Service Restrictions: This is a standard service that can be installed at any node, and may return species and UID values for species that are not available via NatureServe Explorer.

Request URL: {baseURL}/idd/rest/v1/nationalSpecies/list/nameSearch?

Request Parameters:

Parameter
Value
Description
name string (required) The search string. May use asterisks for wildcard searching. Unlike "google" search, mutliple terms must be in the correct order. E.g., "frog*yellow" will not find "the yellow frog", but "the*frog" will find "the yellow frog".
nationCode string (required) The two-letter ISO nation abbreviation (e.g., "US" or "CA").

Response Fields:
The schema document for this service response is located at http://services.natureserve.org/docs/schemas/biodiversityDataFlow/1/0/NatureServeResultContainers_v1.0.xsd.

See the User Friendly Documents for field details: http://services.natureserve.org/docs/schemas/biodiversityDataFlow/1/0/documentation_speciesSearchResult_v1.0.xml

Sample Response:

URL: https://services.natureserve.org/idd/rest/v1/nationalSpecies/list/nameSearch?nationCode=CA&name=*colin*

This service searches on the French common name as well for Canadian records. A future enhancement to the XML Payload is to include all the name data being used for the search.
XML Payload: <?xml version="1.0" encoding="iso-8859-1"?>
<speciesSearchReport xsi:schemaLocation="http://services.natureserve.org/docs/schemas/biodiversityDataFlow/1 BiodiversityDataFlow_v1.0.xsd" xmlns="http://services.natureserve.org/docs/schemas/biodiversityDataFlow/1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaVersion="1.0">
    <conditions>
        <match>
            <searchTerm>*colin*</searchTerm>
        </match>
    </conditions>
    <speciesSearchResultList>
        <speciesSearchResult uid="ELEMENT_NATIONAL.2.162045">
            <globalSpeciesUid>ELEMENT_GLOBAL.2.104712</globalSpeciesUid>
            <natureServeExplorerURI>
            http://www.natureserve.org/explorer/servlet/NatureServe?searchSpeciesUid=ELEMENT_GLOBAL.2.104712
            </natureServeExplorerURI>
            <jurisdictionNationName code="CA">CANADA</jurisdictionNationName>
            <jurisdictionScientificName>Oreortyx pictus</jurisdictionScientificName>
            <commonName language="en">Mountain Quail</commonName>
        </speciesSearchResult>
        <speciesSearchResult uid="ELEMENT_NATIONAL.2.161867">
            <globalSpeciesUid>ELEMENT_GLOBAL.2.104472</globalSpeciesUid>
            <natureServeExplorerURI>
            http://www.natureserve.org/explorer/servlet/NatureServe?searchSpeciesUid=ELEMENT_GLOBAL.2.104472
            </natureServeExplorerURI>
            <jurisdictionNationName code="CA">CANADA</jurisdictionNationName>
            <jurisdictionScientificName>Callipepla californica</jurisdictionScientificName>
            <commonName language="en">California Quail</commonName>
        </speciesSearchResult>
        <speciesSearchResult uid="ELEMENT_NATIONAL.2.164363">
            <globalSpeciesUid>ELEMENT_GLOBAL.2.106280</globalSpeciesUid>
            <natureServeExplorerURI>
            http://www.natureserve.org/explorer/servlet/NatureServe?searchSpeciesUid=ELEMENT_GLOBAL.2.106280
            </natureServeExplorerURI>
            <jurisdictionNationName code="CA">CANADA</jurisdictionNationName>
            <jurisdictionScientificName>Colinus virginianus</jurisdictionScientificName>
            <commonName language="en">Northern Bobwhite</commonName>
        </speciesSearchResult>
    </speciesSearchResultList>
</speciesSearchReport>



 

Copyright © 2007
NatureServe

 
Sitemap www.natureserve.org Contact Us Acknowledgements

Copyright © 2007. NatureServe.

NatureServe.org d Contact Usd Site Mapd Acknowledgements