现在位置:首页 > 机器接口 >  OAI-PMH

综合资源登记系统OAI-PMH接口使用说明


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

1、基地址:/irsrOAI

2、OAI-PMH版本:2.0

3、支持最大记录数:100

4、支持元数据格式:oai_dc

5、支持动词:Identify,ListMetadataFormats,ListIdentifiers,ListRecords,GetRecord

6、信息删除标记:无

 二、各动词具体调用简介

2.1、动词Identify

2.1.1、调用地址:/irsrOAI?verb=Identify

2.1.2、可调用参数:无

2.1.3、动词描述:该动词用于检索有关仓储的信息,返回系统的基地址,接口的版本,系统管理员邮箱,系统建立时间,是否包含删

                 除信息以及日期参数的格式。使用该动词检索时,不能添加其他参数信息,否则系统认为参数输入错误。

2.2、动词ListMetadataFormats

2.2.1、调用地址:/irsrOAI?verb=ListMetadataFormats

2.2.2、可调用参数:

       Identifier:可选参数,指定条目的唯一标识。如果调用该参数则返回仓储中与该标识匹配的元数据格式,否则返回仓储中所

       有的元数据格式。

       应用举例:/irsrOAI?verb=ListMetadataFormats&identifier=oai:llas.ac.cn:irsr-C2010000031

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

2.3、动词ListIdentifiers

2.3.1、调用地址:/irsrOAI?verb=ListIdectifiers

2.3.2、可调用参数:

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

       统建立时间。

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

       前时间。

       metadataPrefix:在不使用resumptionToken的情况下为必选参数,返回与metadataPrefix指定的元数据格式匹配的元数据信

       息。(metadataPrefix可用于指定的元数据格式可通过动词ListMetadataFormats请求返回,具体操作见2.2)

       应用举例:

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

       /irsrOAI?verb=ListIdectifiers&from=2010-01-01&until=2011-12-31&metadataPrefix=oai_dc

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

       录,当符合参数条件的请求多于100条时,系统会给出一个流控制标志,将resumptionToken参数设置为这个流控制标志进行请

       求后,系统将返回其他的符合参数条件的信息,直到所有信息都被返回。

       应用举例:

       /irsrOAI?verb=ListIdectifiers&resumptionToken=irsr-100-20100101-20111231-oai_dc

2.3.3、动词描述:该动词用于返回动词ListRecords请求返回信息的头部(headers)信息,包括所有符合参数条件的条目的唯一标识

       和建立时间。

2.4、动词ListRecords

2.4.1、调用地址:/irsrOAI?verb=ListRecords

2.4.2、可调用参数:

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

       统建立时间。

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

       前时间。

       metadataPrefix:在不使用resumptionToken的情况下为必选参数,返回与metadataPrefix指定的元数据格式匹配的元数据信

       息。(metadataPrefix可用于指定的元数据格式可通过动词ListMetadataFormats请求返回,具体操作见2.2)

       应用举例:

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

       /irsrOAI?verb=ListRecords&from=2010-01-01&until=2011-12-31&metadataPrefix=oai_dc

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

       录,当符合参数条件的请求多于100条时,系统会给出一个流控制标志,将resumptionToken参数设置为这个流控制标志进行请

       求后,系统将返回其他的符合参数条件的信息,直到所有信息都被返回。

       应用举例:

       /irsrOAI?verb=ListRecords&resumptionToken=irsr-100-20100101-20111231-oai_dc

2.4.3、动词描述:

       该动词用于从仓储中去所有符合参数条件的条目的详细信息,其中包括:

       条目唯一标识(在节点identifier中);

       条目建立时间(在节点datestamp中);

       条目标题及别名(在节点dc:title中),dc:title可能有多个,第一个是条目的标题,后面的都是该条目的别名;

       条目类别(在节点dc:type中),dc:type可能有多个,第一个表明条目的总分类,irsr中的信息总体分为资源

       (collection),机构(org),服务(service)三类,后面的为条目在总分类下的具体分类。

       条目使用语言(在节点dc:language中);

       条目的描述(在节点dc:description中);

       条目的格式(在节点dc:format中);

       条目的主题(在节点dc:subject中);

       条目的源地址(在节点dc:creator中);

       条目的版权及调用申明(在节点dc:rights中);

2.5、动词GetRecord

2.5.1、调用地址:

       /irsrOAI?verb=GetRecord&identifier=oai:llas.ac.cn:irsr-C2010000031&metadataPrefix=oai_dc

2.5.2、可调用参数:

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

       metadataPrefix:必选参数,返回与metadataPrefix指定的元数据格式匹配的元数据信。(metadataPrefix可用于指定的元数

       据格式可通过动词ListMetadataFormats请求返回,具体操作见2.2)

       应用举例:

       /irsrOAI?verb=GetRecord&identifier=oai:llas.ac.cn:irsr-C2010000031&metadataPrefix=oai_dc

2.5.3、动词描述:

       该动词用于检索仓储中一个单独的条目的所有符合系统指定的元数据格式的元数据信息。返回的条目信息的具体情况参照2.4.3

       中的描述。




  如果您还有其他问题,请联系我们!

  • 技术负责人:刘魏
  • Email:liuw@llas.ac.cn
  • 电话:0931-8273076
版权所有 © 2010-2014 中国科学院兰州文献情报中心
地址:甘肃省兰州市天水中路8号  邮政编码:730000