SsODNet

The complete list of bibliographic references used to populate SsODNet.datacloud are also available in a single document in bibTeX, JSON, or PDF format.

https://ssp.imcce.fr/webservices/ssodnet/api/datacloud.php?[parameters]

The output parameters are described below. The output formats are VOTable (default), HTML, plain text format, and JSON. Only argument -name is mandatory, except if argument -resource equal collection. In that case argument -name can be omitted.

Web Service URI:

https://ssp.imcce.fr/webservices/ssodnet/ssodnet.php

Namespace:

https://ssp.imcce.fr/webservices/ssodnet

WSDL:

https://ssp.imcce.fr/webservices/ssodnet/ssodnet.php?wsdl

SOAP header:

name of the SOAP header element: clientID

SOAP header's content: array('from' => 'YourName', 'hostip'=>'')

Method:

datacloud (inputArray)

The output of the datacloud method is an object containing the following attributes:

'flag'

Status of the response: flag=1 means ok; flag=0 or flag=-1 mean that an error occured

'status'

HTTP status-code of the response (e.g. 400: bad request, 422: Unprocessable Entity, 500: internal error)

'ticket'

Unix timestamp of the response which can be useful to stamp the request

'result'

String containing the ephemeris of the requested solar system body with parameters depending on user's options (cf. Output parameters section).

json

Data are written in a JSON object.

votable

Data are written in the IVOA standard VOTable format

html

Data are transformed from VOTable to HTML by XSLT processing (SsODNet XSL style sheet)

text

Data are returned in plain text where each block of data is separated by the semi-colon character ';' and each value in a block is separated by the pipe '|' character

Click on the following links (output in JSON format):

The output parameters of the datacloud method depend on the nature of the resource: collection, bibref, list or data. Depending on the mime type, the output can be retrieved in three formats:

JSON

This is the preferred format to quickly handle the outputs. The data can be easily traversed and loaded in memory into associative arrays. The data structures are detailed in the JSON format section.

VOTable

This is the most complete and interoperable format. The data are well described with generous metadata. They can be easily loaded in memory into a XML tree, and displayed with IVOA applications.

Text

This is the worst option to handle the outputs. Just made for human reading.

When the output mime type is the JSON data-interchange format, the data are encapsulated into a structure defined as follows:

{ "flag": int, "ticket": int, "version": string, "data": {} }

where data contains an object which depends on the requested resource:

Test Example

"data": { collection }

where collection is a list of one or more objects describing resources:

"<resource_name>": { 
  "idcollection": datacloud id of the collection (string),
  "description": Description of the collection (string),
  "nbrows": Total number of data (i.e. rows) of the collection (int),
  "nbsso": Total number of distinct SSO in the collection (int),
  "nbbibref": Total number of bibliographic references used to populate the collection (int),
  "bibref": Array of bibliographic references of the collection:
    [ {"shortbib": string, "year": int, "title": string, "bibcode": string, "ads_url": string} ],
  "self": URL to access the metadata of this collection (string) 
}

Test Example

"data": { collection }

where collection is a list of one or more objects providing the bibliographic references used to populate the collection:

"<resource_name>": [ {
  "shortbib": Short bibref (string),
  "year": Year of publication (int),
  "title": Title of the article (string), 
  "bibcode": Bibcode of the article (string), 
  "ads_url": Direct link to the article in ADS (string)
} ]

Test Example

"data": { 
   "<sso_id>": { 
      "identity": { identity },
      "datacloud": [ {
         "idcollection": Collection id (int),
         "collection": Name of the collection (string),
         "description": Description of the collection (string),
         "self": Self link to access the metadata of this collection (string),
         "datalink": Direct link to get the data of this SSO for this collection (string) 
      } ],
      "self": Self link to get this list (string)
   }
}

where <sso_id> is the name of the Sso, and where identity is an object describing the Sso:

"identity": { 
    "name": Name of the SSO (string),
    "number": Number of the SSO (string),
    "type": Type of SSO (string),
    "class": Dynamical class of the SSO (string),
    "parent": Name of the SSO parent (string),
    "system": Name of the planetary system to which the SSO belongs (string),
    "aliases": [ Array of aliases of the SSO (string) ],
    "ephemeris": True if Miriade.ephemcc can compute positional ephemeris (boolean) ,
    "physical-ephemeris": True if Miriade.ephemph can compute physical ephemeris (boolean),
    "physical-models": [ Array of spin solution Id (boolean) ],
}

Test Example

"data": { 
   "<sso_id>": { 
      "identity": { identity },
      "datacloud": { 
         "<resource_name>": [ { table_data } ]
      },
      "self": Self link to get the data of this SSO (string)
   }
}

where table_data is an object containing the data of the corresponding resource.

$> curl "<URL>"

$> wget "<URL>"

In order to help you to invoke the SsODNet Web service, we provide some clients written in differents languages. Here are some detailed explanations to write a client with PHP and SOAP which invokes the datacloud method:

1/ Provide the input parameters which are mandatory for the service:

// Client's ID: provide the name of your project or organisation or yourself
$from = 'MyName';
// Input parameters
$param = array('name' => 'a:io',
               'resource' => 'all',
               'mime' => 'json',
               'maxrec' => 10
);

2/ Define the SOAP options, the namespace and the WSDL URI of SsODNet web service:

// Enables or disables the WSDL caching feature
ini_set('soap.wsdl_cache_enabled', 1);
// SkyBoT namespace
$namespace = 'https://ssp.imcce.fr/webservices/ssodnet';
// SkyBoT WSDL
$uriwsdl = $namespace.'/ssodnet.wsdl';

3/ Create a SoapClient object in WSDL mode, set the SOAP header, then call the method and catch exceptions:

try {
   // Constructs the client
   $client = new SoapClient($uriwsdl, array('exceptions'=>1));
   // SOAP header
   $header = array('from'=>$from, 'hostip'=>'', 'lang'=>'en');
   $client->__setSoapHeaders(array(new SOAPHeader($namespace, 'clientID', $header)));  
   // Call the datacloud method
   $response = $client->__soapCall('datacloud',array($param));
   // Display the results
   if ($param['mime'] == 'text') {
      $res = explode(';', $response->result);
      $nbr = count($res);
      $newkey = array_keys($res);
      header("HTTP/1.0 ".$response->status);
      header("Content-Type: text/plain");
      echo "# Flag: ".$response->flag.PHP_EOL;
      echo "# Ticket: ".$response->ticket.PHP_EOL;
      for ($i=0; $i<$nbr; $i++) { echo $res[$newkey[$i]],PHP_EOL; }
   } else if ($param['mime'] == 'json') {
      header("HTTP/1.0 ".$response->status);
      header("Content-Type: application/json");
      echo $response->result;
   } else {
      header("HTTP/1.0 ".$response->status);
      header("Content-Type: text/xml;content=x-votable");
      echo $response->result;
   }
} catch (SoapFault $fault) {
   trigger_error("SOAP Fault: {$fault->getTraceAsString()} (faultcode: {$fault->faultcode}, 
                               faultstring: {$fault->faultstring})", E_USER_ERROR);
}