Versions Compared

Old Version 36

changes.mady.by.user Kenny Lo

Saved on

compared with

New Version Current

changes.mady.by.user Kenny Lo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page documents ImageServ v1 API that aims to be compliant with supporting essential VO interfaces, specifically DALI 1.1 and SODA 1.1.  The formal specification for ImageServ API v1

is written per JSON Schema Specification. The following table is one equivalent URL representation of the ImageServ v0 examples:

#APIDescriptionParametersReturn ValueExample
VO_1[NEW]GET /api/image/v1/availabilityGet the current status on the availability including supported API versions of this service.

Return the current list of image repositories and their access URLs available.

{ 
    "Status": "imageREST_v1 is accepting queries.",
    "available": "true"
}
VO_2[NEW]GET /api/image/v1/capabilitiesGet the image repositories available on this service.

{
    "availability": {
         "url": "image/v1/availability"
     },     
     "query": {
         "url": "image/v1/DC_W13_Stripe82",
         "interface": ["DAX"]
    },
    "capabilities": {
         "url": "image/v1/capabilities"
    }
}






I_1

GET /api/image/v1/<db id>?ds=raw&ra=<%f>&dec=<%f>&filter=<%c>Get raw full image closest to RA/Dec.

filter: g, i, r, u, z

FITS image
GET /api/image/v1/DC_W13_Stripe82?ds=raw&ra=359.195&dec=-0.1055&filter=r
I_2GET /api/image/v1/<db id>?ds=raw&run=<%d>&camcol=<%d>&field=<%d>&filter=<%c>Get raw full image by DM Butler DataId.filter: g, i, r, u, zFITS imageGET /api/image/v1/DC_W13_Stripe82?ds=raw&run=5646&camcol=4&field=694&filter=g
I_3GET /api/image/v1/<db id>?ds=raw&sid=<%d>Get raw full image by ScienceId.
FITS imageGET /api/image/v1/DC_W13_Stripe82?ds=raw&sid=3325410171
I_4GET /api/image/v1/<db id>?ds=raw&ra=<%f>&dec=<%f>&filter=<%c>&width=<%f>&height=<%f>&unit=arcsecGet raw cutout image at RA/Dec with dimensions in arcsec.
FITS image

GET /api/image/v1/DC_W13_Strip82?ds=raw&ra=359.195&dec=-0.1055&filter=r&width=30.0&height=45.0&unit=arcsec

I_5GET /api/image/v1/<db id>?ds=raw&ra=<%f>&dec=<%f>&filter=<%c>&width=<%f>&height=<%f>&unit=pixelGet raw cutout image at RA/Dec with dimensions in pixel.filter: g, i, r, u, zFITS imageGET /api/image/v1/DC_W13_Stripe82?ds=raw&ra=359.195&dec=-0.1055&filter=r&width=30&height=45&unit=pixel
I_6GET /api/image/v1/<db id>?ds=calexp?ra=<%f>&dec=<%f>&filter=<%c>Get calexp full image at RA/Dec.filter: g, i, r, u, z

FITS image

GET /api/image/v1/DC_W13_Stripe82?ds=calexp&ra=37.644598&dec=0.104625&filter=r
I_7GET /api/image/v1/<db id>?ds=calexp?run=<%d>&camcol=<%d>&field=<%d>&filter=<%c>Get calexp full image at RA/Dec by DM Butler DataId.filter: g, i, r, u, zFITS imageGET /api/image/v1/DC_W13_Stripe82?ds=calexp&run=5646&camcol=4&field=694&filter=g
I_8GET /api/image/v1/<db id>?ds=calexp&sid=<%d>Get calexp full image by ScienceId.
FITS imageGET /api/image/v1/DC_W13_Stripe82?ds=calexp&sid=3325410171
I_9GET /api/image/v1/<db id>?ds=calexp&ra=<%f>&dec=<%f>&filter=<%c>&width=<%f>&height=<%f>&unit="arcsec"Get calexp cutout image with dimensions in arcsec.filter: g, i, r, u, zFITS imageGET /api/image/v1/DC_W13_Stripe82?ds=calexp&ra=37.644598&dec=0.104625&filter=r&width=30.0&height=45.0&unit=arcsec
I_10GET /api/image/v1/<db id>?ds=calexp?ra=<%f>&dec=<%f>&filter=<%c>&width=<%f>&height=<%f>&unit=pixelGet calexp cutout image with dimensions in pixel.filter: g, i, r, u, zFITS imageGET /api/image/v1/DC_W13_Stripe82?ds=calexp&ra=37.644598&dec=0.104625&filter=r&width=100&height=100&unit=pixel
I11GET /api/image/v1/<db id>?ds=calexp?sid=<%d>&ra=<%f>&dec=<%f>&width=<%f>&height=<%f>&unit=arcsecGet calexp cutout image by ScienceID with dimensions in arcsec.
FITS imageGET /api/image/v1/DC_W13_Stripe82?ds=calexp&sid=5646240694&ra=37.6292&dec=0.104625&width=30.0&height=45.0&unit=arcsec
I12GET /api/image/v1/DC_W13_Stripe82?ds=calexp&sid=<%d>&ra=<%f>&dec=<%f>&width=<%d>&height=<%d>&unit=pixelGet calexp cutout image by ScienceId with dimensions in pixel.
FITS imageGET /api/image/v1/DC_W13_Stripe82?ds=calexp&sid=5646240694&ra=37.6292&dec=0.104625&width=100&height=100&unit=pixel
I_13GET /image/v1/<db id>?ds=deepcoadd&ra=<%f>&dec=<%f>&filter=<%c>Get deepcoadd full image closest to RA/Dec.filter: g, i, r, u, zFITS imageGET /api/image/v1/DC_W13_Stripe82?ds=deepcoadd&ra=19.37995&dec=-0.3146&filter=r
I_14GET /api/image/v1/<db id>?ds=deepCoadd&tract=<%d>&patch=<%d>,<%d>&filter=<%c>Get deepcoadd full image by DM Butler DataId.
FITS imageGET /api/image/v1/DC_W13_Stripe82?ds=deepcoadd&tract=0&patch=225,1&filter=i
I_15GET /api/image/v1/<db id>?ds=deepcoadd&sid=<%d>Get deepcoadd full image by ScienceId.
FITS imageGET /api/image/v1/DC_W13_Stripe82?ds=deepcoadd&sid=23986176
I_16GET /api/image/v1/<db id>?ds=deepcoadd&ra=<%f>&dec=<%f>&filter=<%c>&width=<%f>&height=<%f>&unit=arcsecGet deepcoadd cutout image at RA/Dec with dimensions in arcsec.filter: g, i, r, u, zFITS imageGET /api/image/v1/DC_W13_Stripe82?ds=deepcoadd&ra=19.36995&dec=-0.3147&filter=r&width=115&height=235&unit=arcsec
I_17GET /api/image/v1/<db id>?ds=deepcoadd&ra=<%f>&dec=<%f>&filter=<%c>&width=<%f>&height=<%f>&unit=pixelGet deepcoadd cutout image at RA/Dec with dimensions in pixel.filter: g, i, r, u, zFITS imageGET /api/image/v1/DC_W13_Stripe82?ds=deepcoadd&ra=19.36995&dec=-0.3147&filter=r&width=115&height=235&unit=pixel
I18GET /api/image/v1/<db id>?ds=raw&sid=<%d>&ra=<%f>&dec=<%f>&width=<%d>&height=<%d>&unit=arcsecGet raw cutout image by ScienceID at RA/Dec with dimensions in arcsec.
FITS imageGET /image/v1/DC_W13_Stripe82?ds=raw&sid=5646240694&ra=37.6292&dec=0.104625&width=30.0&height=45.0&unit=arcsec
I19GET /api/image/v1/<db id>?ds=raw&sid=<%d>&ra=<%f>&dec=<%f>&width=&height=&unit=pixelGet raw cutout image by ScienceID at RA/Dec with dimensions in pixel.
FITS imageGET /api/image/v1/DC_W13_Stripe82?ds=raw&sid=5646240694&ra=37.6292&dec=0.104625&width=100&height=100&unit=pixel
I20GET /api/image/v1/<db id>?ds=deepcoadd&sid=<%d>&ra=<%f>&dec=<%f>&width=<%f>&height=<%f>Get deepcoadd cutout image at RA/Dec with dimensions in arcsec
FITS imageGET /api/image/v1/DC_W13_Stripe82?ds=deepcoadd&sid=23986176&ra=9.47103&dec=-1.181766&width=30.0&height=45.0&unit=arcsec
I21GET /api/image/v1/<db id>?ds=deepcoadd&sid=<%d>&ra=<%f>&dec=<%f>&width=<%d>&height=<%d>&unit=pixelGet deepcoadd cutout image at RA/Dec with dimensions in pixel.
FITS imageGET /api/image/v1/DC_W13_Stripe82?ds=deepcoadd&sid=23986176&ra=9.47103&dec=-1.181766&width=100&height=100&unit=pixel
I22[NEW]GET /api/image/v1/<db id>?ds=deepcoadd&tract=<%d>&patch=<%d>,<%d>&filter=<%c>&ra=<%f>&dec=<%f>&width=<%d>&height=<%d>&unit=arcsecGet deepcoadd cutout image of specified DM Butler DataId at RA/Dec and dimensions in arcsec.
FITS imageGET /api/image/v1/DC_W13_Stripe82?ds=deepcoadd&tract=0&patch=225,1&filter=i&ra=40.49055&dec=-0.946593&width=100&height=100&unit=arcsec
Utility API for DevGET /api/image/v1/<db id>?ds=raw&get_dataid&ccdexpid=5646240964Get the data id corresponding to the science id (or science ccd exposure id).
JSONGET /api/image/v1/DC_W13_Stripe82?ds=raw&get_dataid=get&ccdexpid=5646240964
Utility API for DevGET /api/image/v1/<db id>?ds=raw&get_ccdexpid=get&<data id>Get the science id corresponding to the data id.
JSONGET /api/image/v1/DC_W13_Stripe82?ds=raw&get_ccdexpid=get&camcol=4&field=694&filter=r&run=5646