《内蒙古北斗高分综合应用服务平台第4部分：数据接口.docx》由会员分享，可在线阅读，更多相关《内蒙古北斗高分综合应用服务平台第4部分：数据接口.docx（27页珍藏版）》请在三一办公上搜索。
1、ICS35l100.70CCSL78DB15内蒙古自治区地方标准DB15/TXXXXXXXX内蒙古北斗高分综合应用服务平台第4部分：数据接口InnermongoliaBeidouGaofencomprehensiveapplicationserviceplatfomPart4：Datainterface（征求意见稿）XXXX-XX- XX 发布XXXX-XX-XX实施内蒙古自治区市场监督管理局目次前言.111范围12规范性引用文件13术语和定义14数据对外接口14.1 概念14.2 Web访问接口14.3 数据推送接口15数据接口开发要求15.1 调用方式15.2 请求报文举例25.3 响应报
2、文举例26接口说明26. 用户信息对接接口27. 1.l获取用户信息28. 1.2验证账号密码36.1 机构管理36.21 列表查询36.22 增加操作46.23 修改操作56.24 删除操作56.25 获取所有机构树形结构66.3终端操作66.31列表查询66.32增加操作86.33修改操作96.34删除操作106.4终端位置信息管理106.41 获取终端位置信息（实时轨迹）106.42 获取终端位置信息（历史轨迹）116.43 短报文下发116.44 指令下发126.45 位置信息推送126.46 紧急告警信息推送136.47 短报文信息推送13,Z.刖百本文件按照GB/T1.1-2020
3、标准化工作导则第1部分：标准化文件的结构和起草规则的规定起草。本文件由中共内蒙古自治区委员会军民融合发展委员会办公室提出。本文件由内蒙古自治区军民融合标准化技术委员会(SAM/TC57)归口。本文件起草单位：内蒙古自治区军民融合发展研究中心、航天恒星科技有限公司、内蒙古卫星应用产业协会。本文件主要起草人：内蒙古北斗高分综合应用服务平台第4部分：数据接口1范围本文件规定了内蒙古北斗高分综合应用服务平台不同功能模块间的接口定义、接口内容及通信方式。本文件适用于内蒙古北斗高分综合应用服务平台（以下简称“平台）的接口设计。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。
4、其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T25070-2019信息安全技术信息系统数据传输安全要求GB/T11457-2006信息技术软件工程术语3术语和定义GB/T25070-2019xGB/T11457-2006界定的术语和定义适用于本文件。4数据对外接口4. 1概念数据对外接口服务模块提供异构数据源统一标准化的数据对外APl接口服务功能，核心是要能满足不同客户个性化的数据需求。整个数据对外接口服务模块分为TVEB访问接口、数据推送接口。4.2 Web访问接口Web访问接口服务主要为业务系统中的数据需求提
5、供数据服务支持。通过标准协议和个性化参数来满足各业务系统的数据需求。整个WEB访问接口基于大数据基础支撑平台并采用分布式架构，提供跨编程语言、跨操作系统平台的远程调用，可以向外界暴露了一系列能通过Web调用的API接口实现其他业务应用调用，满足内蒙古北斗高分行业其他业务需求。4.3 数据推送接口通过利用消息队列构建业务数据推送接口服务，同时针对不同的场景可用采用不同的推送模式，满足个性化推送需求。为了提升推送的到达率，可通过服务发起多种类型的消息推送，用户可根据实际的业务场景，选择合适的推送内容、推送渠道以及推送方式。5数据接口开发要求5.1 调用方式支持如下HTTP调用方式：a) PUT:更
6、新资源，请求消息必须包含资源中的部分或所有成员；b) POST:创建资源，请求消息必须包含资源中的一个成员；C)GET：请求指定的资源信息；d)DELETE:删除一个或所有支持post方法的资源成员。5.2 请求报文举例当方法是PUT/POST时，HTTP主体通常需要包含JSoN数据。请求必须发送到设备的HTTP/HTTPS端口。5.3 响应报文举例响应报文举例如下：a) “URL”：代表HTTP请求消息携带的URLCJ当请求方法为get/put/deletc时，URL与请求中的URL相同。对于PoSt请求，它是新创建对象的URL。客户端可以使用它直接获取新对象。b) CrcatcdIDT：代
7、表资源支持httppost/delcte方法。它将传输新对象的ID,该ID由服务器为新对象创建。c) “Codg：代表处理系统结果。详见错误码说明。d) msg:代表处理系统结果的解释。e) “比说：请求(获取)的资源的信息或数据。大多数情况下都是JSON。对于相同的URL,放置请求数据格式与getresponse中的数据相同。如果服务器工作失败，或者HTTP方法为Put/Post,则响应“data”包含，nullo6接口说明6.1 用户信息对接接口6.1.1 获取用户信息请求UrI：usegetUscrInfOByTokeno请求方式：POSTo调用量上限(次/日)：500o请求头参数见表1
8、,接口返回参数如表2。表1获取用户信息请求头参数参数名称参数说明备注X-Access-Tokentokenapp请求头中是否有app；有,则是app端访问否则是web端访问表2返回参数说明参数名称参数说明值code状态码200表示成功msg返回信息的相关描述data返回数据格式见表3表3data参数示例说明参数名称参数说明备注Id用户Idemail用户邮箱name账号mobile手机号orgld机构IdorgName机构名称rolelds角色Id集合roleNames角色名称status用户状态sex性别0：男；1：女remove是否被移除0:未被移除；1：已被移除sysNames系统名称集合
9、6.1.2验证账号密码请求URL：/user/verifyUsemamendPass,ord0请求方式：POSTo调用量上限（次/日）：500。请求参数见表4,接口返回参数如表5。表4验证账号密码请求参数说明名称说明必传类型备注username账号是Stringpassword密码是StringIxsleids标识旦string表5返回参数说明参数名称参数说明值code状态码200表示成功msg返回信息的相关描述data返回数据格式见表6表6data参数示例说明参数名称参数说明备注Id用户Idemail用户邮箱name账号mobile手机号orgld机构IdorgName机构名称rolelds
10、角色Id集合roleNames角色名称status用户状态sex性别0：男；1：女remove是否被移除0：未被移除；1：已被移除sysNames系统名称集合6.2机构管理请求UrI：orggetOigList0请求方式：POST请求。调用量上限（次/日）：500o请求头header见表7,请求参数见表8,返回参数说明见表9。表7列表查询请求头说明参数名称参数说明值X-Access-TokenToken557ff54d84aac8049d5309e155fc表8列表查询请求参数说明名称说明必传类型备注alias机构简称否Stringname机构名称否StringarentName上级机构名称否
11、StringpageNum起始页是StringpageSize每页条数是String表9查新列表返回参数说明参数名称参数说明值code状态码200msg返回信息描述data返回数据格式见表10表10dala参数示例说明参数名称参数说明备注endrow结束行HasNextPage是否有下一页false：无；ture:有hasPrevious是否有历史数据false：无；ture：有isFistPage是否是第一页false：不是；ture：是isLastPage是否是最后一页false：不是；ture：是list列表数据navigatefirstPage导航至第一页navigateLastPe导
12、航至最后一页navigatefirstPageNums导航至第一页页码nextPage下一页PageNum起始页PageSiZe每页条数prePage前一页size大小StarRow开始行total总数6.2.2增加操作请求Url：orgaddOrg0请求方式：POST请求。调用量上限（次/日）：500。请求头header见表7,请求参数见表11,返回参数见表12。表11增加操作请求参数情况名称说明必传类型备注alias机构简称是Stringname机构名称是StringParentName上级机构名称是StringmdmCode机构编码否Stringpid父id否StringsysCode系
13、统code否Stringuserid用户id否String表12增加操作返回参数说明参数名称参数说明值code状态码200msg返回信息描述data返回数据6.2.3修改操作请求url：/Orgupdaterg0请求方式：POST请求。调用量上限（次/日）：500。请求头header见表7,请求参数见表13,返回参数见表14。表13修改操作请求参数情况名称说明必传类型备注alias机构简称是StringCreateBy创建人否Stringid数据Id是Stringlevel等级否Stringname机构名称是StringOrgTyPe机构类型是StringParentNamc上级机构名称是St
14、ringpid父id否Stringremark备注否Stringremove是否移除是StringsysCode系统code否StringsysName系统名称否StringUpdateBy更新人否Stringuserid用户id否String表14修改操作返回参数说明参数名称参数说明值code状态码200data返回数据msg返回信息描述6.2.4删除操作请求UrI：orgdeleteOrg0请求方式：POST请求。调用量上限（次/日）：500o请求头header见表7,请求参数见表15.返回参数见表16。表15删除操作请求参数情况名称说明必传类型备注id删除数据的id是Stringusei
15、Id用户id是String表16删除操作返回参数说明参数名称参数说明值code状态码200data返回数据msg返回信息描述6.2.5获取所有机构树形结构请求Url：orggetAllOrgTree0请求方式：POST请求。调用量上限（次/日）：100Oo请求参数：无，返回参数见表17。表17获取所有机构树形结构返回参数说明参数名称参数说明值code状态码200msg返回信息描述data返回数据格式见表18表18dala参数示例说明参数名称参数说明备注id机构Idname机构名称pid父Idchdren子节点Id:子节点Id；name:子节点名称；Pid:所属父节点Id6.3终端操作6.3.1
16、列表查询请求Url：0inallistTerminalTies0请求方式：POST请求。调用量上限（次/日）：1000o请求头header见表7,请求参数见表19.返回参数见表20。表19列表查询请求参数情况名称说明必传类型备注ObjType工作状态否Stringorgld机构id否Stringt(11inalModel终端型号否StringsysCode所属系统code否String智慧巡边702001森林防火T02002智慧放牧T02003农牧机械H02004terminalType终端类型否StringsimNosSim卡号否StringbeidouNos北斗编号否Stringtermi
17、nalNo终端序列号否StringtieFlag是否绑卡否StringpageNum起始页是StringPageSize每页条数是String表20终端列表返回参数说明参数名称参数说明值code状态码200msg返回信息描述data返回数据格式见表21表21终端列表data参数示例说明参数名称参数说明备注endrow结束行hasNextPage是否有下一页false：无；true：有hasPrevious是否有历史数据false：无；true：有isFistPage是否是第一页false：不是；tme：是isLastPage是否是最后一页false：不是；tne：是list列表数据格式见表22
18、navigatefirstPage导航至第一页RavigateLastPage导航至最后一页navigatefirstPageNums导航至第一页页码nextPage下一页PageNum起始页PageSize每页条数prePage前一页size大小StarRow开始行total总数表22返回Hst参数说明参数名称参数说明备注beidould北斗卡编号beidoulds多个北斗卡编号用逗号隔开BeidouList北斗实体beidouNos北斗卡CreateBy创建人参数名称参数说明备注CreateTime创建时间dataProtocol:数据协议delFlag删除状态0：未删除；1:删除id终端
19、信息表主键idimei终端imei号manufactured生产厂家InodelId:终端类型编号msgFlag是否支持短报文通信1：是；0：否orgld所属机构idorgName所属机构名字remark备注simidsim卡编号simlds多个Sim卡编号逗号隔开simList多个sim卡号simNosSim卡号sn终端SN号sysCode所属系统Codesysname所属系统名称terminalActivetime激活时间terminalAuthcode终端鉴权码terminalFirmWareVersion固件版本terminalModel终端型号terminalName终端名termi
20、nalNo终端序列号terminalRecordtime终端记录时间terminalSoftwareVersion软件版本tminalType终端类型t0minalTypeCode终端类型codetieFlag是否绑卡0：是；1：否ttsFlag是否支持TTS语音播报：1：是；0：否UpdateBy修改人UpdateTime修改时间UsedOrgId使用机构idUsedOrgName使用机构名字warehouse出入库信息WorkStatus工作状态6.3.2增加操作请求Url：teninalinsertTerminal0请求方式：POST请求。调用量上限（次/日）：500。请求头header
21、见表7,请求参数见表23,返回参数见表24。表23增加操作请求参数说明名称说明必传类型备注InOdend终端型号选择不能为空是StringterIninalNo终端序列号是StringterminalAuthcode终端鉴权码否StringWorkStatus工作状态否Stringwarehouse在库情况否StringorgNarae所属机构是Stringsysname所属系统早String名称说明必传类型备注terminalNme终端型号是StringterminalType终端类型是StringbeidouList北斗卡号否Stringimei终端IMEl否StringOrgld所属机构
22、Id否Stringsimlds多个卡号Id,逗号隔开否StringsimList多个卡号，逗号隔开否StringsimNossim卡号否Stringsyscode机构编码否Stringto*minalModel终端模型否StringUsedOrgid使用机构Id否StringUsedOrgName使用机构名称否StringterminalFirmwareVersion固定版本否Stringremark备注否StringterminalSoftwareVersion软件版本否String表24终端新增返回参数说明参数名称参数说明值code状态码200msg返回信息描述6.3.3修改操作请求Url
23、:jstminalUpdateTerminalo请求方式：POST请求。调用量上限（次/日）：500。请求头header见表7,请求参数见表25.返回参数见表26。表25修改操作请求参数说明名称说明必传类型备注beidould北斗卡号Id否Stringbeidoulds多个北斗卡号Id否StringbeidouIdList多个北斗卡号否StringbeidouldNos北斗卡号否StringCreateBy创建人否StringCreateTime创建时间否StringdataProtocol数据协议否StringdeFlag删除标志否Stringhashcodehash编码否Stringid终
24、端Id否Stringimei终端IMEl否StringIpp地址否Stringlatitude纬度否Stringmaufactured终端生产商否Stringmodelld终端型号选择不能为空是StringmOintarType监控类型否StringmSgFlag消息标识否Stringorgld所属机构Id否Stringport端口号否Stringremark备注否Stringsimlds多个卡号Id,逗号隔开否StringsimList多个卡号，逗号隔开否String名称说明必传类型备注simNos多个卡号否StringsnSN号否Stringsyscode机构编码否StringSysCod
25、eOld机构编码Id否Stringsysname所属系统是StringIerminalActivetine终端激活时间否StringterminalAuthcode终端鉴权码否StringterminalFirmwareVersion固定版本否StringtaminalModel终端模型否StringterminalNme终端名称是StringtcrminalRccordtiine终端记录时间StringterminalType终端类型是StringterminalSoftwareVersion软件版本否StringupdateBy更新人否StringUpdateTime更新时间否String
26、UseTermail终端使用否Stringuserld使用人机构Id否StringUseOrName使用人机构名称否Stringwarehouse在库情况否Stringworkstatus工作状态否String表26终端修改返回参数说明参数名称参数说明值code状态码200msg返回信息描述6.3.4删除操作请求Url：ZteiininaVupdateTerniinalDelFlago请求方式：POST请求。调用量上限（次/日）：500。请求头header见表7,请求参数见表27.返回参数见表28。表27删除操作请求参数说明名称说明必传类型备注ids删除id集合是String表28终端删除操作
27、返回参数说明参数名称参数说明值code状态码200msg返回信息描述total总数6.4终端位置信息管理6.4.1获取终端位置信息（实时轨迹）请求Url：searchgetLocationo请求方式：GET请求。调用量上限（次/日）：10000。请求参数见表29。返回参数见表30。表29获取终端位置信息请求参数说明名称说明必传类型备注terminalld终端id是String表30获取终端位置信息返回参数说明参数名称参数说明值code状态码200rasg返回信息描述data返回数据格式见表31表31获取终端位置信息data返回参数说明参数名称参数说明备注alarm告警0：未报警1：报警cour
28、se角度fmatted_address地址Iat纬度Ion经度speed速度state在线离线状态1：离线0：在线time时间6.4.2获取终端位置信息（历史轨迹）请求Url：/dataVisiVfindHistayAllo请求方式：PoST请求。调用量上限（次/日）：100Oo请求参数见表32,返回参数见表33。表32获取终端位置信息（历史轨迹）请求参数说明名称说明必传类型备注terminalld终端id是StringendTime结束时间是StringStartTime开始时间是String表33取终端位置信息（历史轨迹）返回参数说明参数名称参数说明值code状态码200msg返回信息描述
29、result返回数据格式见表34表34获取终端位置信息返回参数说明参数名称参数说明备注alt高度course方向Iat纬度Ing经度speed速度tld终端idtime时间6.4.3短报文下发下发接口/BDDA/rest/command/messageTxtNew0请求方式：POSTo调用量上限（次/日）：WOOo请求参数见表35,返回参数见表36。表35短报文下发请求参数说明名称说明必传类型备注tld终端ID是StringtxtContent消息内容是StringtdcgraphType编码方式否String上汉字2-代码3-混编表36短报文下发返回参数说明名称说明必传类型备注code返回编
30、码否String200成功203渣无此终端204-终端查询异常msg返回内容描述否String6.4.4指令下发下发接口：/BDDA/rest/command/sendMessage0请求方式：POSTo调用量上限（次/日）：WOOo请求参数见表37,返回参数见表38。表37指令下发请求参数说明名称说明必传类型备注fiq发送频次否Stringconfirm是否反馈否String是否反馈0：不反馈，1：反馈SendType发送类型否String发送类型（立即发，上线发）sn终端Sn号否Stringtld终端ID是Stringcode发送编码是Stringcontent内容是Stringtime时
31、间戳是Stringmode群发还是单发否String表38指令下发返回参数说明名称说明必传类型备注code返回编码否String200-成功500-失败msg返回内容描述否String6.4.5位置信息推送实时数据通过Kafka消息队列的方式实现交互，数据格式为json数据。告警信息Topic:LBS_POSITION。调用量上限（次/日）：WOOo参数说明见表39。表39位置信息推送参数说明名称说明必传类型备注idID是String随机UUID名称说明必传类型备注terminalNo终端编号是StringsysCode系统编码否Stringorgld机构id否StringterminalTy
32、pe终端类型否String10090OI-北斗手持终端1009002-北斗车载终端1009003-农机监测终端1009OOr北斗指挥终端I型1009005-北斗RDSS手持终端1009006-北斗RDSS车载终端1009007-放牧定位项圈1009008-北斗指挥终端II型tld终端序列号否String终端唯一编号terminalModel终端型号否StringterminalName终端名称否StringIng经度是double小数点后6位Iat纬度是double小数点后6位alt高度否Stringspeed速度否double小数点后2位COUrSe方向否doubletime时间戳是Stri
33、ng6.4.6紧急告警信息推送实时数据通过Kafka消息队列的方式实现交互，数据格式为json数据。告警信息Topic：ALARM,S0So调用量上限（次/日）：100Oo参数说明见表40。表40紧急告警信息推送参数说明名称说明必传类型备注idID是String随机UUIDterminalNo终端编号是StringsysCode系统编码否Stringorgld机构id否StringterminalType终端类型否String1009001-北斗手持终端1009002-北斗车载终端1009003-农机监测终端10090Or北斗指挥终端I型1009005-北斗RDSS手持终端1009006-北斗
34、RDSS车载终端1009007-放牧定位项圈1009008-北斗指挥终端II型tld终端序列号否String终端唯一编号teminalModel终端型号否StringterminalName终端名称否StringIng经度否double小数点后6位Iat纬度否double小数点后6位alt高度否Stringspeed速度否double小数点后2位course方向否doubletime时间戳是String6.4.7短报文信息推送实时数据通过Kafka消息队列的方式实现交互，数据格式为json数据。短报文信息推送ToPic：mq_gw_sendbdmessageo调用量上限（次/日）：WOOo参数说明见表41。表41短报文信息推送参数说明名称说明必传类型备注id随机UUID是Stringtld终端ID否StringsysCode系统编码否Stringuserid发信方（ID号）是StringreceiveUserId收信方（D号）是Stringcode发送编码是Stringtype通信类型1:点对点2:通播3:组播4：监听是Stringcontent内容是Stringtime时间戳是String
