获取项目详情 - 联犀-core

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

用户正在使用的设备ID(小程序,ios,安卓的设备ID)

Body 参数application/json

projectID

string

项目id 只读

必需

withAdminUser

boolean

可选

同时获取管理员核心信息

withTopAreas

boolean

可选

同时返回顶层的区域列表

示例

{
  "projectID": "string",
  "withAdminUser": true,
  "withTopAreas": true
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/system/project/info/read' \
--header 'Ithings-Project-Id: {{Ithings-Project-Id}}' \
--header 'Ithings-Token: {{iThings-token}}' \
--header 'app-code: {{appCode}}' \
--header 'device-id;' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

data

object (ProjectInfo)

可选

createdTime

string

创建时间（只读）

可选

projectID

string

项目id（只读）

可选

projectName

string

项目名称（读写）

可选

adminUserID

string

可选

管理员用户id（读写）

position

object (Point)

可选

address

string

可选

项目详细地址（读写）

projectImg

string

可选

isSysCreated

integer <int64>

可选

是否是系统创建的,系统创建的只有管理员可以删除

isUpdateProjectImg

boolean

可选

desc

string

项目备注（读写）

可选

tags

object

自定义标签

可选

areaCount

integer <int64>

可选

项目下的区域统计(只读)

userCount

integer <int64>

可选

项目下的用户统计(只读)

deviceCount

integer <int64>

可选

项目下的设备统计(只读)

ppsm

integer <int64>

可选

w.h/m2 每平方米功耗建筑定额能耗 Power per square meter

area

number <float>

可选

建筑面积(单位平米)

adminUser

object (UserCore)

可选

areas

array[object (AreaInfo) {21}]

可选

示例

{
  "code": "200",
  "msg": "string",
  "data": {
    "createdTime": "string",
    "projectID": "string",
    "projectName": "string",
    "adminUserID": "string",
    "position": {
      "longitude": 180,
      "latitude": 90
    },
    "address": "string",
    "projectImg": "string",
    "isSysCreated": 0,
    "isUpdateProjectImg": true,
    "desc": "string",
    "tags": {},
    "areaCount": 0,
    "userCount": 0,
    "deviceCount": 0,
    "ppsm": 0,
    "area": 0,
    "adminUser": {
      "userID": "string",
      "userName": "string",
      "email": "string",
      "phone": "string",
      "lastIP": "string",
      "regIP": "string",
      "nickName": "string",
      "headImg": "string",
      "tags": {},
      "createdTime": "string"
    },
    "areas": [
      {
        "createdTime": "string",
        "projectID": "string",
        "areaID": "string",
        "parentAreaID": "string",
        "areaName": "string",
        "position": {
          "longitude": 180,
          "latitude": 90
        },
        "desc": "string",
        "tags": {},
        "lowerLevelCount": 0,
        "deviceCount": 0,
        "groupCount": 0,
        "useBy": "string",
        "isLeaf": 0,
        "isSysCreated": 0,
        "areaIDPath": "string",
        "areaNamePath": "string",
        "areaImg": "string",
        "isUpdateAreaImg": true,
        "configFile": "string",
        "isUpdateConfigFile": true,
        "children": [
          {}
        ]
      }
    ]
  }
}