OAI interface documentation

For SIL International's repository for the SIL Language and Culture Archives.

This repository is compatible with the protocols of both the OAI (Open Archives Initiative) and OLAC (Open Language Archives Community).

Repository identifier: sil.org
OAI protocol version: 2.0
OLAC protocol version: 1.0
BASE-URL: http://www.ethnologue.com/sil_archives2.asp

Verbs

For arguments (O) indicates optional, (M) indicates mandatory, and (E) indicates exclusive (ie. that parameter and no others may be specified, otherwise that parameter may no be specified).

• verb=Document
  test: verb=Document

• verb=GetRecord
  arguments=identifier(M), metadataPrefix(M)
  test: verb=GetRecord&identifier=oai:sil.org:10003&metadataPrefix=oai_dc
  test: verb=GetRecord&identifier=oai:sil.org:10003&metadataPrefix=olac

• verb=Identify
  test: verb=Identify

• verb=ListIdentifiers
  arguments=until(O), from(O), set(O), resumptionToken(E)
  test: verb=ListIdentifiers&metadataPrefix=oai_dc
  test: verb=ListIdentifiers&metadataPrefix=olac
  test: verb=ListIdentifiers&resumptionToken=part2
  test: verb=ListIdentifiers&metadataPrefix=olac&from=2005-01-01
  test: verb=ListIdentifiers&metadataPrefix=olac&until=2006-01-01
  test: verb=ListIdentifiers&metadataPrefix=olac&from=2005-01-01&until=2006-01-01

• verb=ListMetadataFormats
  arguments=identifier(O)
  test: verb=ListMetadataFormats
  test: verb=ListMetadataFormats&identifier=oai:sil.org:10003

• verb=ListRecords
  arguments=until(O), from(O), set(O), resumptionToken(E), metadataPrefix(M)
  test: verb=ListRecords&metadataPrefix=oai_dc
  test: verb=ListRecords&metadataPrefix=olac
  test: verb=ListRecords&resumptionToken=11olac
  test: verb=ListRecords&resumptionToken=39olac
  test: verb=ListRecords&resumptionToken=49olac

• verb=ListSets
  test: verb=ListSets

Metadata formats

In this implementation the following two formats are available for all records.

• prefix=olac
  schema=http://www.language-archives.org/OLAC/1.0/olac.xsd
• prefix=oai_dc
  schema=http://www.openarchives.org/OAI/2.0/oai_dc.xsd

See output from verb=ListMetadataFormats.
 

Error conditions

The following links test the error conditions reported by this repository:

• error=badArgument
  test: verb=GetRecord&identifier=oai:ethnologue.com:AAA
  test: verb=GetRecord&metadataPrefix=oai_dc
  test: verb=ListIdentifiers
  test: verb=ListIdentifiers&resumptionToken=part2&metadataPrefix=oai_dc
  test: verb=ListRecords
  test: verb=ListIdentifiers&metadataPrefix=olac&from=2003-01-01&until=2002-01-01
  test: verb=ListIdentifiers&metadataPrefix=olac&from=2003/01/01
  test: verb=ListIdentifiers&metadataPrefix=olac&from=2002-12-1
  test: verb=ListIdentifiers&metadataPrefix=olac&until=2004-jan-01

• error=badResumptionToken
  test: verb=ListIdentifiers&resumptionToken=X32
  test: verb=ListRecords&resumptionToken=X32
  test: verb=ListRecords&resumptionToken=x2olac

• error=badVerb
  test: verb=Query

• error=cannotDisseminateFormat
  test: verb=GetRecord&identifier=oai:sil.org:10003&metadataPrefix=marc
  test: verb=ListIdentifiers&metadataPrefix=marc
  test: verb=ListRecords&metadataPrefix=marc

• error=idDoesNotExist
  test: verb=GetRecord&identifier=oai:sil:10003&metadataPrefix=oai_dc
  test: verb=GetRecord&identifier=oai:sil.org:ABCD&metadataPrefix=oai_dc
  test: verb=ListMetadataFormats&identifier=oai:sil.org:ABCD

• error=noRecordsMatch
  test: verb=ListIdentifiers&metadataPrefix=olac&from=2006-01-01
  test: verb=ListIdentifiers&metadataPrefix=olac&until=2005-01-01

• error=noMetadataFormats
  Not applicable, since every valid identifier may return both oai_dc and olac metadata.

• error=noSetHierarchy
  test: verb=ListSets
  test: verb=ListIdentifiers&set=Languages