FieldScope REST API Documentation

Authentication

Login

Logout

URL Structure

A uniform URL structure is employed across the API. The default emitter format is JSON, but can be changed to XML by modifying the URL. An optional project parameter can be employed for context-sensitive queries for a particular FieldScope project. For pagination, count and start may be provided. Default pagination values are count=25 and start=0.

Some examples are provided below:

GET http://www.fieldscope.org/api/observations - Gets the first 25 FieldScope observations.
GET http://www.fieldscope.org/api/olympic/observations - Gets the first 25 Olympic National Park observations.
GET http://www.fieldscope.org/api/frogwatch/stations?count=100&start=25 - Gets 100 Frogwatch stations, starting at the 25th entry.
GET http://www.fieldscope.org/api/frogwatch/stations.xml - Gets the first 25 Frogwatch stations in XML format.

JSON Structure

For every READ request to the API, a standard JSON structure is utilized, which includes pagination data and query results. Additionally, XML format is available. The JSON format looks roughly like this:
{
    count: 25,
    start: 0,
    results: [
        { obj1_param1: obj1_value1,
          ...
        },
        ...
    ]
}

XML Structure

The equivalent XML structure looks like this:
<?xml version="1.0" encoding="utf-8"?>
<response>
    <count>25</count>
    <start>0</start>
    <results>
        <resource>
            <obj1_param1>obj1_value1></obj1_param1>
            ...
        </resource>
        ...
    </results>
</response>

Schemas

Read

Stations

Read

Create

Update

Delete

Observations

Read

Create

Update

Delete