Bio Project
Creating the project
The user may create a bio project by submitting a call to the following endpoint in which the mandatory fields are included in the body of the call.
The status field must be set to "active" for the project to be able to create traces. This field can be changed later.
Remember unlike with Hierarchical Projects, with Bio and Plain projects we need to include the commit interval a project creation, which corresponds tot he period at which the information contained in the project will be traced.
Creates a new bio project
POST https://api.airtrace.io/v1/bio
Request Body
name*
String
Name of the new project
photo*
String
Project picture url
status*
String
Status of the current project
commit_interval*
String
Commit interval for the project
Adjusting the boundary
A geographical boundary for the project may be set by the user in order to specify the geographical limits where the environmental information will be tracked.
This field must be sent as a json object containing the single field "gps" in the body of the call. The gps field contains the bounding box for the project in WGS84 coordinate reference system and encoded as an array containing 4 elements.
Given 2 opposite corners of our bounding box (points a and b) then the body of the call will take the following format:
{
"gps": [a_longitude, a_latitude, b_longitude, b_latitude]
}Adjust a Bio Project's geographical boundary
POST https://api.airtrace.io/v1/bio/{id}/map
Path Parameters
*
String
Id of the Bio Project
Request Body
gps*
A list of boundary point's coordinates
Submitting Biological Data
When submitting Biological Data to a Bio project the user may rely on 2 different methods. The user can either submit data manually one species at a time, or in bulk by uploading a shapefile that contains the data for all the species that the project will track.
When submitting data manually, the user may attach the coordinates of the species as the "gps" parameter inside the request's body. The coordinates must be in WGS84 coordinate reference system and be encoded as an array containing firstly the longitude value and secondly the latitude.
The name of the species as well as the diameter of the specimen may also be included. If the name of the species is not found in AirTrace's records, the user will be informed.
Add Biological Data manually
POST https://api.airtrace.io/v1/bio/{id}/manual
Path Parameters
*
String
Id of the Bio Project
Request Body
gps*
A list of boundary point's coordinates
name*
String
Species name
diameter*
String
Specimen's diameter in meters
When adding data in bulk, the user may submit a shapefile containing the information for each specimen by attaching the zipped shapefile in the request.
The attached file must be in zip format and be called "gis.zip". The file must contain the components for the shapefile, namely "gis.gdf", "gis.shp" and "gis.shx".
Each entry in the shapefile must consist of a point geometry where the geographical location of the specimen is encoded, as well as a record for each specimen where the "name" and "diameter" fields are specified.
Add Biological Data in bulk
POST https://api.airtrace.io/v1/bio/{id}/gis
A file called "gis.zip" following the previously described format must be attached to the call as a multipart field.
Path Parameters
*
String
Id of the Bio Project
Reviewing Bio Project's data
In order to review the information attached to a given Bio Project, the user may create a GET request in which the Bio Project's id is included. The response will contain all data from each specimen that is tracked in the bio project, regardless of whether it was uploaded manually or in bulk.
Get Biological Data from a Bio Project
GET https://api.airtrace.io/v1/bio/{id}
Path Parameters
*
String
Id of the Bio Project
Checking all available Species
When logging scientific data on arboreal or otherwise any kind of species, conflicts usually arise from the naming conventions that are utilized for recording different species' names.
Depending on the level of specificity, geographical location and many other factors, one may find that records for the same species might follow a naming convention that may differ from what the user expects.
While the API tries to detect and adjust for changes in naming convention, the most consistent way for a user to make sure that the species name that is being uploaded corresponds to an available species in our records is to check the name against the list of available species supplied in this endpoint.
Get a list of all available species
GET https://api.airtrace.io/v1/bio/species
Last updated