getExtRif API

getExtRif API Documentation

getRIFCS-architecture

The getExtRif API provides access to the contents of the ANDS Collections Registry, much like the getRIFCS API.

The important difference is that getExtRif includes an additional non-RIFCS element called <extRif:extendedMetadata>. During the processing of new records in the ANDS Registry, this element is populated with additional metadata about the record content and it’s context.

ANDS is able to exploit the rich mesh of metadata and services infrastructure to “enrich” or “annotate” the record content.

Example of these annotations include:

  • resolving subject strings against a controlled vocabulary service (<extRif:subjects>)
  • analysing the spatial information provided and translating it to a geometry compatible with Google Maps (<extRif:spatialGeometry>)
  • richly identifying the links to other objects in the registry (<extRif:related_object>)
  • storing information about the date the record was received in the registry and what URL it was allocated in Research Data Australia (<extRif:updateTimestamp> and <extRif:slug>)

These details are often difficult or impossible to determined from the original RIF-CS XML alone. Use this service is you require the richer content stored in the extended metadata, inferred by ANDS and its partner systems.

Service Usage

Before you start! To use this service, institutions or individuals must register for a free API key.

Resource URL

http://researchdata.ands.org.au/registry/services/{YOUR API KEY}/getExtRif?{params}

Please refer to the getRIFCS service documentation for a description of valid parameters to use for this service. Other than the inclusion of extended metadata in the response contents, these services are identical.

  • This API is a RESTful Web Service. Simply replace the blue parameters with the appropriate values and issue a HTTP GET request.
  • Replace {YOUR API KEY} with the key your organisation registered (no API key? register for free)
  • By default, results are limited to 10 records per request. Use the start and rows parameters to step through additional results.

Common Questions

We are still working on documenting the extRif namespace properly, however, we suggest you refer to the Indexed Fields List as many of these are mapped directly out of the extended metadata.

Example Usage

Retrieving extended metadata for a record

Return a particular record (including it’s extRif annotations):(look for the <extRif:extendedMetadata> element!)

  • Service Response:
    <?xml version="1.0" encoding="UTF-8"; ?>
    <registryObjects xmlns="http://ands.org.au/standards/rif-cs/registryObjects" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ands.org.au/standards/rif-cs/registryObjects http://services.ands.org.au/documentation/rifcs/schema/registryObjects.xsd">
      <registryObject xmlns:extRif="http://ands.org.au/standards/rif-cs/extendedRegistryObjects" group="Australian Ocean Data Network" extRif:enriched="true">
        <key>AODN:c9cb7389-7af1-4e0a-8c95-6f295f1cec1e</key>
        <originatingSource>http://www.aims.gov.au/adc</originatingSource>
    
          <extRif:extendedMetadata>
              <extRif:slug>aims-weather-station-data-cleveland-bay-platform-rain-from-03-jul-1990-to-21-oct-1992</extRif:slug>
              <extRif:dataSourceKey>acdata.unsw.edu.au</extRif:dataSourceKey>
              <extRif:status>PUBLISHED</extRif:status>
    
              <extRif:id>128152</extRif:id>
              <extRif:dataSourceTitle>University of New South Wales - AC Data Main</extRif:dataSourceTitle>
              <extRif:dataSourceID>135</extRif:dataSourceID>
              <extRif:updateTimestamp>1372744479</extRif:updateTimestamp>
    
              <extRif:displayTitle>AIMS Weather Station Data - Cleveland Bay Platform Rain -  From 03 Jul 1990 To 21 Oct 1992</extRif:displayTitle>
              <extRif:listTitle>AIMS Weather Station Data - Cleveland Bay Platform Rain -  From 03 Jul 1990 To 21 Oct 1992</extRif:listTitle>
              <extRif:simplifiedTitle>AIMS Weather Station Data - Cleveland Bay Platform Rain -  From 03 Jul 1990 To 21 Oct 1992</extRif:simplifiedTitle>
    
             <extRif:the_description>This data set was collected by weather sensors deployed on the AIMS Weather Station site Cleveland Bay.</extRif:the_description>
    
              <extRif:subjects>
                  <extRif:subject>
                    <extRif:subject_value>Oceans  -  Ocean Temperature  - Water Temperature</extRif:subject_value>
                    <extRif:subject_type>local</extRif:subject_type>
                    <extRif:subject_resolved>Oceans  -  Ocean Temperature  - Water Temperature</extRif:subject_resolved>
                    <extRif:subject_uri></extRif:subject_uri>
                  </extRif:subject>
                  <extRif:subject>
                    <extRif:subject_value>EARTH SCIENCES - Atmospheric Sciences - Meteorology</extRif:subject_value>
                    <extRif:subject_type>local</extRif:subject_type>
                    <extRif:subject_resolved>EARTH SCIENCES - Atmospheric Sciences - Meteorology</extRif:subject_resolved>
                    <extRif:subject_uri></extRif:subject_uri>
                  </extRif:subject>
                  <extRif:subject>
                    <extRif:subject_value>01</extRif:subject_value>
                    <extRif:subject_type>anzsrc-for</extRif:subject_type>
                    <extRif:subject_resolved>MATHEMATICAL SCIENCES</extRif:subject_resolved>
                    <extRif:subject_uri>http://purl.org/au-research/vocabulary/anzsrc-for/2008/01</extRif:subject_uri>
                  </extRif:subject> 
              </extRif:subjects>
    
              <extRif:spatialGeometry>
                <extRif:polygon>146.88116,-19.15583</extRif:polygon>
                <extRif:extent>146.88116 -19.15583</extRif:extent>
                <extRif:center>146.88116 -19.15583</extRif:center>
                <extRif:area>0</extRif:area>
              </extRif:spatialGeometry>
    
              <extRif:related_object>
                <extRif:related_object_key>AODN:adc@aims.gov.au</extRif:related_object_key>
                <extRif:related_object_id>127501</extRif:related_object_id>
                <extRif:related_object_class>party</extRif:related_object_class>
                <extRif:related_object_display_title>Data Manager, AIMS Data Centre</extRif:related_object_display_title>
                <extRif:related_object_relation>metadataContact</extRif:related_object_relation>
              </extRif:related_object>
    
              <extRif:related_object>
                <extRif:related_object_key>AODN:adc@aims.gov.au</extRif:related_object_key>
                <extRif:related_object_id>128305</extRif:related_object_id>
                <extRif:related_object_class>party</extRif:related_object_class>
                <extRif:related_object_display_title>Alongi, Daniel M, Dr</extRif:related_object_display_title>
                <extRif:related_object_relation>metadataContact</extRif:related_object_relation>
              </extRif:related_object>
    
          </extRif:extendedMetadata>
    
            <collection type="dataset">
                <identifier type="local">AODN:c9cb7389-7af1-4e0a-8c95-6f295f1cec1e</identifier>
                <name type="primary">
                  <namePart type="full">AIMS Weather Station Data - Cleveland Bay Platform Rain -  From 03 Jul 1990 To 21 Oct 1992</namePart>
                </name>
                <location>
                  <address>
                    <electronic type="url">
                      <value>http://mest.aodn.org.au:80/geonetwork/srv/en/metadata.show?uuid=c9cb7389-7af1-4e0a-8c95-6f295f1cec1e</value>
                    </electronic>
                  </address>
                </location>
                <location>
                  <address>
                    <electronic type="url">
                      <value>http://data.aims.gov.au/metadataviewer/faces/view.xhtml?uuid=c9cb7389-7af1-4e0a-8c95-6f295f1cec1e</value>
                    </electronic>
                  </address>
                </location>
                <location dateFrom="1990-07-03T14:00:00" dateTo="1992-10-21T11:00:00" type="coverage">
                  <spatial type="iso19139dcmiBox">northlimit=-19.15583; southlimit=-19.15583; westlimit=146.88116; eastLimit=146.88116; projection=WGS84</spatial>
                </location>
                <relatedObject>
                  <key>AODN:adc@aims.gov.au</key>
                  <relation type="metadataContact"/>
                </relatedObject>
                <relatedObject>
                  <key>AODN:reception@aims.gov.au</key>
                  <relation type="custodian"/>
                </relatedObject>
                <relatedObject>
                  <key>AODN:adc@aims.gov.au</key>
                  <relation type="pointOfContact"/>
                </relatedObject>
                <relatedObject>
                  <key>AODN:Australian Bureau of Statistics: National Information and Referral Service (NIRS)</key>
                  <relation type="owner"/>
                </relatedObject>
                <relatedObject>
                  <key>AODN:adc@aims.gov.au</key>
                  <relation type="isManagedBy"/>
                </relatedObject>
                <subject type="local">Oceans  -  Ocean Temperature  - Water Temperature</subject>
                <subject type="local">EARTH SCIENCES - Atmospheric Sciences - Meteorology</subject>
                <subject type="anzsrc-for">0104</subject>
                <subject type="anzsrc-for">0105</subject>
                <subject type="anzsrc-for">0103</subject>
                <subject type="anzsrc-for">04</subject>
                <subject type="anzsrc-for">9699</subject>
                <description type="brief">This data set was collected by weather sensors deployed on the AIMS Weather Station site Cleveland Bay .
    
          Deployment Information for Rain
          Data Interval: From 03 Jul 1990 Through 21 Oct 1992
          Deployment Location: Cleveland Bay Platform
          Latitude: -19.15583 - Longitude: 146.88116</description>
                <description type="rights">Attribution 3.0 Australia</description>
                <description type="rights">Format for citation of data sourced from the Australian Institute of Marine Science (AIMS) in a list of references is as follows: "Australian Institute of Marine Science. [year-of-data-download], [Title], [data-access-URL], accessed [date-of-access]".</description>
                <description type="rights">Data, products and services from AIMS are provided "as is" without any warranty as to fitness for a particular purpose.</description>
              </collection>
     </registryObject></registryObjects>

Leave a Reply

Your email address will not be published. Required fields are marked *

4 × 4 =