VO-Paris Data Centre

Observatoire de Paris

Registry REST API v1

VoResources

VoResources is a collection of resources registered in the VO. Users of the registry can search for resources and get all their metadata.

This collection is built by harvesting all publishing registries known to the IVOA (ie. registered in the RofR). The resources registered twice or more are not included in this collection.

/voresources/search

Description
Returns metadata for all resources matching a specified query. Only active resources are returned.
The search operation is applied to relevant fields of the resource that include at minimum: identifier, description, title, type, subjects, publisher, shortname, waveband and standardid. You can set constraints on specified fields or on all fields. By default when multiple constraints are set, the results of all constraints are combined with a logical AND.
As more than 13000 resources are registered it is necessary to handle pagination to give safely access to all resources.
URL Structure
http://voparis-registry.obspm.fr/vo/ivoa/1/voresources/search
Method
GET
URL Parameters
  • keywords required URL-encoded string. Syntax follows the Apache Lucene query language. ABNF notation:
    keywords = "keywords" "=" rules *(LWS rules)
    rules = field-query | term-query
    field-query = field-name ":" term-query
    term-query = quoted-string
    field-name = "identifier"
       | "description"
       | "title"
       | "type"
       | "subjects"
       | "publisher"
       | "shortname"
       | "waveband"
       | "standardid"
  • orValues To combine multiple constraints with a logical OR.
  • from The minimum position in the complete list of matching resources.
  • max The maximum number of resources to return.
  • identifiersOnly To return only resource identifiers.
Success Response
  • Code: 200 OK / Content: see here
  • Code: 204 No Content
Error Response
  • Code: 400 Bad Request
  • Code: 405 Method Not Allowed
  • Code: 500 Internal Server Error
  • Code: 502 Bad Gateway
Returns
JSON-formatted list of metadata for any resources. More information on the returned metadata fields are available here.
{
   "numberReturned": 2,
   "total": 36,
   "from": 1,
   "more": true,
   "resources": [
      {
         "status": "active",
         "publisher": "Institut d'Astrophysique de Paris",
         "updated": "2013-02-28T00:00:00Z",
         "description": "VO-compliant publication...",
         "title": "Five Supernova Survey Galaxies",
         "provenance": "ivo://vopdc/registry",
         "waveband": [
            "Optical",
            "Infrared"
         ],
         "created": "2010-02-11T00:00:00Z",
         "contactemail": "vo.paris@obspm.fr",
         "subjects": [
            "Virtual Observatory",
            "Spectrum",
            "Galaxies"
         ],
         "referenceurl": "http://www.iap.fr",
         "contactname": "VOPDC support team",
         "capabilities": [
            {
               "accessurl": "http://voparis-srv.obspm.fr/srv/scs-fss.php?",
               "standardid": "ivo://ivoa.net/std/ConeSearch",
               "version": "1.03"
            }
         ],
         "shortname": "FSS",
         "identifier": "ivo://vopdc.iap/fss",
         "type": "CatalogService"
      },
      {..}
   ]
}
Return metadata definitions
  • numberReturned The number of resources returned.
  • total The number of resources matching the query.
  • from The minimum position in the complete list of matching resources.
  • more To know if additional resources are available beginning with the position from + numberReturned.
  • resources The list of metadata for each resources returned.
Examples

/voresources

Description
Returns metadata for the specified resource.
URL Structure
http://voparis-registry.obspm.fr/vo/ivoa/1/voresources
Method
GET
URL Parameters
  • identifier required The URL-encoded VO identifier of the resource you search.
Success Response
  • Code: 200 OK / Content: see here
Error Response
  • Code: 404 Resource not found
  • Code: 405 Method Not Allowed
  • Code: 500 Internal Server Error
  • Code: 502 Bad Gateway
Returns
JSON-formatted list of metadata of the resource.
{
   "status": "active",
   "publisher": "VO-Paris Data Centre",
   "updated": "2013-02-28T00:00:00Z",
   "description": "This registry provides...",
   "title": "VO-Paris Data Center Publishing Registry",
   "provenance": "ivo://vopdc/registry",
   "referenceurl": "http://vo.obspm.fr",
   "created": "2013-01-15T00:00:00Z",
   "contactemail": "vo.paris@obspm.fr",
   "subjects": [
      "Registry",
      "Virtual Observatory"
   ],
   "capabilities": [
      {
         "accessurl": "http://voparis-registry.obspm.fr/vo/oai",
         "standardid": "ivo://ivoa.net/std/Registry",
         "version": "1.0"
      }
   ],
   "contactname": "VOPDC support team",
   "shortname": "VOPDC Registry",
   "identifier": "ivo://vopdc/registry",
   "type": "Registry"
}
Examples
  • identifier=ivo://vopdc [json, xml]
Note
You can retrieve the native XML description of the resource by using the following endpoint: http://voparis-registry.obspm.fr/vo/ivoa/1/voresources.xml

Registry

Allows users to discover this registry.

/identity

Description
Retrieves the full description of the registry itself.
This is equivalent to GET /voresources operation where identifier is the identifier of this registry.
URL Structure
http://voparis-registry.obspm.fr/vo/ivoa/1/identity
Method
GET
Success Response
  • Code: 200 OK / Content: see here
Error Response
  • Code: 405 Method Not Allowed
  • Code: 500 Internal Server Error
  • Code: 502 Bad Gateway
Returns
JSON-formatted list of metadata of this registry.
{
   "status": "active",
   "publisher": "VO-Paris Data Centre",
   "updated": "2013-02-28T00:00:00Z",
   "description": "This registry provides...",
   "title": "VO-Paris Data Center Publishing Registry",
   "provenance": "ivo://vopdc/registry",
   "referenceurl": "http://vo.obspm.fr",
   "created": "2013-01-15T00:00:00Z",
   "contactemail": "vo.paris@obspm.fr",
   "subjects": [
      "Registry",
      "Virtual Observatory"
   ],
   "capabilities": [
      {
         "accessurl": "http://voparis-registry.obspm.fr/vo/oai",
         "standardid": "ivo://ivoa.net/std/Registry",
         "version": "1.0"
      }
   ],
   "contactname": "VOPDC support team",
   "shortname": "VOPDC Registry",
   "identifier": "ivo://vopdc/registry",
   "type": "Registry"
}

/api

Allows users to access to this version of the Registry REST API documentation.

URL Structure
http://voparis-registry.obspm.fr/vo/ivoa/1/api
Method
GET