Operations at https://irmaservices.nps.gov/v2/rest/taxonomy
This page describes the service operations at this endpoint.
| Uri | Method | Description |
|---|---|---|
| {code} | GET | Return a list of taxa whose TaxonCode (NPS internal) or TSN (ITIS external) match the given value, or an empty result set if there is no match. |
| GET | Returns the single taxon matching the given code for 'codeType of 'taxoncode' (NPS internal) or 'tsn' (ITIS external). | |
| categories | GET | Return the current list of Categories. |
| categories/{code} | GET | Return the single Category having the given code. |
| ranks | GET | Return the current list of Ranks. |
| ranks/{code} | GET | Return the single Rank having the given code. |
| schemas/BasicCategory | GET | Show the schema for a basic Category item. |
| schemas/BasicClsSource | GET | Show the schema for a basic Classification Source item. |
| schemas/BasicSearchResult | GET | Show the schema for a list of basic search results. This is the level of detail returned by specifying 'basic', and is the same data as returned by the QuickSearch on the Portal. It is also the default when no detail level is specified. |
| schemas/CategoryProfile | GET | Show the schema for a Category profile, returned when requesting a single Category by code. |
| schemas/ClsSourceProfile | GET | Show the schema for a Classification Source profile, returned when requesting a single Classification Source by code. |
| schemas/Rank | GET | Show the schema for a Rank entry. Basic and profile are the same. |
| schemas/TaxonProfile | GET | Show the schema for a list of Taxon profiles, containing several subcollections of related data. This is the level of detail when you specify 'profile'. |
| searchByCodes/{codeType} | GET | Returns an array of taxa matching one or more given codes for 'codeType of 'taxoncode' (NPS internal) or 'tsn' (ITIS external). |
| searchByCommonName/{searchString} | GET | Return a list of taxa with a common name than matches or contains the given search string, or an empty result set if there is no match. |
| searchByScientificName/{searchString} | GET | Return a list of taxa whose scientific name matches or contains the given search string, or an empty result set if there is no match. |
| sources | GET | Return the current list of Classification Sources. |
| sources/{code} | GET | Return the single Classification Source having the given code. |
| sources/{code}/categories | GET | Return the list of Categories associated with the given Source. |
| sources/{code}/ranks | GET | Return the list of Ranks associated with the given Source. |
| urlOptions/category | GET | Show the list of Category codes. These are valid strings for the 'category' query parameter in name searches. |
| urlOptions/codeType | GET | Show the list of code types. These are valid strings for the 'codeType' query parameter when searching by code. |
| urlOptions/detail | GET | Show the list of Reference detail available. These are valid strings for the optional '&detail=' query parameter. The default is 'basic'. |
| urlOptions/format | GET | Show the list of response formats. These are valid strings for the optional '&format=' query parameter of any query. The default is 'xml' |
| urlOptions/paging | GET | Show the query parameters for paging large result sets. Paging is supported, but currently must be managed by the client - i.e. the service currently does not return paging details in its response. |
| urlOptions/source | GET | Show the list of Source codes. These are valid strings for the 'source' query parameter in name searches. |