设备API - 新大陆物联网云平台

请求方式及地址

   GET 
   http://api.nlecloud.com/Devices/Datas

URL请求参数

参数	类型	描述	其它
devIds	string	设备ID用逗号隔开, 限制100个设备	Required

响应参数

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

响应示例

{
  "ResultObj": [
    {
      "DeviceID": 1,
      "Name": "sample string 2",
      "Datas": [
        {
          "ApiTag": "sample string 1",
          "Value": {},
          "RecordTime": "sample string 3"
        },
        {
          "ApiTag": "sample string 1",
          "Value": {},
          "RecordTime": "sample string 3"
        }
      ]
    },
    {
      "DeviceID": 1,
      "Name": "sample string 2",
      "Datas": [
        {
          "ApiTag": "sample string 1",
          "Value": {},
          "RecordTime": "sample string 3"
        },
        {
          "ApiTag": "sample string 1",
          "Value": {},
          "RecordTime": "sample string 3"
        }
      ]
    }
  ],
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

请求方式及地址

   GET 
   http://api.nlecloud.com/Devices/SimulationDatas

URL请求参数

参数	类型	描述	其它
devIds	string	设备ID用逗号隔开, 限制100个设备	Required

响应参数

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

响应示例

{
  "ResultObj": [
    {
      "DeviceID": 1,
      "Name": "sample string 2",
      "Floor": "sample string 3",
      "Room": "sample string 4",
      "Datas": [
        {
          "ApiTag": "sample string 1",
          "Value": {}
        },
        {
          "ApiTag": "sample string 1",
          "Value": {}
        }
      ]
    },
    {
      "DeviceID": 1,
      "Name": "sample string 2",
      "Floor": "sample string 3",
      "Room": "sample string 4",
      "Datas": [
        {
          "ApiTag": "sample string 1",
          "Value": {}
        },
        {
          "ApiTag": "sample string 1",
          "Value": {}
        }
      ]
    }
  ],
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

请求方式及地址

   GET 
   http://api.nlecloud.com/Devices/Status

URL请求参数

参数	类型	描述	其它
devIds	string	设备ID用逗号隔开, 限制100个设备	Required

响应参数

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

响应示例

{
  "ResultObj": [
    {
      "DeviceID": 1,
      "Name": "sample string 2",
      "IsOnline": true,
      "LastOnlineIP": "sample string 4",
      "Tag": "sample string 5"
    },
    {
      "DeviceID": 1,
      "Name": "sample string 2",
      "IsOnline": true,
      "LastOnlineIP": "sample string 4",
      "Tag": "sample string 5"
    }
  ],
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

请求方式及地址

   GET 
   http://api.nlecloud.com/Devices/{deviceId}

URL请求参数

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

响应参数

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

响应示例

{
  "ResultObj": {
    "Sensors": [
      {
        "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"
      }
    ],
    "DeviceID": 1,
    "Name": "sample string 2",
    "Tag": "sample string 3",
    "SecurityKey": "sample string 4",
    "ProjectID": 5,
    "Protocol": "sample string 6",
    "IsOnline": true,
    "LastOnlineIP": "sample string 8",
    "LastOnlineTime": "sample string 9",
    "Coordinate": "sample string 10",
    "CreateDate": "sample string 11",
    "IsShare": true,
    "IsTrans": true
  },
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

请求方式及地址

   GET 
   http://api.nlecloud.com/Devices

URL请求参数

参数	类型	描述
Keyword	string	关键字（可选，从id或name字段左匹配）
DeviceIds	string	指定设备ID（可选，如“124,34423,2345”，多个用逗号分隔，最多100个）
Tag	string	设备标识（可选）
IsOnline	string	在线状态（可选，true\|false）
IsShare	string	数据保密性（可选，true\|false）
ProjectKeyWord	string	项目ID或纯32位字符的项目标识码（可选）
PageSize	integer	指定每页要显示的数据个数，默认20，最多100
StartDate	string	起始时间（可选，包括当天，格式YYYY-MM-DD）
EndDate	string	结束时间（可选，包括当天，格式YYYY-MM-DD）
PageIndex	integer	指定页码

响应参数

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

响应示例

{
  "ResultObj": {
    "PageSet": [
      {
        "DeviceID": 1,
        "Name": "sample string 2",
        "Tag": "sample string 3",
        "SecurityKey": "sample string 4",
        "ProjectID": 5,
        "Protocol": "sample string 6",
        "IsOnline": true,
        "LastOnlineIP": "sample string 8",
        "LastOnlineTime": "sample string 9",
        "Coordinate": "sample string 10",
        "CreateDate": "sample string 11",
        "IsShare": true,
        "IsTrans": true
      },
      {
        "DeviceID": 1,
        "Name": "sample string 2",
        "Tag": "sample string 3",
        "SecurityKey": "sample string 4",
        "ProjectID": 5,
        "Protocol": "sample string 6",
        "IsOnline": true,
        "LastOnlineIP": "sample string 8",
        "LastOnlineTime": "sample string 9",
        "Coordinate": "sample string 10",
        "CreateDate": "sample string 11",
        "IsShare": true,
        "IsTrans": true
      }
    ],
    "PageCount": 1,
    "PageIndex": 2,
    "PageSize": 3,
    "RecordCount": 4
  },
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

请求方式及地址

   POST 
   http://api.nlecloud.com/Devices

包体请求参数

参数	类型	描述	其它
Protocol	byte	通讯协议（1:TCP 2:MQTT 3:HTTP）	Required
IsTrans	boolean	数据上报状态，true \| false（可选，默认为ture）
ProjectIdOrTag	string	项目ID（一个数字）或标识码（一个32位字符串）	String length: inclusive between 1 and 32
Name	string	设备名称（中英文、数字的6到15个字）	RequiredString length: inclusive between 1 and 30
Tag	string	设备标识（英文、数字或其组合6到30个字符）	RequiredMatching regular expression pattern: ^[a-zA-Z0-9_]{6,30}$
Coordinate	string	设备座标（可选，格式为经度值, 纬度值）
DeviceImg	string	设备头像（可选）
IsShare	boolean	数据保密性，true \| false（可选，默认为ture）

请求示例

{
  "Protocol": 64,
  "IsTrans": true,
  "ProjectIdOrTag": "sample string 3",
  "Name": "sample string 7",
  "Tag": "sample string 8",
  "Coordinate": "sample string 9",
  "DeviceImg": "sample string 10",
  "IsShare": true,
  "ReturnUrl": "sample string 12",
  "DataToken": "sample string 13"
}

响应参数

参数	类型	描述
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}

URL请求参数

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

包体请求参数

参数	类型	描述	其它
Protocol	byte	通讯协议（1:TCP 2:MQTT 3:HTTP）	Required
IsTrans	boolean	数据上报状态，true \| false（可选，默认为ture）
ProjectIdOrTag	string	项目ID（一个数字）或标识码（一个32位字符串）	String length: inclusive between 1 and 32
Name	string	设备名称（中英文、数字的6到15个字）	RequiredString length: inclusive between 1 and 30
Tag	string	设备标识（英文、数字或其组合6到30个字符）	RequiredMatching regular expression pattern: ^[a-zA-Z0-9_]{6,30}$
Coordinate	string	设备座标（可选，格式为经度值, 纬度值）
DeviceImg	string	设备头像（可选）
IsShare	boolean	数据保密性，true \| false（可选，默认为ture）

请求示例

{
  "Protocol": 64,
  "IsTrans": true,
  "ProjectIdOrTag": "sample string 3",
  "Name": "sample string 7",
  "Tag": "sample string 8",
  "Coordinate": "sample string 9",
  "DeviceImg": "sample string 10",
  "IsShare": true,
  "ReturnUrl": "sample string 12",
  "DataToken": "sample string 13"
}

响应参数

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

响应示例

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

请求方式及地址

   DELETE 
   http://api.nlecloud.com/Devices/{deviceId}

URL请求参数

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

响应参数

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

响应示例

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

应用开发●API接口●设备API

批量查询设备最新数据

批量查询设备实时模拟数据

批量查询设备的在线状态

查询单个设备

模糊查询设备

添加个新设备

更新某个设备

删除某个设备