OAI-PMH Provider
OAI-PMH is a standard protocol for metadata harvesting published by the Open Archives Initiative. It is commonly used as a protocol to harvest metadata from Data Providers (such as the RDA Registry) to Service Providers (such as your application).
OAI-PMH is a good choice when your software system already implements a “harvester” (a software application that can extract and collate metadata records from the OAI provider).
One significant advantage of using OAI-PMH is the ability to harvest “incrementally”, based on timestamp. This allows you to only retrieve records that have changed since the last time your harvest successfully executed.
Usage
CODE
https://researchdata.edu.au/registry/services/oai
This API is an implementation of the OAI-PMH protocol. Please consult the specification for implementation details.
Example Usage
Retrieving Information about this OAI-PMH provider
Request
BASH
curl -XGET https://researchdata.edu.au/registry/services/oai\?verb\=IdentifyExample Response
XML
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2018-10-25T11:26:01Z</responseDate>
<request verb="Identify">https://researchdata.edu.au/registry/services/oai</request>
<Identify>
<repositoryName>Australian National Data Services (ANDS)</repositoryName>
<baseURL>https://researchdata.edu.au/registry/services/oai</baseURL>
<protocolVersion>2.0</protocolVersion>
<adminEmail>services@ands.org.au</adminEmail>
<earliestDatestamp>2017-04-21T12:44:42Z</earliestDatestamp>
<deletedRecord>transient</deletedRecord>
<granularity>YYYY-MM-DDThh:mm:ssZ</granularity>
</Identify>
</OAI-PMH>Retrieving which sets are available for selective harvesting
Request
BASH
curl -XGET https://researchdata.edu.au/registry/services/oai\?verb\=ListSetsResponse
XML
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2018-10-25T11:42:56Z</responseDate>
<request verb="ListSets">https://researchdata.edu.au/registry/services/oai</request>
<ListSets>
<set>
<setSpec>class:collection</setSpec>
<setName>collection</setName>
</set>
<set>
<setSpec>class:service</setSpec>
<setName>service</setName>
</set>
<set>
<setSpec>class:party</setSpec>
<setName>party</setName>
</set>
<set>
<setSpec>class:activity</setSpec>
<setName>activity</setName>
</set>
<set>
<setSpec>datasource:60</setSpec>
<setName>ALA GeoNetwork</setName>
</set>
<set>
<setSpec>datasource:58</setSpec>
<setName>ANDS Discovered Services</setName>
</set>
...
<resumptionToken completeListSize="111" cursor="0">eyJvZmZzZXQiOjEwMH0=</resumptionToken>
</ListSets>
</OAI-PMH>
Retrieving RIFCS records
Request
BASH
curl -XGET https://researchdata.edu.au/registry/services/oai\?verb\=ListRecords\&metadataPrefix\=rifSample Response
XML
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:default="http://ands.org.au/standards/rif-cs/registryObjects" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2018-10-25T11:44:57Z</responseDate>
<request verb="ListRecords" metadataPrefix="rif">https://researchdata.edu.au/registry/services/oai</request>
<ListRecords>
<record>
<header>
<identifier>oai:ands.org.au::248</identifier>
<datestamp>2017-10-06T01:25:00Z</datestamp>
<setSpec>class:service</setSpec>
<setSpec>datasource:9</setSpec>
<setSpec>datasource:Australian-Institute-of-Marine-Science-Metadata-Catalogue</setSpec>
<setSpec>group:9</setSpec>
<setSpec>group:Australian-Institute-of-Marine-Science</setSpec>
<setSpec>group:Australian0x20Institute0x20of0x20Marine0x20Science</setSpec>
</header>
<metadata>
<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 group="Australian Institute of Marine Science">
<key>AIMS/b0cba902-4e15-4d23-a568-e7cd4b201aac</key>
<originatingSource>http://eatlas.org.au</originatingSource>
<service type="report">
<identifier type="global">b0cba902-4e15-4d23-a568-e7cd4b201aac</identifier>
<identifier type="uri">http://eatlas.org.au/data/uuid/b0cba902-4e15-4d23-a568-e7cd4b201aac</identifier>
<name type="primary">
<namePart>eAtlas Web Mapping Service (WMS) - Legacy MTSRF Server (AIMS)</namePart>
</name>
<relatedObject>
<key>AIMS/71127e4d-9f14-4c57-9845-1dce0b541d8d</key>
<relation type="isPartOf"/>
</relatedObject>
<location>
<address>
<electronic type="url" target="landingPage">
<value>http://eatlas.org.au/data/uuid/b0cba902-4e15-4d23-a568-e7cd4b201aac</value>
</electronic>
</address>
</location>
<relatedObject>
<key>AIMS/Lawrey,Eric,Dr</key>
<relation type="pointOfContact"/>
</relatedObject>
<relatedObject>
<key>AIMS/AustralianInstituteofMarineScience(AIMS)</key>
<relation type="hasAssociationWith"/>
</relatedObject>
<subject type="local">biota</subject>
<subject type="local">boundaries</subject>
<subject type="local">elevation</subject>
<subject type="local">planningCadastre</subject>
<subject type="local">imageryBaseMapsEarthCover</subject>
<subject type="local">biota</subject>
<subject type="local">boundaries</subject>
<subject type="local">elevation</subject>
<subject type="local">planningCadastre</subject>
<subject type="local">imageryBaseMapsEarthCover</subject>
<description type="brief">The eAtlas delivers its mapping products via two Web Mapping Services, a legacy server (from 2008-2011) and a newer primary server (2011+) to which all new content it added. This record describes the legacy WMS.
This service delivers map layers associated with the eAtlas project (http://eatlas.org.au), which contains map layers of environmental research focusing on the Great Barrier Reef. The majority of the layers corresponding to Glenn De'ath's interpolated maps of the GBR developed under the MTSRF program (2008-2010).
This web map service is predominantly maintained for the legacy eAtlas map viewer (http://maps.eatlas.org.au/geoserver/www/map.html). All the these legacy map layers are available through the new eAtlas mapping portal (http://maps.eatlas.org.au), however the legends have not been ported across.
This WMS is implemented using GeoServer version 1.7 software hosted on a server at the Australian Institute of Marine Science.
For ArcMap use the following steps to add this service:
1. "Add Data" then choose GIS Servers from the "Look in" drop down.
2. Click "Add WMS Server" then set the URL to "http://maps.eatlas.org.au/geoserver/wms?"
Note: this service has around 460 layers of which approximately half the layers correspond to Standard Error maps, which are WRONG (please ignore all *Std_Error layers.
This services is operated by the Australian Institute of Marine Science and co-funded by the MTSRF program.</description>
<coverage>
<spatial type="iso19139dcmiBox">northlimit=90; southlimit=-90; westlimit=-180; eastLimit=180; projection=EPSG</spatial>
<spatial type="text">northlimit=90; southlimit=-90; westlimit=-180; eastLimit=180; projection=EPSG</spatial>
</coverage>
<relatedInfo type="website">
<identifier type="uri">http://maps.eatlas.org.au/geoserver/</identifier>
<relation type="hasAssociationWith"/>
<title>Welcome page for the legacy eAtlas GeoServer WMS. From here you can find all service capabilities and layer previews</title>
</relatedInfo>
<relatedInfo type="website">
<identifier type="uri">http://maps.eatlas.org.au/geoserver/www/map.html</identifier>
<relation type="hasAssociationWith"/>
<title>legacy eAtlas mapping portal, which allows viewing of all the layers from this service.</title>
</relatedInfo>
<rights>
<licence type="CC-BY" rightsUri="http://creativecommons.org/licenses/by/2.5/au/">Creative Commons Attribution</licence>
</rights>
</service>
</registryObject>
</registryObjects>
</metadata>
</record>
<record>
<header>
<identifier>oai:ands.org.au::249</identifier>
<datestamp>2017-10-06T01:25:09Z</datestamp>
<setSpec>class:service</setSpec>
<setSpec>datasource:9</setSpec>
<setSpec>datasource:Australian-Institute-of-Marine-Science-Metadata-Catalogue</setSpec>
<setSpec>group:9</setSpec>
<setSpec>group:Australian-Institute-of-Marine-Science</setSpec>
<setSpec>group:Australian0x20Institute0x20of0x20Marine0x20Science</setSpec>
</header>
<metadata>
<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 group="Australian Institute of Marine Science">
<key>AIMS/71127e4d-9f14-4c57-9845-1dce0b541d8d</key>
<originatingSource>http://eatlas.org.au</originatingSource>
<service type="report">
<identifier type="global">71127e4d-9f14-4c57-9845-1dce0b541d8d</identifier>
<identifier type="uri">http://eatlas.org.au/data/uuid/71127e4d-9f14-4c57-9845-1dce0b541d8d</identifier>
<location>
<address>
<electronic type="url" target="directDownload">
<value>http://maps.eatlas.org.au/maps/ows?service=wms&version=1.1.1&request=GetCapabilities</value>
<title>GetCapabilities document for the WMS version 1.1.1</title>
<mediaType>application/octet-stream</mediaType>
</electronic>
</address>
</location>
<name type="primary">
<namePart>eAtlas Web Mapping Service (WMS) (AIMS)</namePart>
</name>
<relatedObject>
<key>AIMS/f55b4dbc-a944-4246-ba12-d6e5110dd8c7</key>
<relation type="isPartOf"/>
</relatedObject>
<location>
<address>
<electronic type="url" target="landingPage">
<value>http://eatlas.org.au/data/uuid/71127e4d-9f14-4c57-9845-1dce0b541d8d</value>
</electronic>
</address>
</location>
<rights>
<accessRights type="open"/>
</rights>
<relatedObject>
<key>AIMS/Lawrey,Eric,Dr</key>
<relation type="pointOfContact"/>
</relatedObject>
<relatedObject>
<key>AIMS/AustralianInstituteofMarineScience(AIMS)</key>
<relation type="hasAssociationWith"/>
</relatedObject>
<subject type="local">biota</subject>
<subject type="local">boundaries</subject>
<subject type="local">elevation</subject>
<subject type="local">planningCadastre</subject>
<subject type="local">imageryBaseMapsEarthCover</subject>
<subject type="local">biota</subject>
<subject type="local">boundaries</subject>
<subject type="local">elevation</subject>
<subject type="local">planningCadastre</subject>
<subject type="local">imageryBaseMapsEarthCover</subject>
<description type="brief">The eAtlas delivers its mapping products via two Web Mapping Services, a legacy server (from 2008-2011) and a newer primary server (2011+) to which all new content it added. This record describes the primary WMS.
This service delivers map layers associated with the eAtlas project (http://eatlas.org.au), which contains map layers of environmental research focusing on the Great Barrier Reef and its neighbouring coast, the Wet Tropics rainforests and Torres Strait. It also includes lots of reference datasets that provide context for the research data. These reference datasets are sourced mostly from state and federal agencies. In addition to this a number of reference basemaps and associated layers are developed as part of the eAtlas and these are made available through this service.
This services also delivers map layers associated with the Torres Strait eAtlas.
This web map service is predominantly set up and maintained for delivery of visualisations through the eAtlas mapping portal (http://maps.eatlas.org.au) and the Australian Ocean Data Network (AODN) portal (http://portal.aodn.org.au). Other portals are free to use this service with attribution, provided you inform us with an email so we can let you know of any changes to the service.
This WMS is implemented using GeoServer version 2.3 software hosted on a server at the Australian Institute of Marine Science. Associated with each WMS layer is a corresponding cached tiled service which is much faster then the WMS. Please use the cached version when possible.
The layers that are available can be discovered by inspecting the GetCapabilities document generated by the GeoServer. This XML document lists all the layers, their descriptions and available rendering styles. Most WMS clients should be able to read this document allowing easy access to all the layers from this service.
For ArcMap use the following steps to add this service:
1. "Add Data" then choose GIS Servers from the "Look in" drop down.
2. Click "Add WMS Server" then set the URL to "http://maps.eatlas.org.au/maps/wms?"
Note: this service has over 1000 layers and so retrieving the capabilities documents can take a while.
This services is operated by the Australian Institute of Marine Science and co-funded by the National Environmental Research Program Tropical Ecosystems hub.</description>
<coverage>
<spatial type="iso19139dcmiBox">northlimit=90; southlimit=-90; westlimit=-180; eastLimit=180; projection=EPSG</spatial>
<spatial type="text">northlimit=90; southlimit=-90; westlimit=-180; eastLimit=180; projection=EPSG</spatial>
</coverage>
<relatedInfo type="website">
<identifier type="uri">http://maps.eatlas.org.au/maps/</identifier>
<relation type="hasAssociationWith"/>
<title>Welcome page for the eAtlas GeoServer WMS. From here you can find all service capabilities and layer previews</title>
</relatedInfo>
<relatedInfo type="service">
<identifier type="uri">http://maps.eatlas.org.au/maps/ows</identifier>
<relation type="supports">
<description>Access via service</description>
<url>http://maps.eatlas.org.au/maps/ows?service=wms&version=1.1.1&request=GetCapabilities</url>
</relation>
<title>GetCapabilities document for the WMS version 1.1.1</title>
</relatedInfo>
<relatedInfo type="website">
<identifier type="uri">http://maps.eatlas.org.au</identifier>
<relation type="hasAssociationWith"/>
<title>eAtlas mapping portal, which allows viewing of all the layers from this service (and some others)</title>
</relatedInfo>
<rights>
<licence type="CC-BY" rightsUri="http://creativecommons.org/licenses/by/2.5/au/">Creative Commons Attribution</licence>
</rights>
</service>
</registryObject>
</registryObjects>
</metadata>
</record>
...
<resumptionToken completeListSize="79695" cursor="100">eyJsaW1pdCI6MTAwLCJzZXQiOm51bGwsIm9mZnNldCI6MTAwLCJmcm9tIjpudWxsLCJ0byI6bnVsbCwidmVyYiI6Ikxpc3RSZWNvcmRzIiwibWV0YWRhdGFQcmVmaXgiOiJyaWYifQ==</resumptionToken>
</ListRecords>
</OAI-PMH>
Retrieving RIFCS records for a given set
Request
BASH
curl -XGET https://researchdata.edu.au/registry/services/oai\?verb\=ListRecords\&metadataPrefix\=rif\&set\=group:26Sample Response
XML
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:default="http://ands.org.au/standards/rif-cs/registryObjects" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2018-10-25T11:55:17Z</responseDate>
<request verb="ListRecords" metadataPrefix="rif" set="group:26">https://researchdata.edu.au/registry/services/oai</request>
<ListRecords>
<record>
<header>
<identifier>oai:ands.org.au::82172</identifier>
<datestamp>2017-09-13T03:50:11Z</datestamp>
<setSpec>class:collection</setSpec>
<setSpec>datasource:60</setSpec>
<setSpec>datasource:ALA-GeoNetwork</setSpec>
<setSpec>group:26</setSpec>
<setSpec>group:ALA</setSpec>
</header>
<metadata>
<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 group="ALA">
<key>ALA/ccfaf426a6dd0fc438e967779ac37cab7b4ed61c</key>
<originatingSource>Atlas of Living Australia</originatingSource>
<collection type="dataset" dateAccessioned="2017-01-12T01:19:14">
<identifier type="global">ccfaf426a6dd0fc438e967779ac37cab7b4ed61c</identifier>
<name type="primary">
<namePart>occurrence_density</namePart>
</name>
<location>
<address>
<electronic type="url">
<value>http://spatial.ala.org.au</value>
</electronic>
</address>
</location>
<relatedObject>
<key>ALA/DaveMartin</key>
<relation type="pointOfContact"/>
</relatedObject>
<relatedObject>
<key>ALA/AtlasofLivingAustralia</key>
<relation type="hasAssociationWith"/>
</relatedObject>
<coverage>
<spatial type="iso19139dcmiBox">northlimit=-17.349999999999994; southlimit=-38.55; westlimit=113.9833; eastLimit=152.9333; projection=EPSG:4326</spatial>
<spatial type="text">northlimit=-17.349999999999994; southlimit=-38.55; westlimit=113.9833; eastLimit=152.9333; projection=EPSG:4326</spatial>
</coverage>
<relatedInfo type="service">
<identifier type="uri">http://localhost:8084/geoserver/wms?SERVICE=WMS&</identifier>
<relation type="isAvailableThrough"/>
<title>ALA:odensity_1463021672399</title>
<notes>occurrence_density</notes>
</relatedInfo>
<relatedInfo>
<title>A very simple color map (LegendURL)</title>
</relatedInfo>
<rights>
<rightsStatement rightsUri="http://spatial.ala.org.au"/>
</rights>
<dates type="modified">
<date type="dateFrom" dateFormat="W3CDTF">20170112T01:19:14</date>
</dates>
</collection>
</registryObject>
</registryObjects>
</metadata>
</record>
<record>
<header>
<identifier>oai:ands.org.au::82173</identifier>
<datestamp>2017-09-13T03:50:11Z</datestamp>
<setSpec>class:party</setSpec>
<setSpec>datasource:60</setSpec>
<setSpec>datasource:ALA-GeoNetwork</setSpec>
<setSpec>group:26</setSpec>
<setSpec>group:ALA</setSpec>
</header>
<metadata>
<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 group="ALA">
<key>ALA/DaveMartin</key>
<originatingSource>Atlas of Living Australia</originatingSource>
<party type="person">
<name type="primary">
<namePart>Dave Martin</namePart>
</name>
<relatedObject>
<key>ALA/AtlasofLivingAustralia</key>
<relation type="isMemberOf"/>
</relatedObject>
<location>
<address>
<electronic type="url">
<value>http://geoserver.org</value>
</electronic>
</address>
</location>
<location>
<address>
<physical type="streetAddress">
<addressPart type="telephoneNumber">+61 2 6246 4439</addressPart>
</physical>
</address>
</location>
</party>
</registryObject>
</registryObjects>
</metadata>
</record>
...
<resumptionToken completeListSize="3879" cursor="100">eyJsaW1pdCI6MTAwLCJzZXQiOiJncm91cDoyNiIsIm9mZnNldCI6MTAwLCJmcm9tIjpudWxsLCJ0byI6bnVsbCwidmVyYiI6Ikxpc3RSZWNvcmRzIiwibWV0YWRhdGFQcmVmaXgiOiJyaWYifQ==</resumptionToken>
</ListRecords>
</OAI-PMH>