我们鼓励网站管理员同我们的网站建立链接。您可以从网址栏中复制URL,也可以建立您自己的API/URL(见下文)。我们要求您直接与世行网站建立链接,不要将世行网页嵌入您的网站。
目前,我们找出了一个与文件库档案结果建立链接的改进方法。请参见下文示例。
文件与报告固定API
文件与报告数据库可支持两类页面的简化URL,一类是结果页面,另一类是文件档案页面。即便今后文件与报告数据库移入新平台,我们也将确保固定API得到支持,因此用户不必改变其与世行文件链接的URL。
上述页面的URL由三部分组成,它们共同确定:(1);处理指令所采用的应用程序;(2)用户端的页面形式;(3)该页面所显示的文件。
这三部分共同表现为以下形式:
http:///?
域名
从技术上讲,URL的第一部分为域名。就本网站而言,域名是"documents.shihang.org”。
指令类型
用户端的页面形式,即URL的第二部分,根据指令类型确定。指令类型有两种,一种是“档案”,一种是“查询”。如输入第一种指令,得到的回复将是单个文件档案(或资料档案)。如输入第二种指令,得到的回复将是与该指令相符的一系列文件。
指令类型 | 用户端页面 |
---|---|
档案 | 单个文件的全套档案,同时设有与文件本身的一个或多个链接。 |
查询 | 查询结果为以清单或表格形式显示的一系列文件。 |
参数序列
URL的第三部分也是最后一部分由一个或几个参数及其数值组成,它们共同确定网页所显示的文件或一系列文件。参数及其数值序列由(置于指令类型前的)“?”将其与指令类型分开。
“档案”类指令要求有单个参数“docid”(文件识别号),其数值为页面所显示的档案文件的影像银行(ImageBank)或文件与报告识别号。参数名称“docid”由“=”与其数值分开。
除“docid”参数外,“档案”指令也支持可选参数“pageLanguage”(页面语言)。该参数确定档案显示页面的语言种类,可以由非英语网站以该网站所用语言显示影像银行文件。目前,系统可支持法语和西班牙语。
参数名称 | 说明 |
---|---|
文件识别号 | 该文件的识别号码,其档案将被显示。 |
页面语言 | 档案显示页面的语言种类。目前,这一功能尚未启用。 |
例如:
documents.shihang.org/record?docid=000160016_20040929135419
如输入“查询”指令,回复页面上所列出的为一系列文件。该指令可有一个或几个参数,每增加一个指令将会使所显示的结果更精确。这些参数与文件档案中的某个属性相对应。每个参数名称由“=”与其数值分开。如果使用一对以上参数/数值,每对新增参数/数值由“&”将其与前面的一对分开,但首对之前无需使用“&”。如要为某属性查询一个以上数值,可以为该属性增加几对参数/数值(每对均由一个数值),也可以将参数名称使用一次,然后列出几个数值,并用空格将这些数值分开。在为某个属性查询多个数值时,得到的文件数量将会增加,因为结果中可能会包括以前每个数值下所查询的文件。
与“档案”指令一样,“查询”指令也可以指定结果显示页面的语言种类。目前,系统可支持法语和西班牙语。
参数名称 | 数值 | 说明 |
---|---|---|
文字 | 文字 | 一个或几个字 |
标题 | 文字 | 文件标题 |
文集 | 文字 | 文件所属文集的标题 |
来源 | 文字 | 文件来源 |
作者 | 文字 | 文件作者 |
地区 | 文字或识别号 | 文件所属的地区 |
国家 | 文字或识别号 | 文件所属的国家 |
部门 | 文字或识别号 | 文件所属的部门 |
分部门 | 文字或识别号 | 文件所属的分部门 |
主题 | 文字或识别号 | 文件所阐述的主题 |
文件大类 | 文字或识别号 | 文件所属的文件大类 |
文件类型 | 文字或识别号 | 文件本身 |
语言 | 文字或识别号 | 文件编写或译文所采用的语言 |
日期 | 年/月/日 | 文件提交或公开的日期 |
开始日期 | 年/月/日 | 日期范围的开始日。所显示的文件必须是在该日或此后提交或公开的文件。具体操作时,有无截止日期并不重要。如果未输入截止日期,页面将显示截止当前的文件。 |
截止日期 | 年/月/日 | 日期范围的截止日。所显示的文件必须是在该日或此前提交或公开的文件。具体操作时,有无开始日期并不重要。如果未输入开始日期,日期范围将包括到截止日之前的所有日期。 |
报告 | 识别号 | 为该文件设定的报告号码 |
硬贷款 | 识别号 | 文件所属硬贷款的号码 |
软贷款 | 识别号 | 与该文件有关的软贷款号码 |
项目 | 文字或识别号 | 文件所属项目的名称或识别号 |
信托基金 | 识别号 | 与文件有关的信托基金 |
页面大小 | 数字 | 每页所显示的结果数量(不超过50条) |
页面语言 | 识别号 | 结果页面所用的语言。系统目前支持的语言为法语和西班牙语。 |
排列方式 | 结果排列所依据的属性(“日期”、“标题”、“报告”或“文件类型”)。除日期以将序排列外, 其余均已升序排列。 |
参见以下示例:
列出关于单个主题的文件:
documents.shihang.org/query?topic=Education
列出关于单个主题和国家的文件:
documents.shihang.org/query?country=China&topic=Education
查询某一确定日期出版或公布的所有文件与报告:
documents.shihang.org/query?date=2004/2/4
查询两个日期范围内就一个主题出版或公布的所有文件与报告:
documents.shihang.org/query?startDate=2004/1/1&endDate=2004/2/1&topic=Agriculture
查询所有阿拉伯语文件:
documents.shihang/query?language=Arabic