OAI Documentation
OregonDigital has a standard OAI interface which supports Dublin Core (oai_dc) and Qualified Dublin Core (oai_qdc). It can be accessed at /oai with standard verbs. Example URLs:
- Identify: http://oregondigital.org/oai?verb=Identify
- ListRecords: http://oregondigital.org/oai?verb=ListRecords&metadataPrefix=oai_dc or http://oregondigital.org/oai?verb=ListRecords&metadataPrefix=oai_qdc
- ListSets: http://oregondigital.org/oai?verb=ListSets
- ListIdentifiers: http://oregondigital.org/oai?verb=ListIdentifiers&metadataPrefix=oai_dc or http://oregondigital.org/oai?verb=ListIdentifiers&metadataPrefix=oai_qdc
- ListRecords + Set: http://oregondigital.org/oai?verb=ListRecords&metadataPrefix=oai_qdc&set=oregondigital:osu-yearbooks
- ListRecords with resumptionToken: http://oregondigital.org/oai?verb=ListRecords&resumptionToken=oai_qdc.s(oregondigital:osu-yearbooks):100
Configuration for OD's OAI interface can be found in app.yml, which is used by https://github.com/OregonDigital/oregondigital/blob/master/lib/oregon_digital/oai/provider.rb.
The Ruby-OAI gem is used: https://github.com/code4lib/ruby-oai
https://github.com/OregonDigital/oregondigital/blob/master/lib/oregon_digital/oai/concern.rb
- OAI requests need to retrieve information from Solr, not Fedora, to provide timely responses.
- Labels should be displayed instead of URIs.
- Restricted Items should not be included.
- For compound items, only the parent object is returned, child items are not included.
A thumbnails controller was written to provide the thumbnail image URL given the item's pid. This was used with a template in Primo by MWDL.
This image 'request': http://oregondigital.org/thumbnails/oregondigital-h989r3203.jpg
Resolves to the actual file: http://oregondigital.org/media/thumbnails/3/0/oregondigital-h989r3203.jpg
- Mountain West Digital Library (Primo)
- Example Results
- Oregon Explorer (Blacklight LibraryFind)
- Western Waters Digital Library (PKP Open Archives Harvester)
- Mountain West Digital Library: Instructions for Setting up new OAI Hubs: http://mwdl.org/getinvolved/repository_setup.php
- OAI Request Examples: http://memory.loc.gov/ammem/oamh/oai_request.html