5. 空间中台API

API列表

编号 API名称 路径 版本
5.1 获取空间列表 /mid/space/query/list 1.0
5.2 获取空间信息 /mid/space/query/info 1.0
5.3 创建空间 /mid/space/create 1.0
5.4 更新空间信息 /mid/space/update/info 1.0
5.5 删除空间信息 /mid/space/delete 1.0
5.6 更新数据状态 /mid/space/update/state 1.0

API调用

5.1: 获取空间列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/space/query/list

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId BODY STRING 否 项目ID
typeCode BODY STRING 是 空间类型
custId BODY STRING 否 客户ID
beginModifyTimestamp BODY STRING 否 需要查询的数据的时间戳范围，格式为：yyyy-MM-dd HH:mm:ss
endModifyTimestamp BODY STRING 否 需要查询的数据的时间戳范围，格式为：yyyy-MM-dd HH:mm:ss
soueceCode BODY STRING 是 多租户Code

请求Body描述(非Form表单数据)

{
  "projectId": "123456",
  "typeCode": "",
  "custId": "",
  "beginModifyTimestamp": "2019-07-22 17:19:21",
  "endModifyTimestamp": "2019-07-23 17:19:21",
  "soueceCode": 0
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
spaces data JSONArray 是 空间列表
parkingId data.spaces[] INTEGER 是 车位ID
projectId data.spaces[] INTEGER 是 项目ID
placeId data.spaces[] INTEGER 是 车场ID
unitId data.spaces[] INTEGER 否 单元ID
buildId data.spaces[] INTEGER 否 楼栋ID
floorId data.spaces[] INTEGER 否 楼层ID
houseId data.spaces[] INTEGER 否 房屋ID
areaId data.spaces[] INTEGER 否 区域ID
name data.spaces[] STRING 是 空间名
floor data.spaces[] STRING 是 楼层
status data.spaces[] STRING 是 是否启用status
totalArea data.spaces[] STRING 是 项目总面积
billArea data.spaces[] STRING 是 计费面积
useArea data.spaces[] STRING 是 使用面积
mangarArea data.spaces[] STRING 是 物管面积
buildArea data.spaces[] STRING 是 建筑面积
greenArea data.spaces[] STRING 是 绿化面积
latitude data.spaces[] STRING 是 经度
longitude data.spaces[] STRING 是 纬度
返回结果示例
item    项目
{
  "code": "200",
  "message": "success",
  "data": {
     "records": [
            {
                "code": "",
                "name": "美的智慧生活体验馆01",
                "projectId": 21291201
                "status": ""
                "city": "",
                "province": "",
                "region": "",
                "address": "",
                "totalArea": "",
                        "billArea": "",
                        "useArea": "",
                        "mangarArea": "",
                        "buildArea": "",
                        "greenArea": "",
                        "latitude": "",
                        "longitude": ""
            }]
  }
}
building    楼幢
{
  "code": "200",
  "message": "success",
  "data": {
     "records": [
            {
                "code": "Z01",
                "name": "9栋",
                "buildId": 50094376,
                "projectId": 21291201
            }]
  }
}
unit    单元
{
  "code": "200",
  "message": "success",
  "data": {
     "records": [
            {
                "unitId": 50110002,
                "code": "01",
                "name": "01单元",
                "buildId": 50094376,
                "projectId": 21291201
            }]
  }
}
floor    楼层
{
  "code": "200",
  "message": "success",
  "data": {
     "records": [
            {
                "floorId": 50094378,
                "code": "01",
                "name": "1层",
                "unitId": 50094377,
                "buildId": 50094376,
                "projectId": 21291201
            }]
  }
}
area    区域
{
  "code": "200",
  "message": "success",
  "data": {
     "records": [
            {
                "bulterTel": "18978346824",
                "areaId": 1191999,
                "name": "01-03单元区域",
                "bulterName": "张三",
                "status": 1,
                "projectId": 21291201
            }]
  }
}
house    房屋
{
  "code": "200",
  "message": "success",
  "data": {
     "records": [
            {
                "floorId": 50094378,
                "houseId": 14495160,
                "code": "",
                "name": "9栋_01单元_101",
                "unitId": 50094377,
                "buildId": 50094376,
                "projectId": 21291201,
                "floor": 1
            }]
  }
}
room    房间
{
  "code": "200",
  "message": "success",
  "data": {
     "records":[{

     }]
  }
}
pub        公共区域
{
  "code": "200",
  "message": "success",
  "data": {
     "records":[{
                "positionId": 50450469,
                "createTime": "2019-12-05T11:14:38.000+0000",
                "name": "公共区域1",
                "updateTime": "2019-12-05T11:29:17.000+0000",
                "subPositionType": 0, // 0公共区域，1公共区域位置
                "projectId": 21472136,
                "upPositionId": 50450452,
                "status": 0
            }]
  }
}
car-park 车场
{
  "code": "200",
  "message": "success",
  "data": {
     "records":[{
                "positionId": 50090177,
                "createTime": "2018-06-27T07:32:19.000+0000",
                "name": "君兰江山停车场",
                "updateTime": null,
                "subPositionType": 0, // 0 车场， 1车场区域
                "projectId": 610,
                "upPositionId": 1526,
                "status": 1
            }]
  }
}
parking    车位
{
  "code": "200",
  "message": "success",
  "data": {
     "records": [
            {
                "code": "0001",
                "name": "三区车位（13、14、15栋）--951",
                "placeId": 50110013,
                "parkingId": 50110014,
                "projectId": 21291201,
                "placeName": "体验馆车场一"
            }]
  }
}

5.2: 获取空间信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/space/query/info

方法：POST

请求参数

名称 位置 类型 必填 描述
typeCode BODY STRING 是 空间类型
spaceId BODY STRING 否 客户ID

请求Body描述(非Form表单数据)

{
  "typeCode": "",
  "spaceId": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
spaceStruct data JSONObject 是 空间信息
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     "spaceStruct": {

     }
  }
}

5.3: 创建空间

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/space/create

方法：POST

请求参数

名称 位置 类型 必填 描述
typeCode BODY STRING 是 空间类型
spaceStruct BODY JSONObject 是 空间信息
soueceCode BODY STRING 是 多租户Code

请求Body描述(非Form表单数据)

{
  "typeCode": "",
  "spaceStruct": {

     }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
spaceId data STRING 否 客户ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     "spaceId": ""
  }
}

5.4: 更新空间信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/space/update/info

方法：POST

请求参数

名称 位置 类型 必填 描述
typeCode BODY STRING 是 空间类型
spaceStruct BODY JSONObject 是 空间信息

请求Body描述(非Form表单数据)

{
  "typeCode": "",
  "spaceStruct": {

     }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {

  }
}

5.5: 删除空间信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/mid/space/delete

方法：POST

请求参数

名称 位置 类型 必填 描述
typeCode BODY STRING 是 空间类型
spaceId BODY STRING 否 客户ID

请求Body描述(非Form表单数据)

{
  "typeCode": "",
  "spaceId": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
     "spaceStruct": {

     }
  }
}

5.6: 更新数据状态

异常返回示例
{"code":"1501","message":""}

错误码列表(1501-1599)

错误码 错误信息 描述
1501 the organize not exists 组织不存在
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

results matching ""

    No results matching ""