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

GET : /{region_type}

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:

• regionKey (string): Region type key
• regionName (string): Formatted region type name
• regions (Array): List of regions of this type
• regions[].key (string): Key for this region
• regions[].name (string): Formatted name for this region

GET : /projects

Provides a list of all habitat projects.

Returned JSON is provided with:

• regionType (string): Region type key
• regionKey (string): Region key
• regionName (string): Formatted region name
• projects (Array): List of projects
• projects[].projectname (string): Project name
• projects[].projectid (number): Project ID

GET : /project/{projectid}

Provides details on the project specified by the Project ID.

Returned JSON is provided with:

• projectid (number): Project ID
• projectname (string): Project name
• projecttype (string): Project type
• projecturl (string): Link to project page on EcoAtlas
• programname (string): Administrative program or region for the project
• abstract (string): Abstract
• organization (string): Organization responsible for maintaining the project information
• county (string): County
• alternateid (string): Comma-separated list of alternate IDs
• totestcost (number): Total estimated cost
• groups (Array): List of groups associated with project
• groups[].name (string): Group name
• perfcriteria (Array): List of performance criteria associated with project
• perfcriteria[].description (string): Description of performance criteria
• events (Array): List of events associated with project
• events[].date (string): Event date
• events[].type (string): Event type
• contacts (Array): List of contact information associated with project
• contacts[].role (string): Contact role
• contacts[].firstname (string): Contact first name
• contacts[].lastname (string): Contact last name
• sites (Array): List of sites associated with project
• sites[].id (string): Site ID
• sites[].name (string): Site name
• sites[].status (string): Site status
• sites[].latitude (string): Site coordinates (latitude)
• sites[].longitude (string): Site coordinates (longitude)
• activity (Array): List of activities associated with site
• activity[].activityid (string): ID of activity
• activity[].activityname (string): Name of activity
• activity[].activitystatus (string): Status of activity
• activity[].habitat (string): Habitat of activity
• activity[].subhabitat (string): Subhabitat of activity
• activity[].amount (string): Amount of habitat or activity
• activity[].unit (string): Units for habitat or activity amount
• funding (Array): List of funding sources associated with activity
• funding[].fundingid (string): ID of funding source
• funding[].program (string): Program of funding source
• funding[].grantcontractnum (string): Grant contract number
• funding[].awarddate (string): Award date of funding
• funding[].fundingamount (string): Funding amount
• funding[].comments (string): Funding comments
• subactivity (Array): List of subactivities asssociated with activity
• subactivity.subactivityid (string): ID of subactivity
• subactivity.subactivityname (string): Name of subactivity

GET : /projectGeom/{projectid}

Provides details on the project specified by the Project ID.

Returned JSON is provided with:

• projectid (number): Project ID
• projectname (string): Project name
• projecttype (string): Project type
• projecturl (string): Link to project page on EcoAtlas
• programname (string): Administrative program or region for the project
• abstract (string): Abstract
• organization (string): Organization responsible for maintaining the project information
• county (string): County
• alternateid (string): Comma-separated list of alternate IDs
• totestcost (number): Total estimated cost
• groups (Array): List of groups associated with project
• groups[].name (string): Group name
• perfcriteria (Array): List of performance criteria associated with project
• perfcriteria[].description (string): Description of performance criteria
• events (Array): List of events associated with project
• events[].date (string): Event date
• events[].type (string): Event type
• contacts (Array): List of contact information associated with project
• contacts[].role (string): Contact role
• contacts[].firstname (string): Contact first name
• contacts[].lastname (string): Contact last name
• sites (Array): List of sites associated with project
• sites[].id (string): Site ID
• sites[].name (string): Site name
• sites[].status (string): Site status
• sites[].latitude (string): Site coordinates (latitude)
• sites[].longitude (string): Site coordinates (longitude)
• sites[].geom (string): Site geometry
• activity (Array): List of activities associated with site
• activity[].activityid (string): ID of activity
• activity[].activityname (string): Name of activity
• activity[].activitystatus (string): Status of activity
• activity[].habitat (string): Habitat of activity
• activity[].subhabitat (string): Subhabitat of activity
• activity[].amount (string): Amount of habitat or activity
• activity[].unit (string): Units for habitat or activity amount
• funding (Array): List of funding sources associated with activity
• funding[].fundingid (string): ID of funding source
• funding[].program (string): Program of funding source
• funding[].grantcontractnum (string): Grant contract number
• funding[].awarddate (string): Award date of funding
• funding[].fundingamount (string): Funding amount
• funding[].comments (string): Funding comments
• subactivity (Array): List of subactivities asssociated with activity
• subactivity.subactivityid (string): ID of subactivity
• subactivity.subactivityname (string): Name of subactivity

GET : /projects/{region_type}/{region_name}

Provides a list of all projects within the specified region.

Returned JSON is provided with:

• regionType (string): Region type key
• regionKey (string): Region key
• regionName (string): Formatted region name
• projects (Array): List of projects
• projects[].projectname (string): Project name
• projects[].projectid (number): Project ID

GET : /projects/group/?q={group_name}

As project groups are not fixed and names can vary, searching via a URI parameter may be more desirable. This allows searches via proper strings (e.g. with whitespace). Special characters will be replaced with a character wildcard.

Returned JSON is provided with:

• regionType (string): Region type key
• regionKey (string): Region key
• regionName (string): Formatted region name
• projects (Array): List of projects
• projects[].projectname (string): Project name
• projects[].projectid (string): Project ID

© San Francisco Estuary Institute 2017