OAIINONE开放资源集成服务平台

OAI-PMH接口使用说明

一、OAI-PMH接口基本调用信息

1、基础地址：/oaOAI

2、OAI-PMH版本：2.0

3、支持最大记录数：10

4、支持元数据格式：oai_dc

5、支持动词：Identify，ListMetadataFormats，ListSets, ListIdentifiers，ListRecords，GetRecord

二、各动词具体调用简介

2.1、动词Identify

2.1.1、调用地址：/oaOAI?verb=Identify

2.1.2、可调用参数：无

2.1.3、动词描述：该动词用于检索有关仓储的信息，返回系统的基地址，接口的版本，系统管理员邮箱，系统建立时间以及日期参数的格式。使用该动词检索时，不能添加其他参数信息，否则系统认为参数输入错误。

2.2、动词ListMetadataFormats

2.2.1、调用地址：/oaOAI?verb=ListMetadataFormats

2.2.2、可调用参数：无

2.2.3、动词描述：该动词用于检索仓储中可获取的元数据格式。

2.3、动词ListSets

2.2.1、调用地址：/oaOAI?verb=ListSets

2.2.2、可调用参数：无

2.2.3、动词描述：该动词用于检索仓储中可获取的集合信息。

2.4、动词ListIdentifiers

2.4.1、调用地址：/oaOAI?verb=ListIdectifiers

2.4.2、可调用参数：

l from：格式为YYYY-MM-DD的可选参数，指定了获取信息的建立时间的下限。当不使用该参数时，系统默认将时间下限设置为系统建立时间。

l until：格式为YYYY-MM-DD的可选参数，指定了获取信息的建立时间的上限。当不使用该参数时，系统默认将时间上限设置为当前时间。

l set：必须使用，以确定合适的集合。

l metadataPrefix：在不使用resumptionToken的情况下为必选参数，返回与metadataPrefix指定的元数据格式匹配的元数据信息。

应用举例：以上三个参数可根据需要全部使用或全部不用也可按任意组合使用。

/oaOAI?verb=ListIdentifiers&from=2017-12-06&until=2017-12-08&set=PR&metadataPrefix=oai_dc

l resumptionToken：独立存在的参数，不能与from,until和metadataPrefix同时使用，由于系统设置每次请求最多返回10条记

录，当符合参数条件的请求多于10条时，系统会给出一个流控制标志，将resumptionToken参数设置为这个流控制标志进行请求后，系统将返回其他的符合参数条件的信息，直到所有信息都被返回。

应用举例：

/oaOAI?verb=ListIdentifiers&resumptionToken=1483953345137:10:968145:oai_dc

2.4.3、动词描述：该动词用于从仓储中找出所有符合参数条件的标识符。

2.5、动词ListRecords

2.5.1、调用地址：/oaOAI?verb=ListRecords

2.5.2、可调用参数：

l from：格式为YYYY-MM-DD的可选参数，指定了获取信息的建立时间的下限。当不使用该参数时，系统默认将时间下限设置为系统建立时间。

l until：格式为YYYY-MM-DD的可选参数，指定了获取信息的建立时间的上限。当不使用该参数时，系统默认将时间上限设置为当前时间。

l set：必须使用，以确定合适的集合。

l metadataPrefix：在不使用resumptionToken的情况下为必选参数，返回与metadataPrefix指定的元数据格式匹配的元数据信息。

应用举例：以上三个参数可根据需要全部使用或全部不用也可按任意组合使用。

/oaOAI?verb=ListRecords&from=2017-12-06&until=2017-12-08&set=PR&metadataPrefix=oai_dc

l resumptionToken：独立存在的参数，不能与from,until和metadataPrefix同时使用，由于系统设置每次请求最多返回10条记录，当符合参数条件的请求多于10条时，系统会给出一个流控制标志，将resumptionToken参数设置为这个流控制标志进行请求后，系统将返回其他的符合参数条件的信息，直到所有信息都被返回。

应用举例：

/oaOAI?verb=ListRecords&resumptionToken=1483953345137:10:968145:oai_dc

2.5.3、动词描述：

该动词用于从仓储中找出所有符合参数条件的条目的详细信息。

2.6、动词GetRecord

2.6.1、调用地址：/oaOAI?verb=GetRecord

2.6.2、可调用参数：

l Identifier：可选参数，指定条目的唯一标识。如果调用该参数则返回仓储中与该标识匹配的条目的详细信息。

l metadataPrefix：必选参数，返回与metadataPrefix指定的元数据格式匹配的元数据信。（metadataPrefix可用于指定的元数据格式可通过动词ListMetadataFormats请求返回，具体操作见2.2）

应用举例：

/oaOAI?verb=GetRecord&identifier=oai:or.clas.ac.cn:1000&metadataPrefix=oai_dc

2.6.3、动词描述：

该动词用于检索仓储中一个单独的条目的所有符合系统指定的元数据格式的元数据信息。

三、元数据信息说明

元素标题	字段名	说明
题名	dc:title	作品题名, 可有多个，第一个为主题名，后面的都是别名
作者	dc:creator	作品的创作者，包括专利发明/设计人。
贡献者	dc:contributor	对作品内容做出贡献的其他责任者
主题词	dc:subject	作品的主题属性，IR中对应于作品的关键词描述。
描述	dc:description	作品内容描述或摘要
类型	dc:type	作品内容类型
出版者	dc:publisher	作品相关的出版者信息
来源	dc:source	作品的出处信息，IR中以规范引用格式信息方式给出
日期	dc:date	作品发表、出版、发布、报告的日期；学位论文答辩日期、专利授权日期等。
语种	dc:language	作品内容使用的语种信息
标识符	dc:identifier	URI标识
格式	dc:format	作品的MIME类型等格式信息
时空范围	dc:coverage	与作品内容有关时空信息
关系	dc:relation	相关资源
版权申明	dc:rights	版权申明

元数据示例截图：