StraboSpot REST API

The StraboSpot REST API uses HTTP Basic Auth for authentication. An account can be obtained by clicking on the "ACCOUNT->REGISTER" link above. Once an account is created, it will need to be validated by email. When using the StraboSpot REST API, you will use your email address as the username and your password as entered during registration.
Table of Contents Upload Spot(s)
Get Spot
Delete Spot
Get My Spots
Delete All of My Spots
Authenticate User
Upload Image
Get Image
Delete Image
Verify Image Existence
Create Dataset
Update Dataset
Get Dataset
Delete Dataset
Get My Datasets
Add Spot to Dataset
Get All Spots for Given Dataset
Get All Fields for Given Dataset
Delete All Spots for Given Dataset
Create Project
Update Project
Get Project
Delete Project
Get My Projects
Get All Images for a Given Project
Add Dataset to Project
Get All Datasets for Given Project
Delete All Datasets for Given Project
Create Profile
Update Profile
Get Profile
Delete Profile
Upload Profile Image
Get Profile Image
Delete Profile Image

Upload Spots(s)

Example request
  • POST:https://strabospot.org/db/datasetspots/12345
  • Where: 12345 is the dataset id.
  • Accept: application/json; charset=UTF-8
  • Note: This function accepts a GeoJSON FeatureCollection and populates it as individual spot(s) for the given dataset. An existing dataset is required. 
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "images": [
          {
            "height": 1999,
            "id": 1122334455667788991,
            "annotated": true,
            "title": "new image here",
            "width": 720,
            "caption": "caption here"
          },
          {
            "height": 999,
            "id": 1122334455667788992,
            "annotated": true,
            "title": "title of image here",
            "width": 720,
            "caption": "caption here"
          },
          {
            "height": 669,
            "id": 1122334455667788993,
            "annotated": false,
            "title": "",
            "width": 500,
            "caption": "caption here"
          }
        ],
        "time": "2016-02-18T21:10:35.000Z",
        "id": 12345678901,
        "orientation_data": [
          {
            "dip_direction": 65,
            "strike": 55,
            "dip": 45,
            "facing": "upright",
            "orientation_type": "planar_orientation"
          }
        ],
        "modified_timestamp": 1455830604745,
        "date": "2016-02-18T21:10:35.000Z",
        "samples": [
          {
            "sample_id_name": "id2",
            "oriented_sample": "yes",
            "sample_description": "Hhh",
            "sample_orientation_notes": "Fffhhh"
          }
        ],
        "name": "My test point1"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -97.678707920763003,
          38.576879262485001
        ]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "images": [
          {
            "height": 1999,
            "id": 1122334455667788994,
            "annotated": true,
            "title": "new image here",
            "width": 720,
            "caption": "caption here"
          },
          {
            "height": 999,
            "id": 1122334455667788995,
            "annotated": true,
            "title": "title of image here",
            "width": 720,
            "caption": "caption here"
          },
          {
            "height": 669,
            "id": 1122334455667788996,
            "annotated": false,
            "title": "",
            "width": 500,
            "caption": "caption here"
          }
        ],
        "time": "2016-02-18T21:10:35.000Z",
        "id": 12345678902,
        "orientation_data": [
          {
            "dip_direction": 65,
            "strike": 55,
            "dip": 45,
            "facing": "upright",
            "orientation_type": "planar_orientation"
          }
        ],
        "modified_timestamp": 1455830604745,
        "date": "2016-02-18T21:10:35.000Z",
        "samples": [
          {
            "sample_id_name": "id3",
            "oriented_sample": "yes",
            "sample_description": "Hhh",
            "sample_orientation_notes": "Fffhhh"
          }
        ],
        "name": "My test point2"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -97.678707920763003,
          38.576879262485001
        ]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "images": [
          {
            "height": 1999,
            "id": 1122334455667788997,
            "annotated": true,
            "title": "new image here",
            "width": 720,
            "caption": "caption here"
          },
          {
            "height": 999,
            "id": 1122334455667788998,
            "annotated": true,
            "title": "title of image here",
            "width": 720,
            "caption": "caption here"
          },
          {
            "height": 669,
            "id": 1122334455667788999,
            "annotated": false,
            "title": "",
            "width": 500,
            "caption": "caption here"
          }
        ],
        "time": "2016-02-18T21:10:35.000Z",
        "id": 12345678903,
        "orientation_data": [
          {
            "dip_direction": 65,
            "strike": 55,
            "dip": 45,
            "facing": "upright",
            "orientation_type": "planar_orientation"
          }
        ],
        "modified_timestamp": 1455830604745,
        "date": "2016-02-18T21:10:35.000Z",
        "samples": [
          {
            "sample_id_name": "id3",
            "oriented_sample": "yes",
            "sample_description": "Hhh",
            "sample_orientation_notes": "Fffhhh"
          }
        ],
        "name": "My test point3"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -97.678707920763003,
          38.576879262485001
        ]
      }
    }
  ]
}
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8 
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "images": [
          {
            "height": 1999,
            "id": 1122334455667788991,
            "annotated": true,
            "title": "new image here",
            "width": 720,
            "caption": "caption here",
            "self": "https://strabospot.org/image/1122334455667788991"
          },
          {
            "height": 999,
            "id": 1122334455667788992,
            "annotated": true,
            "title": "title of image here",
            "width": 720,
            "caption": "caption here",
            "self": "https://strabospot.org/image/1122334455667788992"
          },
          {
            "height": 669,
            "id": 1122334455667788993,
            "annotated": false,
            "title": "",
            "width": 500,
            "caption": "caption here",
            "self": "https://strabospot.org/image/1122334455667788993"
          }
        ],
        "time": "2016-02-18T21:10:35.000Z",
        "id": 12345678901,
        "self": "https://strabospot.org/feature/12345678901",
        "orientation_data": [
          {
            "dip_direction": 65,
            "strike": 55,
            "dip": 45,
            "facing": "upright",
            "orientation_type": "planar_orientation"
          }
        ],
        "modified_timestamp": 1455830604745,
        "date": "2016-02-18T21:10:35.000Z",
        "samples": [
          {
            "sample_id_name": "id2",
            "oriented_sample": "yes",
            "sample_description": "Hhh",
            "sample_orientation_notes": "Fffhhh"
          }
        ],
        "name": "My test point1"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -97.678707920763003,
          38.576879262485001
        ]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "images": [
          {
            "height": 1999,
            "id": 1122334455667788994,
            "annotated": true,
            "title": "new image here",
            "width": 720,
            "caption": "caption here",
            "self": "https://strabospot.org/image/1122334455667788994"
          },
          {
            "height": 999,
            "id": 1122334455667788995,
            "annotated": true,
            "title": "title of image here",
            "width": 720,
            "caption": "caption here",
            "self": "https://strabospot.org/image/1122334455667788995"
          },
          {
            "height": 669,
            "id": 1122334455667788996,
            "annotated": false,
            "title": "",
            "width": 500,
            "caption": "caption here",
            "self": "https://strabospot.org/image/1122334455667788996"
          }
        ],
        "time": "2016-02-18T21:10:35.000Z",
        "id": 12345678902,
        "self": "https://strabospot.org/feature/12345678902",
        "orientation_data": [
          {
            "dip_direction": 65,
            "strike": 55,
            "dip": 45,
            "facing": "upright",
            "orientation_type": "planar_orientation"
          }
        ],
        "modified_timestamp": 1455830604745,
        "date": "2016-02-18T21:10:35.000Z",
        "samples": [
          {
            "sample_id_name": "id3",
            "oriented_sample": "yes",
            "sample_description": "Hhh",
            "sample_orientation_notes": "Fffhhh"
          }
        ],
        "name": "My test point2"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -97.678707920763003,
          38.576879262485001
        ]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "images": [
          {
            "height": 1999,
            "id": 1122334455667788997,
            "annotated": true,
            "title": "new image here",
            "width": 720,
            "caption": "caption here",
            "self": "https://strabospot.org/image/1122334455667788997"
          },
          {
            "height": 999,
            "id": 1122334455667788998,
            "annotated": true,
            "title": "title of image here",
            "width": 720,
            "caption": "caption here",
            "self": "https://strabospot.org/image/1122334455667788998"
          },
          {
            "height": 669,
            "id": 1122334455667788999,
            "annotated": false,
            "title": "",
            "width": 500,
            "caption": "caption here",
            "self": "https://strabospot.org/image/1122334455667788999"
          }
        ],
        "time": "2016-02-18T21:10:35.000Z",
        "id": 12345678903,
        "self": "https://strabospot.org/feature/12345678903",
        "orientation_data": [
          {
            "dip_direction": 65,
            "strike": 55,
            "dip": 45,
            "facing": "upright",
            "orientation_type": "planar_orientation"
          }
        ],
        "modified_timestamp": 1455830604745,
        "date": "2016-02-18T21:10:35.000Z",
        "samples": [
          {
            "sample_id_name": "id3",
            "oriented_sample": "yes",
            "sample_description": "Hhh",
            "sample_orientation_notes": "Fffhhh"
          }
        ],
        "name": "My test point3"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -97.678707920763003,
          38.576879262485001
        ]
      }
    }
  ]
}

Get Spot

Example request
  • GET: https://strabospot.org/db/feature/14309503161234,
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
{
  "geometry" : {
    "type" : "Polygon",
    "coordinates" : [[
      [100,0], [101,0], [101,1], [100,1],[100,0]
    ]]
  },
  "properties" : {
    "id": 14309503161234,
    "date" : "2014-11-20",
    "name" : "My Test Feature Polygon Name",
    "self" : "https://strabospot.org/db/feature/1234"
  },
  "type" : "Feature"
  
}

Delete Spot

Example request
  • DELETE: https://strabospot.org/db/feature/14309503161234,
  • Accept: application/json; charset=UTF-8
Example response
  • 204: No Content

Get My Spots (Return all spots of authorized user)

Example request
  • GET: https://www.strabospot.org/db/myFeatures
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
{
  "type" : "FeatureCollection",
  "features" : [
    {
      "geometry" : {
        "type" : "Polygon",
        "coordinates" : [[
      [100,0], [101,0], [101,1], [100,1],[100,0]
        ]]
      },
      "properties" : {
        "id" : 14309503161234,
        "date" : "2014-11-20",
        "name" : "Test 3",
        "self" : "https://strabospot.org/db/feature/1242"
      },
      "type" : "Feature"
    },
    {
      "geometry" : {
        "type" : "Polygon",
        "coordinates" : [[
      [100,0], [101,0], [101,1], [100,1],[100,0]
        ]]
      },
      "properties" : {
        "id": 14309503161235,
        "date" : "2014-11-20",
        "name" : "Test 2",
        "self" : "https://strabospot.org/db/feature/1241"
      },
      "type" : "Feature"
    },
    {
      "geometry" : {
        "type" : "Polygon",
        "coordinates" : [[
      [100,0], [101,0], [101,1], [100,1],[100,0]
        ]]
      },
      "properties" : {
        "id" : 14309503161236,
        "date" : "2014-11-20",
        "name" : "Test 1",
        "self" : "https://strabospot.org/db/feature/1240"
      },
      "type" : "Feature"
    },
    {
      "geometry" : {
        "type" : "Polygon",
        "coordinates" : [[
      [100,0], [101,0], [101,1], [100,1],[100,0]
        ]]
      },
      "properties" : {
        "id" : 14309503161237,
        "date" : "2014-11-20",
        "name" : "Test Poly",
        "self" : "https://strabospot.org/db/feature/1239"
      },
      "type" : "Feature"
    }

  ]
}

Delete All of My Spots (Delete all spots of authorized user)

Example request
  • DELETE: https://strabospot.org/db/myFeatures
  • Accept: application/json; charset=UTF-8
Example response
  • 204: No Content

Authenticate User

Example request
  • POST: https://strabospot.org/userAuthenticate
  • Accept: application/json; charset=UTF-8 
{
	
	"email" : "foo@foo.com",
	"password" : "bar"

}
Example response
  • 200: OK
  • Content-Type: application/json 
{
  "valid" : "true"
}
or 
{
  "valid" : "false"
}

Upload Image

Example request
  • POST: https://strabospot.org/db/image
  • Accept: application/json; charset=UTF-8 
Due to a file being uploaded, this service accepts multiple POST variables:

Variable Name: "id" - ID of image being uploaded. (required)
Variable Name: "modified_timestamp" - Unix timestamp when image last modified. (optional)
Variable Name: "image_file" - File containing image to be uploaded. (required)


Also, please note the the encapsulation type MUST be set to "multipart/form-data".
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8 
{"self":"https://strabospot.org/db/image/531","id":"531"}
Note: Due to the complexity of using multipart/form-data, a test page has been created to test this service.
This page can be found at: https://strabospot.org/imageupload.

Get Image

Example request
  • GET: https://strabospot.org/db/image/527
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: image/jpg 
File content of image is returned.

Delete Image

Example request
  • DELETE: https://strabospot.org/db/image/1234
  • Accept: application/json; charset=UTF-8
Example response
  • 204: No Content

Verify Image Existence

Example request
  • GET: https://strabospot.org/db/verifyimage/1234
  • Accept: application/json; charset=UTF-8
Example response
  • 200: Success
  • 404: Not Found

Create Dataset

Example request
  • POST: https://strabospot.org/db/dataset
  • Accept: application/json; charset=UTF-8 
{
	"id": 14573623121234,
	"name": "MyDatasetName",
	"modified_timestamp": 1457377455,
	"date": "03/08/2016"
}
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8 
{
	"datasettype" : "app",
	"name": "MyDatasetName",
	"id": 14573623121234,
	"self" : "https://strabospot.org/db/dataset/123456",
	"modified_timestamp": 1457377455,
	"date": "03/08/2016"
}

Update Dataset

Example request
  • POST: https://strabospot.org/db/dataset/14573623121234
  • Accept: application/json; charset=UTF-8
  • Warning: All attributes will be overwritten with provided JSON values. 
{
   "name": "MyNewDatasetName"
}
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8 
{
	"datasettype" : "app",
	"name": "MyNewDatasetName",
	"id": 14573623121234,
	"self" : "https://strabospot.org/db/dataset/14573623121234",
	"modified_timestamp": 1457377455,
	"date": "03/08/2016"
}

Get Dataset

Example request
  • GET: https://strabospot.org/db/dataset/"id": 14573623121234,
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
{
	"datasettype" : "app",
	"name": "MyNewDatasetName",
	"id": 14573623121234,
	"self" : "https://strabospot.org/db/dataset/123456",
	"modified_timestamp": 1457377455,
	"date": "03/08/2016"
}

Delete Dataset (also deletes spots)

Example request
  • DELETE: https://strabospot.org/db/dataset/123456
  • Accept: application/json; charset=UTF-8
Example response
  • 204: No Content

Get My Datasets (Return all datasets of authorized user)

Example request
  • GET: https://www.strabospot.org/db/myDatasets
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
{
  "datasets" : [
    {
		"datasettype" : "app",
		"self" : "https://strabospot.org/db/dataset/14573623121234",
		"id" : 14573623121234,
		"name" : "MyNewDatasetName",
		"modified_timestamp": 1457362312,
		"date": "03/08/2016"
    },
    {
		"datasettype" : "app",
		"self" : "https://strabospot.org/db/dataset/14573623121235",
		"id" : 14573623121235,
		"name" : "Second Dataset",
		"modified_timestamp": 1457362312,
		"date": "03/08/2016"
    },
    {
		"datasettype" : "app",
		"self" : "https://strabospot.org/db/dataset/14573623121236",
		"id" : 14573623121236,
		"name" : "ThirdDataset",
		"modified_timestamp": 1457362312,
		"date": "03/08/2016"
    },
    {
		"datasettype" : "app",
		"self" : "https://strabospot.org/db/dataset/14573623121237",
		"id" : 14573623121237,
		"name" : "FourthDataset",
		"modified_timestamp": 1457362312,
		"date": "03/08/2016"
    }
  ]
}

Add Spot to Dataset

Example request
  • POST: https://strabospot.org/db/datasetSpots/123456
  • Where: 123456 is the dataset id.
  • Accept: application/json; charset=UTF-8 
{
	"id":14309503161234
}
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8 
{
  "message" : "Spot 14309503161234 added to dataset 123456."
}

Get all Spots for Given Dataset

Example request
  • GET: https://www.strabospot.org/db/datasetSpots/123456
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
{
  "type" : "FeatureCollection",
  "features" : [
    {
      "geometry" : {
        "type" : "Polygon",
        "coordinates" : [[
      [100,0], [101,0], [101,1], [100,1],[100,0]
        ]]
      },
      "properties" : {
        "id" : 14309503161234,
        "date" : "2014-11-20",
        "name" : "Test 3",
        "self" : "https://strabospot.org/db/feature/1242"
      },
      "type" : "Feature"
    },
    {
      "geometry" : {
        "type" : "Polygon",
        "coordinates" : [[
      [100,0], [101,0], [101,1], [100,1],[100,0]
        ]]
      },
      "properties" : {
        "id": 14309503161235,
        "date" : "2014-11-20",
        "name" : "Test 2",
        "self" : "https://strabospot.org/db/feature/1241"
      },
      "type" : "Feature"
    },
    {
      "geometry" : {
        "type" : "Polygon",
        "coordinates" : [[
      [100,0], [101,0], [101,1], [100,1],[100,0]
        ]]
      },
      "properties" : {
        "id" : 14309503161236,
        "date" : "2014-11-20",
        "name" : "Test 1",
        "self" : "https://strabospot.org/db/feature/1240"
      },
      "type" : "Feature"
    },
    {
      "geometry" : {
        "type" : "Polygon",
        "coordinates" : [[
      [100,0], [101,0], [101,1], [100,1],[100,0]
        ]]
      },
      "properties" : {
        "id" : 14309503161237,
        "date" : "2014-11-20",
        "name" : "Test Poly",
        "self" : "https://strabospot.org/db/feature/1239"
      },
      "type" : "Feature"
    }

  ]
}

Get all Fields that are populated for Given Dataset

Example request
  • GET: https://www.strabospot.org/db/datasetFields/123456
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
[
  "id",
  "self",
  "name",
  "date",
  "time",
  "modified_timestamp",
  "strike",
  "dip_direction",
  "dip",
  "facing",
  "label",
  "trend",
  "plunge",
  "rake",
  "rake_calculated"
]
  • Optional: An optional point/line/polygon can be added to this request to limit the output to a specific feature type, e.g.,
    https://www.strabospot.org/db/datasetFields/123456/point
    or
    https://www.strabospot.org/db/datasetFields/123456/polygon

Delete All Spots for Given Dataset (removes linking, but spots remain intact)

Example request
  • DELETE: https://strabospot.org/db/datasetSpots/123456
  • Accept: application/json; charset=UTF-8
Example response
  • 204: No Content

Create Project

Example request
  • POST: https://strabospot.org/db/project
  • Accept: application/json; charset=UTF-8 
{
  "id": 14573774551234,
  "date": "03/08/2016",
  "modified_timestamp": 1457377455,
  "description": {
    "project_name": "My Project Name",
    "start_date": "startdate",
    "end_date": "enddate",
    "purpose_of_study": "purposeofstudy",
    "other_team_members": "otherteammembers",
    "area_of_interest": "areaofinterest",
    "spot_prefix": "spotprefixlabel",
    "starting_number_for_spot": "startingnumberforspots",
    "sample_prefix": "sampleprefixlabel",
    "instruments": "instrumentsused",
    "gps_datum": "gpsdatum",
    "magnetic_declination": "magneticdeclination",
    "Notes": "notes"
  },
  "daily_setup": {
    "foo": "foo"
  },
  "rock_units": [
    {
      "unit_label_abbreviation": "unitlabel",
      "map_unit_name": "unitorformationname",
      "member_name": "membername",
      "submember_name": "submembername",
      "absolute_age_of_geologic_unit": "absoluteageofgeologicunit",
      "age_uncertainty": "ageuncertainty",
      "group_unit_type": "groupunittype",
      "rock_type": "rocktype",
      "sediment_type": "sedimenttype",
      "other_sediment_type": "othersedimenttype",
      "sedimentary_rock_type": "sedimentaryrocktype",
      "igneous_rock_class": "igneousrockclass",
      "volcanic_rock_type": "volcanicrocktype",
      "other_volcanic_rock_type": "othervolcanicrocktype",
      "plutonic_rock_types": "plutonicrocktypes",
      "other_plutonic_rock_type": "otherplutonicrocktypes",
      "metamorphic_rock_types": "metamorphicrocktypes",
      "other_metamorphic_rock_type": "othermetamorphicrocktype",
      "group_geologic_age": "groupgeologicage",
      "epoch": "epoch",
      "other_epoch": "otherepoch",
      "period": "period",
      "era": "era",
      "eon": "eon",
      "age_modifier": "agemodifier",
      "description": "description",
      "Notes": "notes"
    },
    {
      "unit_label_abbreviation": "unitlabel",
      "map_unit_name": "unitorformationname",
      "member_name": "membername",
      "submember_name": "submembername",
      "absolute_age_of_geologic_unit": "absoluteageofgeologicunit",
      "age_uncertainty": "ageuncertainty",
      "group_unit_type": "groupunittype",
      "rock_type": "rocktype",
      "sediment_type": "sedimenttype",
      "other_sediment_type": "othersedimenttype",
      "sedimentary_rock_type": "sedimentaryrocktype",
      "igneous_rock_class": "igneousrockclass",
      "volcanic_rock_type": "volcanicrocktype",
      "other_volcanic_rock_type": "othervolcanicrocktype",
      "plutonic_rock_types": "plutonicrocktypes",
      "other_plutonic_rock_type": "otherplutonicrocktypes",
      "metamorphic_rock_types": "metamorphicrocktypes",
      "other_metamorphic_rock_type": "othermetamorphicrocktype",
      "group_geologic_age": "groupgeologicage",
      "epoch": "epoch",
      "other_epoch": "otherepoch",
      "period": "period",
      "era": "era",
      "eon": "eon",
      "age_modifier": "agemodifier",
      "description": "description",
      "Notes": "notes"
    }
  ],
  "preferences": {
    "orientation": false,
    "_3dstructures": false,
    "images": false,
    "sample": false,
    "inferences": false,
    "nesting": false,
    "right_hand_rule": false,
    "drop_down_to_finish": false,
    "student_mode": false
  }
}
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8 
{
  "description": {
    "project_name": "My Project Name",
    "start_date": "startdate",
    "end_date": "enddate",
    "purpose_of_study": "purposeofstudy",
    "other_team_members": "otherteammembers",
    "area_of_interest": "areaofinterest",
    "spot_prefix": "spotprefixlabel",
    "starting_number_for_spot": "startingnumberforspots",
    "sample_prefix": "sampleprefixlabel",
    "instruments": "instrumentsused",
    "gps_datum": "gpsdatum",
    "magnetic_declination": "magneticdeclination",
    "Notes": "notes"
  },
  "daily_setup": {
    "foo": "foo"
  },
  "rock_units": [
    {
      "unit_label_abbreviation": "unitlabel",
      "map_unit_name": "unitorformationname",
      "member_name": "membername",
      "submember_name": "submembername",
      "absolute_age_of_geologic_unit": "absoluteageofgeologicunit",
      "age_uncertainty": "ageuncertainty",
      "group_unit_type": "groupunittype",
      "rock_type": "rocktype",
      "sediment_type": "sedimenttype",
      "other_sediment_type": "othersedimenttype",
      "sedimentary_rock_type": "sedimentaryrocktype",
      "igneous_rock_class": "igneousrockclass",
      "volcanic_rock_type": "volcanicrocktype",
      "other_volcanic_rock_type": "othervolcanicrocktype",
      "plutonic_rock_types": "plutonicrocktypes",
      "other_plutonic_rock_type": "otherplutonicrocktypes",
      "metamorphic_rock_types": "metamorphicrocktypes",
      "other_metamorphic_rock_type": "othermetamorphicrocktype",
      "group_geologic_age": "groupgeologicage",
      "epoch": "epoch",
      "other_epoch": "otherepoch",
      "period": "period",
      "era": "era",
      "eon": "eon",
      "age_modifier": "agemodifier",
      "description": "description",
      "Notes": "notes"
    },
    {
      "unit_label_abbreviation": "unitlabel",
      "map_unit_name": "unitorformationname",
      "member_name": "membername",
      "submember_name": "submembername",
      "absolute_age_of_geologic_unit": "absoluteageofgeologicunit",
      "age_uncertainty": "ageuncertainty",
      "group_unit_type": "groupunittype",
      "rock_type": "rocktype",
      "sediment_type": "sedimenttype",
      "other_sediment_type": "othersedimenttype",
      "sedimentary_rock_type": "sedimentaryrocktype",
      "igneous_rock_class": "igneousrockclass",
      "volcanic_rock_type": "volcanicrocktype",
      "other_volcanic_rock_type": "othervolcanicrocktype",
      "plutonic_rock_types": "plutonicrocktypes",
      "other_plutonic_rock_type": "otherplutonicrocktypes",
      "metamorphic_rock_types": "metamorphicrocktypes",
      "other_metamorphic_rock_type": "othermetamorphicrocktype",
      "group_geologic_age": "groupgeologicage",
      "epoch": "epoch",
      "other_epoch": "otherepoch",
      "period": "period",
      "era": "era",
      "eon": "eon",
      "age_modifier": "agemodifier",
      "description": "description",
      "Notes": "notes"
    }
  ],
  "preferences": {
    "orientation": false,
    "_3dstructures": false,
    "images": false,
    "sample": false,
    "inferences": false,
    "nesting": false,
    "right_hand_rule": false,
    "drop_down_to_finish": false,
    "student_mode": false
  },
  "projecttype": "app",
  "self": "https://strabospot.org/db/project/14573774551234",
  "id": 14573774551234,
  "date": "03/08/2016",
  "modified_timestamp": 1457377455
}

Update Project

Example request
  • POST: https://strabospot.org/db/project/14573774551234
  • Accept: application/json; charset=UTF-8
  • Warning: All attributes will be overwritten with provided JSON values. 
{
  "description": {
    "project_name": "My New Project Name",
    "start_date": "startdate",
    "end_date": "enddate",
    "purpose_of_study": "purposeofstudy",
    "other_team_members": "otherteammembers",
    "area_of_interest": "areaofinterest",
    "spot_prefix": "spotprefixlabel",
    "starting_number_for_spot": "startingnumberforspots",
    "sample_prefix": "sampleprefixlabel",
    "instruments": "instrumentsused",
    "gps_datum": "gpsdatum",
    "magnetic_declination": "magneticdeclination",
    "Notes": "notes"
  },
  "daily_setup": {
    "foo": "foo"
  },
  "rock_units": [
    {
      "unit_label_abbreviation": "unitlabel",
      "map_unit_name": "unitorformationname",
      "member_name": "membername",
      "submember_name": "submembername",
      "absolute_age_of_geologic_unit": "absoluteageofgeologicunit",
      "age_uncertainty": "ageuncertainty",
      "group_unit_type": "groupunittype",
      "rock_type": "rocktype",
      "sediment_type": "sedimenttype",
      "other_sediment_type": "othersedimenttype",
      "sedimentary_rock_type": "sedimentaryrocktype",
      "igneous_rock_class": "igneousrockclass",
      "volcanic_rock_type": "volcanicrocktype",
      "other_volcanic_rock_type": "othervolcanicrocktype",
      "plutonic_rock_types": "plutonicrocktypes",
      "other_plutonic_rock_type": "otherplutonicrocktypes",
      "metamorphic_rock_types": "metamorphicrocktypes",
      "other_metamorphic_rock_type": "othermetamorphicrocktype",
      "group_geologic_age": "groupgeologicage",
      "epoch": "epoch",
      "other_epoch": "otherepoch",
      "period": "period",
      "era": "era",
      "eon": "eon",
      "age_modifier": "agemodifier",
      "description": "description",
      "Notes": "notes"
    },
    {
      "unit_label_abbreviation": "unitlabel",
      "map_unit_name": "unitorformationname",
      "member_name": "membername",
      "submember_name": "submembername",
      "absolute_age_of_geologic_unit": "absoluteageofgeologicunit",
      "age_uncertainty": "ageuncertainty",
      "group_unit_type": "groupunittype",
      "rock_type": "rocktype",
      "sediment_type": "sedimenttype",
      "other_sediment_type": "othersedimenttype",
      "sedimentary_rock_type": "sedimentaryrocktype",
      "igneous_rock_class": "igneousrockclass",
      "volcanic_rock_type": "volcanicrocktype",
      "other_volcanic_rock_type": "othervolcanicrocktype",
      "plutonic_rock_types": "plutonicrocktypes",
      "other_plutonic_rock_type": "otherplutonicrocktypes",
      "metamorphic_rock_types": "metamorphicrocktypes",
      "other_metamorphic_rock_type": "othermetamorphicrocktype",
      "group_geologic_age": "groupgeologicage",
      "epoch": "epoch",
      "other_epoch": "otherepoch",
      "period": "period",
      "era": "era",
      "eon": "eon",
      "age_modifier": "agemodifier",
      "description": "description",
      "Notes": "notes"
    }
  ],
  "preferences": {
    "orientation": false,
    "_3dstructures": false,
    "images": false,
    "sample": false,
    "inferences": false,
    "nesting": false,
    "right_hand_rule": false,
    "drop_down_to_finish": false,
    "student_mode": false
  },
  "modified_timestamp": 1457377455
}
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8 
{
  "description": {
    "project_name": "My New Project Name",
    "start_date": "startdate",
    "end_date": "enddate",
    "purpose_of_study": "purposeofstudy",
    "other_team_members": "otherteammembers",
    "area_of_interest": "areaofinterest",
    "spot_prefix": "spotprefixlabel",
    "starting_number_for_spot": "startingnumberforspots",
    "sample_prefix": "sampleprefixlabel",
    "instruments": "instrumentsused",
    "gps_datum": "gpsdatum",
    "magnetic_declination": "magneticdeclination",
    "Notes": "notes"
  },
  "daily_setup": {
    "foo": "foo"
  },
  "rock_units": [
    {
      "unit_label_abbreviation": "unitlabel",
      "map_unit_name": "unitorformationname",
      "member_name": "membername",
      "submember_name": "submembername",
      "absolute_age_of_geologic_unit": "absoluteageofgeologicunit",
      "age_uncertainty": "ageuncertainty",
      "group_unit_type": "groupunittype",
      "rock_type": "rocktype",
      "sediment_type": "sedimenttype",
      "other_sediment_type": "othersedimenttype",
      "sedimentary_rock_type": "sedimentaryrocktype",
      "igneous_rock_class": "igneousrockclass",
      "volcanic_rock_type": "volcanicrocktype",
      "other_volcanic_rock_type": "othervolcanicrocktype",
      "plutonic_rock_types": "plutonicrocktypes",
      "other_plutonic_rock_type": "otherplutonicrocktypes",
      "metamorphic_rock_types": "metamorphicrocktypes",
      "other_metamorphic_rock_type": "othermetamorphicrocktype",
      "group_geologic_age": "groupgeologicage",
      "epoch": "epoch",
      "other_epoch": "otherepoch",
      "period": "period",
      "era": "era",
      "eon": "eon",
      "age_modifier": "agemodifier",
      "description": "description",
      "Notes": "notes"
    },
    {
      "unit_label_abbreviation": "unitlabel",
      "map_unit_name": "unitorformationname",
      "member_name": "membername",
      "submember_name": "submembername",
      "absolute_age_of_geologic_unit": "absoluteageofgeologicunit",
      "age_uncertainty": "ageuncertainty",
      "group_unit_type": "groupunittype",
      "rock_type": "rocktype",
      "sediment_type": "sedimenttype",
      "other_sediment_type": "othersedimenttype",
      "sedimentary_rock_type": "sedimentaryrocktype",
      "igneous_rock_class": "igneousrockclass",
      "volcanic_rock_type": "volcanicrocktype",
      "other_volcanic_rock_type": "othervolcanicrocktype",
      "plutonic_rock_types": "plutonicrocktypes",
      "other_plutonic_rock_type": "otherplutonicrocktypes",
      "metamorphic_rock_types": "metamorphicrocktypes",
      "other_metamorphic_rock_type": "othermetamorphicrocktype",
      "group_geologic_age": "groupgeologicage",
      "epoch": "epoch",
      "other_epoch": "otherepoch",
      "period": "period",
      "era": "era",
      "eon": "eon",
      "age_modifier": "agemodifier",
      "description": "description",
      "Notes": "notes"
    }
  ],
  "preferences": {
    "orientation": false,
    "_3dstructures": false,
    "images": false,
    "sample": false,
    "inferences": false,
    "nesting": false,
    "right_hand_rule": false,
    "drop_down_to_finish": false,
    "student_mode": false
  },
  "projecttype": "app",
  "self": "https://strabospot.org/db/project/204006",
  "id": 14573774551234,
  "date": "03/08/2016",
  "modified_timestamp": 1457377455
}

Get Project

Example request
  • GET: https://strabospot.org/db/project/14573774551234
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
{
  "description": {
    "project_name": "My Project Name",
    "start_date": "startdate",
    "end_date": "enddate",
    "purpose_of_study": "purposeofstudy",
    "other_team_members": "otherteammembers",
    "area_of_interest": "areaofinterest",
    "spot_prefix": "spotprefixlabel",
    "starting_number_for_spot": "startingnumberforspots",
    "sample_prefix": "sampleprefixlabel",
    "instruments": "instrumentsused",
    "gps_datum": "gpsdatum",
    "magnetic_declination": "magneticdeclination",
    "Notes": "notes"
  },
  "daily_setup": {
    "foo": "foo"
  },
  "rock_units": [
    {
      "unit_label_abbreviation": "unitlabel",
      "map_unit_name": "unitorformationname",
      "member_name": "membername",
      "submember_name": "submembername",
      "absolute_age_of_geologic_unit": "absoluteageofgeologicunit",
      "age_uncertainty": "ageuncertainty",
      "group_unit_type": "groupunittype",
      "rock_type": "rocktype",
      "sediment_type": "sedimenttype",
      "other_sediment_type": "othersedimenttype",
      "sedimentary_rock_type": "sedimentaryrocktype",
      "igneous_rock_class": "igneousrockclass",
      "volcanic_rock_type": "volcanicrocktype",
      "other_volcanic_rock_type": "othervolcanicrocktype",
      "plutonic_rock_types": "plutonicrocktypes",
      "other_plutonic_rock_type": "otherplutonicrocktypes",
      "metamorphic_rock_types": "metamorphicrocktypes",
      "other_metamorphic_rock_type": "othermetamorphicrocktype",
      "group_geologic_age": "groupgeologicage",
      "epoch": "epoch",
      "other_epoch": "otherepoch",
      "period": "period",
      "era": "era",
      "eon": "eon",
      "age_modifier": "agemodifier",
      "description": "description",
      "Notes": "notes"
    },
    {
      "unit_label_abbreviation": "unitlabel",
      "map_unit_name": "unitorformationname",
      "member_name": "membername",
      "submember_name": "submembername",
      "absolute_age_of_geologic_unit": "absoluteageofgeologicunit",
      "age_uncertainty": "ageuncertainty",
      "group_unit_type": "groupunittype",
      "rock_type": "rocktype",
      "sediment_type": "sedimenttype",
      "other_sediment_type": "othersedimenttype",
      "sedimentary_rock_type": "sedimentaryrocktype",
      "igneous_rock_class": "igneousrockclass",
      "volcanic_rock_type": "volcanicrocktype",
      "other_volcanic_rock_type": "othervolcanicrocktype",
      "plutonic_rock_types": "plutonicrocktypes",
      "other_plutonic_rock_type": "otherplutonicrocktypes",
      "metamorphic_rock_types": "metamorphicrocktypes",
      "other_metamorphic_rock_type": "othermetamorphicrocktype",
      "group_geologic_age": "groupgeologicage",
      "epoch": "epoch",
      "other_epoch": "otherepoch",
      "period": "period",
      "era": "era",
      "eon": "eon",
      "age_modifier": "agemodifier",
      "description": "description",
      "Notes": "notes"
    }
  ],
  "preferences": {
    "orientation": false,
    "_3dstructures": false,
    "images": false,
    "sample": false,
    "inferences": false,
    "nesting": false,
    "right_hand_rule": false,
    "drop_down_to_finish": false,
    "student_mode": false
  },
  "projecttype": "app",
  "self": "https://strabospot.org/db/project/14573774551234",
  "id": 14573774551234,
  "date": "03/08/2016",
  "modified_timestamp": 1457377455
}

Delete Project (also deletes datasets)

Example request
  • DELETE: https://strabospot.org/db/project/123456
  • Accept: application/json; charset=UTF-8
Example response
  • 204: No Content

Get My Projects (Return all projects of authorized user)

Example request
  • GET: https://www.strabospot.org/db/myProjects
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
{
  "projects": [
    {
      "projecttype": "app",
      "name": "My Project Name",
      "self": "https://strabospot.org/db/project/14573774551234",
      "id": 14573774551234,
	  "date": "03/08/2016",
	  "modified_timestamp": 1457377455
    },
    {
      "projecttype": "app",
      "name": "new project name",
      "self": "https://strabospot.org/db/project/14573774551235",
      "id": 14573774551235,
	  "date": "03/08/2016",
	  "modified_timestamp": 1457377455
    }
  ]
}

Add Dataset to Project

Example request
  • POST: https://strabospot.org/db/projectDatasets/123456
  • Where: 123456 is the project id.
  • Accept: application/json; charset=UTF-8 
{
	"id":654321
}
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8 
{
  "message" : "Dataset 654321 added to Project 123456."
}

Get all Datasets for Given Project

Example request
  • GET: https://www.strabospot.org/db/projectDatasets/123456
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
{
  "datasets": [
    {
      "datasettype": "app",
      "name": "My Dataset Name",
      "self": "https://strabospot.org/db/dataset/14573774551234",
      "id": 14573774551234,
	  "date": "03/08/2016",
	  "modified_timestamp": 1457377455
    },
    {
      "datasettype": "app",
      "name": "My New Dataset Name",
      "self": "https://strabospot.org/db/dataset/14573774551235",
      "id": 14573774551235,
	  "date": "03/08/2016",
	  "modified_timestamp": 1457377455
    },
    {
      "datasettype": "app",
      "name": "Another Dataset Name",
      "self": "https://strabospot.org/db/dataset/14573774551236",
      "id": 14573774551236,
	  "date": "03/08/2016",
	  "modified_timestamp": 1457377455
    }
  ]
}

Delete All Datasets for Given Project (removes linking, but datasets remain intact)

Example request
  • DELETE: https://strabospot.org/db/projectDatasets/123456
  • Accept: application/json; charset=UTF-8
Example response
  • 204: No Content

Get all Images for Given Project

Example request
  • GET: https://www.strabospot.org/db/projectImages/123456
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
{
  "images": [
    {
      "id": 14761235708763,
      "modified_timestamp": 1476123123
    },
    {
      "id": 14761235603555,
      "modified_timestamp": 1476123134
    },
    {
      "id": 14759541269574,
      "modified_timestamp": 1476123234
    },
    {
      "id": 14759526677778,
      "modified_timestamp": 1476123345
    },
    {
      "id": 14759532056864,
      "modified_timestamp": 1476123456
    }
  ]
}

Create Profile

Example request
  • POST: https://strabospot.org/db/profile
  • Accept: application/json; charset=UTF-8
  • Note: "name" parameter is not accepted, as this information is gathered from the credentials table 
{
  "mapbox_access_token": "lkajsdflkj"
}
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8 
{
  "name": "John Doe",
  "mapbox_access_token": "lkajsdflkj"
}

Update Profile

Example request
  • POST: https://strabospot.org/db/profile
  • Accept: application/json; charset=UTF-8
  • Note: "name" parameter is not accepted, as this information is gathered from the credentials table
  • Warning: All attributes will be overwritten with provided JSON values. 
{
  "mapbox_access_token": "lkajsdflkj"
}
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8 
{
  "name": "John Doe",
  "mapbox_access_token": "lkajsdflkj"
}

Get Profile

Example request
  • GET: https://strabospot.org/db/profile
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: application/json; charset=UTF-8 
{
  "name": "John Doe",
  "mapbox_access_token": "lkajsdflkj"
}

Delete Profile (doesn't delete name)

Example request
  • DELETE: https://strabospot.org/db/profile
  • Accept: application/json; charset=UTF-8
Example response
  • 204: No Content

Upload Profile Image

Example request
  • POST: https://strabospot.org/db/profileimage
  • Accept: application/json; charset=UTF-8 
This service accepts the following POST variable:

Variable Name: "image_file" - File containing image to be uploaded. (required)

Also, please note the the encapsulation type MUST be set to "multipart/form-data".
Example response
  • 201: Created
  • Content-Type: application/json; charset=UTF-8
Note: Due to the complexity of using multipart/form-data, a test page has been created to test this service.
This page can be found at: https://strabospot.org/profileimageupload.

Get Profile Image

Example request
  • GET: https://strabospot.org/db/profileimage
  • Accept: application/json; charset=UTF-8
Example response
  • 200: OK
  • Content-Type: image/jpg 
File content of image is returned.

Delete Profile Image

Example request
  • DELETE: https://strabospot.org/db/profileimage
  • Accept: application/json; charset=UTF-8
Example response
  • 204: No Content
  • Content-Type: application/json; charset=UTF-8 
{
  "message": "Profile image deleted."
}
Funded by the National Science Foundation    |    Maps provided by Mapbox    |    EarthCube Partner