Error retrieving metadata
An error occurred while retrieving the service metadata.
Report of Petitions Sent to the U.S. FWS Regarding Listed Species
Report of Petitions sent to the U.S. FWS regarding Listed species.
Data Explorer
The easiest way to begin using the Report of Petitions Sent to the U.S. FWS Regarding Listed Species REST API is via the ECOS Data Explorer's
point-and-click user interface. As you join data and create filters within the explorer, it captures your interactions as
REST API parameters.
Use the explorer's Export Link button to view and copy the valid REST API URL.
See the Help tab with the Data Explorer for
additional assistance using data explorer interface.
REST API
Parameters
Read the full Pull Reports parameter documentation for a description of valid parameter values.
Usage
Requests into the API always export at least one column from the service's base table: Petitions. Use the columns parameter to join additional columns from supportive tables into your request result.
For example, to include all columns from a supportive table with path /table/path into the result, specify the table path within the columns parameter:
&columns=/table/path
To include a subset of columns, include a comma separated list of column id's after the table path:
&columns=/table/path@columnId1,columnId2
Use one or more filter parameters on any column to restrict the result to just rows which match the filter condition(s).
For instance, the following filter restricts the results to all records in which columnId1 in supportive table /table/path has a value greater than 1000:
&filter=/table/path@columnId1 > 1000
See the Pull Reports Export Report API for a complete description of all API parameter format and capabilities.
Base Table
Petitions
Path: /pr
The base table is the originating table for all report joins.
Description: Petitions received
Example service requests: Return the first 10 rows.
Child relationships
- Species Entity [ left join] [to-many]
- Petition Finding(s) [ left join] [to-many]
- Petition Document [ left join] [to-many]
- Petition Action [ left join] [to-many]
- Petitioner [ left join] [to-many]
| Name | Id | Description | Type | Exportable? |
|---|---|---|---|---|
| Petition ID | id | The unique integer value of this Petition within the FWS ECOS database. | Integer | true |
| Petition Date | petition_date | The date the petition | Date | true |
| Petition Title | title | The Petition title. | String | true |
| Active | active | Whether Petition is active or not | Boolean | true |
| Where species is believed to or known to occur | states | Comma separated list of state abbreviations where species associated with the petition is believed to or known to occur. | String | true |
| Is Withdrawn | is_withdrawn | Is the Petition Withdrawn? | String | true |
Supportive Tables
The following tables may be joined to the base table to add additional information to the data service.
Petition Action
Path: /pr/pr_action
Description: Petition Action.
Example service requests: Return the first 10 rows from the result of joining this table to the report's base table.
Child relationships
None
| Name | Id | Description | Type | Exportable? |
|---|---|---|---|---|
| Action | action | Petition action. | String | true |
| Sort | sort | Column to sort petitions by. | String | true |
| Petition ID | petition_id | The unique FWS ECOS database integer value for the associated petition. | Integer | true |
Petition Document
Path: /pr/pr_document
Description: The issued petition document.
Example service requests: Return the first 10 rows from the result of joining this table to the report's base table.
Child relationships
None
| Name | Id | Description | Type | Exportable? |
|---|---|---|---|---|
| Petition Document ID | id | The unique integer value of this Petition document within the FWS ECOS database. | Integer | true |
| File Name | file_name | The document file name. | String | true |
| File Path | file_path | The document file path. | String | true |
| Document Title | doc_title | The document title. | String | true |
| Petition ID | petition_id | The unique FWS ECOS database integer value for the associated petition. | Integer | true |
Petition Finding(s)
Path: /pr/finding
Description: The Petition Finding(s).
Example service requests: Return the first 10 rows from the result of joining this table to the report's base table.
Child relationships
None
| Name | Id | Description | Type | Exportable? |
|---|---|---|---|---|
| Finding ID | id | The unique FWS ECOS database integer value for the petition finding. | Integer | true |
| Finding | finding | Textual finding identifier associated with the petition finding. | String | true |
| Finding Date | finding_date | The date of the petition finding | String | true |
| TSNs | tsns | TSNs of populations associated with the petition and finding. | String | true |
| Petition ID | petition_id | The unique FWS ECOS database integer value for the associated petition. | Integer | true |
| FR ID | fr_id | FR ID | String | true |
| FR Date | fr_date | FR Date of the petition finding | String | true |
| FR Title | fr_title | FR Title | String | true |
| FR URL | fr_url | FR URL | String | true |
Petitioner
Path: /pr/petitioner
Description: Petitioner.
Example service requests: Return the first 10 rows from the result of joining this table to the report's base table.
Child relationships
None
| Name | Id | Description | Type | Exportable? |
|---|---|---|---|---|
| Petitioner Name | name | Name of the Petitioner. | String | true |
| Petition ID | petition_id | The unique FWS ECOS database integer value for the associated petition. | Integer | true |
Species Entity
Path: /pr/species
Description: A species entity is a set of individuals of a species of interest to the U.S. FWS. An entity may represent all individuals of the species or just those within a designated management unit Species entities may have a listing status under the ESA.
Example service requests: Return the first 10 rows from the result of joining this table to the report's base table.
Child relationships
None
| Name | Id | Description | Type | Exportable? |
|---|---|---|---|---|
| Common Name | cn | The common name of the species. If the species is listed under the ESA, the name is displayed as it is shown in the listing document. | String | true |
| Inverted Common Name | in | The inverted common name of the species. If the species is listed under the ESA, the name is displayed as it is shown in the listing document. | String | true |
| Scientific Name | sn | The scientific name of the species. If the species is listed under the ESA, the name is displayed as it is shown in the listing document. Each value is hyper-linked to the ECOS species profile report. | String | true |
| Status Category | status_category | The general status (i.e. category) of this entity as it relates to the ESA.
| String | true |
| ESA Listing Status | status | The specific status of this entity as it relates to its status_ategory and the ESA. View status definitions. | String | true |
| Proposed ESA Listing Status | alt_status | The alternate specific status of this entity as it relates to its status_category and the ESA. View status definitions. | String | true |
| ESA Listing Date | listing_date | The effective date of the listing as published in Title 50 of the Code of Federal Regulations (CFR), parts 17.11 and 17.12. This field will be null if the species entity has not been listed. | Date | true |
| Lead Agency | agency | The U.S. Federal agency that has authority for this species if the species is managed via the ESA. Typically, 'FWS' for terrestrial and freshwater species, 'NMFS' for marine species, and 'FWS and ‘NMFS' for species which inhabit both environments. | String | true |
| Distinct Population Segment? | dps | When this is true, a species has been listed (or is being evaluated for listing) as a Distinct Population Segment (DPS) based on the three elements outlined in this joint NOAA and FWS DPS policy. | Boolean | true |
| Entity Abbreviation | abbrev | The population abbreviation. | String | true |
| Entity Description | desc | The description of the distinct population segment. Only non-null if the record's 'Distinct Population Segment?' value is true. | String | true |
| More Information Link To Population | more_info_url | The url link to more information of the population. | String | true |
| Is Foreign? | is_foreign | Species who reside and whose life requirements occur entirely outside the United States are considered wholly foreign species. Species who span both a foreign country and the United States are considered "transboundary" species. Therefore, migratory birds that span foreign countries and the U.S. are considered transboundary species, and the Regions are be responsible for them. Wholly foreign species are the responsibility of the Branch of Foreign Species. | Boolean | true |
| Is BCC? | is_bcc | The 1988 amendment to the Fish and Wildlife Conservation Act mandates the FWS to “identify species, subspecies, and populations of all migratory nongame birds that, without additional conservation actions, are likely to become candidates for listing under the Endangered Species Act (ESA) of 1973.” Birds of Conservation Concern (BCC) 2008 is the most recent effort to carry out this mandate. For more information see, https://www.fws.gov/birds/management/managed-species/birds-of-conservation-concern.php | Boolean | true |
| Range Envelope | range_envelope | Well Known Text representation of the bounding box envelope which encompasses the entity's current range. | String | true |
| Range Shapefile | range_shapefile | The name of the current range shapefile associated with a species. | String | true |
| ECOS Listed Species ID | id | The unique integer value of this species entity within the FWS ECOS database. | Integer | true |
| VIP Code | vipcode | Legacy value of this species entity within the FWS ECOS database. | String | true |
| ECOS Species ID | sid | The unique integer value of this species within the FWS ECOS database. | Integer | true |
| Range Shapefile URL | shapefile_url | The URL of the current range shapefile associated with a species. | String | |
| Foreign or Domestic | country | An indication of whether the species is Foreign or Domestic or Both. | String | true |
| Species Group | gn | The taxanomic Group the species belongs to. | String | true |
| Range Shapefile Last Updated | shapefile_last_updated | The last date the Range Shapefile was updated. | String | true |
| Recovery Priority Number | recovery_priority_number | Recovery Priority Number | String | true |
