GET
/marvin2/api/cubes/
¶Returns general cube info
Query Parameters: | |
---|---|
|
|
Response JSON Object: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/cubes/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": "this is a cube!"
}
POST
/marvin2/api/cubes/
(name)/
¶Returns the necessary information to instantiate a cube for a given plateifu.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/cubes/8485-1901/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"plateifu": "8485-1901",
"mangaid": "1-209232",
"ra": 232.544703894,
"dec": 48.6902009334,
"header": "XTENSION= 'IMAGE', NAXIS=3, .... END",
"wcs_header": "WCSAXES = 3 / Number of coordindate axes .... END",
"redshift": 0.0407447,
"wavelength": [3621.6, 3622.43,...,10353.8]
}
}
GET
/marvin2/api/cubes/
(name)/
¶Returns the necessary information to instantiate a cube for a given plateifu.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/cubes/8485-1901/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"plateifu": "8485-1901",
"mangaid": "1-209232",
"ra": 232.544703894,
"dec": 48.6902009334,
"header": "XTENSION= 'IMAGE', NAXIS=3, .... END",
"wcs_header": "WCSAXES = 3 / Number of coordindate axes .... END",
"redshift": 0.0407447,
"wavelength": [3621.6, 3622.43,...,10353.8]
}
}
POST
/marvin2/api/cubes/
(name)/extensions/
(cube_extension)/
¶Returns the extension for a cube given a plateifu/mangaid.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/cubes/8485-1901/extensions/flux/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"extension_data": [[0,0,..0], [], ... [0, 0, 0,... 0]]
}
}
GET
/marvin2/api/cubes/
(name)/extensions/
(cube_extension)/
¶Returns the extension for a cube given a plateifu/mangaid.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/cubes/8485-1901/extensions/flux/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"extension_data": [[0,0,..0], [], ... [0, 0, 0,... 0]]
}
}
POST
/marvin2/api/cubes/
(name)/quantities/
(x)/
(y)/
¶Returns a dictionary with all the quantities.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/cubes/8485-1901/quantities/10/12/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"flux": {"value": [0,0,..0], "ivar": ...},
"specres": ...}
}
}
GET
/marvin2/api/cubes/
(name)/quantities/
(x)/
(y)/
¶Returns a dictionary with all the quantities.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/cubes/8485-1901/quantities/10/12/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"flux": {"value": [0,0,..0], "ivar": ...},
"specres": ...}
}
}
GET
/marvin2/api/general/getroutemap/
¶Build the URL route map for all routes in the Flask app.
Syntax of output: {“api”: {blueprint: {endpoint: {‘methods’:x, ‘url’:x} } }
Form Parameters: | |
---|---|
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Raises BrainError: | |
Raised when url_for can’t format the endpoint name into a valid url. |
Example request:
GET /marvin2/api/general/getroutemap/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"urlmap": {"api": {"CubeView:index": {"methods": "HEAD,OPTIONS,GET","url": "/marvin2/api/cubes/"},
...
}
}
}
POST
/marvin2/api/general/mangaid2plateifu/
(mangaid)/
¶Returns a plateifu given a mangaid
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/general/mangaid2plateifu/1-209232/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {8485-1901"}
}
GET
/marvin2/api/general/mangaid2plateifu/
(mangaid)/
¶Returns a plateifu given a mangaid
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/general/mangaid2plateifu/1-209232/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {8485-1901"}
}
POST
/marvin2/api/general/nsa/drpall/
(mangaid)/
¶Returns the NSA data in drpall for a given mangaid.
Note that this always uses the drpver/drpall versions that are default in the server.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/general/nsa/drpall/1-209232/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"camcol": 2,
"elpetro_absmag": [-14.3422, -15.7994,-17.0133, ...],
"elpetro_amivar": [],
...
}
}
GET
/marvin2/api/general/nsa/drpall/
(mangaid)/
¶Returns the NSA data in drpall for a given mangaid.
Note that this always uses the drpver/drpall versions that are default in the server.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/general/nsa/drpall/1-209232/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"camcol": 2,
"elpetro_absmag": [-14.3422, -15.7994,-17.0133, ...],
"elpetro_amivar": [],
...
}
}
POST
/marvin2/api/general/nsa/full/
(mangaid)/
¶Returns the NSA data for a given mangaid from the full catalogue.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/general/nsa/full/1-209232/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"aid": 0,
"asymmetry":[-0.0217, 0.00517, -0.0187, ...],
"bastokes": [[0.7290, 0.9677, ...], [], ...],
...
}
}
GET
/marvin2/api/general/nsa/full/
(mangaid)/
¶Returns the NSA data for a given mangaid from the full catalogue.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/general/nsa/full/1-209232/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"aid": 0,
"asymmetry":[-0.0217, 0.00517, -0.0187, ...],
"bastokes": [[0.7290, 0.9677, ...], [], ...],
...
}
}
GET
/marvin2/api/maps/
¶Returns general maps info
Form Parameters: | |
---|---|
|
|
Response JSON Object: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/maps/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": "this is a maps!"
}
POST
/marvin2/api/maps/
(name)/
¶POST
/marvin2/api/maps/
(name)/
(bintype)/
¶POST
/marvin2/api/maps/
(name)/
(bintype)/
(template)/
¶Returns the parameters needed to initialise a Maps remotely.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/maps/8485-1901/SPX/GAU-MILESHC/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"plateifu": "8485-1901",
"mangaid": "1-209232",
"header": "XTENSION= 'IMAGE', NAXIS=3, .... END",
"wcs_header": "WCSAXES = 3 / Number of coordindate axes .... END",
"shape": [34, 34],
"bintype": "SPX",
"template": "GAU-MILESHC"
}
}
GET
/marvin2/api/maps/
(name)/
¶GET
/marvin2/api/maps/
(name)/
(bintype)/
¶GET
/marvin2/api/maps/
(name)/
(bintype)/
(template)/
¶Returns the parameters needed to initialise a Maps remotely.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/maps/8485-1901/SPX/GAU-MILESHC/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"plateifu": "8485-1901",
"mangaid": "1-209232",
"header": "XTENSION= 'IMAGE', NAXIS=3, .... END",
"wcs_header": "WCSAXES = 3 / Number of coordindate axes .... END",
"shape": [34, 34],
"bintype": "SPX",
"template": "GAU-MILESHC"
}
}
POST
/marvin2/api/maps/
(name)/
(bintype)/
(template)/map/
(property_name)/
¶POST
/marvin2/api/maps/
(name)/
(bintype)/
(template)/map/
(property_name)/
(channel)/
¶Returns data, ivar, mask, and unit for a given map.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/maps/8485-1901/SPX/GAU-MILESHC/map/emline_gflux/ha_6564/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"header": {"BITPIX": "-64", "C01": "OIId-3728", ...},
"unit": "1E-17 erg/s/cm^2/spaxel",
"value": [[0.0,0.0,0.0,...], [0,0,0,...], ... ],
"ivar": [[0.0,0.0,0.0,...], [0,0,0,...], ... ],
"mask": [[1073741843, 1073741843, 1073741843, ...], [1073741843, 1073741843, 1073741843, ...], ... ]
}
}
GET
/marvin2/api/maps/
(name)/
(bintype)/
(template)/map/
(property_name)/
¶GET
/marvin2/api/maps/
(name)/
(bintype)/
(template)/map/
(property_name)/
(channel)/
¶Returns data, ivar, mask, and unit for a given map.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/maps/8485-1901/SPX/GAU-MILESHC/map/emline_gflux/ha_6564/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"header": {"BITPIX": "-64", "C01": "OIId-3728", ...},
"unit": "1E-17 erg/s/cm^2/spaxel",
"value": [[0.0,0.0,0.0,...], [0,0,0,...], ... ],
"ivar": [[0.0,0.0,0.0,...], [0,0,0,...], ... ],
"mask": [[1073741843, 1073741843, 1073741843, ...], [1073741843, 1073741843, 1073741843, ...], ... ]
}
}
POST
/marvin2/api/maps/
(name)/
(bintype)/
(template)/quantities/
(x)/
(y)/
¶Returns a dictionary with all the quantities.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/maps/8485-1901/quantities/10/12/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"emline_gflux_ha6564": {"value": 2.3, "ivar": ...},
"binid": ...}
}
}
GET
/marvin2/api/maps/
(name)/
(bintype)/
(template)/quantities/
(x)/
(y)/
¶Returns a dictionary with all the quantities.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/maps/8485-1901/quantities/10/12/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"emline_gflux_ha6564": {"value": 2.3, "ivar": ...},
"binid": ...}
}
}
POST
/marvin2/api/maps/
(name)/dapall
¶POST
/marvin2/api/maps/
(name)/
(bintype)/dapall
¶POST
/marvin2/api/maps/
(name)/
(bintype)/
(template)/dapall
¶Returns the DAPall data for a given mangaid or plateifu.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/maps/8485-1901/SPX/GAU-MILESHC/dapall HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"dapall_data": {"plate": 7443,
"ifudesign": 12701,
... }
}
}
GET
/marvin2/api/maps/
(name)/dapall
¶GET
/marvin2/api/maps/
(name)/
(bintype)/dapall
¶GET
/marvin2/api/maps/
(name)/
(bintype)/
(template)/dapall
¶Returns the DAPall data for a given mangaid or plateifu.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/maps/8485-1901/SPX/GAU-MILESHC/dapall HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"dapall_data": {"plate": 7443,
"ifudesign": 12701,
... }
}
}
POST
/marvin2/api/modelcubes/
(name)/
¶POST
/marvin2/api/modelcubes/
(name)/
(bintype)/
¶POST
/marvin2/api/modelcubes/
(name)/
(bintype)/
(template)/
¶Retrieves a ModelCube.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/modelcubes/8485-1901/SPX/GAU-MILESHC/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"plateifu": 8485-1901,
"mangaid": '1-209232',
"header": "XTENSION= 'IMAGE', NAXIS=3, .... END",
"wcs_header": "WCSAXES = 3 / Number of coordindate axes .... END",
"shape": [34, 34],
"wavelength": [3621.6, 3622.43, 3623.26, ...],
"redcorr": [1.06588, 1.065866, 1.06585, ...],
"bintype": "SPX",
"template": "GAU-MILESHC"
}
}
GET
/marvin2/api/modelcubes/
(name)/
¶GET
/marvin2/api/modelcubes/
(name)/
(bintype)/
¶GET
/marvin2/api/modelcubes/
(name)/
(bintype)/
(template)/
¶Retrieves a ModelCube.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/modelcubes/8485-1901/SPX/GAU-MILESHC/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"plateifu": 8485-1901,
"mangaid": '1-209232',
"header": "XTENSION= 'IMAGE', NAXIS=3, .... END",
"wcs_header": "WCSAXES = 3 / Number of coordindate axes .... END",
"shape": [34, 34],
"wavelength": [3621.6, 3622.43, 3623.26, ...],
"redcorr": [1.06588, 1.065866, 1.06585, ...],
"bintype": "SPX",
"template": "GAU-MILESHC"
}
}
POST
/marvin2/api/modelcubes/
(name)/
(bintype)/
(template)/quantities/
(x)/
(y)/
¶Returns a dictionary with all the quantities.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/modelcubes/8485-1901/SPX/GAU_MILESHC/quantities/10/12/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"binned_flux": {"value": [0,0,..0], "ivar": ...},
"emline_fit": ...}
}
}
GET
/marvin2/api/modelcubes/
(name)/
(bintype)/
(template)/quantities/
(x)/
(y)/
¶Returns a dictionary with all the quantities.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/modelcubes/8485-1901/SPX/GAU_MILESHC/quantities/10/12/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"binned_flux": {"value": [0,0,..0], "ivar": ...},
"emline_fit": ...}
}
}
POST
/marvin2/api/modelcubes/
(name)/binids/
(modelcube_extension)/
¶POST
/marvin2/api/modelcubes/
(name)/
(bintype)/binids/
(modelcube_extension)/
¶POST
/marvin2/api/modelcubes/
(name)/
(bintype)/
(template)/binids/
(modelcube_extension)/
¶Returns the binid array for a modelcube given a plateifu/mangaid.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/modelcubes/8485-1901/binids/flux/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"binid": [[0,0,..0], [], ... [0, 0, 0,... 0]]
}
}
GET
/marvin2/api/modelcubes/
(name)/binids/
(modelcube_extension)/
¶GET
/marvin2/api/modelcubes/
(name)/
(bintype)/binids/
(modelcube_extension)/
¶GET
/marvin2/api/modelcubes/
(name)/
(bintype)/
(template)/binids/
(modelcube_extension)/
¶Returns the binid array for a modelcube given a plateifu/mangaid.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/modelcubes/8485-1901/binids/flux/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"binid": [[0,0,..0], [], ... [0, 0, 0,... 0]]
}
}
POST
/marvin2/api/modelcubes/
(name)/extensions/
(modelcube_extension)/
¶POST
/marvin2/api/modelcubes/
(name)/
(bintype)/extensions/
(modelcube_extension)/
¶POST
/marvin2/api/modelcubes/
(name)/
(bintype)/
(template)/extensions/
(modelcube_extension)/
¶Returns the extension for a modelcube given a plateifu/mangaid.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/modelcubes/8485-1901/extensions/flux/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"extension_data": [[0,0,..0], [], ... [0, 0, 0,... 0]]
}
}
GET
/marvin2/api/modelcubes/
(name)/extensions/
(modelcube_extension)/
¶GET
/marvin2/api/modelcubes/
(name)/
(bintype)/extensions/
(modelcube_extension)/
¶GET
/marvin2/api/modelcubes/
(name)/
(bintype)/
(template)/extensions/
(modelcube_extension)/
¶Returns the extension for a modelcube given a plateifu/mangaid.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/modelcubes/8485-1901/extensions/flux/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"extension_data": [[0,0,..0], [], ... [0, 0, 0,... 0]]
}
}
GET
/marvin2/api/plates/
¶Returns general maps info
Form Parameters: | |
---|---|
|
|
Response JSON Object: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/plates/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": "this is a plate!"
}
POST
/marvin2/api/plates/
(plateid)/
¶Retrieve basic info about a plate
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/plate/8485/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"plateid": "8485",
"header": {"AIRMSMAX": "1.07643", "AIRMSMED": "1.04336", "AIRMSMIN": "1.03694", ... }
}
}
GET
/marvin2/api/plates/
(plateid)/
¶Retrieve basic info about a plate
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/plate/8485/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"plateid": "8485",
"header": {"AIRMSMAX": "1.07643", "AIRMSMED": "1.04336", "AIRMSMIN": "1.03694", ... }
}
}
POST
/marvin2/api/plates/
(plateid)/cubes/
¶Returns a list of all the cubes for this plate
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/plate/8485/cubes/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"plateifus": ["8485-12701","8485-12702","8485-1901","8485-1902", ...]
}
}
GET
/marvin2/api/plates/
(plateid)/cubes/
¶Returns a list of all the cubes for this plate
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/plate/8485/cubes/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"plateifus": ["8485-12701","8485-12702","8485-1901","8485-1902", ...]
}
}
GET
/marvin2/api/query/
¶Returns general query info
Query Parameters: | |
---|---|
|
|
Response JSON Object: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": "this is a query!"
}
POST
/marvin2/api/query/cleanup/
¶Clean up idle server-side queries or retrieve the list of them
Do not use!
Query Parameters: | |
---|---|
|
|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/cleanup/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": 'clean success'
}
GET
/marvin2/api/query/cleanup/
¶Clean up idle server-side queries or retrieve the list of them
Do not use!
Query Parameters: | |
---|---|
|
|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/cleanup/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": 'clean success'
}
POST
/marvin2/api/query/cubes/
¶Performs a remote query
Query Parameters: | |
---|---|
|
|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/cubes/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5", "searchfilter": "nsa.z<0.1"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"chunk": 100,
"count": 4,
"data": [["1-209232",8485,"8485-1901","1901",0.0407447],
["1-209113",8485,"8485-1902","1902",0.0378877],
["1-209191",8485,"8485-12701","12701",0.0234253],
["1-209151",8485,"8485-12702","12702",0.0185246]
],
"filter": "nsa.z<0.1",
"params": ["cube.mangaid","cube.plate","cube.plateifu","ifu.name","nsa.z"],
"query": "SELECT ... FROM ... WHERE ...",
"queryparams_order": ["mangaid","plate","plateifu","name","z"],
"returnparams": null,
"runtime": {"days": 0,"microseconds": 55986,"seconds": 0},
"totalcount": 4
}
GET
/marvin2/api/query/cubes/
¶Performs a remote query
Query Parameters: | |
---|---|
|
|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/cubes/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5", "searchfilter": "nsa.z<0.1"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"chunk": 100,
"count": 4,
"data": [["1-209232",8485,"8485-1901","1901",0.0407447],
["1-209113",8485,"8485-1902","1902",0.0378877],
["1-209191",8485,"8485-12701","12701",0.0234253],
["1-209151",8485,"8485-12702","12702",0.0185246]
],
"filter": "nsa.z<0.1",
"params": ["cube.mangaid","cube.plate","cube.plateifu","ifu.name","nsa.z"],
"query": "SELECT ... FROM ... WHERE ...",
"queryparams_order": ["mangaid","plate","plateifu","name","z"],
"returnparams": null,
"runtime": {"days": 0,"microseconds": 55986,"seconds": 0},
"totalcount": 4
}
POST
/marvin2/api/query/cubes/columns/
¶POST
/marvin2/api/query/cubes/columns/
(colname)/
¶Retrieves the entire result set for a single column
Query Parameters: | |
---|---|
|
|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/cubes/columns/plateifu/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5", "searchfilter": "nsa.z<0.1"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"chunk": 100,
"count": 4,
"data": ["8485-1901", "8485-1902", "8485-12701", "7443-12701", "8485-12702"],
}
GET
/marvin2/api/query/cubes/columns/
¶GET
/marvin2/api/query/cubes/columns/
(colname)/
¶Retrieves the entire result set for a single column
Query Parameters: | |
---|---|
|
|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/cubes/columns/plateifu/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5", "searchfilter": "nsa.z<0.1"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"chunk": 100,
"count": 4,
"data": ["8485-1901", "8485-1902", "8485-12701", "7443-12701", "8485-12702"],
}
POST
/marvin2/api/query/cubes/getsubset/
¶Remotely grab a subset of results from a query
Query Parameters: | |
---|---|
|
|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/cubes/getsubset/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5", "searchfilter": "nsa.z<0.1", "start":10, "end":15},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"chunk": 100,
"count": 4,
"data": [["1-209232",8485,"8485-1901","1901",0.0407447],
["1-209113",8485,"8485-1902","1902",0.0378877],
["1-209191",8485,"8485-12701","12701",0.0234253],
["1-209151",8485,"8485-12702","12702",0.0185246]
],
"filter": "nsa.z<0.1",
"params": ["cube.mangaid","cube.plate","cube.plateifu","ifu.name","nsa.z"],
"query": "SELECT ... FROM ... WHERE ...",
"queryparams_order": ["mangaid","plate","plateifu","name","z"],
"returnparams": null,
"runtime": {"days": 0,"microseconds": 55986,"seconds": 0},
"totalcount": 4
}
GET
/marvin2/api/query/cubes/getsubset/
¶Remotely grab a subset of results from a query
Query Parameters: | |
---|---|
|
|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/cubes/getsubset/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5", "searchfilter": "nsa.z<0.1", "start":10, "end":15},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"chunk": 100,
"count": 4,
"data": [["1-209232",8485,"8485-1901","1901",0.0407447],
["1-209113",8485,"8485-1902","1902",0.0378877],
["1-209191",8485,"8485-12701","12701",0.0234253],
["1-209151",8485,"8485-12702","12702",0.0185246]
],
"filter": "nsa.z<0.1",
"params": ["cube.mangaid","cube.plate","cube.plateifu","ifu.name","nsa.z"],
"query": "SELECT ... FROM ... WHERE ...",
"queryparams_order": ["mangaid","plate","plateifu","name","z"],
"returnparams": null,
"runtime": {"days": 0,"microseconds": 55986,"seconds": 0},
"totalcount": 4
}
POST
/marvin2/api/query/getparamslist/
¶Retrieve a list of all available input parameters into the query
Query Parameters: | |
---|---|
|
|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/getparamslist/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": ['nsa.z', 'cube.ra', 'cube.dec', ...]
}
GET
/marvin2/api/query/getparamslist/
¶Retrieve a list of all available input parameters into the query
Query Parameters: | |
---|---|
|
|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/query/getparamslist/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": ['nsa.z', 'cube.ra', 'cube.dec', ...]
}
POST
/marvin2/api/rss/
(name)/
¶This method performs a get request at the url route /rss/<id>.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/rss/8485-1901/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {}
}
GET
/marvin2/api/rss/
(name)/
¶This method performs a get request at the url route /rss/<id>.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/rss/8485-1901/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {}
}
POST
/marvin2/api/rss/
(name)/fibers/
¶Returns a list of all the flux, ivar, mask, and wavelength arrays for all fibres.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/rss/8485-1901/fibers/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"wavelength": [3621.6, 3622.43, 3623.26, ...],
"0": [flux, ivar, mask],
"1": [flux, ivar, mask],
...
"170": [flux, ivar, mask]
}
}
GET
/marvin2/api/rss/
(name)/fibers/
¶Returns a list of all the flux, ivar, mask, and wavelength arrays for all fibres.
Parameters: |
|
---|---|
Form Parameters: | |
|
|
Response JSON Object: | |
|
|
JSON Parameters: | |
|
|
Response Headers: | |
|
|
Status Codes: |
|
Example request:
GET /marvin2/api/rss/8485-1901/fibers/ HTTP/1.1
Host: api.sdss.org
Accept: application/json, */*
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 1,
"error": null,
"inconfig": {"release": "MPL-5"},
"utahconfig": {"release": "MPL-5", "mode": "local"},
"traceback": null,
"data": {"wavelength": [3621.6, 3622.43, 3623.26, ...],
"0": [flux, ivar, mask],
"1": [flux, ivar, mask],
...
"170": [flux, ivar, mask]
}
}