園區業務中獲取設備所屬空間
路徑 | /campus/paas/openapi/space/by/device/query |
版本號 | 1.0.0 |
協議 | HTTPS |
請求方法 | POST |
是否需要用戶身份鑒權 | 否 |
超時時間 | 10000 |
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
appId | String | 否 | 統一應用id | |
iotId | String | 是 | 設備標識 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
響應碼, 200: 成功 |
|
message | String |
錯誤消息 |
|
localizedMsg | String |
本地語言錯誤消息 |
|
data | JSON |
響應結果 |
|
spaceId | String |
空間id |
|
attribute | String |
空間屬性 |
|
gmtCreate | Long |
創建時間 |
|
creatorType | String |
創建人類型 |
|
creatorId | String |
創建人ID |
|
gmtModified | Long |
更新時間 |
|
modifierType | String |
修改人類型 |
|
modifierId | String |
修改人ID |
|
creatorNickName | String |
如果創建人是identityId,則有值 |
|
modifierNickName | String |
如果修改人是identityId,則有值 |
|
parentId | String |
上級空間id |
|
businessId | String |
業務空間id |
|
name | String |
空間名稱 |
|
path | String |
空間路徑 /pid/pid/pid/pid/ |
|
description | String |
空間描述 |
|
typeCode | String |
空間類型代碼 |
|
usesCode | String |
空間用途代碼 |
|
usesName | String |
空間用途名稱 |
|
typeName | String |
空間類型名稱 |
|
geoDTO | JSON |
空間geo |
|
length | String |
空間長度,單位m |
|
width | String |
空間寬度,單位m |
|
altitude | String |
空間高度,單位m |
|
area | String |
空間面積,單位m2 |
|
volume | String |
空間體積,單位m3 |
|
poiCode | String |
空間編碼不含父子級 |
|
bizType | String |
業務類型home / campus |
|
poiCodePath | String |
空間編碼含父子級 |
|
hasChild | Boolean |
是否有下級空間節點 |
|
hasDeviceChild | Int |
空間是否包含設備,1: 有; 0: 無 |
|
status | Int |
空間狀態 1:啟用;0:停用; |
|
spaceScope | Int |
0:公用;1:私有; |
|
namePath | String |
空間路徑名稱 |
|
typeCodePath | String |
空間路徑code ex. /building/unit/floor/house/ |
示例
請求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0"
},
"params":{
"appId": "value0",
"iotId": "value1"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"spaceId":"acgdh*****390ojhjkldj",
"attribute":{
"direction":"east"
},
"gmtCreate":"2019-02-22 12:22:22",
"gmtModified":"2019-02-22 12:22:22",
"parentId":"sjfhu*****ibisdf27890oijhjk",
"businessId":"a3468*****kj",
"name":"我的家",
"path":"/sjfhu*****ibisdf27890oijhjk/acgd*****8390ojhjkldj/",
"hasChild":false,
"hasDeviceChild":1,
"status":1,
"spaceScope":1,
"namePath":"/公寓/我的家"
}
}
異常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "請求被禁止",
"data": null
}
錯誤碼
HttpCode | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
500 | 500 | Internal Error | Internal Error |
503 | 503 | Service Unavailable | Service Unavailable |
403 | 403 | Request Limited | Request Limited |
401 | 401 | Empty Signature | Empty Signature |
400 | 400 | Request Format Error | Request Format Error |
200 | 20003 | Find Backend Error | Find Backend Error |
200 | 20004 | Backend Service Error | Backend Service Error |
200 | 20055 | Backend Service Invalid | Request Format Error |
200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
200 | 401 | Request Authorized Error | Request Authorized Error |
200 | 403 | Request Forbidden | Request Forbidden |
200 | 500 | Server Error | Server Error |
200 | 2459 | oa error message | 會話Id不存在 |
200 | 2459 | oa error message | 會話Id不存在 |
200 | 2402 | iotToken not exist | |
200 | 2402 | iotToken not exist | |
200 | 2401 | refreshToken invalid | refreshToken已經失效 |
200 | 2401 | refreshToken invalid | refreshToken已經失效 |
200 | 460 | identityIds need between 1-50 | 入參錯誤 |
200 | 460 | identityIds need between 1-50 | 入參錯誤 |
200 | 403 | request forbidden. | 請求被禁止 |
200 | 403 | request forbidden. | 請求被禁止 |