警翼移动执法电子证据管理软件对外接口说明指导书V.docx

移动执法电子证据管理软件对外接口
说 明 书

深圳警翼智能科技股份
地址：深圳市南山区粤海街道滨海大道深圳市软件产业基地5栋E座1102
电话：(+86)
传真：(+86)

目录
一、概述 3
二、组织机构列表接口 4
2.1功效说明 4
2.2处理过程 4
2.3接口协议 4
2.4返回JSON文档说明 4
2.4.1返回header参数说明 5
2.4.2返回body参数说明 5
2.5备注 5
三、统计仪列表接口 6
3.1功效说明 6
3.2处理过程 6
3.3接口协议 6
3.4返回JSON文档说明 6
3.4.1返回header参数说明 7
3.4.2返回body参数说明 7
3.5备注 7
四、视频获取接口 8
4.1功效说明 8
4.2处理过程 8
4.3接口协议 8
4.4返回JSON文档说明 8
4.4.1返回header参数说明 8
4.4.2返回body参数说明 9
4.5备注 10
五、视频、图片、音频播放接口 11
5.1功效说明 11
5.2处理过程 11
5.3接口协议 11
5.4返回视频、图片、音频播放说明 11

一、概述
1、目标
方便其它系统能够方便地对接本系统，能够方便地得到需要视频文件播放地址，能够调用本系统播放页面。
2、术语
执法统计仪：又称警用执法统计仪或现场执法统计仪，是一款集数码摄像、数码摄影、对讲送话器功效于一身，能够对执法过程中进行动态、静态现场情况数字化统计便携式设备。以下简称统计仪。
警翼DZZJ移动执法电子证据管理软件：由深圳警翼软件技术开发，用于对基层公安机关聚集多媒体执法资料查询和管理。本软件全方面支持警翼采集工作站及警翼现场执法统计仪，可实现模块化组网模式，将基层用户和管理单位连成整体，方便执法资料跨区域跨等级查询调用、电子证据实现全局统一管理，更有利于保护民警权益、规范民警执法。以下简称DZZJ管理软件。
3、约定
为使得描述能够愈加正确，文档中均给出了json示例，示例中所包含值并无特殊含义。特此说明。

二、组织机构列表接口
2.1功效说明
提供给第三方管理平台查看、调用DZZJ管理软件组织机构架构。
2.2处理过程
1、对传入接口参数进行解析，返回对应页组织机构架构信息；
2、本接口默认返回第一页统计仪信息；
3、每页默认返回50条组织机构信息。当返回组织机构信息不足50条时，表示已查询到目前组织机构信息最终一页。
2.3接口协议
URL
http://[ip]:[port]/?_a=getunit&page=1
http请求类型
GET/POST
输出格式
Json (application/json;charset=utf-8)
1、 参数说明
page
查询第几页数据（每页50条）
2.4返回JSON文档说明
1、输入请求示例
http://[ip]:[port]/?_a=getunit&page=1
2、返回示例
{
   "header":{
      "state":"success",
      "count":11
   },
   "body":Array[11]
}
2.4.1返回header参数说明
参数项
数据类型
数据长度
是否可空
说明
state
varchar
255
否
返回请求状态,success表示请求成功，请求成功时，在body中显示请求主体；
count
int
11
否
返回请求主体数量；

2.4.2返回body参数说明
参数项
数据类型
数据长度
是否可空
说明
id
int
11
否
组织机构id
unit_no
varchar
255
是
组织机构编号
unit_name
varchar
255
是
组织机构名称
parentid
int
11
否
上级组织机构id
orderby
int
2
是
组织机构排序
3、返回主体：
{
   "id":"2",
   "unit_no":"",
   "unit_name":"XX区公安局",
   "parentid":"1",
   "orderby":"1"
}

三、统计仪列表接口
3.1功效说明
提供给第三方管理平台查看、调用DZZJ管理软件统计仪信息。
3.2处理过程
1、对传入接口参数进行解析，返回对应页统计仪信息；
2、本接口默认返回第一页统计仪信息；
3、每页默认返回50条组织机构信息。当返回组织机构信息不足50条时，表示已查询到目前组织机构信息最终一页。
3.3接口协议
URL
http://[ip]:[port]/?_a=getdevice&page=1
http请求类型
GET/POST
输出格式
Json (application/json;charset=utf-8)
1、参数说明
page
查询第几页数据（每页50条）
3.4返回JSON文档说明
1、输入请求示例
http://[ip]:[port]/?_a=getdevice&page=1
2、返回示例
{
   "header":{
      "state":"success",
      "count":50
   },
   "body":Array[50]
}
3.4.1返回header参数说明
参数项
数据类型
数据长度
是否可空
说明
state
varchar
255
否
返回请求状态,success表示请求成功，请求成功时，在body中显示请求主体；
count
int
11
否
返回请求主体数量；

3.4.2返回body参数说明
参数项
数据类型
数据长度
是否可空
说明
id
int
11
否
统计仪id
hostname
varchar
255
是
统计仪持有些人姓名
hostcode
varchar
255
是
统计仪持有些人编号
hostbody
varchar
255
是
统计仪编号
unit_no
varchar
255
是
组织机构编号
state
varchar
2
否
0-正常；1-报障，2-报废；
3、返回主体：
{
"id":"35",
"hostname":"宋江",
"hostcode":"100099",
"hostbody":"1671518",
"unit_no":"1001",
"state":"0"
}
四、视频获取接口
4.1功效说明
提供给第三方管理平台查看、调用DZZJ管理软件视频信息。
4.2处理过程
1、 对传入接口参数进行解析并校验，若参数不全或无效，则直接返回错误码和错误信息；
2、 经过检验后，显示对应页视频数据信息；
3、 本接口默认返回第一页视频信息；
4、每页默认返回50条组织机构信息。当返回组织机构信息不足50条时，表示已查询到目前组织机构信息最终一页。
4.3接口协议
URL
http://[ip]:[port]/?_a=getmedia&page=1&begin_time=日期&police_id=id&org_code=code
http请求类型
GET/POST
输出格式
Json (application/json;charset=utf-8)
1、参数说明
page
查询第几页数据（每页50条）
begin_time
上传时间（时间格式为YYYY-mm-dd）
police_id
警员编号
org_code
组织机构编号

4.4返回JSON文档说明
1、输入请求示例
http://[ip]:[port]/?_a=getmedia&page=1&begin_time=-10-24&police_id=100000&org_code=
2、返回示例
{
    "header":{
        "state":"success",
        "count":7
    },
    "body":Array[7]
}
4.4.1返回header参数说明
参数项
数据类型
数据长度
是否可空
说明
state
varchar
255
否
返回请求状态,success表示请求成功，请求成功时，在body中显示请求主体；fail表示请求失败，并返回失败信息；
count
int
11
否
返回请求主体数量；

4.4.2返回body参数说明
参数项
数据类型
数据长度
是否可空
说明
data_id
int
11
否
视频id
capture_date
varchar
255
是
创建时间
device_no
varchar
255
是
统计仪编号
creation_date
timestamp
0
是
上传时间
media_name
varchar
255
否
文件名: 机身编号@生成日期
file_name
varchar
255
是
文件别名
police_no
varchar
255
是
统计仪持有些人编号
org_no
varchar
255
是
组织机构编号
org_name
varchar
255
是
组织机构名称
file_type
varchar
255
是
文件类型
serverurl
varchar
255
是
文件上传服务器地址
playposition
varchar
255
是
播放相对位置
thumb
varchar
255
是
缩略图
file_length
varchar
255
是
文件长度(Byte)
file_duration
int
11
是
视频播放时间长度(ms)
media_desc
longtext
0
是
备注
upload_station_ip
varchar
255
否
创建工作站ip
upload_station
varchar
255
是
创建工作站
thumburl_def
varchar
255
是
默认媒体缩略图
thumburl
varchar
255
是
缩略图地址
playurl
varchar
255
是
播放地址
3、返回主体：
{
   "data_id":"548",
   "capture_date":"-10-24 13:53:06",
   "device_no":"1671421",
   "creation_date":"-10-24 14:53:25",
   "media_name":"1671421@00",
   "file_name":"张飞@00",
   "police_no":"100000",
   "org_no":"",
   "org_name":"XX区公安局",
   "file_type":"MP4",
   "serverurl":"FTPServer",
   "playposition":"media/1024/MP4/",
   "thumb":"media/1024/MP4/",
   "file_length":"263.25",
   "file_duration":"132",
   "media_desc":"afafaafa11111",
   "upload_station_ip":"192.168.1.213",
   "upload_station":"WS06S",
   "thumburl_def":"",
   "thumburl":"http://ip/media/1024/MP4/",
   "playurl":"http://ip/media/1024/MP4/"
}

五、视频、图片、音频播放接口
5.1功效说明
提供给第三方管理平台使用DZZJ管理软件视频、图片、音频播放功效。使用播放功效应下载DZZJ管理软件播放器。
5.2处理过程
1、对传入接口参数进行解析并校验，若参数不全或无效，则不显示视频、图片、音频信息；
2、经过检验后，显示对视频、图片、音频播放页面并播放；
5.3接口协议
URL
http://[ip]:[port]/?_a=video&id=id
http请求类型
GET/POST
2、 参数说明
id
id对应于4.4.2中data_id
5.4返回视频、图片、音频播放说明
1、输入请求示例
http://[ip]:[port]/?_a=video&id=547
2、返回示例