项目管理

接入商业照明 SaaS 的第一步是创建项目，完成后您可以通过管理项目的方式管理您需要控制的场景。

API 列表

请求方式	API	说明
POST	/v1.0/illumination/construction/project	创建项目
PUT	/v1.0/illumination/construction/project	编辑项目
DELETE	/v1.0/illumination/construction/project/{projectId}	删除项目
GET	/v1.0/illumination/construction/project/{projectId}	获取单个项目信息
GET	/v1.0/illumination/construction/projects	获取项目列表
GET	/v1.0/iot-02/projects/{project_id}/devices/count	查询项目的设备统计信息

创建项目

接口说明

创建项目。

接口地址

POST /v1.0/illumination/construction/project

请求参数

参数名	类型	参数类型	说明	是否必需
name	string	body	项目名称	是
leaderMobile	string	body	负责人电话	是
leaderName	string	body	负责人名称	是
address	string	body	项目地址	是
detail	string	body	项目详情地址，非经纬度解析地址。	否
longitude	double	body	项目地址所在经度	是
latitude	double	body	项目地址所在纬度	是
projectType	Integer	body	项目类型 0：室内版 1：户外版 2：停车场版	否

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回 13 位时间戳
result	Object	返回结果

result 参数说明

{
  "projectId": "string // 项目 ID",
  "ownerId": "string // 家庭 ID"
}

请求示例

{
  "leaderMobile": "负责人电话",
  "address": "项目地址",
  "leaderName": "负责人名称",
  "latitude": "项目地址所在纬度",
  "name": "项目名称",
  "detail": "项目详情地址，非经纬度解析的地址",
  "longitude": "项目地址所在经度"
}

响应示例

{
  "ownerId": "家庭 ID",
  "projectId": "项目 ID"
}

编辑项目

接口说明

编辑项目。

接口地址

PUT /v1.0/illumination/construction/project

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	string	body	项目 ID	是
name	string	body	项目名称	否
leaderMobile	string	body	负责人电话	否
leaderName	string	body	负责人名称	否
address	string	body	项目地址	否
detail	string	body	项目详情地址，非经纬度解析的地址	否
longitude	double	body	项目地址所在经度	否
latitude	double	body	项目地址所在纬度	否

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回 13 位时间戳
result	Object	返回结果

result 参数说明

{
  "projectId": "string // 项目 ID"
}

请求示例

{
  "leaderMobile": "负责人电话",
  "address": "项目地址",
  "leaderName": "负责人名称",
  "latitude": "项目地址所在纬度",
  "name": "项目名称",
  "detail": "项目详情地址，非经纬度解析的地址",
  "projectId": "项目 ID",
  "longitude": "项目地址所在经度"
}

响应示例

{
  "projectId": "项目 ID"
}

删除项目

接口说明

删除项目。

接口地址

DELETE /v1.0/illumination/construction/project/{projectId}

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	string	url	项目 ID	是

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回 13 位时间戳
result	Object	返回结果

result 参数说明

{
  "success": "boolean"
}

请求示例

{
  "projectId": "项目 ID"
}

响应示例

{
  "success": "是否成功"
}

获取单个项目信息

接口说明

获取单个项目信息。

接口地址

GET /v1.0/illumination/construction/project/{projectId}

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	string	url	项目 ID	是

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回 13 位时间戳
result	Object	返回结果

result 参数说明

{
  "projectId": "string // 项目 ID",
  "ownerId": "string // 家庭 ID",
  "name": "string // 项目名称",
  "leaderMobile": "string // 负责人电话",
  "leaderName": "string // 负责人名称",
  "address": "string // 项目地址",
  "detail": "string // 项目详情地址",
  "longitude": "double // 项目地址所在经度",
  "latitude": "double // 项目地址所在纬度",
  "timeZoneId": "string // 时区 ID",
  "timeZone": "string // 项目地址的时区",
  "zoneId": "string // 项目地址的时区 ID",
  "source": "int // 项目创建来源",
  "locationId": "long // 家庭位置 ID",
  "gmtCreate": "long // 创建时间",
  "controlMode": "int // 控制模式",
  "success": "boolean",
  "namespace": "string"
}

请求示例

{
  "projectId": "string // 项目 ID"
}

响应示例

{
  "projectId": "项目 ID",
  "ownerId": "家庭 ID",
  "name": "项目名称",
  "leaderMobile": "负责人电话",
  "leaderName": "负责人名称",
  "address": "项目地址",
  "detail": "项目详情地址",
  "longitude": "项目地址所在经度",
  "latitude": "项目地址所在纬度",
  "timeZoneId": "时区 ID",
  "timeZone": "项目地址的时区",
  "zoneId": "项目地址的时区 ID",
  "source": "项目创建来源",
  "locationId": "家庭位置 ID",
  "gmtCreate": "创建时间",
  "controlMode": "控制模式",
  "success": "boolean",
  "namespace": "string"
}

获取项目列表

接口说明

获取项目列表。

接口地址

GET /v1.0/illumination/construction/projects

请求参数

参数名	类型	参数类型	说明	是否必需
page	int	body	页码参数，最小为 1	否
pageSize	int	body	每页记录数量，最大为 10000	否
keyword	string	body	查询关键字	否

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回 13 位时间戳
result	Object	返回结果

result 参数说明

{
  "total": "int",
  "list": [
    {
      "projectId": "string // 项目 ID",
      "ownerId": "string // 家庭 ID",
      "name": "string // 项目名称",
      "leaderMobile": "string // 负责人电话",
      "leaderName": "string // 负责人名称",
      "address": "string // 项目地址",
      "detail": "string // 项目详情地址",
      "longitude": "double // 项目地址所在经度",
      "latitude": "double // 项目地址所在纬度",
      "timeZoneId": "string // 时区 ID",
      "timeZone": "string // 项目地址的时区",
      "zoneId": "string // 项目地址的时区 ID",
      "source": "int // 项目创建来源",
      "locationId": "long // 家庭位置 ID",
      "gmtCreate": "long // 创建时间",
      "controlMode": "int // 控制模式",
      "success": "boolean",
      "namespace": "string"
    }
  ]
}

请求示例

{
  "pageSize": "每页记录数量",
  "page": "页码参数"
}

响应示例

{
  "total": "int",
  "list": [
    {
      "projectId": "项目 ID",
      "ownerId": "家庭 ID",
      "name": "项目名称",
      "leaderMobile": "负责人电话",
      "leaderName": "负责人名称",
      "address": "项目地址",
      "detail": "项目详情地址",
      "longitude": "项目地址所在经度",
      "latitude": "项目地址所在纬度",
      "timeZoneId": "时区 ID",
      "timeZone": "项目地址的时区",
      "zoneId": "项目地址的时区 ID",
      "source": "项目创建来源",
      "locationId": "家庭位置 ID",
      "gmtCreate": "创建时间",
      "controlMode": "控制模式",
      "success": "boolean",
      "namespace": "string"
    }
  ]
}

查询项目的设备统计信息

接口说明

查询指定项目的设备统计信息，包含设备总数、在线设备数、离线设备数和告警设备数。

接口地址

GET /v1.0/iot-02/projects/{project_id}/devices/count

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	string	url	项目 ID	是

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回 13 位时间戳
result	Object	返回结果

result 参数说明

{
  "projectId": "String //项目 ID",
  "deviceCount": "int //设备数",
  "onlineDeviceCount": "int //在线设备数",
  "offlineDeviceCount": "int //离线设备数",
  "alarmDeviceCount": "int //告警设备数"
}

响应示例

{
  "projectId": "项目 ID",
  "deviceCount": "设备数",
  "onlineDeviceCount": "在线设备数",
  "offlineDeviceCount": "离线设备数",
  "alarmDeviceCount": "告警设备数"
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见 全局错误码。

错误码	说明
500	系统错误