SkyBoT

Please use instead SsODNet service to resolve the name of any Solar System object.

https://ssp.imcce.fr/webservices/skybot/api/resolver.php?[parameters]

The output results are described in the following section, and are available in VOTable (default), HTML, plain text format, and JSON object (cf. examples). The -mime and -output arguments are optionnal and their value can be omitted (just write nothing or ...&-mime=&-output= without value). In this case, the output is the basic one displayed as VOTable.

Web Service URI:

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

Namespace:

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

WSDL:

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

SOAP header:

name of the SOAP header element: clientID

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

Method:

skybotresolver (inputArray)

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

'flag'

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

'status'

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

'ticket'

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

'result'

a string containing the ephemeris of the requested solar system body with the parameters described in the output results section

votable

the data are written in the IVOA standard VOTable format

html

the data are transformed from VOTable to HTML by XSLT processing (SkyBoT XSL style sheet)

text

the data are returned in plain text where each value is separated by the pipe '|' character

json

the data are written in a JSON object.

• mime=text, out=object
• mime=json out=basic
• mime=html, out=all
• mime=votable, out=all

The output parameters of the method is a string which contains the following information:

[
  { 
    "Num": {int | string}, 
    "Name": {string}, 
    "RA (deg)": {float}, 
    "DEC (deg)": {float}, 
    "Class": {string},
    "VMag (mag)": {float}, 
    "Err (arcsec)": {float}, 
    "dRA (arcsec\/h)": {float}, 
    "dDEC (arcsec\/h)": {float}, 
    "dg (ua)": {float}, 
    "dh (ua)": {float}, 
    "Phase (deg)": {float}, 
    "SunElong (deg)": {float}, 
    "position (au)": { "x": {float}, "y": {float}, "z": {float} },
    "velocity (au\/d)": { "x": {float}, "y": {float}, "z": {float} },
    "ref_epoch": {float} 
  } 
]

$> curl "<URL>"

$> wget "<URL>"

In order to help you to invoke the SkyBoT 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 skybotresolver 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('epoch'    => 'now',
               'name'     => 'io',
               'mime'     => 'json',
               'output'   => 'object',
               'observer' => 500,
               'refsys'   => 'EQJ2000');

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

// Enables or disables the WSDL caching feature
ini_set('soap.wsdl_cache_enabled', 1);
// SkyBoT namespace
$namespace = 'https://ssp.imcce.fr/webservices/skybot';
// SkyBoT WSDL
$uriwsdl = $namespace.'/skybot.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('skybotresolver',$param);
   // Display the results
   if ($param['mime'] == 'text') {
      header("HTTP/1.0 200");
      header("Content-Type: text/plain");
      echo "# Flag: ".$response->flag.PHP_EOL;
      echo "# Ticket: ".$response->ticket.PHP_EOL;
      $res = explode(';', $response->result);
      $nbr = count($res);
      $newkey = array_keys($res);
      for ($i=0; $i<$nbr; $i++) { echo $res[$newkey[$i]].PHP_EOL; }
    } else if ($param['mime'] == 'json') {
      header("HTTP/1.0 200");
      header("Content-Type: application/json");
      echo $response->result;
   } else {
      header("HTTP/1.0 200");
      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);
}