新增设备（API名称：addDevice）
功能介绍
该接口用于与客户系统对接添加设备。
相关API
调用流程
URL
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
|---|---|---|---|
POST |
https://isdp+域名/openapi/v1/ivmRemote/addDevice |
OpenAPI |
application/json |
请求头
KEY |
VALUE |
是否必填 |
描述 |
|---|---|---|---|
Content-Type |
application/json |
是 |
无 |
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 |
类型 |
是否必填 |
描述 |
|---|---|---|---|
deviceId |
String |
是 |
设备编码，请输入数字、英文、_、#等字符 |
deviceName |
String |
是 |
设备名称，请输入数字、中文、英文、_、-等字符 |
deviceAddress |
String |
否 |
设备位置信息 |
projectName |
String |
否 |
项目名称 |
projectNumber |
String |
否 |
项目编码 |
model |
String |
否 |
model |
deviceType |
Long |
是 |
设备类型 可选值WEBCAM/MONITOR_BALL/BODY_WORN_CAMERA/INTELLIGENT_SAFETY_HELMET/INTELLIGENT_MINER_L IGHT/MOBILE/IVS1800/IVS3800 多个以英文逗号分隔，不传默认查询所有 |
deviceManageState |
String |
否 |
设备管理状态 可选值NoActivation/ ACTIVATION，不传默认空 |
deviceSubType |
String |
否 |
设备子类型 |
manufacture |
String |
否 |
制造商 |
description |
String |
否 |
描述 |
deviceAddressNumber |
String |
否 |
设备位置编码 |
autoJoin |
String |
是 |
是否主动接入视频 可选值Y或者N，Y标识开启，N标识不开启 |
enableEndSide |
String |
是 |
是否开启边缘AI 可选值Y或者N，Y标识开启，N标识不开启 |
enableVideoRecording |
String |
是 |
是否开启视频录制 可选值Y或者N，Y标识开启，N标识不开启 |
ownnerId |
Long |
否 |
设备责任人Id |
deviceUserId |
Long |
否 |
设备使用人Id |
customerOrgName |
String |
否 |
使用区域名称 |
customerOrgCode |
String |
否 |
使用区域编码 |
password |
String |
是 |
设备加密密码 |
buOrgId |
Long |
是 |
组织Id |
buOrgName |
String |
是 |
组织名称 |
publicKey |
String |
是 |
公钥 |
响应参数
参数 |
类型 |
描述 |
|---|---|---|
status |
Int |
响应状态，1标识成功，否则不成功 |
message |
String |
响应信息，SUCCESS标识成功，否则失败 |
error |
String |
错误信息，接口错误时有值，正常调用时为空 |
data |
object |
响应消息体 |
groupId |
Long |
群组Id，data子项 |
groupName |
String |
群组名称，data子项 |
timestamp |
Date |
响应时间 |
请求示例
{
"deviceId" : "lq1234565",
"deviceName" : "lq1234565",
"deviceAddress" : "",
"projectName" : "",
"model" : "",
"deviceType" : "INTELLIGENT_SAFETY_HELMET",
"deviceManageState" : "",
"deviceSubType" : "其他",
"manufacture" : "",
"description" : "",
"deviceAddressNumber" : "",
"projectNumber" : "",
"autoJoin" : "Y",
"enableEndSide" : "Y",
"enableVideoRecording" : "Y",
"ownnerId" : "",
"deviceUserId" : "",
"customerOrgName" : "",
"customerOrgCode" : "",
"password" : "6056243f591d17b6c492dc0958b25dd082534ae92eb103e628f19df0d480f791fa74310139be72e05ceac313545080d2575341ec5d577c0235659f1f538640efd0bd0d3172be4b46bc08bd6b1365521*****************************************************************************************e69473fdccbf6f07882e465fd66017df0656a9b2641881daa2a47dfb19b941647e3d9147d2b38f0aa340b6870f24df1cd2794dddfcd4db546dbaa418fccb9ad7fdada2eec6dd481cacea82349c6559659af9",
"buOrgId" : 830,
"buOrgName" : "杨凌作业系统测试",
"publicKey" : "a0894ec6070c281ac4b9140adbc1f5b4624ff69e03f4181dde50fe79b99545af5c76a5af4e5e8c8441bd7ab3496e729395816db118acfea1e4673e47855322cd897b40d8f7278645fd045b392470a9c4806ee6765c1cbc87b3f87224c1c841e88bc5569de5af93f319e6d5cc34c4041ca26a376b6cdb2014605b8abacba5aca4918c4ed72b*****************************************************************************************3cf014a893f807f84873846b5e0773de63a05de12aa31ef2d64ce9379f7c41e037923eaafe4e750cd3eeaa1fae14c1329a2c9a192c930ef4a665e1bb2604ef66ac65f52a3e0cd2720ea2a42e79574688d62b73d31b4614c6e4a32cd96dbd5c1fb37b2a8d1001d3927bbccc48c9f5ce1929b0a2cc1b73761cda503114c5b,10001"
}
响应示例
{
"status" : 1,
"message" : "SUCCESS",
"error" : null,
"data" : "添加设备成功！",
"timestamp" : "2022-09-06T18:05:31.129+0800"
}
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。
