Server's API

Table of Contents

1 - Name resolver
2 - Reverse name resolver
3 - Shortener URL
4 - Acquisition search
5 - HIPS
6 - UWS

## 1 - Name resolver The name resolver is a service that provides longitude/latitude in degree in a specific coordinate system (Equatorial-J2000 or Galactic) from a object's name.

The resource is the following : /nameResolver/{objectName}/{referenceFrame}

1.1 - Request query parameters

parameter	Value	Description
nameResolver	One of CDS, IMCCE, ALL (default)	The selected name resolver

1.2 - Request template parameters

parameter	Value	Description
objectName	(required)	Object name to resolve
coordSystem	(required) - One of EQUATORIAL, GALACTIC	Coordinate system in which the output is formated

1.3 - Available response status and representations

• STATUS 200 : OK - GeoJson
• STATUS 500 : Unexpected error - text/html
• STATUS 400 : The request could not be understood by the server due to malformed syntax- coordinate system is unknown - text/html
• STATUS 503 : The server is currently unable to handle the request due to a temporary overloading or maintenance of the ser - text/html
• STATUS 404 : object not found - text/html

1.4 - GeoJSon format

{ "totalResults": 1, "type": "FeatureCollection", "features": [ { "type": "Feature", "geometry": { "coordinates": [10.6847083,41.26875], "type": "Point" }, "properties": { "crs": { "type": "name", "properties": { "name": "equatorial.ICRS" } }, "credits":"CDS", "identifier":"CDS0" } } ] }

## 2 - Reverse Name resolver The reverse name resolver is a service that provides the object name based on longitude/latitude in degree in a specific coordinate system (Equatorial-J2000 or Galactic).

The resource is the following : /nameResolver/{referenceFrame}/{coordinates-order}

2.1 - Request template parameter

parameter	Value	Description
coordinates-order	(required)	coordinates and the Healpix order separated by (e.g.00:42:44.31 +41:16:09.4;12)
coordSystem	(required) - One of EQUATORIAL, GALACTIC	Coordinate system in which the output is formated

2.2 - Available response status and representations

• STATUS 200 : OK - GeoJson
• STATUS 400 : This error happens when the user input parameters are wrong
• STATUS 500 : Not foreseen error
• STATUS 503 : This error happens when the time between two queries is inferior to 6 seconds
• STATUS 404 : This error happens when no result is returned from the reverse name resolver

2.3 - GeoJSon format

{ "totalResults": 1, "type": "FeatureCollection", "features": [ { "type": "Feature", "geometry": { "coordinates": [359.6682375,-3.5559833333333333], "type": "Point" }, "properties": { "crs": { "type": "name", "properties": { "name": "equatorial.ICRS" } }, "title":"* 27 Psc ", "magnitude":5.808, "credits":"CDS", "seeAlso":"http://simbad.u-strasbg.fr/simbad/sim-id?Ident=* 27 Psc ", "type":"**", "identifier":"* 27 Psc " } } ] }

## 3 - Shortener URL The shortener URL allows a user to save the context of his GUI to the server. Then, the server comes back an URL that allows any users knowing this URL to load the saved context

The API is the following : /shortener/shortenerID

3.1 POST /shortener

Creates a shortener ID

3.1.1 - Create a new URL to save the context

The posted messsage looks like to that:

context:{ "initTarget":[0,0,-57210770.8278], "fov":20, "visibility":{ "SAMP":true, "Constellations":false, "Brighten stars":true, "Equatorial grid":false, "Galactic grid":false, "WISE RGB":false, "SpitzerI1I2I4color":false, "IRIS":false, "Deep CFHTLS":false, "CFHTLS Wide":false, "2MASS":false, "RASS":false, "NVSS":false, "DSS":true, "SDSS":false, "PlanckCMB":false, "Planck-HFI-857":false, "Planck-HFI-545":false, "Planck-HFI-353":false, "Planck-HFI-217":false, "Planck-HFI-143":false, "Planck-HFI-100":false, "Healpix grid":false, "Pacs-SAG4-Herschel":false, "Spire-SAG4-Herschel":false, "ESO":false, "HST":false, "Iso":false, "SPM4":false, "USNO-B1.0":false, "Planets":true, "IMCCE":false, "Exoplanets":false, "Corot exo":false, "Corot astero":false, "Mars":false, "Earth":false }, "up":[0,0,1] }

3.1.2 - Available response status and representations

• STATUS 200 : OK - shortener identifier (a String)
• STATUS 500 : Unexpected error - text/html
• STATUS 400 : Context parameter is empty or the json is unvalid

3.2 GET /shortener/shortenerID

Returns the saved context

3.2.1 - Request query template

parameter	Value	Description
shortenerID	A String	The shortener identifier

3.2.2 - Available response status and representations

• STATUS 200 : OK - GeoJson
• STATUS 500 : Unexpected error - text/html
• STATUS 400 : shortener ID does not exist

## 4 - Acquisition search This API allows an open search query application based on a Cone Search Protocol or Simple Image Access Protocol.

The resources are the following : / /search /dico/name /moc

4.1 - /

Returns the description of the openSearch service for VO Services.

GET /

4.1.1 - Available response status and representations

• STATUS 200 : OK - XML
• STATUS 500 : Unexpected error - text/html

4.1.2 - XML response

` SITools2 search SITools2 connector providing an open search capability

Jean-Christophe Malapert - SITools2 Team open Search data Copyright 2012 2013, SITools2, All Rights Reserved en-us `

4.2 - /search

4.2.1 - Request query parameters

parameter	Value	Description
healpix (required)	integer	Pixel number
order(required)	integer	Healpix order
format(required)	json	Output format
coordSystem(required)	EQUATORIAL OR GALACTIC	Healpix coordinate system

4.2.2 - Available response status and representations

• STATUS 200 : OK - GeoJSON
• STATUS 500|400 : Unexpected error - text/html

4.2.3 - GeoJSon format

{ totalResults: 1, type: "FeatureCollection", features: [ geometry: { coordinates: [10.6847083,41.26875], type: "Point" }, properties: { crs: { type: "name", properties: { name: "EQUATORIAL.ICRS" } }, identifier: "CDS0" } }]}

4.3 - /dico/name

Retrieving the keyword definition.

GET /dico/name

4.3.1 - Request template parameter

parameter	Value	Description
name	String	Key

4.3.2 - Available response status and representations

• STATUS 200 : OK - The definition of the key as string
• STATUS 500 | 400| 404 : Error - text/html

4.4 /moc

Computing the sky coverage

GET /moc

4.4.1 - Available response status and representations

• STATUS 200 : OK - FITS (image/fits), JSON (application/json), PNG (image/png), txt (text/plain)
• STATUS 500 | 400 : Error - text/html

4.4.2 - Formats

• FITS : Retrieves a MOC as FITS. This implementation is provided by CDS.
• JSON : Retrieves a MOC as JSON. This implementation is provided by CDS.
• PNG : Retrieves a MOC as PNG.
• txt : Retrieves a MOC as a string describing the sky coverage.

## 5 - HIPS [HIPS service](http://aladin.u-strasbg.fr/hips/HiPS_technical_doc_v2.pdf) ## 6 - UWS TODO