开发者中心
目录

应用开发●API接口●设备传感器API

查询单个传感器

请求方式及地址

   GET 
   http://api.nlecloud.com/devices/{deviceId}/Sensors/{apiTag}

URL请求参数

参数类型描述其它
deviceId integer 设备ID（必须） Required
apiTag string 传感标识名（必须） Required
isPrivate boolean Default value is False

响应参数

参数类型描述其它
ResultObj SensorBaseInfoDTO
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "ResultObj": {
    "ApiTag": "sample string 1",
    "Groups": 64,
    "Protocol": 64,
    "Name": "sample string 4",
    "CreateDate": "sample string 5",
    "TransType": 64,
    "DataType": 64,
    "TypeAttrs": {},
    "DeviceID": 9,
    "SensorType": "sample string 10",
    "GroupID": 1,
    "Coordinate": "sample string 11",
    "Value": {},
    "RecordTime": "sample string 13"
  },
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

模糊查询传感器

请求方式及地址

   GET 
   http://api.nlecloud.com/devices/{deviceId}/Sensors

URL请求参数

参数类型描述其它
deviceId integer 设备ID（必须） Required
apiTags string 传感标识名（必须），多个标识名之间用逗号分开（参数值为空时查询所有传感器） Required
isPrivate boolean Default value is False

响应参数

参数类型描述其它
ResultObj Collection of SensorBaseInfoDTO
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "ResultObj": [
    {
      "ApiTag": "sample string 1",
      "Groups": 64,
      "Protocol": 64,
      "Name": "sample string 4",
      "CreateDate": "sample string 5",
      "TransType": 64,
      "DataType": 64,
      "TypeAttrs": {},
      "DeviceID": 9,
      "SensorType": "sample string 10",
      "GroupID": 1,
      "Coordinate": "sample string 11",
      "Value": {},
      "RecordTime": "sample string 13"
    },
    {
      "ApiTag": "sample string 1",
      "Groups": 64,
      "Protocol": 64,
      "Name": "sample string 4",
      "CreateDate": "sample string 5",
      "TransType": 64,
      "DataType": 64,
      "TypeAttrs": {},
      "DeviceID": 9,
      "SensorType": "sample string 10",
      "GroupID": 1,
      "Coordinate": "sample string 11",
      "Value": {},
      "RecordTime": "sample string 13"
    }
  ],
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

添加个新传感器

请求方式及地址

   POST 
   http://api.nlecloud.com/devices/{deviceId}/Sensors

URL请求参数

参数类型描述其它
deviceId integer 设备ID Required

包体请求参数

无

请求示例

响应参数

参数类型描述其它
ResultObj integer
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "ResultObj": 1,
  "Status": 0,
  "StatusCode": 2,
  "Msg": "sample string 3",
  "ErrorObj": {}
}

更新某个传感器

请求方式及地址

   PUT 
   http://api.nlecloud.com/devices/{deviceId}/Sensors/{apiTag}

URL请求参数

参数类型描述其它
deviceId integer 设备ID Required
apiTag string 传感器标识名 Required

包体请求参数

无

请求示例

响应参数

参数类型描述其它
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

删除某个传感器

请求方式及地址

   DELETE 
   http://api.nlecloud.com/devices/{deviceId}/Sensors/{apiTag}

URL请求参数

参数类型描述其它
deviceId integer 设备ID Required
apiTag string 传感标识名 Required

响应参数

参数类型描述其它
Status ResultStatus 返回状态
StatusCode integer 返回的状态码
Msg string 返回的消息
ErrorObj Object

响应示例

{
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}