Miriade

https://ssp.imcce.fr/webservices/miriade/api/psv.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=&-visu=). The other input parameters are mandatory.

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:

psv (inputArray)

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

--coord(<code>)

where <code> is one of the following value to display:

• eq: apparent of the date equatorial coordinates
• eq2000: astrometric J2000 equatorial coordinates
• ec: ecliptic coordinates
• rect: rectangular coordinates

--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 magnitude 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.

• name=p:Jupiter, mime=image, so=3, output=--iso, view=wired:png
• name=p:Jupiter, mime=json, so=3, output=--iso, view=wired:png
• name=p:Jupiter, mime=votable, so=3, output=--iso, view=wired:png
• name=a:Pallas, mime=text/csv, so=1, output=--coord(eq),--jd, view=wired:png
• name=p:Mars, mime=text, so=1, output=--jd, view=wired:png

For asteroidal systems, use the argument psvopts="showorbit=1", and define enough step of dates to compute the ephemeris to cover the orbit of the components. Use the special mime type image to only retrieve the first image, e.g.

• name=a:kalliope/linus, gensol=2, nbd=85, step=1h, mime=image, view=wired:png, psvopts="showorbit=1"
• zoom on the primary component to visualize its orbit wrt the system barycenter (purple dashed ellipse).

The output parameters of the ephemph method are described in the following table. Columns with italicized numbers are present only when the corresponding option is enabled.

Notes:

1. This column does not exist when the mime type is set to text.
2. By default the date is expressed in the ISO-8601 format. It can be changed to julian period or calendar date with the output argument.
3. See Optional parameters section.
4. The sub-Earth and sub-Solar point are expressed in the system defined by argument so.
5. The columns 11-40 display the asteroid magnitudes for each requested filter provided through the --colors() option.
6. The column 41 displays the asteroid thermal flux for each requested wavelength provided through the --thermalflux() option. The flux are formatted as a list of values between brackets, e.g. {f1; f2; ...}.
7. The columns 36-38 display the differential position of the component of an asteroidal multiple system, defined by its name as <system>/<component>, e.g. name=a:kalliope/linus. See the HOWTO section for a full description about how to name targets.

$> 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 psv 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' => now,
               'nbd' => 5,
               'step' => '1d',
               'tscale' => 'UTC',
               'so' => 1,
               'gensol' => '',
               'observer' => '500',
               'target' => '',
               'mime' => 'text',
               'output' => '--rv,--lighttime',
               'view' => 'wired:png',
               'psvopts' => 'zoom=0;label=1',
               'features' => 'PT1,45.0,45.0;PT2,10,-5.0'
);

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('psv',array($param));
   // 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");
         header('Content-disposition: attachment;filename="psv.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 if ($param['mime'] == 'image')
   {
      if ($response->status < 300) {
         switch ($param['view']) {
         case "fits":
         case "psv:fits":
           $content = "image/fits"; 
           $dispo = true;
           $ext = "fits";
           break;
         case "png":
         case "psv:png":
         case "wired:png":
           $content = "image/png"; 
           $dispo = false;
           $ext = "png";
           break;
         case "eps":
         case "wired:eps":
           $content = "application/postscript"; 
           $dispo = true;
           $ext = "eps";
           break;
         }
         header("HTTP/1.0 ".$response->status);
         header("Content-Type: ".$content);
         if ($dispo) { header("Content-disposition: attachment;filename=\"psv.".$ext."\""); }
         echo file_get_contents($response->result);
      }
      else
      {
         header("HTTP/1.0 ".$response->status);
         header("Content-Type: text/xml;content=x-votable");
         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);
}