SsODNet

https://ssp.imcce.fr/webservices/ssodnet/api/resolver.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.

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:

resolver (inputArray)

The output of the resolver 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).

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

json

Data are written in a JSON object.

• mime=text
• mime=json
• mime=html
• mime=votable

The output parameters of the resolver method are described in the following table.

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 array with all the SSOs that have been found:

"data": [ { "id": string, 
            "type": string,
            "class": string,
            "name": string,
            "number": int,
            "title": string,
            "aliases": string,
            "parent": string,
            "system": string,
            "ephemeris": {} } ]

and where ephemeris contains the ephemerides of the target at the requested epoch:

"ephemeris": [ { "epoch": float, 
                 "ra": float,
                 "dec": float,
                 "dobs": float,
                 "referenceFrame": string } ]

$> 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 resolver 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' => 'io',
               'mime' => "json",
               'epoch' => 'now',
               'maxrec' => 10,
               'ephem' => '1',
               'coord' => '2D'
);

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 resolver method
   $response = $client->__soapCall('resolver',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);
}