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

• api.ecoatlas.org/{region_type_key}
• api.ecoatlas.org/projects/{region_type_key}/{region_key}
• api.ecoatlas.org/projects/group/?q={group_name}
• api.ecoatlas.org/projects
• api.ecoatlas.org/project/{projectid}

Descriptions

• AlternateID
• Contact
• Event
• Group
• PerformanceMeasure
• Site
• SiteActivity
• SiteEvent

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:

Name	Type	Description
regionTypeKey	String	Region type key specified
regionTypeName	String	Formatted region type name
regions	Object[]	List of individual regions of this region type
regions[].key	String|Number	Key for this region
regions[].name	String	Formatted 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:

Name	Type	Description
regionType	String	Region type key specified
regionTypeName	String	Formatted region type name
regionKey	String	Region key specified
projects	Object[]	List of projects in the specified region
projects[].projectid	Number	Project ID
projects[].projectname	Number	Project 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:

Name	Type	Description
regionType	String	Region type key specified (will be "group")
regionTypeName	String	Formatted region type name (group name, if found)
regionKey	String	Region key specified (group id, if found)
projects	Object[]	List of projects in the specified group
projects[].projectid	Number	Project ID
projects[].projectname	Number	Project name

GET : api.ecoatlas.org/projects

Provides a list of all habitat projects.

Returned JSON is provided with:

Name	Type	Description
regionType	String	Region type key (which will default to "statewide" for a request for all habitat projects)
regionTypeName	String	Formatted region type name (which will default to "Statewide" for a request for all habitat projects)
regionKey	String	Region key specified (which will default to "statewide" for a request for all habitat projects)
projects	Object[]	List of projects
projects[].projectid	Number	Project ID
projects[].projectname	Number	Project name

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

Provides details on the project specified by the Project ID.

Returned JSON is provided with:

Name	Type	Description
project	Object	Basic project information
project.projectid	Number	Project ID
project.projectname	Number	Project name
project.projecttype	String	Project type
project.ecoregion	String	Ecoregion of project
project.region	String	Water board of project
project.projecturl	String	Link of project page on EcoAtlas
project.adminregion	String	Administractive region of project
project.abstract	String	Project abstract
project.organization	String	Organization responsible for maintaining the project information
project.totlestcost	Number	Total estimated cost
counties	Object[]	List of counties this project overlaps
counties[].countyid	Number	ID of county
counties[].name	String	County 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.

Name	Type	Description
alternateid	String	Alternate ID
permittype	String	Type for ID

Contact

People who have a relationship to the project.

Name	Type	Description
role	String	Role of contact
firstname	String	First name
lastname	String	Last 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.

Name	Type	Description
projecteventid	Number	Event ID
eventdate	String	Date of event
eventtype	String	Type of event
comments	String	Comments

Group

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

Name	Type	Description
groupid	Number	Group ID
name	String	Group name
organization	String	Organization 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.

Name	Type	Description
plan	String	Plan name
goal	String	Plan goal
target_begindate	String	Target start date
target_enddate	String	Target end date
target_totaltarget_value	Number	Targeted value
target_unit	String	Units of targeted value
actual_evaluationdate	String	Evaluation date
actual_totalactualvalue	Number	Value on evaluation
actual_unit	String	Units for value on evaluation
actual_evaluationphase	String	Evaluation phase
actual_measurestatus	String	Measure status
actual_datasource	String	Data source

Site

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

Name	Type	Description
site	Object	Basic site information
site.siteid	Number	Site ID
site.name	String	Site name
site.status	String	Status of project site
site.latitude	Number	Latitude of site
site.longitude	Number	Longitude of site
site.datum	String	Datum of site geometry
site.geom	String	WKT 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.

Name	Type	Description
activity	Object	Basic activity information
activity.activityid	Number	Activity ID
activity.activitytype	String	Type of activity
activity.activitystatus	String	Status of activity
activity.habitat	String	Habitat type
activity.subhabitat	String	Subhabitat type
activity.amount	Number	Size of the land area associated with the activity
activity.unit	String	Units for above amount
funding	Object[]	List of funding provided by different entities for this activity
funding[].fundingid	Number	Funding ID
funding[].program	String	Program associated with this funding
funding[].organization	String	Organization providing funding
funding[].grantcontractnum	String	Grant contract number
funding[].awarddate	String	Award date of funding
funding[].fundingamount	Number	Funding amount in USD
funding[].comments	String	Comments
subactivity	Object[]	List of subactivities for this site activity
subactivity[].subactivityid	Number	Subactivity ID
subactivity[].subactivitytypename	String	Subactivity type

SiteEvent

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

Name	Type	Description
siteeventid	Number	Event ID
eventdate	String	Date of event
eventtype	String	Type of event
comments	String	Comments