RPI Querystrings
RPI Querystrings
Version 9-01 1.0 of the Inventory re-introduced URL-based searches. Searches can be initiated by entering a URL to the result page (i.e. rareplants.cnps.org/search/result) and adding the appropriate querystrings to define your search criteria.
Search Result Querystrings
Result querystrings provide criteria for plant searches via URL. For example, to obtain a list of California Rare Plant Rank 1B or 2B plants, add ?crpr=1B:2B to the /search/result url so that the resulting URL would read: https://rareplants.cnps.org/search/result?crpr=1B:2B
Note: that all querystrings must start with a question mark (?) immediately after the page name.
Both page URL forms /Search/result?crpr=1B:2B and /Search/result/?crpr=1B:2B will function.
Supported querystrings include:
Classification
Conservation Status
Location
Ecology and Life History
Ocurence Data (Threats)
Global Search
Plant Details Querystrings
Multiple Criteria
Classification
| Variable: | fam |
| Name: | Family |
| Description: | Return plants with a specified family |
| Options: | Any plant family name |
| Example: | fam=Asteraceae |
| Variable: | genus (also gen for version 8 compatibility) |
| Name: | Genus |
| Description: | Return plants with a specified genus |
| Options: | Any plant genus name |
| Example: | genus=ceanothus |
| Variable: | taxon |
| Name: | Taxon Name |
| Description: | Return plants with Scientific names beginning with a specified letter |
| Options: | Any single alphabetic character |
| Example: | taxon=a |
| Variable: | common |
| Name: | Common Name |
| Description: | Return plants with Common names beginning with a specified letter |
| Options: | Any single alphabetic character |
| Example: | common=m |
| Variable: | spec |
| Name: | Specific Epithet |
| Description: | Return plants with a specified Specific Epithet |
| Options: | Any specific epithet name |
| Example: | spec=breweri |
| Variable: | elm |
| Name: | Element Code |
| Description: | New at Version v9-01 1.0. Return a plant with a specific Element Code |
| Options: | Any NatureServe element code |
| Example: | elm=PDLIN01030 |
Conservation Status
| Variable: | crpr (also cnps for version 8 compatibility) |
| Name: | California Rare Plant Rank |
| Description: | Returns plants matching one or more designated California Rare Plant Rank |
| Options: | 1A, 1B, 2A, 2B, 3, 4 (optional decmials .1, .2, .3) |
| Example: | crpr=1B:2B:3:4 or crpr=2B.2:3.1 |
| Variable: | fesa |
| Name: | Federal List Status |
| Description: | Returns plants matching one or more designated federal listing statuses |
| Options: | FE, FT, FC, None |
| Example: | fesa=FE:FT |
| Variable: | cesa |
| Name: | State List Status |
| Description: | Returns plants matching one or more designated state listing statuses |
| Options: | CE, CT, CR, None |
| Example: | cesa=CE:CT |
| Variable: | fsao |
| Name: | Federal And/Or State Status |
| Description: | Indicates whether both fesa and cesa criteria must be true, or if either criteria can be true |
| Options: | and, or |
| Example: | fesa=FE:FT&cesa=CE:CT&fsao=and |
| Variable: | grank |
| Name: | Global Rank |
| Description: | Returns plants matching one or more designated Global Rank statuses |
| Options: | G1, G2, G3, G4, G5, GH, GX, GU, GNR |
| Example: | grank=G1:G2 |
| Variable: | gssrank |
| Name: | Global Subspecies Rank |
| Description: | Returns plants matching one or more designated global subspecies or variety rank statuses |
| Options: | T1, T2, T3, T4, T5, TH, TX, TU, TNR |
| Example: | gsssrank=T1:T2 |
| Variable: | srank |
| Name: | State Rank |
| Description: | Returns plants matching one or more designated State Rank statuses |
| Options: | S1, S2, S3, S4, S5, SH, SX, SU, SNR |
| Example: | srank=S1:S2 |
| Variable: | iucn |
| Name: | IUCN Status |
| Description: | Returns plants matching one or more selected IUCN Statuses |
| Options: | Any IUCN Status abbreviation found in the Inventory Glossary |
| Example: | iucn=IUCN_CR:IUCN_EN |
| Variable: | sbank |
| Name: | Seed Bank |
| Description: | Returns plants matching one or more selected Seed Banks |
| Options: | Any Seed Bank abbreviation found in the Inventory Glossary |
| Example: | sbank=SB_BerrySB:SB_CRES |
| Variable: | blms |
| Name: | BLM Sensitive |
| Description: | Returns plants with CNDDB BLM Sensitive Other Status designation |
| Options: | T (true), f (false) |
| Example: | blms=T |
| Variable: | usfss |
| Name: | USFS Sensitive |
| Description: | Returns plants with CNDDB USFS Sensitive Other Status designation |
| Options: | T (true), f (false) |
| Example: | usfss=T |
| Variable: | add_after |
| Name: | Added After Year |
| Description: | Returns plants added after January 1 of a specified year |
| Options: | Any four-digit year from 1974 to present |
| Example: | add_after=2010 |
| Variable: | add_before |
| Name: | Added Before Year |
| Description: | Returns plants added before January 1 of a specified year |
| Options: | Any four-digit year before the current year |
| Example: | add_before=2020 |
Location
| Variable: | end |
| Name: | Endemic to California |
| Description: | Returns plants designated as endemic to California |
| Options: | T (true), f (false) |
| Example: | end=T |
| Variable: | isl |
| Name: | Endemic to Islands |
| Description: | Returns plants designated as endemic to islands |
| Options: | T (true), f (false) |
| Example: | isl=T |
| Variable: | ccl |
| Name: | County or Island |
| Description: | Returns plants occurring within one or more designated California counties or islands |
| Options: | Any three-letter California County or Island abbreviation (see the Inventory Glossary for a full list of three-letter codes) |
| Example: | ccl=SBA:SBR:SCZ |
| Variable: | qsl |
| Name: | Quad Selection Method |
| Description: |
Used to indicate whether a search is a 9-quad search Does not effect the actual search. Only updates the Search Criteria text on the result page |
| Options: | 9 (if using a nine-quad search |
| Example: | qsl=9 |
| Variable: | quad |
| Name: | Quad Code (Number) |
| Description: | Returns plants occurring within one or more designated USGS 7.5 minute quadrangles |
| Options: | Any seven-digit CNDDB quad code (USGS quadrangle) |
| Example: | quad=3411738:3411737:3411747:3411748:3411728:3411727:3411726:3411736:3411746 |
| Variable: | elev |
| Name: | Elevation Range |
| Description: |
Two Types:
|
| Elements: |
Four (4) elements - All are required for a successful result
|
| Options: |
|
| Example: | elev=2000:4000:f:b |
| Variable: | hab (also comm for version 8 compatibility) |
| Name: | General Habitats |
| Description: | Returns plants occurring within one or more designated habitats |
| Options: | Any General Habitat abbreviation found in the Inventory Glossary |
| Example: | hab=Chprl:JTWld:PJWld |
| Variable: | microhab |
| Name: | Microhabitat |
| Description: | Returns plants occurring within one or more designated microhabitats |
| Options: | Any Microhabitat abbreviation found in the Inventory Glossary |
| Example: | microhab=Bajadas:Granitic:Gravelly:Scree |
Ecology and Life History
| Variable: | life |
| Name: | Lifeform |
| Description: | Returns plants matching one or more designated lifeforms |
| Options: | tree, herb, shrub, vine, leaf, stem, moss, liverwort, lichen |
| Example: | life=tree:herb:shrub |
| Variable: | dur |
| Name: | Duration |
| Description: | Returns plants matching one or more durations |
| Options: | ann (annual), per (perennial), ephem (ephemeral) |
| Example: | dur=ann:per |
| Variable: | bloom |
| Name: | Blooming Month |
| Description: | Returns plants that bloom in one or more designated months |
| Options: | Any three-letter month abbreviation |
| Example: | bloom=mar:apr:may |
Occurrence Data (Threats)
| Variable: | threat |
| Name: | CNDDB Occurrence Threats |
| Description: | Returns plants that match one or more selected CNDDB threats |
| Options: | Any CNDDB Theat abbreviation found in the Inventory Glossary |
| Example: | threats=Channel:WtrQlty:Disease |
Global Search
| Variable: | global (also fulldata for version 8 compatibility) |
| Name: | Global Search |
| Description: | Returns plants associated with a designated word |
| Options: | Any search word |
| Example: | global=serpentinite |
Plant Details Querystrings
Version 9-01 1.0 also added support for direct links to plant detail pages via URLs specifying a scientific name. Linking directly to a plant can be done by adding the plant’s scientific name to the plant details URL. For example, the following URL will link directly to the plant detail page for Ceanothus gloriosus var. exaltatus:
https://rareplants.cnps.org/Plants/Details?taxon=Ceanothus+gloriosus+var.+exaltatus
Be sure to replace spaces in the scientific name with the plus (+) symbol and include periods in names including ssp. and var.
| Variable: | taxon |
| Name: | Specific Plant Taxon |
| Description: | Returns the Details page for a spcified plant |
| Options: | Any scienific name |
| Example: | taxon=Ceanothus+gloriosus+var.+exaltatus |
Specifying Multiple Criteria
Querystring criteria can be combined by adding an ampersand (&) between individual querystring clauses. For example, the following URL returns a list of plants with a California Rare Plant Rank of 1B or 2B with a Global Rank of G1 or G2 that bloom in March, April, or May:
https://rareplants.cnps.org/Search/result?cnps=1B:2B&grank=G1:G2&bloom=mar:apr:may