Volcview API Documentation - IMAGE API

GET METHODS

Select specified number of most recent images.
https://volcview.wr.usgs.gov/vv-api/imageApi/recent/20

Select 10 most recent images.
https://volcview.wr.usgs.gov/vv-api/imageApi/recent

Select image.
https://volcview.wr.usgs.gov/vv-api/imageApi/image?fileName=FILE_NAME§or=SECTOR&band=BAND&dataType=DATA_TYPE

Select newest image in each sector, data type and band group.
https://volcview.wr.usgs.gov/vv-api/imageApi/newest

Select image stats for GUI based on sector and GUI generated option pairs.
https://volcview.wr.usgs.gov/vv-api/imageApi/timeWindow?sectorId=SECTOR_ID&optionPairs=BAND_ID|DATA_TYPE_ID,BAND_ID|DATA_TYPE_ID,...

Select images for GUI based on sector and GUI generated option pairs, sort = 'oldest' or 'newest'.
https://volcview.wr.usgs.gov/vv-api/imageApi/images?sectorId=1530&optionPairs=341|345,342|345,343|345,340|348,341|348,342|348,343|348,340|349,341|349,342|349,343|349&startDate=02/27/2019 00:00&endDate=03/02/2019 00:00&imageLimit=100&sort=newest

ADD IMAGE

curl -i --header "username:USERNAME" --header "password:PASSWORD" -X POST -F "sector=SECTOR" -F "band=BAND" -F "dataType=DATATYPE" -F "imageUnixtime=1551305700" -F "file=@/local/path/to/image.jpg" https://volcview.wr.usgs.gov/vv-api/imageApi/uploadImage

Notes: Image file name is unique in the database for sector, band and data type combinations. Uploading an existing file name will simply replace the old image with the new one within the matching combination of values.

DELETE IMAGE

curl -i --header "username:USERNAME" --header "password:PASSWORD" -X DELETE http://local-volcview.wr.usgs.gov/vv-api/imageApi/image/SECTOR/BAND/DATA_TYPE/FILE_NAME

CREATE CASE STUDY TODO - document

curl -i --header "username:USERNAME" --header "password:PASSWORD" -X POST -d "{jsonFormattedData}" https://volcview.wr.usgs.gov/vv-api/imageApi/caseStudy

GET CASE STUDY STATUS TODO - document

curl -i --header "username:USERNAME" --header "password:PASSWORD" -X GET https://volcview.wr.usgs.gov/vv-api/imageApi/caseStudyStatus