Skip to content
目录

档案库房接口(共51个) ​

档案库房接口皆为南向接口,需要第三方厂家实现,这里仅提供接口描述。可以根据需要自身系统需求增减接口数量,比如增加前置鉴权接口等。

用于库区(7个) ​

获取库房列表(南向) ​

HTTP GET请求,无参数,返回库房对象列表。库房对象包含库房ID、库房名称。

获取密集架(库区)列表(南向) ​

HTTP GET请求,参数为库房ID,返回密集架对象列表。密集架对象包含库房ID、密集架ID、密集架名称。

获取密集架(库区)详细信息(南向) ​

HTTP GET请求,参数为密集架ID,返回密集架详细信息对象。密集架详细信息对象包含库房ID、密集架ID、密集架名称、密集架型号、是否启用状态监控、是否启用温湿度监测、是否启用气体监测。

获取密集架(库区)实时数据(南向) ​

HTTP GET请求,参数为密集架ID,返回密集架实时数据对象。密集架实时数据对象包含密集架ID、密集架名称、温度值、湿度值、PM2.5、PM10、CO2、TVOC、设备状态、列位置(数组,单位cm)、告警(数组)、是否有人、有人的列号。

获取密集架(库区)的档案状态统计数据(南向) ​

HTTP GET请求,参数为密集架ID,返回统计项对象列表。统计项包含项名称、值(在库、借出数量)。

获取多个密集架(库区)的列位置和告警(南向) ​

HTTP POST请求,参数为密集架ID数组,返回密集架列位置和告警信息对象列表。密集架列位置和告警信息对象包含密集架ID、列位置(数组,单位cm)、告警(数组)。

获取密集架(库区)列列表(南向) ​

HTTP GET请求,参数为密集架ID,返回密集架列对象列表。密集架列对象包含密集架ID、列号、列名称、列类型(1=左活动列,0=固定列,2=右活动列)、面类型(1=左面柜,0=双面柜,2=右面柜)、层数、节数、层位最大存储容量。

用于密集架控制(12个) ​

获取密集架型号的控制列表(南向) ​

HTTP GET请求,参数为密集架型号,返回控制操作枚举列表(字符串数组)。

打开(南向) ​

HTTP GET请求,参数为密集架ID、列号,返回控制执行状态。

关闭(南向) ​

HTTP GET请求,参数为密集架ID、列号,返回控制执行状态。

左移(南向) ​

HTTP GET请求,参数为密集架ID、列号,返回控制执行状态。

右移(南向) ​

HTTP GET请求,参数为密集架ID、列号,返回控制执行状态。

闭架(南向) ​

HTTP GET请求,参数为密集架ID,返回控制执行状态。

通风(南向) ​

HTTP GET请求,参数为密集架ID,返回控制执行状态。

停止(南向) ​

HTTP GET请求,参数为密集架ID,返回控制执行状态。

锁定(南向) ​

HTTP GET请求,参数为密集架ID,返回控制执行状态。

解锁(南向) ​

HTTP GET请求,参数为密集架ID,返回控制执行状态。

休眠(南向) ​

HTTP GET请求,参数为密集架ID,返回控制执行状态。

唤醒(南向) ​

HTTP GET请求,参数为密集架ID,返回控制执行状态。

用于密集架列进入时(16个) ​

获取密集架列的状态统计数据 ​

HTTP GET请求,参数为密集架列ID,返回统计项对象列表。统计项包含项名称、值(在库、借出数量)。

获取密集架列的档案统计数据(南向) ​

HTTP GET请求,参数为密集架ID,返回列档案统计对象列表。列档案统计对象包含列号、最大存储容量、档案总数。

获取层位列表(南向) ​

HTTP GET请求,参数为密集架ID、列号,返回层位对象列表。层位对象包含密集架ID、列号、层号、节号、位置。

获取档案盒列表(南向) ​

HTTP GET请求,参数为密集架ID、列号,返回档案盒对象列表。档案盒对象包含密集架ID、列号、层号、节号、盒类型(true=档案盒,false=无盒档案)、盒流水号、盒ID、盒名称。

获取档案目录列表(南向) ​

HTTP GET请求,参数为盒流水号,返回档案目录对象列表。档案目录对象包含档号、档案名称、状态。

获取档案详细信息(南向) ​

HTTP GET请求,参数为档号,返回档案详细信息对象。档案详细信息对象包含密集架ID、列号、层号、节号、档号、档案名称、盒流水号、盒ID、盒名称、状态、位置、创建时间、有效期、类型、介质、保密级别、责任人、正文页数、附件页数、附件文件数组。

下载档案附件(南向) ​

HTTP GET请求,参数为档案流水号、附件名称,返回二进制文件。

获取档案历史操作记录(南向) ​

HTTP POST请求,参数为档案流水号、开始时间、结束时间,返回档案历史操作记录对象列表。档案历史操作记录对象包含记录流水号、档案流水号、档号、操作类型、描述、操作时间、操作人。

档案开架(南向) ​

HTTP GET请求,参数为档案流水号,返回控制执行状态。

档案闭架(南向) ​

HTTP GET请求,参数为档案流水号,返回控制执行状态。

分页获取待上架档案列表(南向) ​

HTTP POST请求,参数为搜索关键字、页面、每页记录数量,返回分页数据对象。

档案上架(南向) ​

HTTP POST请求,参数为密集架ID、列号、层号、节号、档案(流水)号数组,返回状态。

档案下架(南向) ​

HTTP POST请求,参数为档案(流水)号数组,返回状态。

档案转移(南向) ​

HTTP POST请求,参数为档案(流水)号数组、目标密集架ID、目标列号、目标层号、目标节号、备注,返回状态。

档案借阅(南向) ​

HTTP POST请求,参数为档案(流水)号数组、借阅天数、备注,返回状态。

档案出库(南向) ​

HTTP POST请求,参数为档案(流水)号数组、出库原因、操作备注,返回状态。

用于门口机(4个) ​

获取门口机列表(南向) ​

HTTP GET请求,返回门口机列表。门口机对象包含ID、名称。

分页获取门口机消息列表(南向) ​

HTTP POST请求,参数为档号或档案名称关键字、开始时间、结束时间、分页当前页索引、分页大小,返回门口机消息对象。门口机消息对象包含记录总数、消息对象列表。消息对象包含消息ID、门口机ID、门口机名称、密集架ID、列号、层号、节号、档案名称、档案状态、位置、是否告警、记录时间、处理情况、确认时间、确认人、确认备注。

确认门口机消息(南向) ​

HTTP、POST请求,参数为消息ID列表、确认用户、确认备注,返回状态。

获取所有门口机告警统计数据(南向) ​

HTTP、GET请求,无参数,返回统计对象列表。统计对象包含门口机ID、告警数量。

用于档案搜索(3个) ​

档案搜索(南向) ​

HTTP POST请求,参数为档号或档案名称关键字、分页的当前页码、分页的每页数量,返回档案搜索结果对象。档案搜索结果对象包含记录总数、档案详细信息对象列表。档案详细信息对象包含密集架ID、列号、层号、节号、档号、档案名称、盒流水号、盒ID、盒名称、状态、位置、创建时间、有效期、类型、介质、保密级别、责任人、正文页数、附件页数、附件文件数组。

档案续借(南向) ​

HTTP POST请求,参数为档案(流水)号数组、续借天数、备注,返回状态。

档案归还(南向) ​

HTTP POST请求,参数为档案(流水)号数组,返回状态。

用于档案容量展示(1个) ​

获取多个密集架的档案统计数据(南向) ​

HTTP POST请求,参数为密集架ID数组,返回密集架档案统计对象列表。密集架档案统计对象包含密集架ID、列档案统计对象列表。列档案统计对象包含列号、最大存储容量、档案总数。

用于大屏两侧统计图表(5个) ​

获取档案类型统计数据(南向) ​

HTTP GET请求,无参数,返回统计项对象列表。统计项包含项名称、值。

获取档案状态统计数据(南向) ​

HTTP GET请求,无参数,返回统计项对象列表。统计项包含项名称、值。

获取档案介质统计数据(南向) ​

HTTP GET请求,无参数,返回统计项对象列表。统计项包含项名称、值。

获取档案保密级别统计数据(南向) ​

HTTP GET请求,无参数,返回统计项对象列表。统计项包含项名称、值。

获取档案有效期统计数据(南向) ​

HTTP GET请求,无参数,返回统计项对象列表。统计项包含项名称、值。

技术支持:13352865103(柯工,微信同号)