API接口4.0

简介

本页提供物联网平台API接口4.0说明。

DeviceClass

设备分类管理

API接口	描述
POST api/DeviceClass/Add	增加一个设备分类
POST api/DeviceClass/Modify	修改一个设备分类
POST api/DeviceClass/Delete	删除一个设备分类
POST api/DeviceClass/Read	查询一个设备分类

UserRegion

分中心接口

API接口	描述
POST api/UserRegion/ReadRegion	查询本地设备目录
POST api/UserRegion/ReadAllInMapRange	根据地图范围查询设备
POST api/UserRegion/Read	查询一个设备
POST api/UserRegion/ReadEMList	查询报警列表
POST api/UserRegion/ReadMiniUserList	查询账户

Client

分中心接口-HSWeb

API接口	描述
POST api/v3/Client/ReadOverview	查询全局概览
POST api/v3/Client/ReadLastOrderEM	查询最后报警订单
POST api/v3/Client/ReadOnlineOrderEM	查询在线报警订单
POST api/v3/Client/ReadOrderEMBySN	查询一个报警订单
POST api/v3/Client/ReadDeviceRegion	查询设备区域目录
POST api/v3/Client/ReadDevicesByRegion	按区域查询设备
POST api/v3/Client/ReadDeviceDateTree	查询设备日期树
POST api/v3/Client/ReadDevicesByDate	按日期查询设备
POST api/v3/Client/ReadDeviceBatch	查询设备批次
POST api/v3/Client/ReadDevicesByBatch	按批次查询设备
POST api/v3/Client/ReadDeviceBySN	按SN查询一个设备
POST api/v3/Client/ReadUserRegion	查询用户区域目录
POST api/v3/Client/ReadUsersByRegion	按区域查询用户
POST api/v3/Client/ReadUserDateTree	查询用户日期树
POST api/v3/Client/ReadUsersByDate	按日期查询用户
POST api/v3/Client/ReadUsersByOpt	按选项查询用户
POST api/v3/Client/ReadUserBySN	按SN查询一个用户
POST api/v3/Client/ReadLastLog	查询日志V3
POST api/v3/Client/ReadTrack	轨迹查询
POST api/v3/Client/ReadChat	轨迹查询
POST api/v3/Client/ChangePW	修改密码
POST api/v3/Client/SettingDeviceParams	修改设备参数
POST api/v3/Client/SettingUserParams	修改用户参数
POST api/v3/Client/Deactive	平台强制解绑设备
POST api/v3/Client/AddChat	发送留言
POST api/v3/Client/AddFX	警情通报
POST api/v3/Client/AddRecord	遥控录音

Protocol

设备通信协议管理

API接口	描述
POST api/Protocol/Add	增加一条协议
POST api/Protocol/Modify	修改一条协议
POST api/Protocol/Delete	删除一条协议
POST api/Protocol/Read	查询一条协议

UserDB

客户库管理

API接口	描述
POST api/UserDB/Read	获取系统参数。SN=-1：获取所有系统列表，SN=-2：查询当前客户系统参数
POST api/UserDB/Modify	修改一个系统参数

Control

控制接口

API接口	描述
POST api/Control/Control	控制指令 - 路灯
POST api/Control/ControlModbus	控制指令 - Modbus

wx

帐号管理

API接口	描述
GET api/wxPublic/auth?signature={signature}&timestamp={timestamp}&nonce={nonce}&echostr={echostr}	登录

DeviceGroup

设备分组管理

API接口	描述
POST api/DeviceGroup/Add	增加一个设备分组
POST api/DeviceGroup/Modify	修改一个设备分组
POST api/DeviceGroup/Delete	删除一个设备分组
POST api/DeviceGroup/Read	查询一个设备分组

Strategy

策略管理

API接口	描述
POST api/Strategy/Add	增加一个策略
POST api/Strategy/Modify	修改一个策略
POST api/Strategy/ChangeModel	切换运行模式
POST api/Strategy/Delete	删除一个策略
POST api/Strategy/Read	查询策略 “-1”查询辖下所有
POST api/Strategy/AddItem	增加一个策略项
POST api/Strategy/ModifyItem	修改一个策略项
POST api/Strategy/ReadItem	查询策略项 0=开灯策略项，1-98=时段策略项，99=关灯策略项

OrderEM

报警管理

API接口	描述
POST api/OrderEM/Read	查询一个报警订单
POST api/OrderEM/ReadUserList	查询一个报警订单设备的紧急联系人列表
POST api/OrderEM/Ack	响应
POST api/OrderEM/AddChat	添加一条聊天记录
POST api/OrderEM/AddChatVoice	添加一条聊天记录
POST api/OrderEM/AddRecord	添加一条遥控录音
POST api/OrderEM/AddFX	添加一条分析通报
POST api/OrderEM/FinishEM	结束报警

Log

日志管理

API接口	描述
POST api/Log/ReadLast	查询日志
POST api/Log/ReadLastV2	查询日志V2

wxUser

帐号管理

API接口	描述
POST api/wxUser/Modify	修改一个账户
POST api/wxUser/Setting	设置
POST api/wxUser/Delete	删除一个账户
POST api/wxUser/Read	查询一个账户
POST api/wxUser/ReadByPhone	通过电话号码查询一个账户是否存在
POST api/wxUser/Regist	注册
POST api/wxUser/NameChange	昵称修改
POST api/wxUser/SetPassword	设置密码
POST api/wxUser/Login	登录
POST api/wxUser/LogOut	账号注销
POST api/wxUser/SendSMSbr	发送短信-博容
POST api/wxUser/Binding	绑定设备
POST api/wxUser/UnBind	联络人解绑
POST api/wxUser/UnBindDevice	设备解绑
POST api/wxUser/ModifyInfo1	修改机主信息
POST api/wxUser/ModifyInfo2	变更紧急联络人
POST api/wxUser/AddPhone	新增一个紧急联系人
POST api/wxUser/DelPhone	删除一个紧急联系人
POST api/wxUser/ConfirmPhone	紧急联系人确认
POST api/wxUser/SetMode1	设置Mode1(录音总时长)
POST api/wxUser/SetMode2	设置Mode2 (定位信号传送频率)
POST api/wxUser/SetMode3	设置Mode3 (模式选择：0=主动求助，1=被动监护)
POST api/wxUser/SetMode4	设置Mode4 (态势锁)
POST api/wxUser/SetMark	收藏
POST api/wxUser/ClearMark	取消收藏
POST api/wxUser/DelVoice	删除录音
POST api/wxUser/DelCollect	删除收藏夹录音
POST api/wxUser/PlayedVoice	标记播放过录音
POST api/wxUser/wxReadByIMEI	小程序根据IMEI查询一个设备
POST api/wxUser/wxReadRouterByIMEI	小程序根据IMEI查询一个设备的轨迹
POST api/wxUser/wxReadVoicesByIMEI	小程序根据IMEI查询一个设备的录音文件
POST api/wxUser/wxReadCollectByIMEI	小程序根据IMEI查询一个设备的录音收藏夹
POST api/wxUser/wxMessage	小程序订阅消息接口
GET api/wxUser/wxMessage	小程序订阅消息接口

User

帐号管理

API接口	描述
POST api/User/Modify	修改一个账户
POST api/User/Setting	设置
POST api/User/Delete	删除一个账户
POST api/User/Read	查询一个账户
POST api/User/Login	登录
POST api/User/Regist	注册
POST api/User/AddAccount	增加子账户
POST api/User/GetCode	获取验证码

Report

报表接口

API接口	描述
POST api/Report/Asset	查询资产报表
POST api/Report/DashAssetEM	查询大屏简要 - 资产+报警
POST api/Report/DashEMList	查询大屏报警列表
POST api/Report/EM	查询故障报表
POST api/Report/Statistics	统计报表-实时曲线
POST api/Report/StatisticsDaysInMonth	统计报表-月报表
POST api/Report/StatisticsMonthsInYear	统计报表-年报表
POST api/Report/StatisticsFirst	统计报表-最早记录（用于确定报表目录）
POST api/Report/GetSunStatus	查询日出日落状态
POST api/Report/ProjectList	查询项目列表

LogV2

日志管理

API接口	描述
POST api/LogV2/ReadLastV2	查询日志V2
POST api/LogV2/ReadChat	查询聊天记录
POST api/LogV2/ReadTrack	查询轨迹

miniUser

帐号管理

API接口	描述
POST api/miniUser/Login2	登录
POST api/miniUser/Login2jq	登录
POST api/miniUser/ReLogin	重登录
POST api/miniUser/Logout	注销
POST api/miniUser/ChangePW	修改密码
POST api/miniUser/ResetPW	重置密码
POST api/miniUser/getSMSCode	获取短信验证码
POST api/miniUser/checkSMSCode	校验短信验证码
POST api/miniUser/Modify	账号修改
POST api/miniUser/DelEMListSN	删除一个报警订单
POST api/miniUser/MarkEMListSN	收藏一个报警订单
POST api/miniUser/LoopGetNewEMCount	循环获取新订单数量
POST api/miniUser/LoadOrderEM	循环加载报警订单
POST api/miniUser/ReadBaseBySN	查询用户基本信息：头像、昵称、手机号
POST api/miniUser/ReadAll	查询账户
POST api/miniUser/getToken	获取sts token
POST api/miniUser/ModifyInfo	修改机主信息 -- 后台修改用户的分中心管理权限和管辖区

Device

设备管理

API接口	描述
POST api/Device/Add	增加一个设备
POST api/Device/Modify	修改一个设备
POST api/Device/AllSetParams	批量设置所有子设备参数
POST api/Device/ModifyParams	修改参数
POST api/Device/DefaultParams	还原参数
POST api/Device/Move	转移设备
POST api/Device/MoveGroup	批量修改分组
POST api/Device/MoveStrategy	批量修改策略
POST api/Device/ClearEM	批量清除报警
POST api/Device/Order	故障设备维修派单
POST api/Device/Delete	删除一个设备
POST api/Device/DeleteMore	批量删除设备
POST api/Device/ReadAll	查询多个设备
POST api/Device/ReadAllV2	查询多个设备V2
POST api/Device/ReadAllInMapRange	根据地图范围查询设备
POST api/Device/ReadNodes	查询子设备
POST api/Device/Read	查询一个设备
POST api/Device/ReadByIMEI	根据IMEI查询一个设备
POST api/Device/Find	根据IMEI或名称查找一个设备
POST api/Device/SetLocation	设置设备坐标位置
POST api/Device/GetCameraUrl	设置设备坐标位置
POST api/Device/SetUWB	设置设备UWB

Order

工单管理

API接口	描述
POST api/Order/Read	查询工单
POST api/Order/ReadByIMEI	查询单设备工单
POST api/Order/Taking	接单
POST api/Order/Finish	结单
POST api/Order/Discard	废弃
POST api/Order/Fix	维修

Role

角色管理

API接口	描述
POST api/Role/Add	增加一个角色
POST api/Role/Modify	修改一个角色
POST api/Role/Delete	删除一个角色
POST api/Role/Read	查询一个角色

DeviceV2

设备管理

API接口	描述
POST api/DeviceV2/Active	绑定设备
POST api/DeviceV2/Deactive	解绑设备
POST api/DeviceV2/GuardAgree	确认守护-紧急联系人操作
POST api/DeviceV2/Deguard	取消守护-紧急联系人操作
POST api/DeviceV2/ModifyBase	修改一个设备
POST api/DeviceV2/UserAdd	增加一个紧急联系人
POST api/DeviceV2/UserDel	删除一个紧急联系人
POST api/DeviceV2/UserSetTime	屏蔽一个紧急联系人
POST api/DeviceV2/UserChangeIF	更改通知设置
POST api/DeviceV2/UserChangeParam	切换模式
POST api/DeviceV2/SwitchMode	模式切换
POST api/DeviceV2/ReadByInner	查询我的设备
POST api/DeviceV2/ReadInUser	查询我的守护
POST api/DeviceV2/ReadBySN	查询一个设备
POST api/DeviceV2/ReadAll	查询多个设备
POST api/DeviceV2/Read	查询一个设备
POST api/DeviceV2/ReadNodes	查询子设备
POST api/DeviceV2/ReadAllInMapRange	根据地图范围查询设备
POST api/DeviceV2/ClearEM	批量清除报警
POST api/DeviceV2/DefaultParams	还原参数
POST api/DeviceV2/Unbinding	设备解绑
POST api/DeviceV2/ModifyParams	修改参数
POST api/DeviceV2/Find	根据IMEI或名称查找一个设备
POST api/DeviceV2/Modify	修改一个设备
POST api/DeviceV2/Move	转移设备
POST api/DeviceV2/MoveGroup	批量修改分组
POST api/DeviceV2/MoveStrategy	批量修改策略
POST api/DeviceV2/Order	故障设备维修派单
POST api/DeviceV2/Delete	删除一个设备
POST api/DeviceV2/DeleteMore	批量删除设备
POST api/DeviceV2/ReadByIMEI	根据IMEI查询一个设备
POST api/DeviceV2/SetLocation	设置设备坐标位置
POST api/DeviceV2/GetCameraUrl	设置设备坐标位置
POST api/DeviceV2/SetUWB	设置设备UWB

Frame

登录页素材

API接口	描述
POST api/Frame/Read	获取登录页素材

NB2

NB2 推送接口

API接口	描述
POST api/NB2/TS	NB2 推送指令