Skip to content

URL routes (development)

Jump to bottom
Joe Futrelle edited this page Aug 2, 2019 · 10 revisions

Proposed URL routes

Timeline mode

endpoint: /timeline

params:

  • dataset = name of dataset
  • tags = comma-delimited list of tag names (case insensitive)
  • bin = id of bin
  • instrument = instrument number

All parameters optional.

Specifying a bin shows the timeline with that bin selected.

Specifying a combination of query parameters that result in a zero-length timeline should result in a message that no bins match the criteria.

Bin mode

endpoint: /bin

params:

  • bin = id of bin (required)
  • dataset = dataset name (optional)

Specifying a dataset modifies the breadcrumbs so that you can get to timeline mode showing the dataset with the bin selected.

(Navigating to a tag timeline would be done by clicking on a displayed tag)

(Navigating to an instrument timeline would be done by clicking on the instrument name e.g., IFCB12)

Image mode

endpoint: /image

params:

  • bin = id of bin (required)
  • image = ROI number (required)
  • dataset = dataset name (optional)
  • instrument = instrument number (optional)

Specifying a dataset modifies the breadcrumbs so that navigating back to the bin goes to /bin?bin=xxx&dataset=yyy; same thing with instrument.

Legacy routes

Pages with UI

All work with old-style IFCB... bin IDs and new-style D... bin IDs

Legacy New
/mvco /timeline?dataset=mvco
/mvco/dashboard/http://ifcb-data.whoi.edu/mvco/IFCB1_2012_167_214238 /timeline?dataset=mvco&bin=IFCB1_2012_167_214238
/mvco:tag1:tag2 /timeline?dataset=mvco&tags=tag1,tag2
/mvco/D20190101T123456_IFCB010.html /bin?bin=D20190101T123456_IFCB010&dataset=mvco
/mvco/IFCB1_2012_167_214238_01963.html /image?bin=IFCB1_2012_167_214238&image=1963&dataset=mvco

Direct access in various formats

The /data endpoint accepts what look like filenames and provides access to that data with the correct MIME type. These look more like legacy URLs so that downloading the file will result in a reasonable filename.

Legacy New Supported params
/mvco/IFCB5_2017_165_123456.adc /data/IFCB5_2017_165_123456.adc extensions: adc, hdr, roi, zip, csv
/mvco/IFCB5_2017_165_123456_01234.png /data/IFCB5_2017_165_123456_01234.png extensions: png, jpg
/mvco/D20190101T123456_IFCB010_features.csv /data/D20190101T123456_IFCB010_features.csv products: features, blobs, class_scores
Clone this wiki locally