EcoAtlas REST API


Habitat Projects

EcoAtlas tracks projects that modify habitat, such as wetland or stream restoration, compensatory mitigation, or habitat conservation. Multiple programs are using Project Tracker’s online data entry/edit forms (ptrack.ecoatlas.org) to manage their project information. Projects may have have multiple sites, activities, contacts, and funders.

Projects can be viewed in the landscape context along with other data layers on an interactive map. Individual project information pages summarize the status, events, contacts, funding, and habitat plan for each project. Supporting materials, including monitoring reports, permits, photos, videos, and links to other websites, can be stored in a project’s file repository. In addition, dynamic visualizations help measure the cumulative benefits of public policies and programs for California's aquatic resources.

Routes

Descriptions

Routes

GET : api.ecoatlas.org/{region_type_key}

Provides a list of all queryable regions within the given region type. Currently supported region types include ecoregions (ecoregion), California Regional Water Quality Control Boards (waterboard), administrative regions (adminregion), and groups (group).

Returned JSON is provided with:

NameTypeDescription
regionsObject[]List of individual regions of this region type
regions[].keyString|NumberKey for this region
regions[].nameStringFormatted name for this region
regionTypeKeyStringRegion type key specified
regionTypeNameStringFormatted region type name

GET : api.ecoatlas.org/projects/{region_type_key}/{region_key}

Provides a list of all projects within the specified region.

Returned JSON is provided with:

NameTypeDescription
projectsObject[]List of projects in the specified region
projects[].projectidNumberProject ID
projects[].projectnameNumberProject name
regionKeyStringRegion key specified (group id, if found)
regionTypeStringRegion type key specified
regionTypeNameStringFormatted region type name

GET : api.ecoatlas.org/projects/group/?q={group_name}

You may search for projects within a group via a URI parameter to search by group name. This allows searches via proper strings (e.g. with whitespace). Special characters will be replaced with a character wildcard.

Returned JSON is provided with:

NameTypeDescription
projectsObject[]List of projects in the specified group
projects[].projectidNumberProject ID
projects[].projectnameNumberProject name
regionKeyStringRegion key specified (group id, if found)
regionTypeStringRegion type key specified (will be "group")
regionTypeNameStringFormatted region type name (group name, if found)

GET : api.ecoatlas.org/projects

Provides a list of all habitat projects.

Returned JSON is provided with:

NameTypeDescription
projectsObject[]List of projects in the specified region
projects[].projectidNumberProject ID
projects[].projectnameNumberProject name
regionKeyStringRegion key specified (which will default to "statewide" for a request for all habitat projects)
regionTypeStringRegion type key (which will default to "statewide" for a request for all habitat projects)
regionTypeNameStringFormatted region type name (which will default to "Statewide" for a request for all habitat projects)

GET : api.ecoatlas.org/project/{projectid}

Provides details on the project specified by the Project ID.

Returned JSON is provided with:

NameTypeDescription
alternateids AlternateID[] List of associated AlternateIDs for this project
contacts Contact[] List of associated Contacts for this project
countiesObject[]List of counties this project overlaps
counties[].countyidNumberID of county
counties[].nameStringCounty name
groups Group[] List of associated Groups for this project
performancemeasures PerformanceMeasure[] List of associated PerformanceMeasures for this project
projectObjectBasic project information
project.abstractStringProject abstract
project.adminregionStringAdministractive region of project
project.climateprojecttypeStringWhat type of climate adaptation project is this?
project.designconditionStringHow much sea level rise will the project be adaptable to in feet?
project.designlifeNumberHow long project is designed to function in years?
project.ecoregionStringEcoregion of project
project.extremewaterlevelStringWhat storm event is the project designed to accommodate?
project.floodingdescriptionStringDoes the project consider or address shallow groundwater flooding? (long value)
project.floodingnameStringDoes the project consider or address shallow groundwater flooding? (short value)
project.impact_nomitigation_reqdBooleanIf true, permittee-responsible mitigation is not required, and there is no mitigation project associated with this project.
project.mitigation_projectnameStringIf project type is impact, then this is the name of the related mitigation project.
project.organizationStringOrganization responsible for maintaining the project information
project.projectidNumberProject ID
project.projectnameNumberProject name
project.projecttypeStringProject type
project.projecturlStringLink of project page on EcoAtlas
project.regionStringWater board of project
project.totlestcostNumberTotal estimated cost
projectevents Event[] List of associated Events for this project
sites Site[] List of associated Sites for this project

Definitions

AlternateID

A wetland project may be tracked by a number of governmental and non-governmental entities. Typically, each entity assigns its own internal identification number or code to the project.

NameTypeDescription
alternateidStringAlternate ID
permittypeStringType for ID

Contact

People who have a relationship to the project.

NameTypeDescription
firstnameStringFirst name
lastnameStringLast name
roleStringRole of contact

Event

Events are any kind of noteworthy event related to the project. The event date is flexible: it can be specific to the day, or just indicate a year, if more specific information is not available.

NameTypeDescription
commentsStringComments
eventdateStringDate of event
eventtypeStringType of event
projecteventidNumberEvent ID

Group

Groups are a way to associate related projects, e.g., projects related to a program, conservation plan, or different phases of a project.

NameTypeDescription
groupidNumberGroup ID
nameStringGroup name
organizationStringOrganization attributed to group

PerformanceMeasure

A project's performance measures typically describe the required environmental goals of the project, how to measure them, and what to do if they are not met. Target performance measures are defined at the beginning of a project, and actual performance measures track progress towards achieving these targets.

NameTypeDescription
actual_datasourceStringData source
actual_evaluationdateStringEvaluation date
actual_evaluationphaseStringEvaluation phase
actual_measurestatusStringMeasure status
actual_totalactualvalueNumberValue on evaluation
actual_unitStringUnits for value on evaluation
goalStringPlan goal
planStringPlan name
target_begindateStringTarget start date
target_enddateStringTarget end date
target_totaltarget_valueNumberTargeted value
target_unitStringUnits of targeted value

Site

A project consists of one or more physical locations or sites. Most projects have just one site.

NameTypeDescription
activities SiteActivity[] List of SiteActivities
siteObjectBasic site information
site.datumStringDatum of site geometry
site.geomStringWKT formatted geometry of site
site.latitudeNumberLatitude of site
site.longitudeNumberLongitude of site
site.nameStringSite name
site.projectboundaryBooleanIf true, the polygon associated with this site is for the entire project boundary.
site.statusStringStatus of project site
site.siteidNumberSite ID
site.subregionStringSubregion name used to identify a planning region
siteevents SiteEvent[] List of SiteEvents

SiteActivity

Most activities represent physical changes in habitat that the project's proponents intend to carry out. The total project size should equal the sum of these changes (as recorded in the activity.amount field). Other activities are informational, such as Monitoring and Evaluation, Environmental Education/Outreach, and Demonstration.

NameTypeDescription
activityObjectBasic activity information
activity.activityidNumberActivity ID
activity.activityphaseStringPhase or stage of the project
activity.activitystatusStringStatus of activity
activity.activitytypeStringType of activity
activity.amountNumberSize of the land area associated with the activity
activity.habitatStringHabitat type
activity.includeacresBooleanIf true, habitat or activity size acreage amounts are included in project area totals. Field is used to prevent double-counting of acres when there are multiple activities occurring on the same area.
activity.lowerelevationNumberLowest or most bayward elevation for the project activity in ft NAVD 88
activity.slopeNumberSeaward facing slope of the project activity expressed as the ratio of horizontal distance to vertical rise (H:V).
activity.subhabitatStringSubhabitat type
activity.unitStringUnits for above amount
activity.upperelevationNumberHighest elevation for the project activity in ft NAVD 88
fundingObject[]List of funding provided by different entities for this activity
funding[].awarddateStringAward date of funding
funding[].commentsStringComments
funding[].fundingamountNumberFunding amount in USD
funding[].fundingidNumberFunding ID
funding[].grantcontractnumStringGrant contract number
funding[].organizationStringOrganization providing funding
funding[].programStringProgram associated with this funding
subactivityObject[]List of subactivities for this site activity
subactivity[].subactivityidNumberSubactivity ID
subactivity[].subactivitytypenameStringSubactivity type

SiteEvent

Events are any kind of noteworthy event related to the site.

NameTypeDescription
commentsStringComments
eventdateStringDate of event
eventtypeStringType of event
siteeventidNumberEvent ID

© San Francisco Estuary Institute 2019