交付团队2025
  1. 产品接口
交付团队2025
  • 批次生产
    • 项目接口
      • 配料记录生成接口
      • 配料明细查询接口
      • 更新成品入库信息
      • 获取配料明细并设置备料明细
      • 指令单生成接口(生产拓展新增)
      • 根据指令单id和序号获取配料指令单号
      • 批量下达指令单(先删除再新增)
      • 接收检验结论
      • 销售订单同步
      • 新增化纤工单
    • 产品接口
      • 批次7.0(对内)
        • 指令单【作废】时调用(批量)
        • 获取配方下所有工序-工作单元-程序组合信息
        • 指令单【作废】时调用
        • 获取默认配方
        • 删除Batch工单消费者调度
        • 工厂架构启用接口(校验子节点)
        • 获取工单详细信息
        • 更新工厂架构
        • 停止工单
        • 同步direct公式组及公式
        • Direct请检
        • 新增节点和移动节点是需要进行校验
        • 获取需要批次手动绑定设备的Unit步以及设备信息
        • 新增工厂架构
        • 删除物料
        • 外部系统生成生产订单接口
        • 放弃工单
        • 新增普通配方
        • 外部系统生成计划工单接口(webservice)
        • 获取direct报警信息附件
        • 修改Batch中某个Phase的设定参数值
        • 工厂节点移动接口(划拨业务)
        • Direct删除工单
        • 获取仓库(货位)、源仓库(源货位)
        • 活动确认
        • 质量追溯数据同步接口
        • 修改Batch中某个Phase的设定参数值(修改工单活动计划数量)
        • 车间仓库数据迁移
        • 指令单信息更新
        • 工厂架构外围系统映射接口
        • 修改正在运行批次下的Unit的绑定装置
        • 指令单报工状态修改为已报工
        • 暂停工单
        • 工厂架构停用接口(包含子节点)
        • 启动工单
        • 删除工厂节点
        • 指令单【运行】时调用
        • 指令单【完成】时调用
        • 通过外部系统编码获取用户ID
        • 获取当前应用项目
        • 修改物料
        • 更新工单
        • 不良品处理回填
        • 同步程序组态
        • 修改工厂节点
        • 获取组态物料参数
        • 重启工单
        • 新增工单
        • 删除工单
        • 删除BOM
        • 继续工单
        • 质量结果回填
        • 保持工单
        • 程序实例执行反馈
        • 新增BOM
        • 指令单【运行】时调用(批量)
        • 新增物料
        • 修改BOM
        • Direct删除程序
        • 指令单【完成】时调用(批量)
        • 新增Batch工单消费者调度
        • 新增工厂节点
        • 设置并绑定应用项目
        • 同步direct公式组
        • 指令单备料状态回填
        • 同步direct公式组公式
        • 修改未运行批次下的Unit的绑定装置
      • 批次7.0(对外)
        • 外部系统生成计划工单接口 Copy
        • 删除BOM
        • 删除指令单
        • 生成备料记录
        • 创建产耗记录明细
        • 创建备料需求
        • 新增产品bom(工作流)
        • 新增BOM
        • 创建产耗记录
        • 外部系统生成计划工单接口
        • 创建报工单接口
        • 生成备料指令
        • 修改BOM启用状态
        • 指令单生成接口
  • 连续生产
    • 产品接口
      • ODS
        • 公用
          • 平稳率组态/vxods-psa/ConfigBase/IndexMgt
          • 联锁组态/msService/vxods-ica/interlockProgram-41
          • 平稳率组态/inter-api/psa/setting/findFormula/type
          • 登录请求验证
          • 屏蔽管理/inter-api/flow-service/v1/task/pending/total-146
          • 登录/portal/js/1_065adc39f779ac6c0170.bundle.js.map-92
          • 屏蔽管理/inter-api/psa/quotaConfig/device-154
          • 屏蔽管理/inter-api/auth/v1/getCurrentLoginInfo-151
          • 报表/msService/vxods-ica/interlockStat/dayStat-111
          • 屏蔽管理/inter-api/supplant-license/v1/licenseDetection-148
          • ods/inter-api/psa/quotaConfig/findByFilter
          • 屏蔽管理/inter-api/notification-${username}/v1/notice/message/stationLetter/unreadnum-147
          • 联锁实时/msService/vxods-ica/localeResource-31
          • HTTP登录请求获取token
          • 屏蔽管理/inter-api/psa/excludeManagement/findExclude-155
          • 登录/portal/js/0_065adc39f779ac6c0170.bundle.js.map-91
          • 登录/portal/js/2_065adc39f779ac6c0170.bundle.js.map-90
          • 联锁实时/msService/vxcommon-basic-setting/factory/factoryStructs-93
          • 指标管理页面导出默认根节点下全部指标
          • 平稳率组态/inter-api/vxcommon-basic-setting/factory/factoryStructs
          • 联锁分钟历史/msService/vxods-ica/history/time-54
          • 报表/inter-api/ods-scada/tags/filters-110
          • 平稳率组态/inter-api/rbac/v1/menus/operateRecord
          • 平稳率组态/inter-api/psa/quotaType/findAllQuotaType
          • 联锁实时/msService/vxods-ica/global-34
          • 联锁组态/msService/vxods-ica/interlockController-46
          • 屏蔽管理/inter-api/psa/setting/findFormula/flag-153
          • 联锁组态/msService/vxcommon-basic-setting/getOperateAuth-42
          • 报表/msService/vxods-ica/interlockStat/teamStat-109
          • 联锁实时/inter-api/notification-admin/v1/notice/message/stationLetter/unreadnum-100
          • 联锁实时/msService/vxods-ica/current/status-94
          • 联锁实时/msService/vxods-ica/interlockType-33
          • 联锁组态/msService/vxods-ica/interlockLevel-43
        • 平稳率
          • ODS重算接口
            • 小时历史汇总数据重算接口-指定天范围-指定小时范围
            • 小时历史汇总数据重算接口-当前时间前一小时
            • 上级汇总历史数据重算接口-指定类型-指定天范围
    • 项目接口
      • 连云港碱液
  • 生产安全
    • 产品接口
      • 人员定位标准接口
    • 项目接口
  • WMS产品
    • 定制接口
      • 双环
        • 采购订单生成
      • 戈恩斯
        • 现存量推荐(根据大批号)
      • 华峰
        • 【中间件-数据对象脚本】获取指定容器明细数据
      • 信汇新材料
        • 销售出库单生成
        • 生成形态转换单
        • 现存量检验结果回传
      • 协鑫无人值守接口
      • 废物出库申请单回填
      • 反写位号值调用模拟
      • 领用申请单
      • 生产退料单驳回/作废
      • 任务继续接口
      • 生产入库回传ERP
      • 反写位号值接口
      • 领用退库单获取EAS审核结果
      • 销售退货申请单回传判级物料
      • 第三方LIMS
      • 危化品暂存入库单
      • 危化品领用出库单
      • 同步现存量
      • 接收OA检验结果
      • 调拨入库单同步NC
      • 调拨出库单同步NC
      • 生产退料单提交生效
      • 抽检回填
      • 对生产接口mock
      • 生产出库红字与调拨单结合
      • 生产出库单生效
      • 德方定制其他入库单
      • 下发任务接口
      • 模拟测试接口
      • mock返回值测试接口
      • 采购订单EAS审核结果回填
      • 领用申请单EAS审核结果回填
      • 定时同步现存量
      • 废物入库申请单回填
      • 生产入库生效
      • 生产出库生效
      • 测试
    • 未规划接口
      • 位号mock
    • 项目接口
      • 乳源东阳光
        • 获取token
        • 生成搬运任务单
        • 搬运区域更新(功能按钮)
        • AGV 系统任务状态反馈
        • AGV 系统任务状态异常反馈
        • 搬运任务明细更新(立库回传起始货位)
        • 生产入库状态回传
        • 立库任务取消接口
        • AGV 系统任务状态反馈 调用magicApi
        • AGV 系统任务状态异常反馈 调用magicApi
      • 万华
        • 根据标签查询线边库存
        • 拆包单生成
      • 融科
        • 领料单加权平均单价回填
        • 获取ERP库存
        • 领料单加权平均单价回填
        • 采购申请单同步OA状态
        • 材料试剂登记
        • 采购申请单同步OA状态
        • 销售出库单生成
        • 更新销售出库单
      • 山西兰花
        • 生成其他入库单
      • 华峰
        • 生成烘料计划
        • 删除烘料记录
      • 长青
        • 推送生产入库单代理接口
        • 采购到货
        • 未命名接口
      • 华峰
        • 华峰中间件接口(通用)
      • 蜀能
        • 第三方WMS质检回传
      • 连云港碱业
        • 生产入库单
        • 过磅结果反馈接口
        • 调拨进厂提醒接口
        • 包装入库检验结果同步接口
        • 生产入库检验回传接口
        • 销售发货单
        • 采购订单
      • 硅宝
        • 批量生成生产入库单
        • 批量生产出库单
    • 人员定位
      • 绑定车卡
      • 删除绑定
    • 产品接口
      • 公共分类
        • 盘点单
        • 查询现存量汇总
        • 容器装载
        • 容器卸载
        • 采购入库单修改
        • 销售出库单修改
        • 采购订单
        • 同步现存量
        • 采购入库单
        • 生产入库单
        • 生产退料单
        • 生产出库单
        • 销售退货单
        • 采购退货单
        • 推荐出货货位
        • 混批单
        • 销售出库单
        • 调拨单
        • 销售发货单
        • 货位调整单
        • 采购到货单
        • 其他入库单
        • 冻结申请单
        • 采购入库单_写入二次过磅数据
        • 现存量检验结果回传
        • 解冻申请单
        • 原料调拨入库单
        • 修改容器台账明细
        • 委托单检验回传
        • 生产检验结果回传
        • 生成生效状态的混批单并同步生成生效状态的调拨单
        • 同步现存量
        • 采购入库单_写入一次过磅数据
        • 其他出库单
        • 生成出库需求单信息
        • 批量推荐现存量
        • 生成形态转换单
        • 发货通知单
        • 生产退料出库单
        • 分页查询现存量
      • 内部接口
        • 根据容器确认发货
        • 库存周期率列表
        • 物料库存统计(危化品大屏)
        • 根据容器编码查找容器明细
        • 库存周转率图表
        • 替代料生产出库
        • 查找检查项
        • 替代料计算
        • 修改领料类型关账设置
        • 库存趋势分析
        • 空置容器状态
        • 修改采购入库金额
        • 通用实体查询
        • 条码台账新增/修改
        • 查询容器列表
        • EIQ分析
      • PDA接口
        • 上架推荐货位
        • 拣货货位推荐
        • 仓库+批号查询现存量
        • 模糊查询现存量
      • 3.0门户
        • 现存量汇总查询
        • 仓库待办汇总查询
        • 库龄分析
        • 查询有库存的仓库列表
        • 查询仓库下物料
      • MOCK用
        • 材料申请单
        • 生产备料记录临时mock
        • 生产入库单推送
        • 生产备料记录
    • 未命名接口
      GET
    • 未命名接口
      POST
    • 未命名接口
      POST
    • 未命名接口
      POST
    • 未命名接口
      POST
    • 未命名接口
      POST
    • 未命名接口
      POST
    • 未命名接口
      POST
  • 公用基础
    • 产品接口
      • 公用基础内部接口
        • 物料参照
        • 客商查询
        • 法律法规批量流入接口
        • 获取节点下默认工作日历当月休息日
        • 仓库查询
        • 法律法规分类批量流入接口
        • 承包商及承包商人员的黑名单设置
      • 接口自动化
        • 资质
        • 公司资质
        • 承包商人员资质
        • 人员资质设置
        • 岗位同步
        • 仓库分类同步
        • 新建班组
        • 公司同步
        • 承包商人员
        • 客商同步
        • 排班计划删除
        • 资质分类
        • 生成排班
        • 排班信息查询
        • 单位同步
        • 新建班次
        • 新建排班计划
        • 客商分类同步
        • 设备类型同步
        • 人员同步
        • 排班信息删除
        • 调班申请
        • 物料同步
        • 排班规则删除
        • 部门同步
        • 承包商资质
        • 资质等级
        • 货位同步
        • 设备档案同步
        • 班次规则删除
        • 物料分类同步
        • 仓库同步
        • 班组删除
      • 未规划接口
        • 文档新增
        • 退出
        • 登录
        • 文件夹删除接口
        • 文档删除审批生效
        • 文档升版
        • 文档删除提交
        • 回收站删除接口
      • 公用基础查询接口
        • 按公司查询人员
        • 文档管理新增
        • 根据法律法规分类查询
        • 查询所有人员资质
        • 人员资质查询接口
        • 人员查询
        • 获取文件信息
        • 承包商人员资质查询
        • 按公司查询岗位
        • 按公司查询部门
        • 文件夹新增
        • 承包商人员分页查询
    • 项目接口
  1. 产品接口

人员定位标准接口

1. 登录获取令牌

Path: /inter-api/auth/login

Method: POST

接口描述:

请求参数 :

Body:

名称 类型 备注

userName (^) string 用户名
password (^) string 密码
返回数据
名称 类型 备注
ticket string (^) 令牌
注:在调用下面所有接口时需要在 headers 中加入令牌信息:
例:Authorization: Bearer XXX
返回示例:
{
"companies": [
{
"code": "default_org_company",
"id": 1000 ,
"name": "浙江中控技术股份有限公司"
}
],
"currentCompany": {
"code": "default_org_company",
"id": 1000 ,
"name": "浙江中控技术股份有限公司"
},

"expire": 0 ,

"isThreeRole": false,

"loginType": "0",

"status": "ok",

"tenantId": "dt",

"ticket": "f679ffaf-a30b-44d5-94e9-22fcd60f456fg",

"uniqueLogin": false,

"user": {

"id": 1 ,

"userName": "admin",

"userType": 1

},

"userId": 1 ,

"userType": 1 ,

"username": "admin"

}

以下接口:code=2000000 时,请求成功。

2 历史轨迹查询

path:/msService/VxPLS/v1/locationHis/list/positionHis

method: POST

请求参数:

Body:

名称 类型 是否必须 默认值 备注

sn string 非必须 定位卡号

withInHour number 非必须 (^) 4h、8h、24h
startTime long 非必须 (^) 开始时间
endTime long 非必须 (^) 结束时间
staffCode string 非必须 (^) 人员编码
currentTimes number 非必须 (^) 当前次数
返回数据:
名称 类型 是否必须 默认值 备注
data object 非必须^
LocationHisGath
erBO

├─ locationHiss object [] 非必须 (^)
历史数
据 ,List<List>,分段
├─ total number 非必须 总次数
├─ currentTimes number 非必须 当前次数
├─ tagBinder object 非必须 BinderCacheBO
├─ ─ tagType enum 非必须 标签类型
├─ ─ code string 非必须
├─ ─ tagSn string 非必须 定位标签
├─ ─ id number 非必须 标签绑定者ID
├─ ─ name string 非必须 标签绑定者名称
├── postCode string 非必须 人员岗位
├─ ─ binderTyp
e
number 非必须 标签绑定者类型
├─ ─ binderTyp
eCache
object 非必须^
车或者人的类
型 ,BinderTypeC
acheBO
├─ ─ ─ id number 非必须
├─ ─ ─ typeCod
e
string 非必须^ 类型编码^
├── ─ typeNa
me
string 非必须 类型名称
├─ ─ ─ typeIcon number 非必须 类型图标
├─ ─ ─ normalI
con
number 非必须 普通图标
├─ ─ departmen
tCode
string 非必须 部门名称
├── departmen
tName
string 非必须^
├─ ─ postName string 非必须^ 岗位名称^
├─ ─ cooperator
Code
string 非必须^ 承包商单位编码^

├─ ─ cooperator
Name

string 非必须 承包商单位名称

├── businessId number 非必须^

├─ ─ businessTy
pe

object 非必须^ DictBO

├── code string 非必须^ 编码^

├── value string 非必须 编码值

├── parentCom
Code

string 非必须 母公司

├── phoneNum
ber

string 非必须^

├─ ─ mark string 非必须 (^)
标签绑定者唯一
标识
├─ floorInfoList object [] 非必须 FloorInfoBO
├─ ─ floorInfo string 非必须 楼层信息
├─ ─ entryTime string 非必须 进入时间
├── leaveTime string 非必须^ 离开时间^
├─ ─ dwellTime number 非必须^
停留时间(格
式:x小时x分
钟)
code number 非必须
message string 非必须^
(备注:根据返回的总次数分批请求轨迹数据;根据定位时间分段,分段标准为:间隔两分钟)
请求示例:
{
"sn": "BTT38001279",
"startTime": 1684219218170 ,
"endTime": 1684222818171 ,
"currentTimes": 1
}
返回示例:
{
"code": 2000000,
"message": "",

"data": {

"locationHiss": [

[{

"tagSn": "BTT38001450",

"locationTime": 0,

"floors": 0,

"high": 1,

"lon": 121.9562014,

"lat": 29.930599,

"buildingPatchId": null,

"timestamp": 1682302103250

}],

[{

"tagSn": "BTT38001450",

"locationTime": 0,

"floors": 0,

"high": 1,

"lon": 121.9563598,

"lat": 29.930599,

"buildingPatchId": null,

"timestamp": 1682302287937

}],

[{

"tagSn": "BTT38001450",

"locationTime": 0,

"floors": 0,

"high": 1,

"lon": 121.9558961,

"lat": 29.9293838,

"buildingPatchId": null,

"timestamp": 1682305617500

}]

],

"total": 1,

"currentTimes": 1,

"tagBinder": {

"tagType": "TAG_PERSON",

"code": "YXQB002",

"tagSn": "BTT38001450",

"id": 128,

"name": " 运七 _ 班长 02",

"driver": null,

"postCode": "wc7",

"binderType": 3,

"binderTypeCache": {

"id": 3,

"typeCode": "staff",

"typeName": " 员工 ",

"typeIcon": 1,

"normalIcon": 9

},

"normalIcon": 9,

"mainColor": "#36dff9ff",

"departmentCode": "yxqb",

"departmentName": " 运行七部 ",

"postName": " 外操 7",

"cooperatorCode": null,

"cooperatorName": null,

"businessId": null,

"businessType": null,

"parentComCode": "default_org_company",

"phoneNumber": null,

"mark": null

},

"stayRecords": [{

"id": 252191,

"name": " 运七 _ 班长 02",

"code": "YXQB002",

"tagSn": "BTT38001450",

"depCode": "yxqb",

"depName": " 运行七部 ",

"postCode": "wc7",

"postName": " 外操 7",

"buildingPatchId": null,

"spaceName": " 三期 - 运行七部 - 210 万吨 / 年原料加氢处理 ",

"stayTime": 2,

"entryTime": "2023- 04 - 24 11:03:33",

"leaveTime": "2023- 04 - 24 11:06:23",

"locationDetail": "121.95588188452909,29.93003541571377",

"spaceId": 225,

"spaceType": {

"code": "s.p.region",

"value": " 区域 "

},

"companyCode": "default_org_company",

"startTime": null,

"endTime": null,

"stayStartTime": null,

"stayEndTime": null

}]

}

}

3 历史定位查询

Path :/msService/VxPLS/v1/locationHis/list/momentPosition

Method: POST

请求参数:

Body

名称 类型 是否必须 备注

queryTime string 非必须 查询时间

direction enum 非必须

查询方向(当通过
查询时间未查到数
据是,)
FORWARD
往前
AFTERWAR
D

往后^

返回数据:

名称 类型 是否必须 备注

data object 非必须

LocationMomentCou
ntVO
├─
queryTimestamp

number 非必须 查询时间戳

├─ locations object [] 非必须

某个片刻的轨
迹 ,LocationMoment
VO

├─ tagSn string 非必须 标签号

├─ lon number 非必须 经度

├─ lat number 非必须 纬度

├─ high number 非必须 高度

├─ floors number 非必须 楼层

├─ locationTime number 非必须 定位时间

├─ buildingPatchId string 非必须 楼层信息ID

├─ tagBinder object 非必须

标签绑定者信
息 ,LocationTagBinde
rVO

├─ tagType enum 非必须 标签类型

├─ tagSn string 非必须 定位标签

├─ id number 非必须 标签绑定者ID

├─ name string 非必须 标签绑定者名称

├─ postCode string 非必须 人员岗位

├─ binderType number 非必须 标签绑定者类型

├─ normalIcon number 非必须

├─ mark string 非必须 标签绑定者唯一标识

├─ personTotal number 非必须 人员总数

├─ vehicleTotal number 非必须 车辆总数

├─ regionCounts object [] 非必须

区域统
计 ,RegionCountVO

├─ id number 非必须 区域ID

├─ regionName string 非必须 区域名称

├─ parentId number 非必须 上级ID

├─ personTotal number 非必须 人数统计

├─

personTagSnList

string [] 非必须 String

├─ 非必须

├─ vehicleTotal number 非必须 车辆统计

├─

vehicleTagSnList

string [] 非必须 String

├─ 非必须

├─

personnelTypeCou

nts

object [] 非必须

按人员类型统
计 ,TypeCountVO

├─ id number 非必须 类型ID

├─ typeName string 非必须 类型名称

├─ businessCode string 非必须 业务编码

├─ total number 非必须 人员总数

├─ tagSnList string [] 非必须 SN列表 ,String

├─ 非必须 SN列表

├─
vehicleTypeCounts

object [] 非必须

按车辆类型统
计 ,TypeCountVO

├─ id number 非必须 类型ID

├─ typeName string 非必须 类型名称

├─ businessCode string 非必须 业务编码

├─ total number 非必须 人员总数

├─ tagSnList string [] 非必须 SN列表 ,String

├─ 非必须 SN列表

code number 非必须

message string 非必须

请求示例:

{

"queryTime": "2023- 05 - 18T10:18:15",

"direction":"FORWARD"

}

返回示例:

{

"code": 2000000,

"message": "",

"data": {

"queryTimestamp": 1682302709000,

"locations": [{

"tagSn": "5041",

"lon": 121.6334074,

"lat": 30.0374859,

"high": 3,

"floors": 0,

"locationTime": 1682302708509,

"buildingPatchId": null,

"tagBinder": {

"tagType": "TAG_PERSON",

"code": "5041",

"tagSn": "5041",

"id": 319,

"name": "5041",

"postCode": "supcon_0006",

"binderType": 3,

"normalIcon": 9,

"mark": null

}

}],

"personTotal": 44,

"vehicleTotal": 1,

"regionCounts": [{

"id": 64,

"regionName": "a-1",

"parentId": 63,

"personTotal": 0,

"personTagSnList": [],

"vehicleTotal": 0,

"vehicleTagSnList": []

}],

"personnelTypeCounts": [{

"id": 1,

"typeName": " 承包商 ",

"businessCode": "contractor",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

},

{

"id": 2,

"typeName": " 访客 ",

"businessCode": "visitor",

"total": 2,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

},

{

"id": 3,

"typeName": " 员工 ",

"businessCode": "staff",

"total": 42,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

},

{

"id": 4,

"typeName": " 其他人员 ",

"businessCode": "p.other",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

}

],

"vehicleTypeCounts": [{

"id": 1,

"typeName": " 卡车 ",

"businessCode": "trucks",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

},

{

"id": 2,

"typeName": " 其他 ",

"businessCode": "v.other",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

},

{

"id": 3,

"typeName": " 油罐车 ",

"businessCode": "oiltrucks",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

},

{

"id": 4,

"typeName": " 五吨车 ",

"businessCode": "fiveforklift",

"total": 1,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

},

{

"id": 5,

"typeName": " 十吨车 ",

"businessCode": "tenforklift",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

}

]

}

}

4 报警列表查询

Path: /msService/VxPLS/v1/alarmInfo/page

Method: POST

请求参数:

参数名称 参数值 是否必须 示例

Content-Type application/json 是 (^) 当前页码
Body
名称 类型 是否必须 备注

currentPage number 非必须 当前页码
pageSize number 非必须 每页显示条数,默认 10
queryParam object 非必须 AlarmInfoVO
├─ id number 非必须
├─ alarmType object 必须 报警类型 ,DictVO
├─ code string 非必须
├─ value string 非必须
├─ alarmLevel object 必须 报警等级 ,DictVO
├─ code string 非必须
├─ value string 非必须
├─ tagSn string 非必须
├─ personName string 非必须 报警人
├─ spaceId number 非必须
├─ spaceName string 非必须

├─ alarmTime string 非必须 报警时间

├─ handleTime string 非必须

├─ overTime string 非必须

├─ startTime string 非必须

├─ endTime string 非必须

├─ alarmState object 必须 报警状态 ,DictVO

├─ code string 非必须

├─ value string 非必须

├─ remarks string 非必须

├─ handleOpinion string 非必须

├─ department object 非必须 部门 ,DepartmentVO

├─ departmentCode string 非必须

├─ departmentName string 非必须

├─ layNo string 非必须

├─ layLevel string 非必须

├─ parentDep

DepartmentV
O

非必须 DepartmentVO

├─ post object 非必须 岗位 ,PostVO

├─ postCode string 非必须 岗位编码

├─ postName string 非必须 岗位名称

返回数据:

名称 类型 是否必须 备注

data object 非必须

PageResultV
O

├─ total number 非必须 总数

├─ pageSize number 非必须

每页显示条
数,默认 10

├─ pages number 非必须 分页总数

├─ currentPage number 非必须 当前页码

├─ currentSize number 非必须

当前页记录数
量

├─ records object [] 非必须 事件记录 ,T

├─ id number 非必须

├─ alarmType object 必须

报警类
型 ,DictVO

├─ code string 非必须

├─ value string 非必须

├─ alarmLevel object 必须

报警等
级 ,DictVO

├─ code string 非必须

├─ value string 非必须

├─ tagSn string 非必须

├─ personName string 非必须 报警人

├─ spaceId number 非必须

├─ spaceName string 非必须

├─ alarmTime string 非必须 报警时间

├─ handleTime string 非必须

├─ overTime string 非必须

├─ startTime string 非必须

├─ endTime string 非必须

├─ alarmState object 必须

报警状
态 ,DictVO

├─ code string 非必须

├─ value string 非必须

├─ remarks string 非必须

├─

handleOpinion

string 非必须

├─ department object 非必须

部
门 ,Departm
entVO

├─

departmentCode

string 非必须

├─

departmentNam

string 非必须

e

├─ layNo string 非必须

├─ layLevel string 非必须

├─ parentDep

Department
VO

非必须

Department
VO

├─ post object 非必须 岗位 ,PostVO

├─ postCode string 非必须 岗位编码

├─ postName string 非必须 岗位名称

code number 非必须

message string 非必须

请求示例:

{

"currentPage": 1 ,

"pageSize": 10 ,

"queryParam":{

}

}

返回示例:

data: {total: 3253, pageSize: 10, pages: 326, currentPage: 1, currentSize: 10, records:
[,...]}

total: 3253
pageSize: 10
pages: 326
currentPage: 1
currentSize: 10
records: [,...]
0 : {id: 8597, alarmType: {code: "a.t.intrude", value: "闯入报警"}, alarmLevel:
{code: "general", value: "一般"},...}
id: 8597
alarmType: {code: "a.t.intrude", value: "闯入报警"}
code: "a.t.intrude"
value: "闯入报警"
alarmLevel: {code: "general", value: "一般"}
code: "general"
value: "一般"
tagSn: " 9017 "
personName: "天天"
spaceId: 17
spaceName: "Hazardous Area"
alarmTime: " 2023 - 04 - 23 11:08:31"
handleTime: null
overTime: null
startTime: null
endTime: null
alarmState: {code: "a.s.untreated", value: "未处理"}
code: "a.s.untreated"
value: "未处理"
remarks: null
handleOpinion: null
department: {departmentCode: "standard_department", departmentName: "品质服务部
", layNo: null, layLevel: null,...}
departmentCode: "standard_department"
departmentName: "品质服务部"
layNo: null
layLevel: null
parentDep: null
post: {postCode: "standard_position", postName: "品质监控总监", department:
null}
postCode: "standard_position"
postName: "品质监控总监"
department: null
spaceType: {code: "s.p.region", value: "区域"}
code: "s.p.region"
value: "区域"
lon: 121.
lat: 30.

5 处理报警

基本信息(传报警id和备注信息即可)

Path: /msService/VxPLS/v1/alarmInfo/handle/processed

Method: PUT

请求参数

Headers

参数名称 参数值 是否必须 示例 备注

Content-
Type
application/j
son

是

Body

名称 类型 是否必须 备注

id number 必须 报警id

alarmType object 必须 报警类型 ,DictVO

├─ code string 非必须

├─ value string 非必须

alarmLevel object 必须 报警等级 ,DictVO

├─ code string 非必须

├─ value string 非必须

tagSn string 非必须

personName string 非必须 报警人

spaceId number 非必须

spaceName string 非必须

alarmTime string 非必须 报警时间

handleTime string 非必须

overTime string 非必须

startTime string 非必须

endTime string 非必须

alarmState object 必须 报警状态 ,DictVO

├─ code string 非必须

├─ value string 非必须

remarks string 非必须

handleOpinion string 非必须

department object 非必须 部门 ,DepartmentVO

├─

departmentCod

e

string 非必须

├─

departmentNa

me

string 非必须

├─ layNo string 非必须

├─ layLevel string 非必须

├─ parentDep

DepartmentV
O

非必须 DepartmentVO

post object 非必须 岗位 ,PostVO

├─ postCode string 非必须 岗位编码

├─ postName string 非必须 岗位名称

返回数据

名称 类型 是否必须 默认值 备注 其他信息

data string 非必须 data

undefined:
@string

code number 非必须

undefined:
@integer

message string 非必须

undefined:
@string

6 忽略报警

基本信息

Path: /msService/VxPLS/v1/alarmInfo/handle/ignore/{id}

Method: PUT

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

路径参数

参数名称 示例 备注
id 0 (Integer)

返回数据

名称 类型 是否必须 备注 其他信息
data string 非必须 data undefined: @string^
code number 非必须 undefined: @integer^
message stringa 非必须 undefined: @string^

7 今日报警统计

基本信息

Path: /msService/VxPLS/v1/count/alarmStateCount

Method: GET

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

返回数据

名称 类型 备注
data string data
total int 总数^
untreatedTotal
object^
未处理报警
code String 报警类型编码
name String 报警类型名称^
total int 报警总数
overTotal object 已结束报警^
code String 报警类型编码
name String 报警类型名称^
total int 报警总数^
processedTotal
object^
已处理报警
code String 报警类型编码
name String 报警类型名称^
total int 报警总数
ignoreTotal
object 已忽略报警
code String 报警类型编码
name String 报警类型名称^
total int 报警总数
code number
code=2000000代表请求成功
message stringa

返回示例:

{

"code": 2000000 ,

"message": "",

"data": {

"total": 8 ,

"untreatedTotal": {

"code": "a.s.untreated",

"name": "未处理",

"total": 0

},

"overTotal": {

"code": "a.s.over",

"name": "已结束",

"total": 8

},

"processedTotal": {

"code": "a.s.processed",

"name": "已处理",

"total": 0

},

"ignoreTotal": {

"code": "a.s.ignore",

"name": "已忽略",

"total": 0

},

"untreatedRate": 0.

}

}

8 今日报警排行

基本信息

Path: /msService/VxPLS/v1/count/today/alarm

Method: GET

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

返回数据

名称 类型 备注
data list<Object>^ 返回数据^

total (^) 报警总数
code (^) 报警类型编码
alarmName (^) 报警类型名称
total int 总数^

code number
code=2000000代表请求成功
message stringa

返回示例:

{

"code": 2000000 ,

"message": "",

"data": [

{

"total": 8 ,

"code": "a.t.gather",

"alarmName": "聚集报警"

}

{

"total": 7,

"code": "a.t.intrude",

"alarmName": "闯入报警"

}

]

}

9 定位设备

9 .1 定位标签列表 UR

http://ip:port/VxPLS/index.html#/device/locationTag

9.2 定位标签列表查询

基本信息

Path: /msService/VxPLS/v1/locationTag/list

Method: POST

请求参数

body

参数名称 类型^ 说明^
tagSn string 定位标签^
tagTypeCode String
tag.person 人卡
tag.vehicle 车卡
binding boolean
true 已绑定
false 未绑定

返回数据

名称 类型 是否必须 备注 其他信息
data string 非必须 data undefined: @string^
code number 非必须 undefined: @integer^
message stringa 非必须 undefined: @string^

请求示例:

{

"tagTypeCode":"tag.vehicle",

"binding":true

}

返回示例:

{

"code": 2000000 ,

"message": "",

"data": [

{

"id": 5891 ,

"tagSn": "5502",

"tagType": {

"code": "tag.vehicle",

"value": "车卡"

},

"tagTypeCode": null,

"tagBattery": 0.0,

"binding": true,

"tagState": {

"code": "offline",

"value": "离线"

},

"tagStateCode": null,

"enable": true,

"latestReportTime": null,

"remark": null,

"temType": null,

"locationMode": null,

"tagMac": null,

"personType": null,

"tagUseType": {

"code": "sys.t.u.t.permanent",

"value": "固定卡"

},

"binder": {

"tagType": "TAG_VEHICLE",

"code": "A-9991",

"tagSn": "5502",

"id": 11 ,

"name": "A-9991",

"driver": null,

"postCode": null,

"binderType": 1 ,

"binderTypeCache": {

"id": 1 ,

"typeCode": "trucks",

"typeName": "卡车",

"typeIcon": 6 ,

"normalIcon": 13

},

"normalIcon": 13 ,

"mainColor": null,

"departmentCode": null,

"departmentName": null,

"postName": null,

"cooperatorCode": null,

"cooperatorName": null,

"businessId": null,

"businessType": null,

"businessExpire": false,

"parentComCode": "default_org_company",

"phoneNumber": null,

"mark": "A-9991"

},

"orderStr": null,

"serverProvider": {

"code": "s.p.unknown",

"value": "未知"

}

},

{

"id": 21 ,

"tagSn": "V3304",

"tagType": {

"code": "tag.vehicle",

"value": "车卡"

},

"tagTypeCode": null,

"tagBattery": - 1.0,

"binding": true,

"tagState": {

"code": "offline",

"value": "离线"

},

"tagStateCode": null,

"enable": true,

"latestReportTime": "2023- 05 - 17 18:54:21",

"remark": null,

"temType": null,

"locationMode": null,

"tagMac": null,

"personType": null,

"tagUseType": {

"code": "sys.t.u.t.permanent",

"value": "固定卡"

},

"binder": {

"tagType": "TAG_VEHICLE",

"code": "V3303",

"tagSn": "V3304",

"id": 4 ,

"name": "V3303",

"driver": "",

"postCode": null,

"binderType": 4 ,

"binderTypeCache": {

"id": 4 ,

"typeCode": "fiveforklift",

"typeName": "五吨车",

"typeIcon": 7 ,

"normalIcon": 15

},

"normalIcon": 15 ,

"mainColor": null,

"departmentCode": null,

"departmentName": null,

"postName": null,

"cooperatorCode": null,

"cooperatorName": null,

"businessId": null,

"businessType": null,

"businessExpire": false,

"parentComCode": "default_org_company",

"phoneNumber": null,

"mark": "V3303"

},

"orderStr": null,

"serverProvider": {

"code": "s.p.unknown",

"value": "未知"

}

},

{

"id": 10 ,

"tagSn": "5501",

"tagType": {

"code": "tag.vehicle",

"value": "车卡"

},

"tagTypeCode": null,

"tagBattery": 50.0,

"binding": true,

"tagState": {

"code": "offline",

"value": "离线"

},

"tagStateCode": null,

"enable": true,

"latestReportTime": "2022- 12 - 02 18:48:06",

"remark": "",

"temType": null,

"locationMode": null,

"tagMac": null,

"personType": null,

"tagUseType": {

"code": "sys.t.u.t.permanent",

"value": "固定卡"

},

"binder": {

"tagType": "TAG_VEHICLE",

"code": "A-999",

"tagSn": "5501",

"id": 10 ,

"name": "A-999",

"driver": null,

"postCode": null,

"binderType": 1 ,

"binderTypeCache": {

"id": 1 ,

"typeCode": "trucks",

"typeName": "卡车",

"typeIcon": 6 ,

"normalIcon": 13

},

"normalIcon": 13 ,

"mainColor": null,

"departmentCode": null,

"departmentName": null,

"postName": null,

"cooperatorCode": null,

"cooperatorName": null,

"businessId": null,

"businessType": null,

"businessExpire": false,

"parentComCode": "default_org_company",

"phoneNumber": null,

"mark": "A-999"

},

"orderStr": null,

"serverProvider": {

"code": "s.p.unknown",

"value": "未知"

}

}

]

}

资产

批量新增资产类型

说明:通过类型编码判断,如果存在相同类型编码,则跳过;

接口地址:/VxPLS/v1/deviceType/batchInsert

请求方式:POST

请求数据类型:application/json

响应数据类型:/

接口描述:

请求示例:

[

{

"normalIcon": 0 ,

"typeCode": "",

"typeIcon": 0 ,

"typeName": ""

}

]请求参数:

请求参数:

参数名称 参数说明 in 是否必须

vo vo body true

normalIcon (^) 普通图标,默认请传入 19 true
typeCode 类型编码,新增资产时,类型编码必填 true
typeIcon 类型图标,默认请传入 3 true
typeName (^) 类型名称 true
响应状态:

状态码 说明

2000000 OK

201 Created

401 Unauthorized

403 Forbidden

404 Not Found

响应参数:

参数名称 参数说明 类型

code integer(int32)

data object

message string

响应示例:

{

"code": 2000000 ,

"data": {},

"message": ""}

批量删除资产类型

请谨慎删除类型,若删除了资产中正在使用得类型,会使资产数据异常!!!

接口地址:/VxPLS/v1/deviceType/batchDelete

请求方式:POST

请求数据类型:application/json

响应数据类型:/

接口描述:

请求示例:

[]请求参数:

请求参数:

参数名称 参数说明 in^ 是否必须

vo 类型编码集合(list) body true

响应状态:

状态码 说明

200000 OK

201 Created

401 Unauthorized

403 Forbidden

404 Not Found

响应参数:

参数名称 参数说明 类型

code integer(int32)

data object

message string

响应示例:

{

"code": 2000000 ,

"data": {},

"message": ""

}

批量新增资产

说明:通过编码判断,如果存在相同资产编码,则更新,不存在则新增;

接口地址:/VxPLS/v1/device/batchInsert
请求方式:POST
请求数据类型:application/json
响应数据类型:/

接口描述:

请求示例:

[
{
"department": {
"departmentCode": ""
},
"deviceCode": "",
"deviceName": "",
"deviceState": {
"code": ""
},
"deviceType": {
"typeCode": ""
},
"id": 0
}
]请求参数:

请求参数:

参数名称 参数说明 in

vo vo body

deviceCode 资产编码

department (^) 部门
departmentCode 部门编码
deviceName 资产名称
deviceState (^) 资产状态(默认停用)
code 停用=asset.enable,启用=asset.enable
value
deviceType (^) 资产类型
typeCode 类型编码
id (^) 主键,修改时才需要传入
响应状态:
状态码 说明
2000000 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found
响应参数:
参数名称 参数说明 类型
code integer(int32)
data object
message string
响应示例:

{
"code": 2000000 ,
"data": {},

"message": ""}

批量删除资产

接口地址:/VxPLS/v1/device/batchDelete

请求方式:POST

请求数据类型:application/json

响应数据类型:/

接口描述:

请求示例(body,设备编码集合):

[]请求参数:

请求参数:

参数名称 参数说明 in 是否必须

vo (^) 资产编码集合(list) body true
响应状态:
状态码 说明
2000000 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found
响应参数:
参数名称 参数说明 类型
code integer(int32)
data object
message string

响应示例:

{
"code": 2000000 ,
"data": {},
"message": ""
}

8 车辆

8.1 车辆新增

Path: /msService/VxPLS/v1/vehicle

Method: POST

::::

Body:form-data:

:::: :::: :::: ::
id text :
licensePlate text : :::
vehicleNatureCode text : ::::::::::::::
vehicleNature text : ::::
vehicleTypeId text : ::::id:::::::::::id:::
vehicleType text : ::::
driver text : ::
vehiclePic text : ::::::
tagSn text : ::::
idCard text : ::::::::
genderCode text :
gender text : ::
company text : ::::
remark text : ::
hasPic text : ::::::::::::::
deleteFlag text : ::::::e:: :::::::::true:::fals

::::

:: :: :::: ::: :: ::::
code number ::: undefined: @integer
message string ::: undefined: @string

车车车车车vehicleNature车车车车

:: ::
v.external ::::
v.internal ::::
other ::
8.2 车车车车

Path车 /msService/VxPLS/v 1 /vehicle/delByLicensePlate?licensePlate=XX

Method车 GET

::::

车车车车 车车 车车车车 车车
licensePlate Stirng : :::

::::

车车 车车 车车车车 车车车 车车 车车车车
code number ::: undefined: @integer
message string ::: undefined: @string
8.3 车车车车车车

Path车 /msService//VxPLS/v 1 /vehicleType/list

Method车 POST

:::: body

车车车车 车车 车车车车 车车
typeCode Stirng : ::::
typeName String : ::::

::::

车车 车车 车车车车 车车车 车车 车车车车
code number ::: undefined: @integer
message string ::: undefined: @string

车车车车车

{}

车车车车 :

{

"code": 2000000 ,

"message": "",

"data": [

{

"id": 1 ,

"typeCode": "trucks",

"typeName": "卡车",

"typeIcon": 6 ,

"normalIcon": 13 ,

"remark": "卡车"

},

{

"id": 3 ,

"typeCode": "oiltrucks",

"typeName": "油罐车",

"typeIcon": 5 ,

"normalIcon": 14 ,

"remark": "油罐车"

},

{

"id": 4 ,

"typeCode": "fiveforklift",

"typeName": "五吨车",

"typeIcon": 7 ,

"normalIcon": 15 ,

"remark": "五吨车"

},

{

"id": 5 ,

"typeCode": "tenforklift",

"typeName": "十吨车",

"typeIcon": 8 ,

"normalIcon": 16 ,

"remark": "十吨车"

},

{

"id": 2 ,

"typeCode": "v.other",

"typeName": "其他",

"typeIcon": null,

"normalIcon": 17 ,

"remark": "其他"

},

{

"id": 6 ,

"typeCode": "test",

"typeName": "test",

"typeIcon": 8 ,

"normalIcon": 15 ,

"remark": null

},

{

"id": 7 ,

"typeCode": "sadas",

"typeName": "sadas",

"typeIcon": 8 ,

"normalIcon": 17 ,

"remark": null

},

{

"id": 8 ,

"typeCode": "1",

"typeName": "1",

"typeIcon": 8 ,

"normalIcon": 17 ,

"remark": null

}

]

}

9 访客

9.1 访客新增(带绑定功能)

Path: /msService/VxPLS/v1/bindVisitor

Method: POST

::::

Body:form-data:

:::: :::: :::: ::
visitorCode String : ::::
visitorName text : ::::
idCard text : :::
phoneNumber text : :::
tagSn text : ::::

::::

:: :: :::: ::: :: ::::
code number ::: undefined: @integer
message string ::: undefined: @string
9.2 访客删除 ( 通过访客编码,同解绑 )

Path车 msService/VxPLS/v 1 /bindVisitor/delByCode?visitorCode=XX

Method车 GET

::::

车车车车 车车 车车车车 车车
visitorCode Stirng^ :^ ::::^

::::

车车 车车 车车车车 车车车 车车 车车车车
code number ::: undefined: @integer
message string ::: undefined: @string
9.3 访客解绑(通过标签)

Path: /msService/VxPLS/v 1 /bindVisitor/unbindBySn

Method:Get

::::

requestParam

:::: :::: :::: ::
tagSn text : ::::

::::

:: :: :::: ::: :: ::::
code number ::: undefined: @integer
message string ::: undefined: @string

10 统计

10.1 在线数据统计

Path : /public/VxPLS/v 1 /count/realLocationCount

Method: POST

::::

body:

车车车车 车车 车车车车 车车
personType List<Stirng> :
vehicleType List<String> :
返回数据

名称 类型 默认值 备注

data object LocationCountVO

├─ personTotal

numbe
r

(^) 人员总数
├─ vehicleTotal
numbe
r
车辆总数
├─ regionCounts
object
[]
区域统计 ,RegionCountVO

├─ id

numbe
r

区域ID

├─ regionName string 区域名称

├─ parentId

numbe
r

上级ID

├─ personTotal

numbe
r

(^) 人数统计
├─
personTagSnList
string
[]
String
├─
├─ vehicleTotal
numbe
r
车辆统计
├─
vehicleTagSnList
string
[]
String
├─
├─
personnelTypeCo
unts
object

[]
按人员类型统计
├─ id
numbe
r
类型ID
├─ typeName string 类型名称
├─ businessCode string 业务编码
├─ total
numbe
r
人员总数
├─ tagSnList
string
[]
SN列表 ,String
├─ SN列表
├─
vehicleTypeCounts
object
[]
按车辆类型统计 ,TypeCountVO
├─ id
numbe
r
类型ID
├─ typeName string 类型名称
├─ businessCode string 业务编码
├─ total numbe^ 人员总数

r

├─ tagSnList

string
[]

(^) SN列表 ,String
├─ SN列表
├─
businessTypeCount
s
object
[]
按照业务类型统计(司机、作业
人员、巡检人
员) ,TypeCountVO
├─ id
numbe
r
类型ID
├─ typeName string 类型名称
├─ businessCode string 业务编码
├─ total
numbe
r
(^) 人员总数
├─ tagSnList
string
[]
SN列表 ,String
├─ SN列表
code
numbe
r
message string
返回示例:
{
"code": 2000000,
"message": "",
"data": {
"personTotal": 196,
"vehicleTotal": 0,
"regionCounts": [
{
"id": 47,
"regionName": "d",
"parentId": -1,
"personTotal": 1,
"personTagSnList": [

"5142"

],

"vehicleTotal": 0,

"vehicleTagSnList": []

},

{

"id": 62,

"regionName": "b",

"parentId": -1,

"personTotal": 0,

"personTagSnList": [],

"vehicleTotal": 0,

"vehicleTagSnList": []

},

{

"id": 61,

"regionName": "c",

"parentId": -1,

"personTotal": 0,

"personTagSnList": [],

"vehicleTotal": 0,

"vehicleTagSnList": []

},

{

"id": 63,

"regionName": "a",

"parentId": 69,

"personTotal": 2,

"personTagSnList": [

"5140",

"5069"

],

"vehicleTotal": 0,

"vehicleTagSnList": []

},

{

"id": 64,

"regionName": "a-1",

"parentId": 63,

"personTotal": 0,

"personTagSnList": [],

"vehicleTotal": 0,

"vehicleTagSnList": []

}

],

"personnelTypeCounts": [{

"id": 1,

"typeName": "承包商",

"businessCode": "contractor",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": "#c51f6bcf"

},

{

"id": 2,

"typeName": "访客",

"businessCode": "visitor",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": "#e9f936ff"

},

{

"id": 3,

"typeName": "员工",

"businessCode": "staff",

"total": 196,

"inRegionTotal": 2,

"tagSnList": [

"5140",

"5020"

],

"mainColor": "#36dff9ff"

},

{

"id": 4,

"typeName": "其他人员",

"businessCode": "p.other",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": "#417505ff"

},

{

"id": 5,

"typeName": "Vip人员",

"businessCode": "other-Vip",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": "#289d6e99"

},

{

"id": 16,

"typeName": "1",

"businessCode": "1",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": "#3fc56099"

}

],

"vehicleTypeCounts": [{

"id": 1,

"typeName": "卡车",

"businessCode": "trucks",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": "#32eaf7ff"

},

{

"id": 8,

"typeName": "1",

"businessCode": "1",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": "#67a4ffff"

}

],

"businessTypeCounts": [{

"id": null,

"typeName": "作业",

"businessCode": "b.c.wts",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

},

{

"id": null,

"typeName": "司机",

"businessCode": "b.c.driver",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

},

{

"id": null,

"typeName": "巡检",

"businessCode": "b.c.patrol",

"total": 0,

"inRegionTotal": 0,

"tagSnList": [],

"mainColor": null

}

]

}

}

10.2 人员趋势统计

基本信息

Path: /msService/VxPLS/v1/count/personTrend

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值

是否必
须

示例 备注

Content-Type

application/
json

是

Query

参数名称 是否必须 示例 备注

timeInterval 是 0 查询间隔(天) 7 14 30...(Integer)

返回数据:

名称 类型

是否必
须
默认
值

备注 其他信息

data

object
[]

非必须

PersonTrendV
O

item 类型: object

├─ id

numbe
r

非必须 undefined: @integer^

├─
countTime

string 非必须 统计时间

undefined:
@timestamp

├─ maxNum

numbe
r

非必须 最大人数 undefined: @integer^

├─ date string 非必须 undefined: @string^

├─ amount

numbe
r

非必须 undefined: @integer^

├─
companyCo
de

string 非必须 公司编码 undefined: @string^

code

numbe
r

非必须 undefined: @integer^

message string 非必须 undefined: @string^

返回示例:

{

"code": 2000000,

"message": "",

"data": [{

"id": null,

"countTime": "2023- 06 - 13",

"maxNum": 22,

"date": "2023- 06 - 13 00:00:00",

"amount": 22,

"companyCode": null

}, {

"id": null,

"countTime": "2023- 06 - 14",

"maxNum": 22,

"date": "2023- 06 - 14 00:00:00",

"amount": 22,

"companyCode": null

}, {

"id": null,

"countTime": "2023- 06 - 15",

"maxNum": 22,

"date": "2023- 06 - 15 00:00:00",

"amount": 22,

"companyCode": null

}, {

"id": null,

"countTime": "2023- 06 - 16",

"maxNum": 22,

"date": "2023- 06 - 16 00:00:00",

"amount": 22,

"companyCode": null

}, {

"id": null,

"countTime": "2023- 06 - 17",

"maxNum": 22,

"date": "2023- 06 - 17 00:00:00",

"amount": 22,

"companyCode": null

}, {

"id": null,

"countTime": "2023- 06 - 18",

"maxNum": 22,

"date": "2023- 06 - 18 00:00:00",

"amount": 22,

"companyCode": null

}, {

"id": null,

"countTime": "2023- 06 - 19",

"maxNum": 22,

"date": "2023- 06 - 19 00:00:00",

"amount": 22,

"companyCode": null

}]

}

10.3 报警统计 - 按天分类统计

基本信息

Path: /msService/VxPLS/api/v1/count/alarmTrend/{day}

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值

是否必
须

示例 备注

Content-Type

application/
json

是

Path Query

参数名称 是否必须 示例 备注

day 是 0 查询间隔(天) 7 14 30...(Integer)

返回数据:

名称 类型 备注

data list PersonTrendVO

├─ currentTotal number 当日总报警总数

├─ alarmDate string 报警日期^

├─ alarmTypeCount list 报警类型统计^

object

├─ total string 单报警总数

├─ code number 报警类型编码^

├─ alarmName string 公司编码

code number

message string

返回示例:

{

"code": 2000000 ,

"message": "",

"data": [

{

"currentTotal": 172 ,

"alarmDate": "2023- 10 - 16",

"alarmTypeCount": [

{

"total": 128 ,

"code": "a.t.intrude",

"alarmName": "闯入报警"

},

{

"total": 28 ,

"code": "a.t.lackstaff",

"alarmName": "缺员报警"

},

{

"total": 12 ,

"code": "a.t.gather",

"alarmName": "聚集报警"

},

{

"total": 4 ,

"code": "a.t.overstaff",

"alarmName": "超员报警"

}

]

},

{

"currentTotal": 456 ,

"alarmDate": "2023- 10 - 17",

"alarmTypeCount": [

{

"total": 412 ,

"code": "a.t.intrude",

"alarmName": "闯入报警"

},

{

"total": 24 ,

"code": "a.t.lackstaff",

"alarmName": "缺员报警"

},

{

"total": 4 ,

"code": "a.t.gather",

"alarmName": "聚集报警"

},

{

"total": 16 ,

"code": "a.t.overstaff",

"alarmName": "超员报警"

}

]

},

{

"currentTotal": 889 ,

"alarmDate": "2023- 10 - 18",

"alarmTypeCount": [

{

"total": 752 ,

"code": "a.t.intrude",

"alarmName": "闯入报警"

},

{

"total": 20 ,

"code": "a.t.lackstaff",

"alarmName": "缺员报警"

},

{

"total": 26 ,

"code": "a.t.gather",

"alarmName": "聚集报警"

},

{

"total": 20 ,

"code": "a.t.overstaff",

"alarmName": "超员报警"

},

{

"total": 35 ,

"code": "a.t.hit",

"alarmName": "撞击报警"

},

{

"total": 35 ,

"code": "a.t.fall",

"alarmName": "跌落报警"

},

{

"total": 1 ,

"code": "a.t.helmet.rm",

"alarmName": "脱帽报警"

}

]

},

{

"currentTotal": 94 ,

"alarmDate": "2023- 10 - 19",

"alarmTypeCount": [

{

"total": 47 ,

"code": "a.t.intrude",

"alarmName": "闯入报警"

},

{

"total": 42 ,

"code": "a.t.lackstaff",

"alarmName": "缺员报警"

},

{

"total": 5 ,

"code": "a.t.gather",

"alarmName": "聚集报警"

}

]

},

{

"currentTotal": 320 ,

"alarmDate": "2023- 10 - 20",

"alarmTypeCount": [

{

"total": 308 ,

"code": "a.t.intrude",

"alarmName": "闯入报警"

},

{

"total": 12 ,

"code": "a.t.overstaff",

"alarmName": "超员报警"

}

]

}

]

}

10.4 报警统计 - 按报警类型统计(指定公司)

基本信息

Path: /msService/public/VxPLS/v1/open-api/alarm/statisticAlarmTypeNum

Method: GET

接口描述:电子围栏报警(只包括电子围栏报警,不包括区域报警,报警类型包括:闯入、缺员、离

岗、超员、滞留、静止、超速、违停、接近)、SOS报警(实时数量,报警结束后则不计算)

请求参数

Headers

参数名称 参数值

是否必
须

示例 备注

Content-Type

application/
json

是

Query

参数名称 是否必须 示例 备注

companyIds 否 1000,2000 查询公司id集合(Long)

返回数据:

名称 类型 备注

data

list<Map<String,Ob
ject>>

├─ key object

报警类型对应的报警数量:
a.t.static:静止报警,
a.t.intrude:闯入报警,
a.t.lackstaff:缺员报警,
a.t.drivedeviation:行车偏离报警,
a.t.lowpower:低电量,
a.t.sos:sos报警,
a.t.leavepost:离岗报警,
a.t.overstaff:超员报警,
a.t.park:违停报警,
a.t.overspeed:超速报警,
a.t.retention:滞留报警,
a.t.leavefactory:离场报警
a.t.gather:聚集报警,
a.t.hit:撞击报警,
a.t.fall:跌落报警,
a.t.physical:异常体征报警,
a.t.helmet.rm:脱帽报警,
a.t.withouttag:未带卡报警,
a.t.drown:溺水报警,
a.t.work.approach:危险接近报警

code number

message string

返回示例:

{

"code": 200 ,

"message": "",

"data": {

"a.t.static": 0 ,

"a.t.intrude": 0 ,

"a.t.lackstaff": 56 ,

"a.t.drivedeviation": 0 ,

"a.t.lowpower": 0 ,

"a.t.sos": 251 ,

"a.t.leavepost": 0 ,

"a.t.overstaff": 14 ,

"a.t.park": 0 ,

"a.t.overspeed": 0 ,

"a.t.retention": 0 ,

"a.t.leavefactory": 0 ,

"a.t.gather": 0 ,

"a.t.hit": 0 ,

"a.t.fall": 0 ,

"a.t.physical": 0 ,

"a.t.helmet.rm": 0 ,

"a.t.withouttag": 0 ,

"a.t.drown": 0 ,

"a.t.work.approach": 0

}

}

10.5 卡路里热力图统计 - 统计在线每个人最新的卡路里数据

基本信息

Path: /msService/VxPLS/v1/basePhyDataHis/calorieData

Method: GET

接口描述:统计在线人员的每个人的最新的卡路里数据和定位数据

请求参数

Headers

参数名称 参数值

是否必
须

示例 备注

Content-Type

application/
json

是

返回数据:

name type desc

data array

|─ object

|─tagSn string (^) 标签卡号
|─tagType string
标签类型
TAG_PERSON :人卡
tag.person
TAG_VEHICLE :车卡
tag.vehicle
TAG_DEVICE :资产卡
tag.device
|─lon number (^) 经度 x
|─lat number (^) 纬度 y
|─mercator object (^) 魔卡托坐标

|─x number (^) 经度 x
|─y number (^) 纬度 y
|─z number (^)
|─high number (^) 高度 z
|─floor number (^) 楼层号
|─buildingPatchId string (^) 建筑模型id
|─speed number (^) 速度
|─interval number (^) 时间间隔 单位秒
|─flash boolean (^) 是否闪现
|─motionState string
运动状态
MOTION :运动
STILLNESS :静止
NONE :未检查出状态
|─battery number (^) 电量
|─locationTime integer (^) 定位时间
|─altitude number (^)
|─phyDataHisVO object (^) 异常体征数据
|─id integer (^)
|─tagSn string (^) 标签序号
|─reportTime integer (^) 上报时间戳
|─name string (^) 绑定对象名称
|─binderType integer (^) 标签绑定类型
|─binderCode string (^) 绑定人员编码
|─heartRate integer (^) 心率
|─bloodOxygen integer (^) 血氧
|─calorie integer
卡路里(根据公式计算后
的)
|─bodyTemperature number (^) 体温
|─activityIntensity integer (^)
|─companyCode string (^) 所属公司编码

|─bloodPressureSBP integer (^) 血压SBP
|─bloodPressureDBP integer (^) 血压DBP
|─remarks string (^) 备注
|─bodyHeat integer (^) 热量
code integer
message string
返回示例:
{
"data": [
{
"tagSn": "",
"tagType": "",
"lon": 0.0,
"lat": 0.0,
"mercator": {
"x": 0.0,
"y": 0.0,
"z": 0.0
},
"high": 0.0,
"floor": 0 ,
"buildingPatchId": "",
"speed": 0.0,
"interval": 0.0,
"flash": false,
"motionState": "",
"battery": 0.0,
"locationTime": 0 ,
"altitude": 0.0,
"phyDataHisVO": {
"id": 0 ,
"tagSn": "",
"reportTime": 0 ,
"name": "",
"binderType": 0 ,
"binderCode": "",
"heartRate": 0 ,
"bloodOxygen": 0 ,
"calorie": 0 ,

"bodyTemperature": 0.0,

"activityIntensity": 0 ,

"companyCode": "",

"bloodPressureSBP": 0 ,

"bloodPressureDBP": 0 ,

"remarks": ""

}

}

],

"code": 0 ,

"message": ""

}

11 内部 API

注意:

1 、内部API中,如果通过 FeignClient 来调用,接口地址不需要前缀:/msService

2 、 建议使用 FeignClient 来调用

11.0 接收作业或巡检事件

接口地址: /msService/VxPLS/api/v1/eventCenter/receive

请求方式: POST

请求参数:

名称 说明 类型

是否

必须

备注 支持版本

businessId 业务ID (^) Long 是 (^)
businessType 业务类型 String 是 枚举
businessEven
t
事件状态 (^) String 是
枚举(开始:EVENT_START、
结束:EVENT_END)
businessLink 详情地址 (^) String 否 (^)
staffGuardia
ns
员工监护
人编码
List 否^
contractorGu 没有值需要传入空数组^
ardians
承包商监
护人编码
List 否^
staffCodes 员工编码 (^) List 否

contractorCo
des

承包商编

码

List 否^

eventDescrib
e

事件描述 (^) String 否 (^)
eventTime
事件触发
时间
String 否^ 格式:yyyy-MM-dd HH:mm:ss^
expectedEndT
ime
事件预计
结束时间
String 否^ 格式:yyyy-MM-dd HH:mm:ss^
businessArea
Id
业务区域
ID
Long 是^
businessArea
Name
业务区域
名称
String 是^
businessArea
Geom
业务区域
坐标
String 是^
maxNum
区域最大
人数
Int 否^
enableLackSt
aff
启用缺员
报警
Boole
an
否 默认启用(true) (^)
enableIntrud
e
启用闯入
报警
Boole
an
否 默认启用(true) (^)
enableOverSt
aff
启用超员
报警
Boole
an
否
默认启用(true)。和maxNum
一起用才会生成超员报警
silenceDurat
ion
静默时长 (^) Int 否
设置静默时长,该时长范围内
不触发报警,默认 15 分钟
geometryType 几何类型 (^) String 否
POINT、LINE、POLYGON
默认:POLYGON
V6.1.9.23
radius 半径 (^) short 否
默认 10 米,geometryType
为POINT、LINE时有效
V6.1.9.23
请求参数示例:

返回:

{
"businessId": "2507393411049328",
"businessType": "WTS_fireWork",
"businessEvent": "EVENT_START",
"businessLink": "www.baidu.com",
"staffGuardians": ["zhangsan"],
"contractorGuardians": [],
"staffCodes": ["5299"],
"contractorCodes": [],

"eventDescribe": "测试 107 号文",

"eventTime": "2023- 01 - 05 11:00:00",
"expectedEndTime": "2023- 01 - 05 20:00:00",
"businessAreaId": "2504027730438000",

"businessAreaName": "0907作业区域",

"businessAreaGeom": "{\"coordinates\":[{\"lon\"
:120.13263187163479,\"lat\":30.185306237199267,\"hei\":0.4601
2181730524865},{\"lon\":120.13283195551367,\"lat\":30.18011962915
1328,\"hei\":0.46012181730524865},{\"lon\":120.13774242705372,\"l
at\":30.18023316950266,\"hei\":0.46012181730524865},{\"lon\":120.
13692271027664,\"lat\":30.187542890035576,\"hei\":0.4601218173052
4865},{\"lon\":120.13263187163479,\"lat\":30.185306237199267,\"he
i\":0.46012181730524865}],\"buildingPatchId\":null,\"floor\":null
,\"extHeight\":5,\"layerCode\":\"jobTicketAreaLayer\",\"oldLayerC
ode\":\"jobTicketAreaLayer\"}",
"maxNum": 1 0,
"enableLackStaff": true,
"enableIntrude": true,
"enableOverStaff": true,
"silenceDuration": 15

}

11.1 接收作业或巡检事件( V2 )
说明:

V2版本主要是报警规则内的变更,支持调用方手动录入报警规则信息。

目前支持的报警规则有:缺员、超员、聚集、闯入

接口地址: /msService/VxPLS/api/v2/eventCenter/receive

请求方式: POST

请求参数:

名称 说明 类型

是否

必须

备注 支持版本

businessId

业务
ID

Long 是

businessType

业务类

型

String 是^ 枚举^

businessEvent

事件状

态

String 是^

枚举(开始:EVENT_START、结

束:EVENT_END)

businessLink

详情地

址

String 否^

staffGuardians

员工监

护人编

码

List 否^

contractorGuar 没有值需要传入空数组^
dians

承包商

监护人

编码

List 否^

staffCodes

员工编

码

List 否^

{
"code": 2000000,
"message": "",
"data": ""
}
contractorCode
s

承包商

编码

List 否^

eventDescribe

事件描

述

String 否

eventTime

事件触

发时间

String 否^ 格式:yyyy-MM-dd HH:mm:ss^

expectedEndTim
e

事件预

计结束

时间

String 否^ 格式:yyyy-MM-dd HH:mm:ss^

overStaffAlarm

超员报

警规则

Object 否

|-对象内属性见
示例

lackStaffAlarm

缺员报

警规则

Object 否^

|-对象内属性见
示例

gatherAlarm

聚集报

警规则

Object 否^

|-对象内属性见
示例

intrudeAlarm

闯入报

警规则

Object 否^

|-对象内属性见
示例

companyCode

公司编

码

String 通过OpenFeign调用需要传入

请求参数示例:

{

"businessEvent": "",

"businessId": 0,

"businessLink": "",

"businessType": "",

"companyCode": "",

"contractorCodes": [],

"contractorGuardians": [],

"eventDescribe": "",

"eventTime": "",

"expectedEndTime": "",

"staffCodes": [],

"staffGuardians": [],

"gatherAlarm": {

"alarmLevel": {

"code":"" //significant(重大)、large(较大)、 general

(一般)、low(低)、lower(很低)

},

"fence": {

"businessAreaGeom": "",

"businessAreaId": 0,

"fenceName": "",

"geometryType": "", // POINT(点)、LINE(线)、POLYGON(面)

"radius": 0

}

},

"intrudeAlarm": {

"durationTime" :12,

"alarmLevel": {

"code": "" //significant(重大)、large(较大)、general

(一般)、low(低)、lower(很低)

},

"fence": {

"businessAreaGeom": "",

"businessAreaId": 0,

"fenceName": "",

"geometryType": "", // POINT(点)、LINE(线)、POLYGON(面)

"radius": 0

},

"enableBuffer": true,

"bufferDistance": 12,

返回:

11.2 事件暂停

接口地址: /msService/VxPLS/api/v1/eventCenter/pause

请求方式: POST

请求参数:

名称 说明 类型 是否必须 备注

businessId 业务ID Long (^) 是
pauseTime 暂停时间 String 是 格式:yyyy-MM-dd HH:mm:ss^
请求参数示例:
{
"code": 2000000 ,
"message": "",
"data": ""
}

返回:

11.3 事件重启

接口地址: /msService/VxPLS/api/v1/eventCenter/restart

请求方式: POST

请求参数:

名称 说明 类型

是否必

须

备注

businessId 业务ID Long (^) 是
restartTime (^) 重启时间 String (^) 是 格式:yyyy-MM-dd HH:mm:ss
请求参数示例:
{
"businessId": "2507393411049328",
"pauseTime": "2022- 09 - 08 10:00:00"
}
{
"code": 2000000 ,
"message": "",
"data": ""
}

11.4 关闭事件

接口地址: /msService/VxPLS/api/v1/eventCenter/closeEvent/${businessId}

请求方式: PUT

请求参数:

名称 说明 类型

是否必

须

备注

businessId 业务ID Long (^) 是
请求参数示例:
{
"code": 2000000 ,
"message": "",
"data": ""
}

返回:

车以上为事件中心车
11.4 分析指定人员是否在作业区域

接口地址: /msService/VxPLS/api/v1/business/analysis

请求方式: POST

请求参数:

名称 说明 类型 是否必须 备注

businessId 业务ID Long 否

businessAreaGeo
m

区域坐标 String 是

staffCodes 员工编码 List

contractorCodes (^) 承包商编码 List (^)
radius (^) 半径 Integer (^) 否 单位:米/m
请求参数示例:
{
"businessId": 169226362266,
"staffGuardians": [
"dwz","wyn","zc"
],
"contractorGuardians": [],
"staffCodes": [
"zxr","zc"
],
"contractorCodes": []
}
{
"code": 2000000 ,
"message": "",
"data": ""
}

返回:

{
"businessAreaId": "2504027730438000",
"businessAreaGeom":
"{\"coordinates\":[{\"lon\":120.59800796857627,\"lat\":30.2663862
16629563,\"hei\":3.9090335487097305},{\"lon\":120.5983125455596,\
"lat\":30.26354893856886,\"hei\":3.9090335487097305},{\"lon\":120
.60201412140023,\"lat\":30.263812284163137,\"hei\":3.909033548709
7305},{\"lon\":120.60177165437592,\"lat\":30.266598981186625,\"he
i\":3.9090335487097305},{\"lon\":120.59800796857627,\"lat\":30.26
6386216629563 ,\"hei\":3.9090335487097305}],\"buildingPatchId\":nu
ll,\"floor\":null,\"extHeight\":5,\"layerCode\":\"bsmAreaLayer\",
\"oldLayerCode\":\"bsmAreaLayer\"}",
"staffCodes": ["supcon0012"],
"contractorCodes": [],
"radius": 10
}
11.5 分析员工是否在几何坐标 ( 点线面 ) 内

接口地址: /msService/VxPLS/api/v1/patrol/state/analysis

请求方式: POST

请求参数:

名称 说明 类型 是否必须 备注

patrolPoint (^) 坐标 Long (^) 是
radius (^) 半径 String (^) 否
非必填,默认 10 。几何
坐标为点时有效
staffCode (^) 员工编码 List (^) 是
请求参数示例:
{
"code": 2000000 ,
"message": "",
"data": {
"conform": false, // 是否符合要求
"staffCodes": ["supcon0012"], // 不符合要求的员工编码
"contractorCodes": [] // 不符合要求的承包商编码
}
}

11.6 在线设备列表

接口地址: /msService/VxPLS/api/v1/business/onlineDevices

请求方式: POST

请求参数:

名称 说明 类型 是否必须 备注

deviceCode 设备编号 String 否

请求参数示例:

{
"code": 200 ,
"message": "",
"data": {

"staffCode": "zhangsan", // 员工编码

"patrolState": true, // 就位状态

"coordinate": { // 当前所在坐标位置

"lon": 120.59800796857627, // 经度

"lat": 30.266386216629563, // 纬度

"hei":3.9090335487097305 // 高度

}
}
}

data object []

CurrentRegionV
O
item 类型:
object

├─ id number 区域编码^

undefined:
@integer

├─ regionName string 区域名称

undefined:
@string

├─ managers List

区域负责人(多
个,对应企业组
织架构人员信
息)
item 类型:
object

├─ id number

undefined:
@integer

├─ staffCode string 员工编码^

undefined:
@string

├─ staffName string 员工名称^

undefined:
@string

├─ idCard string 身份证

undefined:
@string

├─ post object PostBO

├─ postCode string 岗位编码

undefined:
@string

├─ postName string 岗位名称

undefined:
@string

├─ company object CompanyBO

├─

companyCode

string 公司编码

undefined:
@string

├─ shortName string 集团或公司简称

undefined:
@string

├─ name string 集团或公司全称

undefined:
@string

├─ userName string 管理员用户名 undefined:

@string

├─ password string 管理员密码

undefined:
@string

├─ fullPath string 公司全路径

undefined:
@string

├─ layNo number 节点层级

undefined:
@integer

├─ sort number

同层级下节点顺
序
undefined:
@float

├─ parentId number 父级节点id

undefined:
@integer

├─ description string 描述

undefined:
@string

├─ department object DepartmentBO

├─
departmentCode

string

undefined:
@string
├─
departmentName

string

undefined:
@string

├─ layNo number

undefined:
@integer

code number

undefined:
@integer

message string

undefined:
@string

请求示例 :

{

"point":"(120.13318495290291,30.18167957180929)"

}

返回示例 :

{

"code": 200,

"message": "",

"data": [

{

"id": 17,

"regionName": "supcon",

"companyPersonNum": 0,

"managers": null,

"persons": null

},

{

"id": 4,

"regionName": "作业-重点监控区域",

"managers": [

{

"id": 1,

"staffCode": "0001",

"staffName": "李四",

"idCard": null,

"post": {

"postCode": "standard_position",

"postName": "默认岗位",

"company": null,

"department": null

},

"department": {

"departmentCode": "standard_department",

"departmentName": "默认部门",

"layNo": null,

"layLevel": null,

"pid": null,

"topDep": null,

"all": null

},

"company": {

"companyCode": "default_org_company",

"shortName": null,

"name": "默认公司",

"userName": null,

"password": null,

"fullPath": null,

"layNo": null,

"sort": null,

"parentId": null,

"description": null

},

"tagSn": "",

"phoneNumber": "",

"headPic": null,

"hasPic": null,

"deleteFlag": false,

"sns": null,

"outSns": null,

"depCodes": null,

"remark": null,

"certificateList": []

}

],

"persons": null

}

]

}

11.7 区域内在线人数

接口地址: /msService/VxPLS/api/v1/geometryAnalysis/personNum

请求方式: POST

请求参数:

名称 说明 类型 是否必须 备注

coordinate (^) 区域坐标 String (^) 是
请求参数示例:

返回:

{
"coordinate":
"{\"coordinates\":[{\"lon\":120.13133544469021,\"lat\":30.1829248
18019817,\"hei\":0.009320019081856326},{\"lon\":120.1313816389864
7,\"lat\":30.18004047977743,\"hei\":0.009320019081856326},{\"lon\
":120.13647001056366,\"lat\":30.180152374124265,\"hei\":0.0093200
19081856326},{\"lon\":120.13463847235148,\"lat\":30.1832115008095
84,\"hei\":0.009320019081856326},{\"lon\":120.13133544469021,\"la
t\":30.182924818019817,\"hei\":0.009320019081856326}],\"buildingP
atchId\":null,\"floor\":null,\"extHeight\":5,\"layerCode\":\"bsmA
reaLayer\",\"oldLayerCode\":\"bsmAreaLayer\"}"
}

返回:

11.9 批量保存图层加载信息

接口地址: /msService/VxPLS/v1/plsDebug/batchSaveLayerLoad

请求方式: POST

请求参数:

名称 说明 类型 是否必须 备注

loadType

加载类型
(map.3d.titles--
三维模型加载
map.3d.layer-- 图
层模型加载
map.real.model-实
时模型加载
pls.real.data- 实
时数据记录
)
String 否 loadType

sn (^) 定位标签号 String 否 sn
receivedTime (^) 接收时间 String 否 receivedTime
loadTime (^) 加载时间 String 否 loadTime
statisticTyp
e
统计分组标注符号 String 否 statisticType
clientId (^) 客户端唯一标注 String 否 clientId
http://XXX:XXX/msService/public/VxPLS/locationDetail/?id=27318077
91727824
{
"code": 200,--注意 这里的code是 200 ,跟平台的成功码一致
"message": "",
"data": {
"high": 0.0,
"buildingPatchId": null,
"lon": 121.63539618334168,
" ": 4,
"id": 2731807791727824,
"lat": 30.03939180764865
}
}

返回:

[
{
"loadType": "map.3d.titles",
"sn": "001",
"receivedTime": "2023- 09 - 26 00:00:00",
"loadTime": "2023- 09 - 26 00:00:02",
"statisticType": "",
"clientId": ""
},
{
"loadType": "map.3d.titles",
"sn": "002",
"receivedTime": "2023- 09 - 26 00:00:00",
"loadTime": "2023- 09 - 26 00:00:01",
"statisticType": "",
"clientId": ""
}
]
11.11 查询模块版本

接口地址: /msService/VxPLS/v1/maintenance/queryVersion

请求方式: GET

请求参数:

名称 说明 类型 是否必须 备注

moduleCode

模块编码(人员定位
是:VxPLS ,地图是:
SESGISConfig_1.0.
0 )
String 是
支持一次查询多个
模块版本信息,多个
编码用英文逗号拼
接,例如:
{
"code": 2000000,
"message": "",
"data": [
{
"clientId": "",
"loadTypes": [
{
"loadType": "map.3d.titles",
"statisticTypes": [
{
"statisticType": "b2b0615c-0eac- 4189 -
9a0b-7c47e8b93f45",
"totalSeconds": 3,
"averageSeconds": 1.50
},
{
"statisticType": "d9a3a09f- 0236 - 449a-
880c-3f6950846a1b",
"totalSeconds": 2,
"averageSeconds": 1.00
} ] } ] } ] }
VxPLS,SESGISConfi
g_1.0.0

请求示例:

名称 类型 是否必须 默认值 备注

data object [] 非必须

|─code (^) string 非必须 模块唯一编码
|─version (^) integer 非必须 乐观锁版本
|─name string 非必须 模型名称
|─nameInternational string^ 非必须^
模型名称(国际化处理)
|─artifact (^) string 非必须 模块缩略码
|─category (^) string 非必须 模块分类
|─projectVersion string 非必须 当前版本
|─lastVersion (^) string 非必须 上次版本
|─initialVersion (^) string 非必须 初始化版本
|─description (^) string 非必须 模型描述信息
|─type (^) string 非必须
微服务类型:Mis,老的bap模
块为null
|─acronym (^) string 非必须 缩略名称,做为数据库前缀
message string 非必须
code integer
返回:

{

"code": 2000000,

"message": "",

"data": [

{

"code": "VxPLS",

"version": 0,

"name": null,

"nameInternational": null,

"artifact": "VxPLS",

"category": null,

"projectVersion": "6.1.9.21",

"lastVersion": null,

"initialVersion": null,

"description": null,

"type": null,

"acronym": null

},

{

"code": "SESGISConfig_1.0.0",

"version": 0,

"name":

"SESGISConfig.modulename.randon1597146703867",

"nameInternational": "地图配置中心",

"artifact": "SESGISConfig",

"category": null,

"projectVersion": "6.1.9.14",

"lastVersion": null,

"initialVersion": null,

"description": "详见更新说明文档",

"type": "Mis",

"acronym": "SESGISConfig"

}

]

}

11.12 查询 rabbitMq 是否启动

接口地址: /msService/VxPLS/v1/maintenance/rabbitmq/enableOrNot

请求方式: GET

请求参数:

名称 说明 类型 是否必须 备注

请求示例:

名称 类型 是否必须 默认值 备注

data object [] 非必须

|─code (^) string 非必须 编码
|─value string 非必须 启动状态国际化值
message string 非必须
返回:

11.13 查询中转服务状态

接口地址 :/msService/VxPLS/v1/maintenance/listTransferServerState

请求方式: GET

请求参数:

名称 说明 类型 是否必须 备注

请求示例:

名称 类型 是否必须 默认值 备注

data object [] 非必须

|─code (^) string 非必须 编码
|─value (^) string 非必须 启动状态国际化值
message string 非必须
返回:
{
"code": 2000000,
"message": "",
"data": {
"code": "server.state.onConnect",
"value": "已连接"
}
}

|─serverProvider (^) object
|─code (^) string
|─value (^) string
|─listenPort (^) integer
|─mqHost (^) string
|─wsUrl string
websocket地址
|─username (^) string
|─password (^) string
|─serverState object 服务状态
|─code (^) string
|─value (^) string
|─mqWorkMode (^) object mq工作模式
|─code (^) string
|─value (^) string
|─locationOffset (^) string
|─appId (^) string
真趣 所需参
数
|─buildId (^) string
|─licence (^) string
|─baseUrl (^) string
|─configs (^) array
数据同步配
置
|─ (^) object
|─providerCode string^
(^) 厂商编码
|─serverAddress string^
厂商服务器
地址
|─appKey (^) string 应用密钥^
|─username string
用户名
|─password (^) string 密码^
|─dispatchParam string^
下发参数 将
数据下发到
硬件

返回:

{

"code": 2000000,

"message": "",

"data": {

"totalNum": 3,

"enableNum": 2,

"serverState": {

"code": "server.state.on",

"value": "已启动"

},

"locationServerVOS": [

{

"id": 3,

"serverCode": "rabbitmq",

"serverName": "rabbitmq",

"serverProvider": {

"code": "s.p.mq",

"value": "rabbitMq标准服务"

},

"listenPort": null,

"mqHost": "192.168.176.68:5672",

"wsUrl": null,

"username": "admin",

"password": "admin",

"serverState": {

"code": "server.on",

"value": "启动"

},

"mqWorkMode": null,

"locationOffset": "",

"appId": null,

"buildId": null,

"licence": null,

"baseUrl": null,

"configs": []

}

]

}

}

11.15 分页查询当前定位数据(支持条件查询)

接口地址: /msService/VxPLS/v1/locationServer/real/data/queryLocation

请求方式: post

请求参数:

名称 说明 类型 是否必须 备注

currentPage 当前页码^ integer 是^
pageSize
每页显示条数,默
认 10 integer^
否
queryParam 查询参数对象^ object 否^

|─tagSn 定位标签 (^) string 否 模糊查询
|─name
标签绑定者名称
string^
否 模糊查询
|─code 标签绑定者编码 (^) string 否
模糊查询
|─tagType 标签类型 (^) string 否
|─binderTypeVO
车或者人的类型
object^
否
|─typeCode
绑定对象类型编
码
string 否^
模糊查询
请求示例:
名称 类型 是否必须 默认值 备注

message string 非必须
code integer
data object [] 非必须
|─ object
|─tagSn string 标签卡号
|─lon number 经度 x
|─lat number 纬度 y
|─high number (^) 高度 z
|─floors number 楼层号
|─buildingPatchId string 建筑模型id
|─battery number 电量
|─locationTime integer 定位时间
|─tagBinder object
|─tagType string 标签类型^

TAG_PERSON

:人卡

tag.person

TAG_VEHICL

E :车卡

tag.vehicle

TAG_DEVICE
:资产卡
tag.device

|─code string

|─tagSn string 定位标签

|─id integer (^) 标签绑定者ID
|─name string
标签绑定者名
称
|─driver string
|─idCard string 身份证
|─postCode string (^) 人员岗位
|─binderType integer
标签绑定者类
型
|─binderTypeCache object
车或者人的类
型
|─id integer
|─typeCode string 类型编码
|─typeName string 类型名称
|─typeIcon integer 类型图标
|─normalIcon integer 普通图标
|─normalIcon integer (^) 普通图标
|─mainColor string
|─departmentCode string 部门名称
|─departmentName string
|─fullPath string 部门全路径
|─postName string 岗位名称
|─cooperatorCode string
承包商单位编
码
|─cooperatorName string
承包商单位名
称

|─businessId integer

事件中心相关
信息

|─businessType object

|─code string (^) 编码
|─value string 编码值
|─businessExpire boolean
|─parentComCode string 母公司
|─comCode string
|─phoneNumber string
|─mark string
标签绑定者唯
一标识
|─staffCertSet array (^) 员工资质
|─ string
|─vehicleNature object 车辆性质
|─code string 编码
|─value string 编码值
|─bindDetailsList array
除了tagSn之
外的其他绑定
的设备
|─ object
|─bindCode string 员工
|─sn string
|─deviceType object
|─icon integer
|─code string
|─name string
|─type string
|─typeOrder integer
|─visible boolean
|─locationOrder integer
|─locationEnable
boolean
|─locationConfigEnable
boolean
|─count integer
|─bindType string
|─interval number 时间间隔 单位^

秒

|─flash boolean 是否闪现

|─tagState string

ON_LINE :ON
_LINE
OFF_LINE :OF
F_LINE
DISAPPEAR :
DISAPPEAR

返回:

{

"code": 2000000,

"message": "",

"data": [

{

"tagSn": "123456789003",

"lon": 120.13295106060224,

"lat": 30.181591283402057,

"high": 0.0,

"floors": 8,

"buildingPatchId": null,

"battery": -1.0,

"locationTime": 1703472053672,

"tagBinder": {

"tagType": "TAG_PERSON",

"code": "ndqy001",

"tagSn": "123456789003",

"id": 85,

"name": "应明军",

"driver": null,

"idCard": null,

"postCode": "aqfzr",

"binderType": 3,

"binderTypeCache": {

"id": 3,

"typeCode": "staff",

"typeName": "员工",

"typeIcon": 1,

"normalIcon": 9

},

"normalIcon": 9,

"mainColor": "#36dff9ff",

"departmentCode": "ajb",

"departmentName": "各企业安监部",

"fullPath": "/默认公司/各企业安监部",

"postName": "安全负责人",

"cooperatorCode": null,

"cooperatorName": null,

"businessId": null,

"businessType": null,

"businessExpire": false,

"parentComCode": "default_org_company",

"comCode": "default_org_company",

11.16 查询人员定位版本和其他业务模块版本是否兼容

接口地址: /msService /VxPLS/v1/maintenance/versionMatching

请求方式: GET

请求参数:

名称 说明 类型 是否必须 备注

请求示例:

名称 类型

是
否
必
须
默认
值

备注

data object []

非
必
须
|─matchOrNot boolean
是否匹配,false:当前有
不符合指定版本的模块,
需要升级到指定版本的
包,true:当前所有模块版
本可用
|─strongDependenceList array
强依赖集合
|─ object
|─dependenceOrNot boolean
是否强依赖
|─fullPackageVersion string
整包版本(工程向测试申
请包需要用到整包版本
号)
|─tester string
测试人员
|─version string
版本号(要求此版本即以
上)
|─desc string 功能描述(强依赖关联的
功能点)
|─projectVersion string
当前版本(当前使用的模
块版本),如果对应模块不
存在返回:“noOne”
|─weakDependenceList array
弱依赖集合,即这部分功
能不影响人员定位功能正
常使用
|─ object
|─dependenceOrNot boolean
是否强依赖
|─fullPackageVersion string
整包版本
|─tester string
测试人员
|─version string
版本号
|─desc string
功能描述
|─projectVersion string
当前版本
message string
非
必
须
code integer
非
必
须

返回:

{

"code": 2000000,

"message": "",

"data": {

"matchOrNot": false,

"strongDependenceList": [

{

"dependenceOrNot": true,

"fullPackageVersion": "VxMap V6.1.9.18- 231119 - M",

"tester": "汤正芹",

"version": "6.1.9.18",

"desc": "新增人员定位一张图",

"projectVersion": "6.1.9.14"

},

{

"dependenceOrNot": true,

"fullPackageVersion": "InPlant-Base V6.2.8.14-

231111 - C",

"tester": "彭希",

"version": "6.2.8.14",

"desc": "承包商同步(涉及多组织权限)、发卡机查询功能",

"projectVersion": "6.1.6.7"

},

{

"dependenceOrNot": true,

"fullPackageVersion": "SES-WssDuty V6.1.6.1-

221129 - C",

"tester": "张兴瑞",

"version": "6.1.6.1",

"desc": "员工类型人员档案查看",

"projectVersion": "noOne"

},

{

"dependenceOrNot": true,

"fullPackageVersion": "InPlant-Qualification

V6.2.8.3- 230726 - C",

"tester": "彭希",

"version": "6.2.8.3",

"desc": "资质闯入报警",

"projectVersion": "6.1.2.2"

},

{

11.17 一键重启服务

接口地址 :/msService/VxPLS/v1/maintenance/restartServer

请求方式: GET

请求参数:

名称 说明 类型 是否必须 备注

请求示例:

名称 类型 是否必须 默认值 备注

data object [] 非必须
message string 非必须
code integer 非必须

返回:

11.18 聚集报警授权获取

接口地址 :/msService/VxPLS/v1/license/getGatherLicense

请求方式: GET

返回:

11.19 区域内在线人员信息

接口地址: /msService/VxPLS/api/v1/geometryAnalysis/personInfo

请求方式: POST

请求参数:

名称 说明 类型 是否必须 备注

coordinate (^) 区域坐标 String (^) 是
geometryType (^) 多边形类型 String
是,枚举类
(POINT
LINE
POLYGON)
radius (^) 半径 int (^) 否
请求参数示例:
{
"code": 2000000 ,
"message": "",
"data":""
}
{
"code": 2000000 ,
"message": "",
"data": true/false # true:有授权;false:无授权
}

|─idCard string 身份证

|─post object

|─postCode string 岗位编码

|─postName string 岗位名称

|─department object

|─departmentCode string 所属部门

|─departmentName string 部门名称

|─company object

|─companyCode string 所属公司编码

|─shortName string 集团或公司简称

|─name string 集团或公司全称

|─tagSn string 定位标签

|─phoneNumber string 电话号码

|─remark string 备注

|─binderType object 人员类型

|─typeCode string

类型编码,

staff::::

contractor:::::

visitor::::

p.other:::

|─typeName string 类型名称^

code integer (^)
message string
返回:

{

"code": 2000000 ,

"message": "",

"data": [

{

"id": 8036 ,

"staffCode": "test",

"staffName": "test",

"idCard": null,

"post": null,

"department": null,

"company": {

"companyCode": "default_org_company",

"shortName": null,

"name": null

},

"tagSn": "",

"phoneNumber": null,

"headPic": null,

"hasPic": null,

"deleteFlag": false,

"remark": null,

"certificateList": null,

"binderType": {

"typeCode": "visitor",

"typeName": "访客"

}

},

{

"id": 29 ,

"staffCode": "zxr",

"staffName": "张兴瑞",

"idCard": null,

"post": {

"postCode": "test",

"postName": "测试工程师",

"company": null,

"department": null

},

"department": null,

"company": {

"companyCode": "default_org_company",

"shortName": null,

12 对外 public 接口

基本信息

Desc:人员初始化接口

Path: /msService/public/VxPLS/v1/thematicMap/listLocation

Method: GET

请求参数

参数名称 参数值 是否必须 示例 备注
businessType 否^
作业:
WTS
巡检:
PATROL
仅操作指定业
务模块

返回 :

基本信息

Desc:实时定位数据接口

Path: /msService/public/VxPLS/v1/locationServer/real/data/location

{
"code": 200,
"message": "",
"data": [
{
"tagSn": "10001",
"lon": 120.13302577046137,
"lat": 30.181857533522233,
"high": 0.0,
"floors": 9,
"locationTime": 1731308927941,
"buildingPatchId": null,
"tagBinder": {
"tagType": "TAG_PERSON",
"code": "yhf2023",
"tagSn": "10001",
"id": 13,
"name": "yhf",
"driver": null,
"departmentCode": "standard_department",
"departmentName": "默认部门",
"postCode": "standard_position",

"postName": "默认岗位",

"binderType": 3,

"type": "员工",

"normalIcon": 9,
"vehicleNature": null,
"mark": null
},
"tagState": "ON_LINE"
}
]
}

Method: POST

请求参数

参数名称 参数值 是否必须 示例 备注
businessType 否^
作业:
WTS
巡检:
PATROL
仅操作指定业
务模块

返回:

{

"code": 2000000,

"message": "",

"data": [

{

"tagSn": "10001",

"mainDeviceOrNot": true,

"lon": 120.13296577046138,

"lat": 30.181842533522236,

"high": 0.0,

"floors": 9,

"buildingPatchId": null,

"battery": 10.0,

"locationTime": "2024- 11 - 11 15:05:53",

"tagBinder": {

"tagType": "TAG_PERSON",

"code": "yhf2023",

"tagSn": "10001",

"id": 13,

"name": "yhf",

"driver": null,

"idCard": null,

"postCode": "standard_position",

"postCodes": "standard_position",

"postName": "默认岗位",

"postNames": "默认岗位",

"binderType": 3,

"binderTypeCache": {

"id": 3,

"typeCode": "staff",

"typeName": "员工",

"typeIcon": 1,

"normalIcon": 9

},

"normalIcon": 9,

"mainColor": "#e6cc0cff",

"departmentCode": "standard_department",

"departmentCodes": "standard_department",

"departmentName": "默认部门",

"departmentFullPath": "/默认公司/默认部门",

"fullPath": "/默认公司/默认部门",

"cooperatorCode": null,

基本信息

Desc: 获取web报警等websocket地址

Path: /msService/public/VxPLS/v1/common/wsUri

Method: GET

返回:

{
"code": 2000000,
"message": "",
"data": "/VxPLS-WS/null-null-null-
75637edb6a164076a95b5c1578d1e78c"
}

附录

1. 字典项

1.1 报警等级

public enum AlarmLevelDict implements BaseDict {

SIGNIFICANT("significant", "重大"),

LARGE("large", "较大"),

GENERAL("general", "一般"),

LOW("low", "低"),

LOWER("lower", "很低");

}

修改于 2025-02-26 12:04:01
上一页
上级汇总历史数据重算接口-指定类型-指定天范围
下一页
采购订单生成
Built with