DB34/T 2837-2017 公共图书馆 总分馆 数据接口规范

ICS

35.100

L79

DB34

安徽省地方标准

DB34/T2837—2017

公共图书馆总分馆数据接口规范

Thepubliclibrary-centralbranchlibrariesDatainterfacespecification

2017-03-30发布2017-04-30实施

安徽省质量技术监督局发布

DB34/T2837—2017

目

次

前言II

1范围1

2规范性引用文件1

3术语和定义1

4数据元素的描述格式3

5数据与接口3

5.1认证4

5.2成员馆注册与注销4

5.3总分馆资源数据6

5.4总分馆馆藏数据14

5.5总分馆流通统计15

5.6总分馆流通操作19

5.7总分馆用户操作22

附录A（规范性附录）数据字典28

参考文献36

I

DB34/T2837—2017

前

言

本标准按照GB/T1.1-2009给出的规则起草。

本标准由安徽省图书馆提出。

本标准由安徽省信息技术标准化技术委员会归口。

本标准起草单位：安徽省图书馆、安徽省智慧公共文化服务工程技术研究中心、安徽省质量和标准

化研究院、安徽华博胜讯信息科技股份有限公司、合肥市图书馆、合肥工业大学、安徽大学。

本标准主要起草人：胡敏、王学杰、许俊松、步翠兰、刘树峰、王建涛、李永钢、智淑英、吴锦、

郑利平、林泽明、汪佂。

II

DB34/T2837—2017

公共图书馆总分馆数据接口规范

1范围

本标准规定了图书馆业务信息化系统之间的数据接口规范。

本标准适用于公共图书馆、高校图书馆和数字资源提供商，也可适用于图书馆行业信息资源交换体

系的设计与建设。

2规范性引用文件

下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文

件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。

GB/T2260中华人民共和国行政区划代码

GB/T2659世界各国和地区名称代码

GB/T3304中国各民族名称的罗马字母拼写法和代码

GB/T4658学历代码

GB/T7408数据元和交换格式信息交换日期和时间表示法

GB/T10114县级以下行政区划代码编制规则

GB11643公民身份号码

GA/T2000.156公安信息代码第156部分:常用证件代码

《中国图书馆分类法》[第五版]

3术语和定义

下列术语和定义适用于本文件。

3.1

公共图书馆联盟publiclibraryconsortium

县、区及其以上级公共图书馆形成的联盟。

3.2

成员馆memberlibrary

注册成为图书馆联盟正式成员的图书馆。

3.3

总分馆central-branchlibrary

在一个总馆下设立若干分馆,实行一元化垂直管理体系和网状结构模式。

1

DB34/T2837—2017

3.4

机器可读目录machinereadablecatalog，MARC

以代码形式和特定结构记录在计算机存储载体上的、可供计算机识别与阅读的目录。

3.5

本体数据ontologydata

由MARC描述的目标数据。

3.6

发现级别exposelevel

阅读资源在文献编目级别的对外暴露程度。

3.7

可用级别availablelevel

最终读者或软件获得本体数据的能力程度。

3.8

收割harvest

根据发现级别，联盟或成员馆以下载的形式获得其他成员馆文献编目的过程。

3.9

揭示reveal

将MARC数据以可视化的形式向用户呈现、表示的过程。

3.10

馆藏reserves

图书馆收集的各种类型文献资料的总和。

3.11

流通circulation

图书或其他资源进出图书馆的过程。

3.12

数据元素dataelement

用一组属性描述定义、标识、表示和允许值的数据单元，它是图书馆业务自动化系统间数据接口所

输入和输出数据的不可分割的基本单位。

2

DB34/T2837—2017

3.13

活动activity

活动是对图书馆举办的线上和线下聚会的泛称。

4数据元素的描述格式

数据元素的描述格式如下：

a)标识符：数据元素的内部唯一标识，由字母与数字组合形成；

b)名称：数据元素的中文名称；

c)说明：数据元素内容的描述与解释；

d)表示格式：数据元素值的类型及长度的表示形式，具体形式见表1；

e)备注：与该数据元素相关的其他说明，包括数据元素的取值范围、遵循的标准规范要求等。

表1数据元素的表示格式

字符含义说明

用C后直接加自然数的方式表示定长，如C4表示4个字符定

C表示数据类型为字符型

长（一个汉字相当于两个Byte）。

N表示数据类型为数值型N后直接加自然数的方式表示定长，N3表示3位数字定长。

用D后加4、6、8等，分别表示不同数据格式的日期型数据元。

D4表示YYYY即只表示到年份；

D表示数据类型为日期型和日期时间型D6表示YYYY-MM即表示到月份；

D8表示YYYY-MM-DD即表示到日。

遵循GB/T7408数据和交换格式信息交换日期和时间表示法。

用T后加2、4、6分别表示不同数据格式的时间型数据元。

T2表示hh即只表示小时；

T表示数据类型为时间型T4表示hh:mm即表示到分钟；

T6表示hh:mm:ss即表示到秒。

注意，本部分为24小时制。

n代表4、6、8，m代表2、4、6。

DnTm表示日期时间型

例如D8T6,表示YYYY-MM-DDhh:mm:ss

BL表示数据类型为布尔型

BN表示数据类型为二进制型在数据格式中应标识出二进制的具体格式，如“JPEG”。

N表示字段的最小长度，M表示字段

如C..6表示最多6个字符；

N..M最大长度（N可以省去，表示可以是

N2..7表示最少2位数字最多7位数字

空串，M不可省去）

N..p,q(p、q

表示数据类型为数值型，最长p位，

均代表一个如N..8,2表示最多8位数字，小数点后2位

小数点后q位（小数点前为p-q位）

自然数)

注：在系统建设中遇到数据格式为“..”时建议按最大值使用

5数据与接口

3

DB34/T2837—2017

5.1认证

定义：Stringauthenticate(StringjsonStr);

描述：成员馆登录认证。

参数说明：遵循JSON格式串要求，数据元素描述见表2。

表2认证接口参数表

标识符名称说明表示格式备注

在成员馆中此凭证需要满足唯一

loginname用户名用户凭证C..30

性要求

SHA处理过的口令通讯端保证用户口令经过SHA

password口令C..60

串。512处理。

参数jsonStr示例：

{

"loginname":"uname",

"password":"pwd"

}

返回值说明：遵循JSON格式串要求，数据元素描述见表3。

表3认证接口返回值表

标识符名称说明表示格式备注

state执行状态指示功能的执行状态N1取值范围见附录A.5

statedesc状态描述执行结果的详细描述C..100

返回值示例：

{

"state":0,

"statedesc":"执行成功"

}

5.2成员馆注册与注销

5.2.1注册

定义：Stringenroll(StringjsonStr);

描述：成员馆注册。

参数说明：遵循JSON格式串要求，数据元素描述见表4。

表4成员馆基本信息表

标识符名称说明表示格式备注

librarycode成员馆编码成员馆唯一标识符C..20参见附录A.19

libraryname成员馆名称成员馆中文名称C..100图书馆对外公示的名称

loginname用户名用户凭证C..30在成员馆中此凭证满足唯一性要求

4

DB34/T2837—2017

表4（续）

标识符名称说明表示格式备注

password口令SHA处理过的口令串C..60用户口令经过SHA512处理

libraryaddr成员馆地址通讯地址C..100

librarycity所在城市城市全称C..50

libraryprovince所在省份省份全称C..100

enrolldate注册日期注册发生日D8非生效日

unenrolldate注销日期注销发生日D8注销当日即为生效日

参数jsonStr示例：

{

"librarycode":"成员馆编码",

"libraryname":"成员馆名称",

"loginname":"登录名",

"password":"口令",

"libraryaddr”:"成员馆地址",

"librarycity":"所在城市",

"libraryprovince":"所在省份",

"enrolldate":"注册日期",

"unenrolldate":"注销日期"

}

返回值说明：参见5.1认证接口的返回值说明。

返回值示例：参见5.1认证接口的返回值示例。

5.2.2注销

定义：Stringunenroll(StringjsonStr);

描述：成员馆注销，注销后即表示退出联盟，不再享有联盟所提供的各项功能及服务。

参数说明：遵循JSON格式串要求，数据元素描述见表5。

表5注销接口参数表

标识符名称说明表示格式备注

在成员馆中此凭证需要满足

loginname用户名用户凭证C..30

唯一性要求

通讯端保证用户口令经过

password口令SHA处理过的口令串。C..60

SHA512处理。

librarycode成员馆编码要注销的成员馆编码C..20参见附录A.19

参数jsonStr示例：

{

"loginname":"uname",

"password":"pwd",

"librarycode":"成员馆编码"

5

DB34/T2837—2017

}

返回值说明：参见5.1认证接口的返回值说明。

返回值示例：参见5.1认证接口的返回值示例。

5.3总分馆资源数据

5.3.1资源接口数据

资源接口数据包括CNMARC描述的资源和数字资源厂商系统描述的元数据资源，具体描述见表6。

表6资源接口数据描述表

标识符名称说明表示格式备注

记录外部资源的标识符，与成

rdid资源描述ID员馆、收割来源一起组成组合C..30分馆各自系统的控制号

唯一索引

librarycode成员馆编码成员馆唯一标识符C..20参见附录A.19

自动化系统为书目条目生成

catalogcode文献编目代码C..50

的唯一标识符

seriesname丛书名丛书名C..100可选

若是MARC书目，则取F200a

title题名书名、杂志名等C..100

字段的值

若是MARC书目，则取F010a

isocodeisbn或issn号图书国际统一编码C..100

字段的值

若是MARC书目，则取F210c

publisher出版社C..150

字段的值

若是MARC书目，则取F210d

publishdate出版日期D4

字段的值

若是MARC书目，则取F200f

author著者作者，书的或者文章的作者C..300

字段的值

authormodifier著者类型书的作者，杂志的编者等C..20取值范围见附录A.12

对于杂志来说，提供杂志目

abstract摘要内容提要C..200录；

对于书籍则提供内容提要

主题词,关键字，可以是句子；

topic主题词C..200

均以逗号隔开

一个引用地址，不保存封面数可选，接口实现者若提供本值

coverpicture封面图片C..100

据本身须为有效URL地址。

可选，对于报刊、杂志须提供

publishingperiod出版周期期刊，杂志的出版周期N..4本值,单位是天；

对于非期刊，该值设置为0

对于纸本，按照实际馆藏数量

赋值，多卷数或纸本资源，此

reservescopier藏量成员馆中总藏量N..2

值为0，具体值写入表13，

对于数字资源，取值为1

6

DB34/T2837—2017

表6（续）

标识符名称说明表示格式备注

可以是厂商网址信息；

也可以是成员馆标识符或厂

标识本条资源收割自哪个数商的标识，如superstar（超

harvestsource收割来源C..100

字资源厂商或成员馆星），bookan（博看）等，可

由收割接口实现提供者自行

定义

如果发现级别为2，本链可用

于获得源文献目录所描述的

sourceurl源URL资源链接C..512明细信息；

如果使用级别为2，本链将可

用于直接下载本体数据。

收割来源的书目数自动化系统中，编目阶段对图

origindate据创建（变更）日书进行书目编目时所创建（变D8

期更）的书目数据的当天日期。

收割到检索库或索引库的日

harvestdate收割日期D8

期

exposelevel发现级别N1取值范围见附录A.1

取值范围：

availablelevel使用级别N11代表内部完全可用，

2代表对外完全可用

searchtype数据检索类型N1取值范围见附录A.3

mediatype媒体类型N1取值范围见附录A.6

pdf,html,txt,avi,mp4,wmv

fileformat资源格式C..50

等等；标示资源类型

书籍、期刊、学位论文（学位）、

电影、电视剧、综艺、动漫、

arttype艺术类型C..50例如：动漫、新闻、电影等等

直播、新闻、娱乐、体育、游

戏、短视频

location地域大陆、香港、美国等C..50

若资源本体不可以获得，则在

remark备注C..500

此提供咨询信息等等

Api实现者，可根据情况使用数据形式，采用json数组形

altfield0备用C..4000

本字段传递额外信息式。

Api实现者，可根据情况使用数据形式，采用json对象形

altfield1备用C..4000

本字段传递额外信息式。

5.3.2活动接口数据

活动资源数据描述见表7。

7

DB34/T2837—2017

表7活动资源数据描述表

标识符名称说明表示格式备注

id活动标识内部标识N16

code活动编码各馆系统内的活动标识C..30

title活动名称C..100

abstracts活动简介摘要C..300

例如培训、讲座、电影播放、创客活

types活动类型C..40

动等

采纳馆方系统中对等的数据，是指活

动所涉及主题的分类词，例如饮食、

keywords活动关键字C..40馆方可自行定义

茶道、解读、人物、教育、少儿等等，

允许有多个关键字，以逗号隔开。

url宣传地址宣传图片或视频的地址C..80

address活动举办地邮政的地址C..100

startdate活动举办日D8

天为单位，可以是小数，如0.5代

continuenum活动持续日N2

表半天

enddate活动结束日D8

0代表1次，其余数字代表周期，

periodnum活动周期性N2

例如7代表每隔7天进行一次

如期举行为1，

status活动状态如期举行；提前取消N1

提前取消为2

librarycode活动所属单位指各级图书馆，包括乡镇文化站等C..20参见附录A.19

1为固定场所，

portable活动流动性固定场所，巡演如下乡活动等等C..40

2为巡演。

contactman活动联系人接口人C..40

contactphone活动联系人电话C..20

sponsor活动主办方C..40

sponsorphone主办方联系电话C..20

organizer活动承办方C..40

organizerphone承办方联系电话C..20

partingnum参加人数N6

partednum实际参加人数N6

commentsnum评论量N10

Api实现者，可根据情况使用本字段数据形式，采用json

altfield0备用