还剩23页未读,继续阅读
本资源只提供10页预览,全部文档请下载后查看!喜欢就下载吧,查找使用更方便
文本内容:
渔船动态监管信息系统外部数据接口协议农业部渔政指挥中心年月
201083.
1.5删除船舶函数:delShip描述删除船舶的基本通信信息,包括船舶名称,通信终端类型,通信终端代码等表0-10函数:delShip说明方向参数类型username Stringpassword String输入mobilename Stringterminal_type Intterminal_code String输出GetShipInfoReturn Boolean
3.2历史通信信息交换接口历史通信信息交换接口用于ASP提供给中心查询历史通信数据功能历史信息交换接口采用WebService方式提供统一的数据接口历史信息交换接口适用对象为系统平台以及ASPo表0-1系统历史通信信息交换接口功能服务端客户端数据中心获取通信历史数据系统中心ASP历史信息交换接口包含以下功能表0-2历史信息交换接口功能服务名说明服务端实现者客户端调用者GetTracksBylD获取某一终端的位置信息ASP数据中心GetRectTracks获取某一区域的位置信息ASP数据中心GetMsgsBylD获取某一终端的通信信息ASP数据中心GetAllMsgs获取全部的通信信息ASP数据中心服务访问地址http://ip:port/track说明
1.
1.1IP:服务器IP地址或者域名
1.
1.2PORT:端口号
1.
1.3trackweb services入口注可以通过http注/ip:port/trackwsdl获取到该web service的语义xml文件
3.
2.1获取某一终端历史位置函数GetTracksBylD描述获取某一船舶在一定时间内的位置信息表0-3函数GetTracksBylD说明方向参数类型说明username string用户名password string密码输入terminal_code String终端号码Begin_UTC Int起始UTC时间End_UTC int结束UTC时间输出GetTracksBylDResponse Track数组Track数据格式定义表0-4Track数据格式定义名称字段名类型说明数据序列号,在整个系统中是唯一的,规则由通信服务商信息ID msg id String代码4位10进制数,系统分配、表示数据中心的用户id”0000”、UTC日期戳(14位10进制数,格式YYYYMMDDHH24MISS)和5位唯一的十进制序列号串联而成,如0111通信终端号码terminal_code string通信终端号码通信终端类型terminal_type Int见表
2.2-2位置类型pos_type Int见表
2.3-1定位时间UTC Int定位UTC时间经度longitude Int经度纬度latitude Int纬度方向course Int对地运动方向船艄向trueheading Int船首方向速度speed Int对地运动速度状态status Int状态定义见表
2.3-3描述vdesc string船舶状态描述
3.
2.2获取某一区域历史位置函数GetRectTracks描述获取某一区域在一定时间内的位置信息表0-5函数GetRectTracks说明方向参数类型说明username string用户名password string密码输入Begin_UTC Int起始UTC时间End_UTC int结束UTC时间beginjong int起始经度end_long int结束经度beginjat int起始纬度end_lat int结束纬度输出GetRectTracksResponse Track数组Track数据格式定义如下表0-6Track数据格式定义名称字段名类型说明数据序列号,在整个系统中是唯一的,规则由通信服务商代码(4位10进制数,系统分配)、表示数据中心的用户id”信息ID msg_id String0000”、UTC日期戳(14位10进制数,格式YYYYMMDDHH24MISS)和5位唯一的十进制序列号串联而成,如0111通信终端号码terminal_code string通信终端号码通信终端类型terminal_type int见表
2.2-2位置类型pos_type int见表
2.3-1定位时间UTC int定位UTC时间经度longitude int经度纬度latitude int纬度方向course int对地运动方向船艄向trueheading int船首方向速度speed int对地运动速度状态status int状态定义见表
2.3-3描述vdesc string船舶状态描述
3.
2.3获取某一终端历史通信信息函数GetMsgsBylD描述获取某一船舶在一定时间内的通信信息表0-7函数GetMsgsBylD说明方向参数类型说明username string用户名password string密码输入terminal_code String终端号码Begin.UTC Int起始UTC时间End_UTC int结束UTC时间输出GetMsgsBylDResponse Message数组Message数据格式定义如下表0-8Message数据格式定义名称字段名类型说明数据序列号,在整个系统中是唯一的,规贝1」由通信服务商代码(4位10进制数,系统分配)、表示数据中心的用户信息ID msg_id Stringid”0000”、UTC日期戳(14位10进制数,格式YYYYMMDDIIII24MI)SS和5位唯一的十进制序列号串联而成,如0111通信终端号码terminal_code string通信终端号码通信终端类型terminal_type Int见表
2.2-2信息类型msg_type Int见表
2.3-2通信时间UTC Int定位UTC时间通信内容msg String信息内容
3.
2.4获取所有终端历史通信信息函数GetAllMsgs描述获取所有船舶在一定时间内的通信信息表0-9函数GetAHMsgs说明方向参数类型说明username string用户名password string密码输入Begin_UTC Int起始UTC时间End_UTC int结束UTC时间输出GetAllMsgsResponse Message数组Message数据格式定义如下表0-10Message数据格式定义名称字段名类型说明数据序列号,在整个系统中是唯一的,规则信息ID msg_id String由通信服务商代码(4位10进制数,系统分配)、表示数据中心的用户id”0000”、UTC日期戳(14位10进制数,格式YYYYMMDDHH24MISS)和5位唯一的十进制序列号串联而成,如0111通信终端号码terminal_code string通信终端号码通信终端类型terminal_type Int见表
2.2-2信息类型msg_type Int见表
2.3-2通信时间UTC Int定位UTC时间通信内容msg String信息内容
3.3动态数据交换协议动态信息交换接口用于接收ASP发送的船舶动态信息(包括单不限于船舶定位终端的位置信息,船舶发送的短信息,船舶发送的报警信息,进出港信息等),同时用于系统平台向船舶定位终端发送指令(包括但不限于单船单次调位,单船设定船舶报位频率,多船单次调位,多船设定报位间隔,单船发送信息,多船发送信息)动态信息交换接口采用TCP自定义协议实现数据接口通信服务商提供TCP服务,系统中心以客户机方式访问通信服务商通信服务商提供服务所在IP以及端口,用户名密码等必须数据动态信息交换接口包含以下功能表0-1动态信息交换接口序号功能说明1登录登录ASP服务,不登录无法进行后续操作2退出登录退出ASP服务3连接保持保持当前连接,如无数据通信,需定期发送连接保持信息发送指令,包括但不限于单船单次调位,单船设定船舶报位频率,4发送请求多船单次调位,多船设定报位间隔,单船发送信息、,多船发送信息5位置数据定位终端的位置信息短信数据定位终端发送的信息
63.
3.1通信格式动态信息交换接口采用类Telnet终端的命令应答方式通信,以\r\n为结束符的字符串为通信指令基本单元其中逗号作为通信指令中的字段分隔符字符编码英文采用ASCH,中文编码采用GBKo具体指令类型见下表表0-2指令类型表序号指令符定义方式发送方接收方说明登陆服务后,服务端首先发送1W S C欢迎标识,连接服务此信息*登录同步C S登录服务端12*登录返回同步S C登陆返回10退出登录同步C S退出30退出登录返回同步S C退出返回k连接保持同步C S4k连接保持返回同步S Cs发送请求同步C S客户端发出命令请求5s发送请求返回同步S C服务端返回请求处理结果6p位置数据异步S C服务端推送位置数据7m短信数据异步S C服务端推送信息数据服务端推送发送命令异步回执8r回执信息异步SC9X错误信息返回同步S CC客户端s服务器所有客户端发送的指令,格式错误以及登录失败在服务器端出错都返回“X”指令,以下对应的返回都指成功执行后的返回
3.
3.2通信指令说明
3.
3.33,
2.1欢迎标识客户端主动和服务器建立TCP连接后,会收到服务器返回的本指令格式w version,date\f\n表0-3欢迎标识名称类型描述字符串命令字Wversion字符串服务软件版本date时间字符串软件发布日期
3.
3.
2.2登录通信接口需要登录后才能发送各种请求消息格式i user,password\r\n表0-4登陆名称类型描述*字符串命令字1user字符串用户名password字符串密码服务器返回i user_id\r\n表0-5服务器返回名称类型描述字符串命令字•1user_id十进制表示整数用户名对应的ID
3.
3.
2.3退出登录客户端退出程序前,应发送退出登录指令,以便结束事务,关闭连接,服务器发送返回指令后,服务器断开TCP连接格式o\r\n表0-6退出登陆名称类型描述字符串命令字0服务器返回o\r\n表0-7服务器返回名称类型描述字符串命令字
03.3,
2.4连接保持客户端需要以一定周期发送此指令,才能保证通信接口的TCP连接不被服务器断开格式k data\r\n表0-8连接保持名称类型描述k字符串命令字任何字符,可用当前的UTC时间data字符串对应的字符串服务器返回k data\r\n
4.
4.
4.
4.
4.
3.
3.
3.
3.
3.
3.
1.
1.
1.
3.
33.
33.
33.
33.
33.
33.
33.
3.3・2・5发送命令(数据中心-ASP)客户端发送与ASP相关的通信请求时,用此命令格式s sequence,terminal_code,terminal_ty^pe,request_type,args\r\n表0-10发送命令名称类型描述字符串命令字S序列号,在整个系统中是唯一的,规则由通信服务商代码(4位10进制数,系统分配)、用户ID码(4位10进制数,登录后获得)、sequence字符串UTC日期戳(14位10进制数,格式YYYYMMDDHH24MISS)和5位唯一的十进制序列号串联而成,如1111通信目标代码可以为移动终端通信码或组IDterminal_code字符串terminal_type十进制数通信终端类型,见表
2.2-2request_type十进制数请求命令代码见表0-11请求命令附带参数,可选的如无,前面逗号args字符串要保留参数组合见表0-一表071请求代码表request_type定义备注0请求单个位置2按组请求位置需通信系统支持按照周期报告,可以设置报位频度,1请求设置打开周期位置报告不受时间段限制请求关闭周期位置报告需通信系统支持69请求发送单条短信12按组请求发送短信需通信系统支持21确认报警表0-12请求类型与目标组合表request_type terminal_code0,1,6,9,21指定的通信终端代码2,12组1D表0-13请求参数表Request_type Args定义0无无2无无1UTC.spanUTC自动报位起始时间span自动报位间隔6无无msg短信内容,用转义中文采用GBK编码9Msgmsg短信内容,:用转义中文采用GBK编码12Msgmsg.确认报警信息,:用A转义中文采用GBK编21Msg码月艮务器返回s sequence.receipt_code.descriptioii^NA表0-14服务器返回名称类型描述s字符串命令字sequence字符串客户端发送命令的序列号命令执行状态码,成功执行返回0,失败错误receipt_code十进制数码见表0-二description字符串命令执行状态描述
3.
3.
2.6动态数据推送(ASP->数据中心)格式Ptermmal_code,comm_type,pos_type,UTC.longitude,latitude,course,t^eheading,speed,status,vdesc\r\n表0-15动态数据推送名称类型描述P字符串命令字数据序列号,在整个系统中是唯一的,规则由通信服务商代码(4位10进制数,系统分配)、表示数据中心的用户id”0000”、UTC日msg_id字符串期戳(14位10进制数,格式YYYYMMDDHH24MISS)和5位唯一的十进制序列号串联而成,如0111terminal_code字符串终端号码commjtype十进制数通信服务商代码,见表
2.2-2pos_type十进制数位置类型,见表
2.3-1UTC十进制数GPS定位时间,见表
2.1-1longitude十进制数经度,见表
2.1-1latitude十进制数纬度,见表
2.1-1course十进制数航向,见表
2.1-1trueheading十进制数船脑向,见表
2.1-1speed十进制数速度,见表
2.1-1status十进制数状态,见表
2.3-3vdesc字符串备注,位置描述
3.3,
2.7不含位置类数据推送格式m tenninal_c()de,c()mm_type,msg_type,UTC,msg\r\n表0-16不含位置类数据推送名称类型描述m字符串命令字数据序列号,在整个系统中是唯一的,规则由通信服务商代码(4位10进制数,系统分配)、表示数据中心的用户id0000”、UTC日msgid字符串期戳(14位10进制数,格式YYYYMMDDHH24MISS)和5位唯一的十进制序列号串联而成,如0111terminal_code字符串终端号码comm_type十进制数通信服务商代码,见表
2.2-2msg_type十进制数短信类型,见表
2.3-2UTC十进制数短信发送时间,见表
2.1-1msg字符串短信内容
3.
3.
2.8组发指令组发短信针对组内的所有目标发送短信,仅发送目标组ID给通信服务商,具体通信行为由通信服务商解释组调位针对组内的所有目标发送调位指令,仅发送目标组ID给通信服务商,具体通信行为由通信服务商解释1)中心按照本协议中3/2节获取组织机构基本信息,节获取船舶与组织机构对应关系提供中心的船舶组织结构给通信服务商2)中心按照本协议中3325发送命令(数据中心,ASP)节中的指令类型2按组请求位置、指令类型12按组请求发送短信指令发送给通信服务商通信指令3)通信服务商收到指令后,根据指令中的组代码ID在中心的组织结构数据中查询到组名称,根据组名称对应服务商本身的组织,按照服务商自定义的组发送命令方法下发指令如指令发送成功返回相应的成功信息,如失败或没有对应组织名称返回相应的错误提示
3.
3.
2.9发送请求异步信息回执格式r terminal_code..term_type.sequence.UTC,receipt_code,msg\x\n表0-17发送请求异步信息回执名称类型描述r字符串命令字terminal_code字符串终端号码comm_type十进制数通信服务商代码,见表222sequence字符串回执对应命令的序列号UTC十进制数状态更新时间,见表
2.1-1receipt_code十进制数状态码msg字符串备注表0-18发送状态代码表状态代马说明0已成功发送到数据中心10000开始处理10100处理成功10200处理失败10300通信链路不可用10400船舶未响应10500船舶不可用10700请求参数错误10800终端不存在10900终端未分配
3.
3.
2.10错误信息返回格式x error_code\r\n0-19错误信息返回名称类型描述X字符串命令字errorjcode十进制数错误代码见表0-20表0-20错误代码表errorjcode定义备注用户名或密码错F0000000用户已登录F0000002无效指令F0000003用户未登录F0000004指令格式错误F0000007该用户已由其他位置登录F0000011指令解释失败F0000016无权发送此命令F
00000171.名词定义监控目标指系统监测对象,可以是安装有定位设备的船舶、车辆、飞行物等,定位设备如AIS、海事卫星、北斗卫星、公众移动通信网(CDMA/GPRS)、短波、超短波、RFID、雷达等在渔船动态监管的客户端软件只能对安装有海事卫星C站、北斗、CDMA/GPRS、短波、超短波等支持双向通信终端设备的监控目标进行主动调取数据、发送信息等操作对仅安装AIS等设备的监控目标只能被动接收数据,进行显示、统计ASP通信应用服务提供商,提供各种通信服务的运营商或系统,如AIS系统、海事卫星运营商、北斗卫星、公众移动通信运营商、短波系统、超短波系统、RFID系统、雷达系统等
2.约定
3.1数据单位定义系统传输统一采用整数传输,所有数字类型的传输参数都经过单位换算,变换为整数进行传输,以下为数据单位定义表表0T数据单位定义表名称单位自1970-01-0100:00:00以来的秒数(64位long),最大UTC不超过3001年1月1日0时0分0秒经度、经度偏移1/10000分纬度、纬度偏移1/10000分航向1/10度速度1/10节半径海里报位间隔1秒转义字符表示,为了区分指令分隔符,”,和结束符\r\n”字符串类数据在进行TCP自定义协议转义字符表示转义插传送时进行转义(逗号)-\.(两个字符)\r\n(回车换行)-\r\n(四个字符)
2.2通信服务商代码定义通信服务商代码用来区分接入系统的通信定位服务厂商,系统采用4位数字表示通信服务商,前两位表示通信类型代码,后两位表示厂商代码表0T通信类型定义类型代码通信类型10海事卫星11北斗卫星12AIS13公众移动通信网14短波15超短波16RFID17雷达目标18〜99待定表0-2通信服务商代码类型代码通信类型1001海事卫星运营商1101北斗运营商11102北斗运营商21201AIS注通信服务商代码前两位代码表示运营商类型,后两位代表不同的运营商代码
2.3数据类型定义系统中传输基本数据分为位置数据和信息数据,下面分别为位置类型定义,信息类型定义,以及定位状态的定义表0T位置类型定义类型代码说明0定时回传位置1单次回传位置100报警回传位置200出港报201进港报表0-2信息类型定义类型代码说明0普通信息1报警信息表0-3定位状态定义类型代码说明0正常1终端故障
3.数据中心与ASP接口数据中心与ASP接口,分为静态信息交换接口、动态信息交换接口、历史数据查询接口静态信息交换接口用来与ASP同步船舶与船舶通信终端的通信基础数据,以及相关组织结构动态信息交换接口用于接收ASP发送的船舶动态信息(包括但不限于船舶定位终端的位置信息,船舶发送的短信息,船舶发送的报警信息,进出港信息等),同时用于系统平台向船舶定位终端发送指令(包括但不限于单船单次调位,单船设定船舶报位频率,多船单次调位,多船设定报位间隔,单船发送信息,多船发送信息)历史数据查询接口用于系统中心从ASP获取历史通信信息
3.1系统静态信息交换接口系统静态信息交换接口包含系统中心对外发布静态信息接口以及中心获取外部静态信息接口静态信息交换接口采用WEB service方式提供统一的数据接口静态信息交换接口适用对象为系统平台以及ASP表0T系统静态信息交换接口功能服务端客户端数据中心对外发布静态信息系统平台ASP数据中心获取外部静态信息ASP系统平台静态信息交换接口包含以下功能表0-2静态信息交换接口功能服务名说明服务端实现者客户端调用者getShipInfo获取船舶通信基础信息数据中心/ASP ASP/数据中心getGroupInfo获取组织机构信息数据中心ASPgetShipGroup获取船舶与组织对应关系数据中心ASPaddShip增加船舶数据中心/ASP ASP/数据中心delShip删除船舶数据中心/ASP ASP/数据中心服务访问地址http://ip:port/shipinfo说明1IP:服务器IP地址或者域名2PORT:端口号3shipinfoweb servicesAD注可以通过http://ip:port/shipinfowsdl获取到该web service的语义xml文件
3.
1.1获取船舶通信基础信息函数getShipInfo描述获取船舶的基本通信信息,包括船舶名称,通信终端类型,通信终端代码,以及船舶内部编码等表0-3函数getShipInfo说明方向参数类型输入username stringpassword string输出GetShipInfoReturn Mobile数组Mobile结构定义如下表0-4Mobile结构名称字段名类型说明船舶系统id mobile_id Int内部id船舶名称mobilename String船舶名称中文见表222通信服务商代通信终端类型terminal_type Int码通信终端号码terminal_code String通信终端号码获取组织机构基本信息函数getGroupInfo描述获取组织机构的基本信息,包括名称、ID、上级组等表0-5函数getGroupInfo说明方向参数类型username String轴入passwordString输出getGroupInfoReturn MobileGroup数组MobileGroup数据结构如下表0-6MobileGroup数据结构名称字段名类型说明组织编码group_id Int船舶组内部编码船舶组名称group_name String船舶组名称上级组编码parent_id Int上级组内部编码
3.
1.3获取船舶与组织机构对应关系函数getShipGroup描述获取终端与组对应关系,包括船舶id,所属组id等表0-7函数getShipGroup说明方向参数类型username string轴入passwordstring输出getShipGroupReturn MobileGroupAssign数组MobileGroupAssign数据结构如下表0-8MobileGroupAssign数据结构名称字段名类型说明组织编码group_id Int船舶组内部编码船舶编码mobile_id Int船舶内部编码
3.
1.4增加船舶函数:addShip描述添加船舶的基本通信信息,包括船舶名称,通信终端类型,通信终端代码等表0-9函数addShip说明方向参数类型Username stringPasswordstring输入Mobilename Stringterminal_type Intterminal_code String输出GetShipInfoReturn boolean。