Harvesting Esploro Records via OAI
Syntax and Metadata Examples
This blogpost outlines how to harvest Esploro records via OAI. This blogpost builds on all of the information presented on the OAI Integration documentation page (https://developers.exlibrisgroup.com/esploro/integrations/oai/) by presenting simple examples of syntax and retrieved metadata.
Identify
You can use the Identify verb to retrieve the details of your OAI integration.
Example syntax: https://na01.alma.exlibrisgroup.com/view/oai/01ALLIANCE_WSU/request?verb=Identify
Example metadata:
…
<Identify>
<repositoryName>Washington State University</repositoryName>
<baseURL>https://na01.alma.exlibrisgroup.com/view/oai/01ALLIANCE_WSU/request</baseURL>
<protocolVersion>2.0</protocolVersion>
…
ListSets
You can use the ListSets verb to retrieve the sets produced by your OAI integration.
Example syntax: https://na01.alma.exlibrisgroup.com/view/oai/01ALLIANCE_WSU/request?verb=ListSets
Example metadata:
…
<ListSets>
<set>
<setSpec>17933_thru_17937</setSpec>
<setName>17933thru17937</setName>
</set>
…
ListMetadataFormats
You can use the ListMetadataFormats verb to retrieve the metadata formats available to your OAI integration.
Example syntax: https://na01.alma.exlibrisgroup.com/view/oai/01ALLIANCE_WSU/request?verb=ListMetadataFormats
Example metadata:
…
<ListMetadataFormats>
<metadataFormat>
<metadataPrefix>esploro</metadataPrefix>
<schema>http://alma.exlibrisgroup.com/esploro/esploro_record.xsd</schema>
<metadataNamespace>http://alma.exlibrisgroup.com/esploro</metadataNamespace>
</metadataFormat>
…
ListIdentifiers
You can use the ListIdentifiers verb to retrieve record IDs available from your OAI integration.
Example syntax: https://na01.alma.exlibrisgroup.com/view/oai/01ALLIANCE_WSU/request?verb=ListIdentifiers&metadataPrefix=esploro&set=17933_thru_17937
Example metadata:
…
<ListIdentifiers>
<header>
<identifier>oai:alma.01ALLIANCE_WSU:11333494070001842</identifier>
<datestamp>2020-09-17T01:14:46Z</datestamp>
<setSpec>17933_thru_17937</setSpec>
</header>
<header>
<identifier>oai:alma.01ALLIANCE_WSU:11333486110001842</identifier>
<datestamp>2020-09-17T01:14:46Z</datestamp>
<setSpec>17933_thru_17937</setSpec>
</header>
…
GetRecord
Using the records IDs above, you can harvest individual records within a set via the GetRecord verb.
Example syntax: https://na01.alma.exlibrisgroup.com/view/oai/01ALLIANCE_WSU/request?verb=GetRecord&identifier=oai:alma.01ALLIANCE_WSU:11333494070001842&metadataPrefix=esploro
Example metadata:
…
<GetRecord>
<record>
<header>
<identifier>oai:alma.01ALLIANCE_WSU:11333494070001842</identifier>
<datestamp>2020-09-17T01:14:46Z</datestamp>
<setSpec>17933_thru_17937</setSpec>
</header>
<metadata>
<record xmlns=”http://www.loc.gov/MARC21/slim“ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance“ xsi:schemaLocation=”http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd“>
…
ListRecords
Or, you can harvest all records within a set with the ListRecords verb.
Example syntax: https://na01.alma.exlibrisgroup.com/view/oai/01ALLIANCE_WSU/request?verb=ListRecords&metadataPrefix=esploro&set=17933_thru_17937
Example metadata:
…
<ListRecords>
<record>
<record xmlns=”http://www.loc.gov/MARC21/slim“ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance“ xsi:schemaLocation=”http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd“>
</record>
</record>
<record>
<record xmlns=”http://www.loc.gov/MARC21/slim“ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance“ xsi:schemaLocation=”http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd“>
</record>
</record>
</ListRecords>
…