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
regionTypeKeyStringRegion type key specified
regionTypeNameStringFormatted region type name
regionsObject[]List of individual regions of this region type
regions[].keyString|NumberKey for this region
regions[].nameStringFormatted name for this region

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
regionTypeStringRegion type key specified
regionTypeNameStringFormatted region type name
regionKeyStringRegion key specified
projectsObject[]List of projects in the specified region
projects[].projectidNumberProject ID
projects[].projectnameNumberProject 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
regionTypeStringRegion type key specified (will be "group")
regionTypeNameStringFormatted region type name (group name, if found)
regionKeyStringRegion key specified (group id, if found)
projectsObject[]List of projects in the specified group
projects[].projectidNumberProject ID
projects[].projectnameNumberProject name

GET : api.ecoatlas.org/projects

Provides a list of all habitat projects.

Returned JSON is provided with:

NameTypeDescription
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)
regionKeyStringRegion key specified (which will default to "statewide" for a request for all habitat projects)
projectsObject[]List of projects
projects[].projectidNumberProject ID
projects[].projectnameNumberProject name

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

Provides details on the project specified by the Project ID.

Returned JSON is provided with:

NameTypeDescription
projectObjectBasic project information
project.projectidNumberProject ID
project.projectnameNumberProject name
project.projecttypeStringProject type
project.ecoregionStringEcoregion of project
project.regionStringWater board of project
project.projecturlStringLink of project page on EcoAtlas
project.adminregionStringAdministractive region of project
project.abstractStringProject abstract
project.organizationStringOrganization responsible for maintaining the project information
project.totlestcostNumberTotal estimated cost
countiesObject[]List of counties this project overlaps
counties[].countyidNumberID of county
counties[].nameStringCounty name
alternateids AlternateID[] List of associated AlternateIDs for this project
groups Group[] List of associated Groups for this project
performancemeasures PerformanceMeasure[] List of associated PerformanceMeasures for this project
projectevents Event[] List of associated Events for this project
contacts Contact[] List of associated Contacts 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
roleStringRole of contact
firstnameStringFirst name
lastnameStringLast name

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
projecteventidNumberEvent ID
eventdateStringDate of event
eventtypeStringType of event
commentsStringComments

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
planStringPlan name
goalStringPlan goal
target_begindateStringTarget start date
target_enddateStringTarget end date
target_totaltarget_valueNumberTargeted value
target_unitStringUnits of targeted value
actual_evaluationdateStringEvaluation date
actual_totalactualvalueNumberValue on evaluation
actual_unitStringUnits for value on evaluation
actual_evaluationphaseStringEvaluation phase
actual_measurestatusStringMeasure status
actual_datasourceStringData source

Site

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

NameTypeDescription
siteObjectBasic site information
site.siteidNumberSite ID
site.nameStringSite name
site.statusStringStatus of project site
site.latitudeNumberLatitude of site
site.longitudeNumberLongitude of site
site.datumStringDatum of site geometry
site.geomStringWKT formatted geometry of site
siteevents SiteEvent[] List of SiteEvents
activities SiteActivity[] List of SiteActivities

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.activitytypeStringType of activity
activity.activitystatusStringStatus of activity
activity.habitatStringHabitat type
activity.subhabitatStringSubhabitat type
activity.amountNumberSize of the land area associated with the activity
activity.unitStringUnits for above amount
fundingObject[]List of funding provided by different entities for this activity
funding[].fundingidNumberFunding ID
funding[].programStringProgram associated with this funding
funding[].organizationStringOrganization providing funding
funding[].grantcontractnumStringGrant contract number
funding[].awarddateStringAward date of funding
funding[].fundingamountNumberFunding amount in USD
funding[].commentsStringComments
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
siteeventidNumberEvent ID
eventdateStringDate of event
eventtypeStringType of event
commentsStringComments

© San Francisco Estuary Institute 2019