Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

As per the OAI-PMH specification, there are various queries that can be performed on the records in your Samvera repository. The string [URL] displayed in these examples should be replaced with the repository’s URL when following the query’s syntax.

Identify

To view general information about your OAI-PMH feed, including your Request URL, click the Identify link or enter the following query.

[URL]/catalog/oai?verb=Identify

List records

To view all records in the repository, click the ListRecords link or enter the following query. 

[URL]/catalog/oai?verb=ListRecords

If the repository has different metadata prefixes, it may be necessary to specify the prefix as per the following queries.

[URL]/catalog/oai?verb=ListRecords&metadataPrefix=oai_dc

[URL]/catalog/oai?verb=ListRecords&metadataPrefix=oai_hyku

List sets

Whether the repository uses collections and/or admin sets, one can query by the sets. For a list of the sets, click the ListSets link or enter the following query.

[URL]/catalog/oai?verb=ListSets

List metadata formats

To view all the metadata formats in the OAI feed, click the link for ListMetadataFormats or enter the following query.

[URL]/catalog/oai?verb=ListMetadataFormats

Unless other metadata formats have been configured, the default metadata prefix is oai_dc.

List Identifiers

To view all identifiers in the repository, click the ListIdentifiers link or enter the following query.

[URL]/catalog/oai?verb=ListIdentifiers

[URL]/catalog/oai?verb=ListIdentifiers&metadataPrefix=oai_dc

List records by set

Sets are configured locally by an institution. To view all records by a set, click on ListSets link or, in a particular implementation, enter according to the query syntax examples.

[URL]/catalog/oai?verb=ListRecords&metadataPrefix=oai_dc&set=collection:[collection name]

[URL]/catalog/oai?verb=ListRecords&metadataPrefix=oai_dc&set=unit:[internal identifier]

Resumption Tokens

OAI-PMH feeds typically consist of a large amount of data. For most queries, you will likely need to use the resumption tokens to get the entire data set. One can use the Resume link or copy and paste the resumptionToken string into the query to continue pulling results.