开发者中心
目录

应用开发●API接口●项目API

查询单个项目

请求方式及地址

   GET 
   http://api.nlecloud.com/Projects/{projectId}

URL请求参数

参数类型描述其它
projectId integer 项目ID Required

响应参数

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

响应示例

{
  "ResultObj": {
    "ProjectID": 1,
    "Name": "sample string 2",
    "Industry": "sample string 3",
    "NetWorkKind": "sample string 4",
    "ProjectTag": "sample string 5",
    "CreateDate": "sample string 6",
    "Remark": "sample string 7"
  },
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

模糊查询项目

请求方式及地址

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

URL请求参数

参数类型描述其它
Keyword string 关键字（可选，从id或name字段模糊匹配查询）
ProjectTag string 项目标识码（可选，一个32位字符串）
NetWorkKind byte 联网方案 （可选，1：WIFI 2：以太网 3:蜂窝网络 4:蓝牙）
PageSize integer 指定每页要显示的数据个数，默认20，最多100
StartDate string 起始时间（可选，包括当天，格式YYYY-MM-DD）
EndDate string 结束时间（可选，包括当天，格式YYYY-MM-DD）
PageIndex integer 指定页码

响应参数

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

响应示例

{
  "ResultObj": {
    "PageSet": [
      {
        "ProjectID": 1,
        "Name": "sample string 2",
        "Industry": "sample string 3",
        "NetWorkKind": "sample string 4",
        "ProjectTag": "sample string 5",
        "CreateDate": "sample string 6",
        "Remark": "sample string 7"
      },
      {
        "ProjectID": 1,
        "Name": "sample string 2",
        "Industry": "sample string 3",
        "NetWorkKind": "sample string 4",
        "ProjectTag": "sample string 5",
        "CreateDate": "sample string 6",
        "Remark": "sample string 7"
      }
    ],
    "PageCount": 1,
    "PageIndex": 2,
    "PageSize": 3,
    "RecordCount": 4
  },
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

新增项目

请求方式及地址

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

包体请求参数

参数类型描述其它
Industry byte 行业类别【1：监控安防（默认） 2：智能家居 3：可穿戴设备 4：智慧农业 5：工业物联 6：新能源 7：楼宇办公 8：智能玩具 9：智慧城市】 Required
NetWorkKind byte 联网方案【1：Wifi(默认) 2：以太网 3：蜂窝网络 4：蓝牙 5：NB-IoT】 Required
Name string 项目名称 RequiredString length: inclusive between 1 and 30
Remark string 项目简介

请求示例

{
  "Industry": 64,
  "NetWorkKind": 64,
  "Name": "sample string 5",
  "Remark": "sample string 6",
  "ReturnUrl": "sample string 7",
  "DataToken": "sample string 8"
}

响应参数

参数类型描述其它
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/Projects/{projectId}

URL请求参数

参数类型描述其它
projectId integer 项目ID Required

包体请求参数

参数类型描述其它
Industry byte 行业类别【1：监控安防（默认） 2：智能家居 3：可穿戴设备 4：智慧农业 5：工业物联 6：新能源 7：楼宇办公 8：智能玩具 9：智慧城市】 Required
NetWorkKind byte 联网方案【1：Wifi(默认) 2：以太网 3：蜂窝网络 4：蓝牙 5：NB-IoT】 Required
Name string 项目名称 RequiredString length: inclusive between 1 and 30
Remark string 项目简介

请求示例

{
  "Industry": 64,
  "NetWorkKind": 64,
  "Name": "sample string 5",
  "Remark": "sample string 6",
  "ReturnUrl": "sample string 7",
  "DataToken": "sample string 8"
}

响应参数

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

响应示例

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

删除项目

请求方式及地址

   DELETE 
   http://api.nlecloud.com/Projects

包体请求参数

请求示例

[
  1,
  2
]

响应参数

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

响应示例

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

查询项目下所有设备的传感器

请求方式及地址

   GET 
   http://api.nlecloud.com/Projects/{projectId}/Sensors

URL请求参数

参数类型描述其它
projectId integer 项目ID 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": {}
}

查询项目下所有设备的传感器

请求方式及地址

   GET 
   http://api.nlecloud.com/Projects/{projectId}/SensorsRealTimeData

URL请求参数

参数类型描述其它
projectId integer 项目ID Required
deviceId integer 设备ID Default value is 0

响应参数

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

响应示例

{
  "ResultObj": [
    {
      "ApiTag": "sample string 1",
      "Name": "sample string 2",
      "DeviceId": 3,
      "Groups": 4,
      "ProjectID": 5,
      "Value": "sample string 6",
      "GatewayDeviceID": 7,
      "RecordTime": "2025-05-01T16:42:08.1887641+08:00"
    },
    {
      "ApiTag": "sample string 1",
      "Name": "sample string 2",
      "DeviceId": 3,
      "Groups": 4,
      "ProjectID": 5,
      "Value": "sample string 6",
      "GatewayDeviceID": 7,
      "RecordTime": "2025-05-01T16:42:08.1887641+08:00"
    }
  ],
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}