|
Making REST Requests to Get Species
REST allows you to make calls to the Get Species service by passing parameter keys and values in a URL (Uniform Resource Locator). Get Species returns its response in XML (Extensible Markup Language) format. You can use a web browser to test Get Species requests and view responses by entering the REST URL into the browser's address bar. The browser will display the raw XML response.
The Base URL
Every REST request to Get Species begins with a base URL that is specific to the locale in which you want to make the request. The following base URL is available:
| https://services.natureserve.org/idd/rest/globalSpecies? |
Request Parameters
The base URL is followed by a series of parameters that define the request. Parameters are separated from the base URL and each other by an ampersand (&) character. Each parameter consists of a key and a value, separated from each other by an equals sign (=). Note that parameters and their values are case-sensitive.
The Get Species parameters are described in the following table:
| Parameter |
Description |
| uid=[element UID] |
An element UID. |
| NSAccessKeyId=[your Access Key ID here] |
An NSAccessKeyId is required in all Get Species service requests. Access Key IDs are used to to identify the sender or site from which the request originated. |
Note:
To obtain an Access Key ID, you must register as a NatureServe Web Services Developer.
|