API

This paragraph describes the overall API of the RoR.

Access / Query

The RoR has a browsable web interface that allows the user to navigate through the elements of the federation. The RoR has also a RESTful interface providing machine-readable results in JSON encoding.

Registry operations

Register operations

Relation operations

REST query interface

Example RESTful query

Request: http://inspire-regadmin.jrc.ec.europa.eu/ror/rest/registers/27

Response:

{"register": {
  "registry": {
    "description": "The INSPIRE infrastructure involves a number of items, which require clear descriptions and the possibility to be referenced through unique identifiers. Examples for such items include INSPIRE themes, code lists, application schemas or discovery services. Registers provide a means to assign identifiers to items and their labels, definitions and descriptions (in different languages). The INSPIRE registry provides a central access point to a number of centrally managed INSPIRE registers. The content of these registers are based on the INSPIRE Directive, Implementing Rules and Technical Guidelines.",
    "publisher": {
      "label": "European Commission, Joint Research Centre",
      "uri": "https://ec.europa.eu/jrc",
      "email": "inspire-registry-dev@jrc.ec.europa.eu"
    },
    "id": "1",
    "label": "INSPIRE registry",
    "uri": "http://inspire.ec.europa.eu/registry",
    "user": "userid",
    "updatefrequency": "http://publications.europa.eu/resource/authority/frequency/DAILY"
  },
  "description": "Code values for statistics measurement method.",
  "publisher": {
    "label": "European Commission, Joint Research Centre",
    "uri": "https://ec.europa.eu/jrc",
    "email": "inspire-registry-dev@jrc.ec.europa.eu"
  },
  "id": "27",
  "label": "Statistics Measurement Method",
  "uri": "http://inspire.ec.europa.eu/codelist/StatisticsMeasurementMethodValue",
  "updatefrequency": "http://publications.europa.eu/resource/authority/frequency/DAILY"
 }
}

RoR Harvesting and Federated Search search indexing system

The RoR user interface will have a private area (using ECAS authentication) where users can specify the URL of the  Registry exchange file  and manage the different procedures related to each of the Registers included in the federation.

The RoR will accept:

• the direct URL to the file (e.g.  http://inspire.ec.europa.eu/registry/registry.en.rdf)
• the content-negotiation approach (e.g  http://inspire.ec.europa.eu/registry  - HTTP headers: [Accept: application/rdf+xml])

For detailed information on required and optional field for the Registry and Register descriptors, prese visit the  conformance classes page .

The system will import all the metadata related to the registry, all the metadata for each of the register specified in the list and all the relations between the registers.

The following paragraphs describe the step performed by the RoR Harvesting system.

Use cases

A list of common use cases are described below.

Use case 1 - The user adds a new Registry descriptor

Use case 2 - The user removes a Registry descriptor

Use case 3 - The user removes a Register descriptor from the Registry descriptor

Use case 4 - Manual start of the Registry or Register harvesting

Use case 5 - Automatic start of the Registry or Register harvesting

Harvesting

The harvesting procedures are divided based on the type of resource: Registry descriptor and Register descriptor.

Registry harvesting steps

Register harvesting steps

Access / Query

The RoR has a browsable web interface that allows the user to navigate through the elements of the federation. The RoR has also a RESTful interface providing machine-readable results in JSON encoding.

Registry operations

Register operations

Relation operations

REST query interface

Example RESTful query

Request: http://inspire-regadmin.jrc.ec.europa.eu/ror/rest/registers/27

Response:

{"register": {
  "registry": {
    "description": "The INSPIRE infrastructure involves a number of items, which require clear descriptions and the possibility to be referenced through unique identifiers. Examples for such items include INSPIRE themes, code lists, application schemas or discovery services. Registers provide a means to assign identifiers to items and their labels, definitions and descriptions (in different languages). The INSPIRE registry provides a central access point to a number of centrally managed INSPIRE registers. The content of these registers are based on the INSPIRE Directive, Implementing Rules and Technical Guidelines.",
    "publisher": {
      "label": "European Commission, Joint Research Centre",
      "uri": "https://ec.europa.eu/jrc",
      "email": "inspire-registry-dev@jrc.ec.europa.eu"
    },
    "id": "1",
    "label": "INSPIRE registry",
    "uri": "http://inspire.ec.europa.eu/registry",
    "user": "userid",
    "updatefrequency": "http://publications.europa.eu/resource/authority/frequency/DAILY"
  },
  "description": "Code values for statistics measurement method.",
  "publisher": {
    "label": "European Commission, Joint Research Centre",
    "uri": "https://ec.europa.eu/jrc",
    "email": "inspire-registry-dev@jrc.ec.europa.eu"
  },
  "id": "27",
  "label": "Statistics Measurement Method",
  "uri": "http://inspire.ec.europa.eu/codelist/StatisticsMeasurementMethodValue",
  "updatefrequency": "http://publications.europa.eu/resource/authority/frequency/DAILY"
 }
}

Search interface

The "Federated search" web interface provide a simple searching form with the autocomplete feature. THe system will search through all of the items defined in the different registers that are in the INSPIRE Register Federation.

The result list will provide:

• The label of the item
• The URI of the item
• The URI of the register containing this item

Validation

To be completed

Translation

To be completed