OAI-PMH 2.0 Verbs

Identify

e.g., http://quod.lib.umich.edu/cgi/o/oai/oai?verb=Identify

This verb identifies the data provider (i.e., you). The response of this verb is created based on the parameters in the $DLXSROOT/lib/oaiGlobals.conf config file.

ListSets

e.g., http://quod.lib.umich.edu/cgi/o/oai/oai?verb=ListSets

ListSets will list the sets in your repository. This verb is used to retrieve the set structure of a collection, which is useful for selective harvesting. Sets can be organized in any manner you wish, e.g., subject, format, chronology.

Set information is used as an optional input by ListIdentifiers and ListRecords.

ListMetadataFormats

e.g., http://quod.lib.umich.edu/cgi/o/oai/oai?verb=ListMetadataFormats&identifier=oai:quod.lib.umich.edu:MIU01-000053324

ListMetadataFormats responds with a list of all the supported formats, e.g., it responds with oai_dc (simple Dublin Core) used alone or with a valid identifier passed in. Other metadata formats are encouraged.

ListIdentifiers

e.g., http://quod.lib.umich.edu/cgi/o/oai/oai?verb=ListIdentifiers&metadataPrefix=oai_dc&set=dlps

This verb will list the identifiers, i.e., the unique record locators, in the repository. If a set is not specified, it will list all the identifiers in groups that have been OAI enabled. If a set is specified, it will list identifiers for the requested set.

GetRecord

e.g., http://quod.lib.umich.edu/cgi/o/oai/oai?verb=GetRecord&metadataPrefix=oai_dc&identifier=oai:quod.lib.umich.edu:MIU01-000053324

GetRecord will return a single record for the identifier requested, in the metadata format requested.

ListRecords

e.g., http://quod.lib.umich.edu/cgi/o/oai/oai?verb=ListRecords&metadataPrefix=oai_dc&set=dlps

This verb works very much like GetRecord, but instead of returning one record, it returns a list of records based on the input parameters. This is the verb harvesters generally use to harvest your collections.