金盘图书馆集成管理系统系统接口说明二次开发接口北京金盘鹏图软件技术有限公司文档修改记录表日期修订版本描述作者2013.8.311.0初稿完成金盘开发部2013.9.11.1增加新书通报函数1.根据时间段获取新书newbooksbetweenday2.检索图书并返回详细信息Searchbookreutndetaildata3.获取超期读者详细信息(带外借列表)getoverdayreaderdetailinfor金盘开发部2013.9.71.2增加图书催还函数:getoverdayreaderbydays金盘开发部2014.6.11.3增加续借函数Prenewbook增加预约函数pbespeakbook金盘开发部北京金盘鹏图软件技术有限公司系统接口:金盘二次开发接口秘密第1页共15页修订时间:2013年9月1日1.1概述二次开发的应用系统可以借助金盘图书馆集成管理系统系统所建立的标准化信息平台最大限度的实现信息共享,使得数字化校园的应用领域得到更大的扩展。1.1.1接口形式接口采用http协议返回json格式数据中间库采用数据交换系统完成数据参照1.1.2网络连接方式接口和金盘服务之间采用TCP/IP和HTTP方式链接!服务依赖Oracle客户端。请在安装接口的计算机上安装oracle客户端1.1.3功能描述1、http服务接口:完成http服务中的相关功能2、中间库:完成统计分析等功能1.1.4接口说明:(一)HTTP服务端口所有返回值都为Unicode转义汉字格式为\uXXXX开发时请注意结果的转义(二)如果服务开启凭据认证功能请在请求时附加凭据中的用户名和密码一、HTTP服务功能1、服务地址:http://发布IP或域名:发布端口/datasnap/rest/TInterFace/2、函数名称及说明1.获取新书通报列表(带复本信息)http://发布IP或域名:发布端口/datasnap/rest/TInterFace/newbooks/天数;入口参数:天数(如:输入30为30天内的新书)返回值:返回值为标准的JSON格式数据JSON节点值说明:北京金盘鹏图软件技术有限公司系统接口:金盘二次开发接口秘密第2页共15页修订时间:2013年9月1日ReturnValue:返回值0为成功-1为失败MSG:消息返回Data:数据集合数据集合定义:MainKay主键码DBKay库键码BTitle题名BAuther责任者BPublish出版者BPublishDay出版日期BPublishLocal出版地BCallNo索书号BISBN标准编码BLangusge语种代码LocalList馆藏信息列表LocalList集合定义:AcessNo登录号BarCode条形码LocalName馆藏地址BorryState外借状态Price价格说明:每层深度的FCount属性都为当前深度列表的记录数量2.获取新书通报列表(不带复本信息)http://发布IP或域名:发布端口/datasnap/rest/TInterFace/newbooksnolocal/天数入口参数:天数(如:输入30为30天内的新书)返回值:返回值为标准的JSON格式数据JSON节点值说明:ReturnValue返回值0成功-1失败北京金盘鹏图软件技术有限公司系统接口:金盘二次开发接口秘密第3页共15页修订时间:2013年9月1日MSG:消息返回Data:数据集合数据集合节点含义:MainKay主键码DBKay库键码BTitle题名BAuther责任者BPublish出版者BPublishDay出版日期BPublishLocal出版地BCallNo索书号BISBN标准编码BLangusge语种代码说明:每层深度的FCount属性都为当前深度列表的记录数量3.根据主键码获得图书复本信息列表http://发布IP或域名:发布端口/datasnap/rest/TInterFace/localbooklist/主键码入口参数:主键码(图书书目的唯一ID)返回值:返回值为标准的JSON格式数据JSON节点值说明:ReturnValue返回值0成功-1失败MSG:消息返回Data:数据集合数据集合节点含义:AcessNo登录号BarCode条形码LocalName馆藏地址BorryState外借状态北京金盘鹏图软件技术有限公司系统接口:金盘二次开发接口秘密第4页共15页修订时间:2013年9月1日Price价格说明:每层深度的FCount属性都为当前深度列表的记录数量4.获得读者信息(包括外借图书列表)http://发布IP或域名:发布端口/datasnap/rest/TInterFace/readerinfor/获取方式/传递值|入口参数:获取方式0:使用借书证号获取1:使用读者条码获取传递值:如果使用借书证号则传递值为借书证号如果使用条形码则传递值为读者条码说明:字符串变量传递必须以”|”结束返回值:返回值为标准的JSON格式数据JSON节点值说明:ReturnValue返回值0成功-1失败MSG:消息返回CardNo:借书证号BarCode:读者条码UserName:姓名Sex:性别RUnit:单位RType:类型RClass:班级Address:联系地址Pho:联系电话Email:电子邮件State:状态BroowList:外借图书列表BroowList集合节点说明:Title:题名Auther:责任者publish:出版者publishDay:出版日期ISBN:标准编码CallNo:索书号AcessNo:登录号北京金盘鹏图软件技术有限公司系统接口:金盘二次开发接口秘密第5页共15页修订时间:2013年9月1日BarCode:条形码BorrowTime:外借时间ReturnTime:应归还时间RenewCount:续借次数说明:每层深度的FCount属性都为当前深度列表的记录数量5.获得已超期的读者信息列表http://发布IP或域名:发布端口/datasnap/rest/TInterFace/getoverdayreaderinfor入口参数:无返回值:返回值为标准的JSON格式数据JSON节点值说明ReturnValue返回值0成功-1失败Msg返回消息ReaderList:读者列表ReaderList集合节点说明CardNo:借书证号BarCode:读者条码UserName:姓名Sex:性别RUnit:单位RType:类型RClass:班级Address:联系地址Pho:联系电话Email:电子邮件State:状态说明:每层深度的FCount属性都为当前深度列表的记录数量6.图书检索http://发布IP或域名:发布端口/datasnap/rest/TInterFace/searchbook/检索类型/检索值入口参数:检索类型:检索类型输入标准北京金盘鹏图软件技术有限公司系统接口:金盘二次开发接口秘密第6页共15页修订时间:2013年9月1日TITLE:书名AUTHER:作者PUBLISH:出版者CALLNO:索书号LANAGE:语种DATATYPE:文献类型SUBJECT:主题词ISBN:标准编码检索值:检索关键字返回值:返回值为标准的JSON格式数据JSON节点值说明ReturnValue:返回值0成功-1失败Msg:返回消息Data:返回结果集Data集合节点说明:MainKay:主键码DBKay:库键码BTitle:题名BAuther:责任者BPublish:出版者BPublishDay:出版日期BPublishLocal:出版地BCallNo:索书号BISBN:标准编码BLangusge:语种代码7.根据日期范围获得新书通报http://发布IP或域名:发布端口/datasnap/rest/TInterFace/newbooksbetweenday/开始日期/结束日期北京金盘鹏图软件技术有限公司系统接口:金盘二次开发接口秘密第7页共15页修订时间:2013年9月1日入口参考:开始日期:查询的开始日期结束日期:查询的结束日期返回结果:请参考新书通报查询结果8.图书检索返回详细信息http://发布IP或域名:发布端口/datasnap/rest/TInterFace/searchbookreutndetaildata/检索类型/检索值功能说明:文献数据检索并返回详细信息(带馆藏信息)入口参数:请参考图书检索入口参数说明返回值:请参考新书通报返回值说明9.获取所有超期读者信息(带外借列表)http://发布IP地址或域名:发布端口/datasnap/rest/TInterFace/getoverdayreaderdetailinfor功能说明:获取超期读者详细信息(带外借列表)入口参数:无返回值:返回值为标准的JSON格式数据JSON节点值说明ReturnValue返回值0成功-1失败Msg返回消息ReaderList:读者列表ReaderList定义请参考[获得读者信息(包括外借图书列表)]函数的返回值说明10.获得读者催还信息http://发布IP或域名:发布端口/datasnap/rest/TInterFace/getoverdayreaderbydays/提前催还天数入口参数:提前催还天数:提前催还的天数返回值:请参考:获得已超期的读者信息列表的返回定义北京金盘鹏图软件技术有限公司系统接口:金盘二次开发接口秘密第8页共15页修订时间:2013年9月1日11.检查读者是否可注销http://发布IP地址或域名:发布端口/datasnap/rest/TInterFace/checkreadercanlogout/检查类型/类型值功能说明:检查读者是否可注销入口参数:获取方式0:使用借书证号获取1:使用读者条码获取传递值:如果使用借书证号则传递值为借书证号如果使用条形码则传递值为读者条码说明:字符串变量传递必须以”|”结束返回值:返回值为标准的JSON格式数据JSON节点值说明:ReturnValue返回值0成功-1失败MSG:消息返回12.注销读者http://发布IP地址或域名:发布端口/datasnap/rest/TInterFace/logoutreader/类型/类型值功能说明:注销读者入口参数:获取方式0:使用借书证号获取1:使用读者条码获取传递值:如果使用借书证号则传递值为借书证号如果使用条形码则传递值为读者条码说明:字符串变量传递必须以”|”结束返回值:返回值为标准的JSON格式数据JSON节点值说明:ReturnValue返回值0成功-1失败MSG:消息返回13.读者基本信息http://发布IP地址或域名:发布端口/datasnap/rest/TInterFace/getreaderbaseinfor/类型/类型值功能说明:注销读者入口参数:获取方式0:使用借书证号获取1:使用读者条码获取2:使用身份证号获取传递值:如果使用借书证号则传递值为借书证号如果使用条形码则传递值为读者条码说明:字符串变量传递必须以”|”结束返回值:返回值为标准的JSON格式数据JSON节点值说明:ReturnValue返回值0成功-1失败MSG:消息返回北京金盘鹏图软件技术有限公司系统接口:金盘二次开发接口秘密第9页共15页修订时间:2013年9月1日RaderName:读者姓名ReaderSex:读者性别ReaderUnit:读者单位ReaderType:读者级别PassWord:读者密码14.图书续借http://发布IP地址或域名:发布端口/datasnap/rest/TInterFace/prenewbook/图书条码/读者条码功能说明:续借图书图书条码,读者条码说明:字符串变量传递必须以”|”结束返回值:返回值为标准的JSON格式数据JSON节点值说明:ReturnValue返回值0成功-1失败MSG:消息返回15.图书预约http://发布IP地址或域名:发布端口/datasnap/rest/TInterFace/pbespeakbook/图书