OAI-PMH Provider

OAI-PMH Provider Documentation

 

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 ANDS 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).

Unlike the Collection Registry APIs, the OAI-PMH provider only supports a few methods of selective harvesting (based on group, data source and record class). There are no complex search capabilities.

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. Further, the OAI-PMH metadata also indicates when a record has been deleted from the registry (a feature not supported in any of the other Collection Registry APIs).

Service Usage

Resource URL

https://researchdata.ands.org.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

  • Service Response:
    <?xml version="1.0" encoding="UTF-8"; ?>
    <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>2013-10-16T01:21:18Z</responseDate>
    	<request verb="Identify">http://researchdata.ands.org.au/registry/services/oai</request>
    	<Identify>
    		<repositoryName>Australian National Data Service (ANDS)</repositoryName>
    		<baseUrl>http://researchdata.ands.org.au/registry/</baseUrl>
    		<protocolVersion>2.0</protocolVersion>
    		<earliestTimestamp>2010-01-12T05:03:58+Z</earliestTimestamp>
    		<deletedRecord>transient</deletedRecord>
    		<granularity>YYYY-MM-DDThh:mm:ssZ</granularity>
    		<adminEmail>services@ands.org.au</adminEmail>
    	</Identify>
    </OAI-PMH>

Retrieving which sets are available for selective harvesting

Return all the indexed metadata about a particular collection:

  • Service Response:
    <?xml version="1.0" encoding="UTF-8"; ?>
    <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>2013-10-22T01:49:52Z</responseDate>
    <request verb="ListSets">http://researchdata.ands.org.au/registry/services/oai</request>
    <ListSets>
    	<set>
    	<setSpec>datasource:Breast-Cancer-Tissue-Bank</setSpec>
    	<setName>Breast Cancer Tissue Bank</setName>
    	</set>
    	<set>
    	<setSpec>datasource:Australian-Institute-of-Marine-Science-Metadata-Catalogue</setSpec>
    	<setName>Australian Institute of Marine Science Metadata Catalogue</setName>
    	</set>
    	<set>
    	<setSpec>datasource:Australian-Centre-for-Microscopy-Microanalysis</setSpec>
    	<setName>Australian Centre for Microscopy Microanalysis</setName>
    	</set>
    	<set>
    	<setSpec>datasource:Australian-Historical-Archaeology-Database</setSpec>
    	<setName>Australian Historical Archaeology Database</setName>
    	</set>
    	<set>
    	<setSpec>datasource:UTS-Seeding-the-Commons</setSpec>
    	<setName>UTS – Seeding the Commons</setName>
    	</set>
    	<set>
    	<setSpec>datasource:University-of-Western-Australia-Harvester</setSpec>
    	<setName>University of Western Australia Harvester</setName>
    	</set>
    	<set>
    	<setSpec>datasource:Victoria-University</setSpec>
    	<setName>Victoria University</setName>
    	</set>
    	<set>
    	<setSpec>datasource:QFAB2</setSpec>
    	<setName>QFAB2</setName>
    	</set>
    	<set>
    	<setSpec>datasource:Australian-Supersite-Network</setSpec>
    	<setName>Australian Supersite Network</setName>
    	</set>
    
    	<set>
    	<setSpec>class:collection</setSpec>
    	<setName>collection</setName>
    	</set>
    	<set>
    	<setSpec>class:service</setSpec>
    	<setName>service</setName>
    	</set>
    	<set>
    	<setSpec>class:activity</setSpec>
    	<setName>activity</setName>
    	</set>
    	<set>
    	<setSpec>class:party</setSpec>
    	<setName>party</setName>
    	</set>
    
    	<set>
    	<setSpec>group:Australian0x20Ocean0x20Data0x20Network</setSpec>
    	<setName>Australian0x20Ocean0x20Data0x20Network</setName>
    	</set>
    	<set>
    	<setSpec>group:Commonwealth0x20Scientific0x20and0x20Industrial0x20Research0x20Organisation</setSpec>
    	<setName>Commonwealth0x20Scientific0x20and0x20Industrial0x20Research0x20Organisation</setName>
    	</set>
    	<set>
    	<setSpec>group:Curtin0x20University</setSpec>
    	<setName>Curtin0x20University</setName>
    	</set>
    	<set>
    	<setSpec>group:Integrated0x20Marine0x20Observing0x20System</setSpec>
    	<setName>Integrated0x20Marine0x20Observing0x20System</setName>
    	</set>
    	<set>
    	<setSpec>group:James0x20Cook0x20University</setSpec>
    	<setName>James0x20Cook0x20University</setName>
    	</set>
    	<set>
    	<setSpec>group:University0x20of0x20Western0x20Sydney</setSpec>
    	<setName>University0x20of0x20Western0x20Sydney</setName>
    	</set>
    	<set>
    	<setSpec>group:University0x20of0x20Wollongong</setSpec>
    	<setName>University0x20of0x20Wollongong</setName>
    	</set>
    	<set>
    	<setSpec>group:Urban0x20Water</setSpec>
    	<setName>Urban0x20Water</setName>
    	</set>
    	<set>
    	<setSpec>group:Urban0x20Water0x20Security0x20Research0x20Alliance</setSpec>
    	<setName>Urban0x20Water0x20Security0x20Research0x20Alliance</setName>
    	</set>
    	<set>
    	<setSpec>group:Victoria0x20University</setSpec>
    	<setName>Victoria0x20University</setName>
    	</set>
    	<set>
    	<setSpec>group:Victorian0x20Institute0x20of0x20Sport</setSpec>
    	<setName>Victorian0x20Institute0x20of0x20Sport</setName>
    	</set>
    </ListSets>
    </OAI-PMH>

Retrieving records for a particular set

  • Service Response:
    <?xml version="1.0" encoding="UTF-8"; ?>
    <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>2013-10-22T01:55:58Z</responseDate>
    	<request verb="ListRecords" set="group:Victorian0x20Institute0x20of0x20Sport" metadataPrefix="rif">http:/researchdata.ands.org.au/registry/services/oai</request>
    	<ListRecords>
    		<record>
    			<header>
    				<identifier>oai:ands.org.au::19601</identifier>
    				<datestamp>2012-01-18T23:30:37Z</datestamp>
    				<setSpec>datasource:Victoria-University</setSpec>
    				<setSpec>class:party</setSpec>
    				<setSpec>group:Victorian0x20Institute0x20of0x20Sport</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="Victorian Institute of Sport">
    				    <key>102.100.100/6891</key>
    				    <originatingSource>http://services.ands.org.au/sandbox/orca/register_my_data</originatingSource>
    				    <party type="group" dateModified="2011-06-29T00:00:00Z">
    				      <identifier type="handle">102.100.100/6891</identifier>
    				      <name type="primary">
    				        <namePart type="title">Victorian Institute of Sport (VIS)</namePart>
    				      </name>
    				      <location>
    				        <address>
    				          <electronic type="url">
    				            <value>http://www.vis.org.au/</value>
    				          </electronic>
    				          <physical type="postalAddress">
    				            <addressPart type="faxNumber">+61 3 9425 0100</addressPart>
    				            <addressPart type="telephoneNumber">+61 3 9425 0000</addressPart>
    				            <addressPart type="addressLine">PO Box 12608,  A'Beckett St, Melbourne VIC 8006</addressPart>
    				          </physical>
    				        </address>
    				        <spatial type="kmlPolyCoords">144.980494,-37.824249</spatial>
    				      </location>
    				      <relatedObject>
    				        <key>102.100.100/6886</key>
    				        <relation type="isFunderOf"/>
    				      </relatedObject>
    				      <relatedObject>
    				        <key>102.100.100/6885</key>
    				        <relation type="hasAssociationWith"/>
    				      </relatedObject>
    				      <relatedObject>
    				        <key>102.100.100/6893</key>
    				        <relation type="hasMember"/>
    				      </relatedObject>
    				      <relatedObject>
    				        <key>102.100.100/7214</key>
    				        <relation type="isFunderOf"/>
    				      </relatedObject>
    				      <subject type="anzsrc-for">1106</subject>
    				      <description type="brief">The VIS was set up to assist the development of Victoria's best athletes. It was established in 1990 by the State Government as a private trustee company, with its Board of Directors appointed by the Victorian Minister for Sport. The VIS is funded by the State Government through Sport and Recreation Victoria, the Commonwealth Government through the Australian Sports Commission and numerous corporate sector sponsors. The VIS provides programs in partnership with State Sporting Organisations, and also offers advanced and specialised coaching, sports science and sports medicine services, career and education advice, and training and competition support are provided to VIS athletes, as well as offering emerging elite athletes from country Victoria assistance through Regional Academy of Sport programs.</description>
    				    </party>
    				  </registryObject></registryObjects>
    			</metadata>
    		</record>
    		<record>
    			<header>
    				<identifier>oai:ands.org.au::19620</identifier>
    				<datestamp>2012-01-18T23:30:37Z</datestamp>
    				<setSpec>datasource:Victoria-University</setSpec>
    				<setSpec>class:party</setSpec>
    				<setSpec>group:Victorian0x20Institute0x20of0x20Sport</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="Victorian Institute of Sport">
    				    <key>102.100.100/6893</key>
    				    <originatingSource>http://services.ands.org.au/sandbox/orca/register_my_data</originatingSource>
    				    <party type="person">
    				      <identifier type="handle">102.100.100/6893</identifier>
    				      <name type="primary">
    				        <namePart type="family">Dwyer</namePart>
    				        <namePart type="given">Dan</namePart>
    				        <namePart type="title">Dr</namePart>
    				      </name>
    				      <location>
    				        <address>
    				          <physical type="postalAddress">
    				            <addressPart type="addressLine">PO Box 12608,'Beckett St, Melbourne VIC 8006</addressPart>
    				          </physical>
    				        </address>
    				      </location>
    				      <relatedObject>
    				        <key>102.100.100/7214</key>
    				        <relation type="isParticipantIn"/>
    				      </relatedObject>
    				      <relatedObject>
    				        <key>102.100.100/6886</key>
    				        <relation type="hasAssociationWith"/>
    				      </relatedObject>
    				      <relatedObject>
    				        <key>102.100.100/6891</key>
    				        <relation type="isMemberOf"/>
    				      </relatedObject>
    				      <subject type="anzsrc-for">1106</subject>
    				      <description type="brief">Specialties in cycling science, fatigue in the brain during exercise and after training, monitoring training intensity and volume, the use of technology in sport science, weight loss, exercise and immune function.</description>
    				    </party>
    				  </registryObject></registryObjects>
    			</metadata>
    		</record>
    	</ListRecords>
    </OAI-PMH>

Leave a Reply

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

sixteen − two =