Miriade

https://ssp.imcce.fr/webservices/miriade/api/ephemcc.php?[parameters]

The output results are described in the following section, and are available in VOTable (default), HTML, comma-separated values (CSV), plain text format, and JSON object (cf. examples). Some parameters are optionnal, and their values can be omitted (just left blank the value, e.g. &-mime=&-output=). The input parameters without default value are mandatory.

https://ssp.imcce.fr/webservices/miriade/api/ephemcc.php?-get=orbital_params&[parameters]

The output response is a text/csv document which contains the following information:

Web Service URI:

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

Namespace:

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

WSDL:

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

SOAP header:

name of the SOAP header element: clientID

SOAP header's content: array('from' => 'YourName', 'hostip'=>'', 'lang'=>'en|fr')

Method:

ephemcc (inputArray)

The output of the ephemcc 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 parameters depending on user's options (cf. Output parameters section).

votable

the data are written in the IVOA standard VOTable format

html

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

text

the data are returned in plain text where each block of data is separated by the semi-colon character ';', and fields are separated by one or more blank character. The first block is the keyword '#! ephem' which marks the beginning of the data.

text/csv

the data are returned in plain text where each block of data is separated by the semi-colon character ';', and fields are separated by a comma. The first line provides the ticket (Unix timestamp of the response) and the flag of the response, and the second line provides the field headers.

json

the data are written in a JSON object.

--greg

to format the epoch as a calendar date.

--iso

to format the epoch as an ISO-8601 date (default).

--jd

to format the epoch as a julian period.

--lighttime

to display the value of the light time between the target and the observer.

--rv

to display the detailed values of radial velocity.

--ttmutc

to display the TT-UTC value.

--colors(<filter>[,<filter>,...])

to compute the magnitude of the target for listed filters (asteroids only). See section How to set up filters.

--thermalflux(λ,pv,η,ε)

to compute the thermal flux of the target (asteroids only) using the Near-Earth Asteroid Thermal Model (NEATM) implemented by the Lagrange laboratory (OCA) and IMCCE. See section How to set up thermal flux.

--pafParams(am,h☉)

to produce an ephemeris file compatible with the VLT parameter file (PAF) format, to be used for the ESO Phase 2 procedures for Moving Target programmes. See section How to set up PAF parameters.

• mime=text, output=--jd
• mime=text/csv, output=--iso
• mime=json, output=--iso
• mime=html, output=--iso,--rv
• mime=votable, output=--jd,--rv

The output parameters of the ephemcc method depend on the type of coordinates (arg. tcoor) and the options (arg. output) that are choosen by the client. Click on the following buttons to display the output parameters in function of the value of the tcoor argument.

{ "sso": {}, "coosys": {}, "ephemeris": {}, "data": {}, "unit": {} }

"sso": { "num": int,
         "name": string,
         "type": string,
         "parameters": {
         "diameter": float,
         "ceu": float,
         "ceurate": float,
         "orbital_period": float,
         "mass": float,
         "dynamical_class": string,
         "taxonomy": { "class": string, "param": string, "source": string } }

"coosys": { "epoch": string, "equinox": string, "system": string }

"ephemeris": { "time_scale": string,
               "planetary_theory": string,
               "relativistic_perturbations": string,
               "coordinates": string,
               "reference_frame": { "type": string, "plane": string, "center": string } }

"data": [ { "epoch": float, 
            "ra": float,
            "dec": float,
            "dobs": float,
            "vmag": float,
            "phase": float,
            "solar_elongation": float,
            "mu_ra_cosdec": float,
            "mu_dec": float,
            "dobs_dot": float } ]

"unit": { "<keyword>": string [, "<keyword>": string, ...] }

where keyword belongs to the list of keywords used inside the document.

$> curl "<URL>"

$> wget "<URL>"

In order to help you to invoke the Miriade 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 ephemcc 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:ceres',
               'type' => "",
               'epoch' => 2458191.2412800924,
               'nbd' => 5,
               'step' => '1d',
               'tscale' => 'UTC',
               'observer' => '500',
               'theory' => 'INPOP',
               'teph' => 1,
               'tcoor' => 1,
               'rplane' => 1,
               'oscelem' => 'astorb',
               'mime' => 'text',
               'output' => '--jd,--rv'
);

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

// Enables or disables the WSDL caching feature
ini_set('soap.wsdl_cache_enabled', 1);
// Miriade namespace
$namespace = 'https://ssp.imcce.fr/webservices/miriade';
// Miriade WSDL
$uriwsdl = $namespace.'/miriade.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('ephemcc',array($param));
   // Display the results
   if (! empty($param['get'])) 
   {
      header("HTTP/1.0 ".$response->status);
      if ($response->status < 300) {
         header("Content-Type: text/csv");
         header('Content-disposition: attachment;filename="orbital_params.csv"'); 
      } else {
         header("Content-Type: text/plain");
      }
      echo $response->result.PHP_EOL;
   }
   else 
   {
      // Affichage du resultat
      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'] == 'text/csv') {
         $res = explode(';', $response->result);
         $nbr = count($res);
         $newkey = array_keys($res);
         header("HTTP/1.0 ".$response->status);
         if ($response->status < 300) {
            header("Content-Type: text/csv");
         } else {
            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);
}