渔船动态监管信息系统 外部数据接口协议.doc

渔船动态监管信息系统渔船动态监管信息系统 外部数据接口协议外部数据接口协议 渔船动态监管信息系统外部数据接口协议 1 目目 录录 1 名词定义名词定义 2 2 约定约定 2 2 1 数据单位定义 2 2 2 通信服务商代码定义 3 2 3 数据类型定义 4 3 数据中心与数据中心与 ASP 接口接口 5 3 1 系统静态信息交换接口 5 3 1 1获取船舶通信基础信息 6 3 1 2获取组织机构基本信息 7 3 1 3获取船舶与组织机构对应关系 8 3 1 4增加船舶 8 3 1 5删除船舶 9 3 2 历史通信信息交换接口 9 3 2 1 获取某一终端历史位置 10 3 2 2 获取某一区域历史位置 11 3 2 3 获取某一终端历史通信信息 13 3 2 4 获取所有终端历史通信信息 14 3 3 动态数据交换协议 15 3 3 1通信格式 16 3 3 2通信指令说明 17 3 3 2 1 欢迎标识 17 3 3 2 2 登录 17 3 3 2 3 退出登录 18 3 3 2 4 连接保持 18 3 3 2 5 发送命令 数据中心 ASP 19 3 3 2 6 动态数据推送 ASP 数据中心 21 3 3 2 7 不含位置类数据推送 22 3 3 2 8 组发指令 22 3 3 2 9 发送请求异步信息回执 23 3 3 2 10 错误信息返回 24 渔船动态监管信息系统外部数据接口协议 2 1 名词定义名词定义 监控目标监控目标 指系统监测对象 可以是安装有定位设备的船舶 车辆 飞行物等 定位设 备如 AIS 海事卫星 北斗卫星 公众移动通信网 CDMA GPRS 短波 超短波 RFID 雷 达等 在渔船动态监管的客户端软件只能对安装有海事卫星 C 站 北斗 CDMA GPRS 短波 超短波等支持双向通信终端设备的监控目标进行主动调取数据 发送信息等操作 对仅安装 AIS 等设备的监控目标只能被动接收数据 进行显示 统计 ASPASP 通信应用服务提供商 提供各种通信服务的运营商或系统 如 AIS 系统 海事卫 星运营商 北斗卫星 公众移动通信运营商 短波系统 超短波系统 RFID 系统 雷达系统 等 2 约定约定 2 12 1 数据单位定义数据单位定义 系统传输统一采用整数传输 所有数字类型的传输参数都经过单位换算 变换为整数进 行传输 以下为数据单位定义表 表 0 1 数据单位定义表 名称单位 UTC 自 1970 01 01 00 00 00 以来的秒数 64 位 long 最大不超过 3001 年 1 月 1 日 0 时 0 分 0 秒 经度 经度偏移1 10000 分 纬度 纬度偏移1 10000 分 航向1 10 度 速度1 10 节 半径海里 报位间隔1 秒 字符串类数据在进行 TCP 自定义 协议插传送时进行转义 转义字符表示 为了区分指令分隔符 和结束符 r n 转义字符 表示转义 逗号 两个字符 r n 回车换行 r n 四个字符 渔船动态监管信息系统外部数据接口协议 3 2 22 2 通信服务商代码定义通信服务商代码定义 通信服务商代码用来区分接入系统的通信定位服务厂商 系统采用 4 位数字表示通信服 务商 前两位表示通信类型代码 后两位表示厂商代码 表 0 1 通信类型定义 类型代码通信类型 10 海事卫星 11 北斗卫星 12AIS 13 公众移动通信网 14 短波 15 超短波 16RFID 17 雷达目标 18 99 待定 表 0 2 通信服务商代码 类型代码通信类型 1001 海事卫星运营商 1101 北斗运营商 1 1102 北斗运营商 2 1201AIS 注 通信服务商代码前两位代码表示运营商类型 后两位代表不同的运营商代码 渔船动态监管信息系统外部数据接口协议 4 2 32 3 数据类型定义数据类型定义 系统中传输基本数据分为位置数据和信息数据 下面分别为位置类型定义 信息类型定 义 以及定位状态的定义 表 0 1 位置类型定义 类型代码说明 0定时回传位置 1单次回传位置 100报警回传位置 200出港报 201进港报 表 0 2 信息类型定义 类型代码说明 0普通信息 1报警信息 表 0 3 定位状态定义 类型代码说明 0正常 1终端故障 渔船动态监管信息系统外部数据接口协议 5 3 数据中心与数据中心与 ASP 接口接口 数据中心与 ASP 接口 分为静态信息交换接口 动态信息交换接口 历史数据查询接口 静态信息交换接口用来与 ASP 同步船舶与船舶通信终端的通信基础数据 以及相关组织结构 动态信息交换接口用于接收 ASP 发送的船舶动态信息 包括但不限于船舶定位终端的位置信 息 船舶发送的短信息 船舶发送的报警信息 进出港信息等 同时用于系统平台向船舶 定位终端发送指令 包括但不限于单船单次调位 单船设定船舶报位频率 多船单次调位 多船设定报位间隔 单船发送信息 多船发送信息 历史数据查询接口用于系统中心从 ASP 获取历史通信信息 3 13 1 系统静态信息交换接口系统静态信息交换接口 系统静态信息交换接口包含系统中心对外发布静态信息接口以及中心获取外部静态信息 接口 静态信息交换接口采用 WEB service 方式提供统一的数据接口 静态信息交换接口适 用对象为系统平台以及 ASP 表 0 1 系统静态信息交换接口 功能服务端客户端 数据中心对外发布静态信息系统平台ASP 数据中心获取外部静态信息ASP系统平台 静态信息交换接口包含以下功能 表 0 2 静态信息交换接口功能 服务名说明服务端实现者客户端调用者 getShipInfo获取船舶通信基础信息数据中心 ASPASP 数据中心 getGroupInfo获取组织机构信息数据中心ASP getShipGroup获取船舶与组织对应关系数据中心ASP addShip增加船舶数据中心 ASPASP 数据中心 delShip删除船舶数据中心 ASPASP 数据中心 渔船动态监管信息系统外部数据接口协议 6 服务访问地址 http ip port shipinfo 说明 1 IP 服务器 IP 地址或者域名 2 PORT 端口号 3 shipinfo web services 入口 注 可以通过 http ip port shipinfo wsdl 获取到该 web service 的语义 xml 文件 3 1 1获取船舶通信基础信息获取船舶通信基础信息 函数 getShipInfo 描述 获取船舶的基本通信信息 包括船舶名称 通信终端类型 通信终端代码 以及 船舶内部编码等 表 0 3 函数 getShipInfo 说明 方向参数类型 usernamestring输入 passwordstring 输出GetShipInfoReturnMobile 数组 Mobile 结构定义如下 表 0 4 Mobile 结构 名称字段名类型说明 船舶系统 idmobile idInt内部 id 船舶名称mobilenameString船舶名称中文 通信终端类型terminal typeInt 见表 2 2 2 通信服 务商代码 通信终端号码terminal codeString通信终端号码 渔船动态监管信息系统外部数据接口协议 7 3 1 2获取组织机构基本信息获取组织机构基本信息 函数 getGroupInfo 描述 获取组织机构的基本信息 包括名称 ID 上级组等 表 0 5 函数 getGroupInfo 说明 方向参数类型 usernameString 输入 passwordString 输出getGroupInfoReturnMobileGroup 数组 MobileGroup 数据结构如下 表 0 6 MobileGroup 数据结构 名称字段名类型说明 组织编码group idInt船舶组内部编码 船舶组名称group nameString船舶组名称 上级组编码parent idInt上级组内部编码 渔船动态监管信息系统外部数据接口协议 8 3 1 3获取船舶与组织机构对应关系获取船舶与组织机构对应关系 函数 getShipGroup 描述 获取终端与组对应关系 包括船舶 id 所属组 id 等 表 0 7 函数 getShipGroup 说明 方向参数类型 usernamestring 输入 passwordstring 输出getShipGroupReturnMobileGroupAssign 数组 MobileGroupAssign 数据结构如下 表 0 8 MobileGroupAssign 数据结构 名称字段名类型说明 组织编码group idInt船舶组内部编码 船舶编码mobile idInt船舶内部编码 3 1 4增加船舶增加船舶 函数 addShip 描述 添加船舶的基本通信信息 包括船舶名称 通信终端类型 通信终端代码等 表 0 9 函数 addShip 说明 方向参数类型 Usernamestring Passwordstring MobilenameString terminal typeInt 输入 terminal codeString 输出GetShipInfoReturnboolean 渔船动态监管信息系统外部数据接口协议 9 3 1 5删除船舶删除船舶 函数 delShip 描述 删除船舶的基本通信信息 包括船舶名称 通信终端类型 通信终端代码等 表 0 10 函数 delShip 说明 方向参数类型 usernameString passwordString mobilenameString terminal typeInt 输入 terminal codeString 输出GetShipInfoReturnBoolean 3 23 2 历史通信信息交换接口历史通信信息交换接口 历史通信信息交换接口用于 ASP 提供给中心查询历史通信数据功能 历史信息交换接口 采用 Web Service 方式提供统一的数据接口 历史信息交换接口适用对象为系统平台以及 ASP 表 0 1 系统历史通信信息交换接口 功能服务端客户端 数据中心获取通信历史数据ASP系统中心 历史信息交换接口包含以下功能 表 0 2 历史信息交换接口功能 服务名说明服务端实现者客户端调用者 GetTracksByID获取某一终端的位置信息ASP数据中心 GetRectTracks获取某一区域的位置信息ASP数据中心 GetMsgsByID获取某一终端的通信信息ASP数据中心 渔船动态监管信息系统外部数据接口协议 10 GetAllMsgs获取全部的通信信息ASP数据中心 服务访问地址 http ip port track 说明 1 IP 服务器 IP 地址或者域名 2 PORT 端口号 3 track web services 入口 注 可以通过 http ip port track wsdl 获取到该 web service 的语义 xml 文件 3 2 1 获取某一终端历史位置获取某一终端历史位置 函数 GetTracksByID 描述 获取某一船舶在一定时间内的位置信息 表 0 3 函数 GetTracksByID 说明 方向参数类型说明 usernamestring用户名 passwordstring密码 terminal codeString终端号码 Begin UTCInt起始 UTC 时间 输入 End UTCint结束 UTC 时间 输出GetTracksByIDResponseTrack 数组 Track 数据格式定义 表 0 4 Track 数据格式定义 名称字段名类型说明 信息 IDmsg idString 数据序列号 在整个系统中是 唯一的 规则 由通信服务商 代码 4 位 10 进制数 系统分配 表示数据中心的用户 id 0000 UTC 日期戳 14 位 10 渔船动态监管信息系统外部数据接口协议 11 进制数 格式 YYYYMMDDHH24MISS 和 5 位唯 一的十进制序列号串联而成 如 110100002009013011552311111 通信终端号码terminal codestring通信终端号码 通信终端类型terminal typeInt见表 2 2 2 位置类型pos typeInt见表 2 3 1 定位时间UTCInt定位 UTC 时间 经度longitudeInt经度 纬度latitudeInt纬度 方向courseInt对地运动方向 船艏向trueheadingInt船首方向 速度speedInt对地运动速度 状态statusInt状态定义见表 2 3 3 描述vdescstring船舶状态描述 3 2 2 获取某一区域历史位置获取某一区域历史位置 函数 GetRectTracks 描述 获取某一区域在一定时间内的位置信息 表 0 5 函数 GetRectTracks 说明 方向参数类型说明 usernamestring用户名 passwordstring密码 Begin UTCInt起始 UTC 时间 输入 End UTCint结束 UTC 时间 渔船动态监管信息系统外部数据接口协议 12 begin longint起始经度 end longint结束经度 begin latint起始纬度 end latint结束纬度 输出GetRectTracksResponseTrack 数组 Track 数据格式定义如下 表 0 6 Track 数据格式定义 名称字段名类型说明 信息 IDmsg idString 数据序列号 在整个系统中是 唯一的 规则 由通信服务商 代码 4 位 10 进制数 系统分配 表示数据中心的用户 id 0000 UTC 日期戳 14 位 10 进制数 格式 YYYYMMDDHH24MISS 和 5 位唯 一的十进制序列号串联而成 如 110100002009013011552311111 通信终端号码terminal codestring通信终端号码 通信终端类型terminal typeint见表 2 2 2 位置类型pos typeint见表 2 3 1 定位时间UTCint定位 UTC 时间 经度longitudeint经度 纬度latitudeint纬度 方向courseint对地运动方向 船艏向trueheadingint船首方向 速度speedint对地运动速度 渔船动态监管信息系统外部数据接口协议 13 状态statusint状态定义见表 2 3 3 描述vdescstring船舶状态描述 3 2 3 获取某一终端历史通信信息获取某一终端历史通信信息 函数 GetMsgsByID 描述 获取某一船舶在一定时间内的通信信息 表 0 7 函数 GetMsgsByID 说明 方向参数类型说明 usernamestring用户名 passwordstring密码 terminal codeString终端号码 Begin UTCInt起始 UTC 时间 输入 End UTCint结束 UTC 时间 输出GetMsgsByIDResponseMessage 数组 Message 数据格式定义如下 表 0 8 Message 数据格式定义 名称字段名类型说明 信息 IDmsg idString 数据序列号 在整个系统中是 唯一的 规则 由通信服务商 代码 4 位 10 进制数 系统分配 表示数据中心的用户 id 0000 UTC 日期戳 14 位 10 进制数 格式 YYYYMMDDHH24MISS 和 5 位唯 一的十进制序列号串联而成 如 110100002009013011552311111 通信终端号码terminal codestring通信终端号码 渔船动态监管信息系统外部数据接口协议 14 通信终端类型terminal typeInt见表 2 2 2 信息类型msg typeInt见表 2 3 2 通信时间UTCInt定位 UTC 时间 通信内容msgString信息内容 3 2 4 获取所有终端历史通信信息获取所有终端历史通信信息 函数 GetAllMsgs 描述 获取所有船舶在一定时间内的通信信息 表 0 9 函数 GetAllMsgs 说明 方向参数类型说明 usernamestring用户名 passwordstring密码 Begin UTCInt起始 UTC 时间 输入 End UTCint结束 UTC 时间 输出GetAllMsgsResponseMessage 数组 Message 数据格式定义如下 表 0 10 Message 数据格式定义 名称字段名类型说明 信息 IDmsg idString 数据序列号 在整个系统中是 唯一的 规则 由通信服务商 代码 4 位 10 进制数 系统分配 表示数据中心的用户 id 0000 UTC 日期戳 14 位 10 进制数 格式 YYYYMMDDHH24MISS 和 5 位唯 一的十进制序列号串联而成 如 110100002009013011552311111 渔船动态监管信息系统外部数据接口协议 15 通信终端号码terminal codestring通信终端号码 通信终端类型terminal typeInt见表 2 2 2 信息类型msg typeInt见表 2 3 2 通信时间UTCInt定位 UTC 时间 通信内容msgString信息内容 3 33 3 动态数据交换协议动态数据交换协议 动态信息交换接口用于接收 ASP 发送的船舶动态信息 包括单不限于船舶定位终端的位 置信息 船舶发送的短信息 船舶发送的报警信息 进出港信息等 同时用于系统平台向 船舶定位终端发送指令 包括但不限于单船单次调位 单船设定船舶报位频率 多船单次调 位 多船设定报位间隔 单船发送信息 多船发送信息 动态信息交换接口采用 TCP 自定 义协议实现数据接口 通信服务商提供 TCP 服务 系统中心以客户机方式访问通信服务商 通信服务商提供服务所在 IP 以及端口 用户名密码等必须数据 动态信息交换接口包含以下功能 表 0 1 动态信息交换接口 序号功能说明 1登录登录 ASP 服务 不登录无法进行后续操作 2退出登录退出 ASP 服务 3连接保持保持当前连接 如无数据通信 需定期发送连接保持信息 4发送请求 发送指令 包括但不限于单船单次调位 单船设定船舶报 位频率 多船单次调位 多船设定报位间隔 单船发送信 息 多船发送信息 5位置数据定位终端的位置信息 6短信数据定位终端发送的信息 渔船动态监管信息系统外部数据接口协议 16 3 3 1通信格式通信格式 动态信息交换接口采用类 Telnet 终端的命令应答方式通信 以 r n 为结束符的字符串 为通信指令基本单元 其中逗号作为通信指令中的字段分隔符 字符编码英文采用 ASCII 中文编码采用 GBK 具体指令类型见下表 表 0 2 指令类型表 序号指令符定义方式发送方接收方说明 1w 欢迎标识 连接服 务 SC 登陆服务后 服务端首先 发送此信息 i登录同步CS登录服务端 2 i登录返回同步SC登陆返回 o退出登录同步CS退出 3 o退出登录返回同步SC退出返回 k连接保持同步CS 4 k连接保持返回同步SC s发送请求同步CS客户端发出命令请求 5 s发送请求返回同步SC服务端返回请求处理结果 6p位置数据异步SC服务端推送位置数据 7m短信数据异步SC服务端推送信息数据 8r回执信息异步SC 服务端推送发送命令异步 回执 9x错误信息返回同步SC C 客户端 S 服务器 所有客户端发送的指令 格式错误以及登录失败在服务器端出错都返回 x 指令 以 下对应的返回都指成功执行后的返回 渔船动态监管信息系统外部数据接口协议 17 3 3 2通信指令说明通信指令说明 3 3 2 13 3 2 1 欢迎标识欢迎标识 客户端主动和服务器建立 TCP 连接后 会收到服务器返回的本指令 格式 w version date r n 表 0 3 欢迎标识 名称类型描述 w字符串命令字 version字符串服务软件版本 date时间字符串软件发布日期 3 3 2 23 3 2 2 登录登录 通信接口需要登录后才能发送各种请求消息 格式 i user password r n 表 0 4 登陆 名称类型描述 i字符串命令字 user字符串用户名 password字符串密码 服务器返回 i user id r n 表 0 5 服务器返回 名称类型描述 i字符串命令字 user id十进制表示整数用户名对应的 ID 渔船动态监管信息系统外部数据接口协议 18 3 3 2 33 3 2 3 退出登录退出登录 客户端退出程序前 应发送退出登录指令 以便结束事务 关闭连接 服务器发送返回 指令后 服务器断开 TCP 连接 格式 o r n 表 0 6 退出登陆 名称类型描述 o字符串命令字 服务器返回 o r n 表 0 7 服务器返回 名称类型描述 o字符串命令字 3 3 2 43 3 2 4 连接保持连接保持 客户端需要以一定周期发送此指令 才能保证通信接口的 TCP 连接不被服务器断开 格式 k data r n 表 0 8 连接保持 名称类型描述 k字符串命令字 data字符串 任何字符 可用当前的 UTC 时间对应的字符串 服务器返回 k data r n 表 0 9 服务器返回 名称类型描述 k字符串命令字 data字符串 任何字符 可用当前的 UTC 时间对应的字符串 渔船动态监管信息系统外部数据接口协议 19 3 3 2 53 3 2 5 发送命令 数据中心发送命令 数据中心 ASP ASP 客户端发送与 ASP 相关的通信请求时 用此命令 格式 s sequence terminal code terminal type request type args r n 表 0 10 发送命令 表 0 11 请求代码表 request type定义备注 0请求单个位置 2按组请求位置需通信系统支持 1请求设置打开周期位置报告 按照周期报告 可以设置报位频 度 不受时间段限制 6请求关闭周期位置报告需通信系统支持 9请求发送单条短信 名称类型描述 s字符串命令字 sequence字符串 序列号 在整个系统中是唯一的 规则 由通信服务商代码 4 位 10 进制数 系统 分配 用户 ID 码 4 位 10 进制数 登录 后获得 UTC 日期戳 14 位 10 进制数 格式 YYYYMMDDHH24MISS 和 5 位唯一的 十进制序列号串联而成 如 110101992009013011552311111 terminal code字符串 通信目标代码 可以为移动终端通信码 或组 ID terminal type十进制数通信终端类型 见表 2 2 2 request type十进制数请求命令代码 见表 0 11 args字符串 请求命令附带参数 可选的 如无 前 面逗号要保留 参数组合见表 0 渔船动态监管信息系统外部数据接口协议 20 12按组请求发送短信需通信系统支持 21确认报警 表 0 12 请求类型与目标组合表 request typeterminal code 0 1 6 9 21指定的通信终端代码 2 12 组 ID 表 0 13 请求参数表 Request typeArgs定义 0无无 2无无 1UTC span UTC 自动报位起始时间 span 自动报位间隔 6无无 9Msg msg 短信内容 用 转义 中文采用 GBK 编码 12Msg msg 短信内容 用 转义 中文采用 GBK 编码 21Msg msg 确认报警信息 用 转义 中文采用 GBK 编码 服务器返回 s sequence receipt code description r n 表 0 14 服务器返回 名称类型描述 s字符串命令字 sequence字符串客户端发送命令的序列号 receipt code十进制数 命令执行状态码 成功执行返回 0 失败 错误码见表 0 description字符串命令执行状态描述 渔船动态监管信息系统外部数据接口协议 21 3 3 2 63 3 2 6 动态数据推送 动态数据推送 ASP ASP 数据中心 数据中心 格式 p terminal code comm type pos type UTC longitude latitude course trueheading speed status vdesc r n 表 0 15 动态数据推送 名称类型描述 p字符串命令字 msg id字符串 数据序列号 在整个系统中是 唯一的 规则 由通信服务商 代码 4 位 10 进制数 系统分配 表示数据中心的用户 id 0000 UTC 日期戳 14 位 10 进制数 格式 YYYYMMDDHH24MISS 和 5 位唯 一的十进制序列号串联而成 如 110100002009013011552311111 terminal code字符串终端号码 comm type十进制数通信服务商代码 见表 2 2 2 pos type十进制数位置类型 见表 2 3 1 UTC十进制数GPS 定位时间 见表 2 1 1 longitude十进制数经度 见表 2 1 1 latitude十进制数纬度 见表 2 1 1 course十进制数航向 见表 2 1 1 trueheading十进制数船艏向 见表 2 1 1 speed十进制数速度 见表 2 1 1 status十进制数状态 见表 2 3 3 vdesc字符串备注 位置描述 渔船动态监管信息系统外部数据接口协议 22 3 3 2 73 3 2 7 不含位置类数据推送不含位置类数据推送 格式 m terminal code comm type msg type UTC msg r n 表 0 16 不含位置类数据推送 名称类型描述 m字符串命令字 msg id字符串 数据序列号 在整个系统中是 唯一的 规则 由通信服务商 代码 4 位 10 进制数 系统分配 表示数据中心的用户 id 0000 UTC 日期戳 14 位 10 进制数 格式 YYYYMMDDHH24MISS 和 5 位唯 一的十进制序列号串联而成 如 110100002009013011552311