有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: weilingwith.tencentcloudapi.com 。

查询空间分类

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSpaceTypeList。
Version String 公共参数,本接口取值:2023-04-27。
Region String 公共参数,详见产品支持的 地域列表
WorkspaceId String 项目空间ID
示例值:"1124"
PageNumber Integer 页码
示例值:1
PageSize Integer 页容量
示例值:10
ApplicationToken String 应用token
示例值:"Sl5ZDmVuHzhN52o8n1KWagl7sLdrLfN7"

3. 输出参数

参数名称 类型 描述
Result SpaceTypeListRes 空间分类列表出参
示例值:{ "SpaceTypeList": [ { "SpaceTypeCode": "DIANTIJIAN", "SpaceTypeName": "电梯间" }, { "SpaceTypeCode": "LOUTIJIAN", "SpaceTypeName": "楼梯间" }, { "SpaceTypeCode": "WODEFANGJIAN", "SpaceTypeName": "我的房间" }, { "SpaceTypeCode": "XIUXISHI", "SpaceTypeName": "休息室" } ] }
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询空间分类

查询空间分类成功响应示例

输入示例

POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSpaceTypeList
<公共请求参数>

{
    "WorkspaceId": "1016",
    "PageNumber": 1,
    "PageSize": 10,
    "ApplicationToken": "ZRCJHdnhqEUEqO1vyskCgWimPucHhREV"
}

输出示例

{
    "Response": {
        "RequestId": "dbb6362d-4e7c-459f-a6e9-ecef04842722",
        "Result": {
            "SpaceTypeList": [
                {
                    "SpaceTypeCode": "CESHILEIXING",
                    "SpaceTypeName": "测试类型"
                },
                {
                    "SpaceTypeCode": "HAHAHA",
                    "SpaceTypeName": "哈哈哈"
                }
            ]
        }
    }
}

示例2 查询空间分类示例-prod

查询空间分类示例-prod

输入示例

POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSpaceTypeList
<公共请求参数>

{
    "WorkspaceId": "1124",
    "PageNumber": 1,
    "PageSize": 10,
    "ApplicationToken": "Sl5ZDmVuHzhN52o8n1KWagl7sLdrLfN7"
}

输出示例

{
    "Response": {
        "RequestId": "21770e5e-a17e-4023-8cc9-51129f6cd37a",
        "Result": {
            "SpaceTypeList": [
                {
                    "SpaceTypeCode": "DIANTIJIAN",
                    "SpaceTypeName": "电梯间"
                },
                {
                    "SpaceTypeCode": "LOUTIJIAN",
                    "SpaceTypeName": "楼梯间"
                },
                {
                    "SpaceTypeCode": "WODEFANGJIAN",
                    "SpaceTypeName": "我的房间"
                },
                {
                    "SpaceTypeCode": "XIUXISHI",
                    "SpaceTypeName": "休息室"
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.BIMAppInternalError BIM服务内部错误
InvalidParameterValue.InvalidElementIdOrProjectId 项目id或构件id取值错误
ResourceNotFound.ElementNotFound 未查询到构件信息