M

ARF Core Database

Florida State University Antarctic Research Facility

Web Services API

The ARF Web Services API provides programmatic access to our collecitons through a REST web servcies API.

The API is:

  • public
  • read-only
  • rate-limited to 60 requests per minute

Overview

Base URL

All URLs referenced in the documentation have the following base:

http://arf.fsu.edu/coresdb/

Representations

The ARF API relies on the HTTP Accept header (reference) in order to determine which representation to deliver.

For example, if you wish to retrieve records in JSONAPI format (recommended), your request should look similar to the following:

GET http://arf.fsu.edu/coresdb/cores HTTP/1.1
Accept: application/vnd.api+json

This minimal example will return records in JSONAPI format.

Supported representations

MIME Type Description
application/vnd.api+json JSONAPI format. This is the most complete data format.
application/json Basic record information encoded in JSON format
text/csv Basic record information encoded in Spreadsheet (CSV) format
text/html HTML interface representation through this website

Resources

Cores

The cores endpoint allows you to browse and search core records. These include cores, core-halves, and core sections.

Index

http://arf.fsu.edu/coresdb/cores

Returns a list of cores.

Parameters:

Parameter Type Filterable Description
limit integer No Specify a limit for the number of records to retrieve
page integer No Specify a page number (starting at 1)
lat decimal range Yes Latitude range (min:max), or (:max), or (:min), or exact value
lon decimal range Yes Longitude range (same syntax as latitude)
cruise string Yes Cruise numbers (comma separated)
method string Yes Core methods (comma separated)
igsn string Yes IGSNs (comma separated)
number string Yes Core name/number
hasimages boolean No Whether or not there are images available in the core

Examples:

# Return IGSNs ARF000001, ARF000002, ARF0000NX
http://arf.fsu.edu/coresdb/cores?igsn=ARF000001,ARF000002,ARF0000W2

# Return all cores between Latitude and Longitude values
http://arf.fsu.edu/coresdb/cores?lat=-51.57:-70.56&lon=-134.77:58.47

Single Core Details

http://arf.fsu.edu/coresdb/cores/{IGSN}

Returns details for a single core. This includes:

  • Core metadata
  • Subcores
  • MSCL data
  • Links for core section images
  • Associated core metadata

Viewing core images

http://arf.fsu.edu/coresdb/images/{IMAGE_ID}

Core section images are available for those cores where image data is available in BMP (original) and JPEG (compressed/shrunk) formats.

Image URLs are available as part of the included data for individual cores records.

Parameters:

Parameter Type Description
full boolean Include full=true in the request to retrieve the full BMP format; otherwise the JPEG compressed version is returned

Cruises

http://arf.fsu.edu/coresdb/cruises

Returns a list of cruises.

Parameters:

Parameter Type Filterable Description
limit integer No Specify a limit for the number of records to retrieve
page integer No Specify a page number (starting at 1)
number string Yes Ship number (e.g. 10)
abbr string Yes Ship abbreviation (e.g. "elt-20")
ship string Yes Ship name (e.g. "Eltanin")
year integer range Yes Cruise year range (min:max), or (:max), or (:min), or exact value
hascores boolean No Whether or not there are cores associated with this cruise

Cruise details

http://arf.fsu.edu/coresdb/cruises/{abbr}

Returns details for a single cruise.

Information included:

  • Cruise abbreviation
  • Link to cores for this cruise
  • Number of cores
  • Ship name (if available)
  • Cruise year (if available)
  • Link to PDF (if available)

The cruise abbreviation (abbr) is the abbreviation for the cruise in our system (e.g. NBP01-01)

Downloading cruise report PDFs

http://arf.fsu.edu/coresdb/cruisereports/{abbr}

Downloads a Cruise Report PDF. Note, this URL will always return content with the content type "application/pdf", regardless of what was requested in the Accept header.

Core methods

http://arf.fsu.edu/coresdb/methods

Returns a list of core extraction methods used for cores in the database.

Parameters:

Parameter Type Filterable Description
limit integer No Specify a limit for the number of records to retrieve
page integer No Specify a page number (starting at 1)
abbr string Yes method abbreviation (e.g. "JKC")
name string Yes Method name (e.g. "Jumbo Kasten Core")
hascores boolean No Whether or not there are cores associated with this method

Pagination and limits are not overly useful for the Core Methods endpoint, since there will never be more than handful of records.