Parameters / invocation

The url for the module takes the form /Oai/<provider>?parameters Where:

URL Part Description
provider Is the code for the provider of the data (it will be restricted by client IP address as to which machines can provide/request data for a provider)

The possible parameters are:

Parameter Description
verb This tels the server which method to run, the available methods are:
identify, listMetadataFormats, listSets, listIdentifiers, listRecords, getRecord.
The parameters for each method are explained below
identifier This identifies a single record using a unique identifier example: oai:http://oai.com:someProvider:1
from This specifies the from date to be applied to the search. The expected format of the date can be obtained my calling the identify method.
until This specifies the until date to be applied to the search. The expected format of the date can be obtained my calling the identify method.
metadataPrefix This will specify which metadata types are available. To all the metadata types can be obtained my calling the identify method.
set This is used to limit the search to a specific set. The default set is "default".
resumptionToken This is a token given by the server to allow continuation of a search that holds more than 100 results.

The available methods/verbs are:

Method/Verb Parameters
Identify Parameters:
NONE.
listMetadataFormats Parameters:
identifier.
listSets Parameters:
resumptionToken.
listIdentifiers Parameters:
from, until, metadataPrefix(required), set, resumptionToken.
listRecords Parameters:
from, until, metadataPrefix(required), set, resumptionToken.
getRecord Parameters:
identifier(required), metadataPrefix(required).

All searches will return structured XML