厦门大学实验室资源信息管理系统接口说明文档.docx
《厦门大学实验室资源信息管理系统接口说明文档.docx》由会员分享，可在线阅读，更多相关《厦门大学实验室资源信息管理系统接口说明文档.docx（14页珍藏版）》请在冰豆网上搜索。
厦门大学实验室资源信息管理系统接口说明文档
厦门大学实验室资源信息管理系统
接口说明文档
1系统概述
厦门大学实验室资源信息管理系统，以下简称“校级平台”，各院级实验仪器管理系统，以下简称“院级系统”。
管理单位可以按照统一的数据标准及格式规范，通过接口的方式将报送数据至校级平台。
本接口采用REST接口方式，提交与返回的数据为JSON格式，以实现校级平台与各院级系统在数据与服务方面的对接，更加有效地开展实验室资源信息管理服务。
本规范适用于各院级系统。
校级平台与院级系统共涉及4个接口，具体如下:
接口名称
用途
预约请求接口
接收校级平台推送的用户预约请求，返回仪器预约页面
仪器数据获取接口
接收校级平台推送的仪器信息
仪器数据报送接口
接收院级系统向校级平台推送仪器信息
使用记录上报接口
接收院级系统向校级平台推送仪器使用记录接口
用户信息接口
用于院级系统与校级用户统一认证和管理
2接口说明
2.1预约请求接口
2.1.1接口描述：
校级平台通过该接口将预约请求推至院级系统，获取相应院级系统返回的仪器预约页面。
2丄2请求消息参数描述
参数名称
类型
是否为空
描述
innerlD
String
否
仪器所属单位内部的唯一编码：
insCode
String
否
管理单位的唯一标识：
2.1.3响应消息参数描述
参数需称
类型
是否为空
描述
页面的地址（url）
String
仪器预约页而的url
2.1.4接口流程
（1）校级系统发布预约仪器服务；
（2）用户点击预约按钮，接口将用户的预约请求（仪器所属单位内部编码innerlD及单位唯一标识）送至相应的院级系统；
（3）院级系统接收到校级平台推送的预约请求，通过在线平台的预约审核流程对预约请求进行审核，根据审核结果并返回具体的仪器预约页面；
（4）用户可以在院级系统返回的预约页面中进行仪器预约操作。
2.1.5注意事项
（1）校级平台统一分配院级单位的唯一标识；
（2）校级平台不提供仪器预约服务，只能将用户预约请求推送至院级系统,山院级系统提供具体的仪器预约服务；
（3）院级系统返回给校级平台的是具体的仪器与预约页面url,而不是院级系统的首页或其他页面，并且确保预约页面能打开；
（4）院级系统返回的预约页面中必须包括该仪器的开放日历及机时安排情况；
2・2仪器数据获取接口
221接口描述：
院级系统获取校级平台仪器数据的接口。
222请求消息参数描述
参数名称
类型
是否为空
描述
insCode
String
否
院级单位的唯一标识
instruType
int
否
填报数据类型：
9仪器信息
2.2.3响应消息参数描述
参数名称
类型
是否为空
描述
状态码
int
否
仪器数据推送结果：
100代表成功
101代表数据存取成功，并根拯结果提
示信息
200代表单位编码错误
201代表填报数据类型错误
202代表推送的数据json字符串格式错误
203代表验证数据格式错误
204代表其他异常
301代表数据库操作异常
仪器数据集合
List
否
见2.2.3返回示例说明
2.2.3返回示例说明
{"statusMOO,
"list":
[
{
"CollegeName,,:
"xxxx,,z//学院名称
"UnitNumber,,:
"2JO2",//单位号"SASACClassificationNum":
"2400502"，〃国资分类号,,lnstrumentChineseName,,:
"xxxx"，〃仪器名称（中文）"lnstrumentClassificationNumber":
"03052207",〃仪器分类号"Model":
"MCR302"，〃型号
"Specifications":
"MCR302,,z//规格
"UnitPrice":
"597916.07"///单价"DateOfProduction":
"2013\/12\^0:
00:
00“,〃出厂日期"PurchaseDate":
"2013V12\^0:
00:
00",//购置日期"StorageTime":
"2014Vll\^50:
00:
00"，〃入库时间"CountryOfOrigin,,:
,xxxx"///生产国别
"CountryCode":
"156,,z//国别码
"Manufacturer,,:
,xxxx7/生产厂家
}
]
}
2.3仪器数据报送接口
231接口描述：
院级系统上报校级平台仪器数据的接口。
232请求消息参数描述
参数名称
类型
是否为空
描述
insCode
String
否
院级单位的唯一标识
instruType
int
否
填报数据类型：
9仪器信息
仪器数据集合
List
否
见仪器数据集合字段说明
仪器数据集合字段说明
参数名称
是否必填
参数说明
示例参考
isCourtyardNew
是
是否院级新增仪器
0为否1为是
CollegeName
是
学院需称
UnitNumber
是
单位号
SASACCIassificationNum
是
国资分类号
InstrumentChineseName
是
仪器名称（中文）
InstrumentClassificationNumber
是
仪器分类号
Model
是
型号
Specifications
是
规格
UnitPrice
是
单价
DateOfProduction
是
出厂日期
PurchaseDate
是
购宜日期
StorageTime
是
入库时间
CountryOfOrigin
是
生产国别
错误
203代表验证数据格式错误
204代表其他异常
301代表数据库操作异常
2.3.4接口流程
（1）校级平台发布仪器数据报送服务；
（2）院级系统通过该接口推送仪器数据至校级平台；
（3）校级平台验证单位唯一标识和仪器类别的正确性；验证失败则返回相应状态码；
（4）校级平台对上报的仪器数据进行验证，验证通过进行数据库存储，已报过的数据则进行更新；验证失败返回相应状态码；
2.2.5注意事项
（1）院级系统通过接口报送的数据格式按照附录1中仪器数据报送接口的各类型仪器示例。
（2）校级平台统一分配院级单位的唯一标识；院级单位可登录校级平台查看本单位的唯一标识，院级系统需保存单位标识关联表；
（3）管理单位院级系统需将平台负责人的通讯邮箱上报校级平台；校级平台对数据验证的错误信息会以邮件的方式发送院级系统负责人的邮箱；
（4）院级系统接与校级平台的对接过程中，如果多次出现错误状态码，及时联系相关人员。
2・4仪器使用记录接口
2.4.1接口描述：
院级系统将仪器使用记录数据上报到校级平台的接口。
242请求消息参数描述
参数名称
类型
是否为空
描述
insCode
String
否
院级系统的唯一标识
使用记录的集合
List
否
详见使用记录的集合字段说明
使用记录的集合字段说明
参数需称
是否必填
参数说明
示例参考
AppointmentStart
是
预约时间（起）
20环出0:
00:
00
AppointmentEnd
是
预约时间（止）
20说笳0:
00:
00
AppointmentLength
是
预约时长
ControllerRecordStart
是
控制器记录时间（起）
20说笳0:
00:
00
ControllerRecordEnd
是
控制器记录时间（止）
20说笳0:
00:
00
ControllerRecordLength
是
控制器记录的实际测试时长
SampleNumber
否
样品个数
SendSampleName
是
预约或送样人姓名
SendSampleNumbe
r
是
预约或送样人教工号（学工号）
SendSampleGroup
是
预约或送样人所属课题组
SendSampleGroupHead
是
预约或送样人所属课题组负责人
CardPersonName
是
刷卡人姓名
CardPersonNumber
是
刷卡人教工号（学工号）
CardPersonGroup
是
刷卡人所属课题组
OrderltemName
否
预约检测项目名称
SendSampleltemNa
me
否
送样检测项目名称
2.4.3响应消息参数描述
参数名称
类型
是否为空
描述
状态码
int
否
服务成效数据推送结果：
100代表成功
200代表单位编码错误
201代表推送的数拯json字符串格式错误
202代表数据验证错误
203代表其他异常
301代表数据库操作异常
2.4.4接口流程
（1）校级贵重仪器设备管理系统根据从各学院抓取的仪器设备使用情况数据作为计费数量的依据；
（2）院级系统调用该接口将单位的仪器设备使用惜况数据推送至校级平台；
（3）校级平台首先验证单位唯一标识的正确性，验证通过则获取仪器设备使用情况数据；验证失败则返回相应的状态码；
（4）校级平台将上报的仪器设备使用情况数据进行验证，验证通过则保存到数据库中，验证失败则返回相应的状态码；
2.3.5注意事项
（1）院级系统通过该接口报送的仪器设备使用情况数据按照附录1中的仪器使用记录接口的示例。
（2）校级平台统一分配院级单位的唯一标识；院级系统需保存单位标识关联表；院级单位可登录校级平台查看本单位的唯一标识；
（3）院级系统需将平台负责人的通讯邮箱地址上报校级平台；校级平台对数据的验证错误信息会以邮件的方式发送院级系统负责人的邮箱；
（4）院级系统接与校级平台的对接过程中，如果多次出现错误的状态码，需联系相关人员。
2・5用户信息接口
校级平台提供用户信息接口，用于院级系统与校级平台的用户统一认证和管理。
具体详情见Oauth说明文档。
对接用户认证开发指南
一、Oauth2.0授权访问流程
OAuth客户端!
OAuth服务器
（1）管理单位网站重定向用户到校级平台提供的authorize接口，如果用户同意授权,校级平台会把用户重定向回到院级单位网站，并附上授权码authorize_code；
（2）校级单位网站使用authorize_code向校级平台的access_token接口发起请求，校级平台在验证请求合法后，会返回访问令牌access_token；
（3）校级单位网站使用access_token向resource接口发起请求，获取用户信息。
二、单位平台工作流程
1.用户在校级平台发起"预约仪器"请求，校级平台将请求重左向到院级平台。
2.院级平台检查用户登录状态，若是登录状态，则直接转到仪器预约页而：
若处于未登录状态，则转到步骤3代表的登录页而。
3.单位平台的登录页而中要有"使用校级平台账号登录"入口。
4.若用户选择直接使用院
升级会员 