文档中心 > API类目 > 智慧园区API

alibaba.campus.device.openapi.getsimpledevice (获取单个设备的基础信息(仅包含设备id,code,是否启用,位置信息,描述等基础信息))

获取指定设备的基础信息(仅包含设备id,code,是否启用,位置信息,描述等基础信息)

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	描述
work_bench_context	WorkBenchContext	必须		请求发送端信息
└ company_id Number 可选 10000 所属公司 └ campus_id Number 必须 100001 所属园区id
uuid	String	必须	67d1d4b8-eefb-4b83-b7ef-c5b2a1f17bba	设备uuid

响应参数

名称	类型	示例值	描述
result	PojoResult		返回对象
content DeviceStandardApiDto [] 设备基础信息 └ code String 物理设备-测试设备code └ campus_name String 滨江园区园区名称 └ campus_id Number 100002 园区id └ building_name String 1号楼楼宇名称 └ building_id Number 100009 楼宇id └ floor_name String 1F 楼层名称 └ floor_id Number 100049 楼层id └ space_name String 会议室空间单元名称 └ space_id Number 100045 空间单元id └ longitude String 120.0283358 经度 └ latitude String 30.2782495 纬度 └ be_logic Boolean false 是否逻辑设备 └ template_code String BrakeMachine 设备模板code └ template_id Number 110 设备模板id └ uuid String 67d1d4b8-eefb-4b83-b7ef-c5b2a1f17bba 设备uuid └ device_id String 67d1d4b8-eefb-4b83-b7ef-c5b2a1f17bba 设备id └ be_run Boolean true 是否启用 └ nickname String 测试设备别名设备别名 └ run_status Number 0 设备运行状态 └ request_id String null 请求id └ error_code String 200 errorCode └ error_msg String null 错误信息 └ success Boolean true 是否成功

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCampusDeviceOpenapiGetsimpledeviceRequest req = new AlibabaCampusDeviceOpenapiGetsimpledeviceRequest();
AlibabaCampusDeviceOpenapiGetsimpledeviceRequest.WorkBenchContext obj1 = new AlibabaCampusDeviceOpenapiGetsimpledeviceRequest.WorkBenchContext();
obj1.setCompanyId(10000L);
obj1.setCampusId(100001L);
req.setWorkBenchContext(obj1);
req.setUuid("67d1d4b8-eefb-4b83-b7ef-c5b2a1f17bba");
AlibabaCampusDeviceOpenapiGetsimpledeviceResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<alibaba_campus_device_openapi_getsimpledevice_response>
    <result>
        <content>
            <code>物理设备-测试</code>
            <campus_name>滨江园区</campus_name>
            <campus_id>100002</campus_id>
            <building_name>1号楼</building_name>
            <building_id>100009</building_id>
            <floor_name>1F</floor_name>
            <floor_id>100049</floor_id>
            <space_name>会议室</space_name>
            <space_id>100045</space_id>
            <longitude>120.0283358</longitude>
            <latitude>30.2782495</latitude>
            <be_logic>false</be_logic>
            <template_code>BrakeMachine</template_code>
            <template_id>110</template_id>
            <uuid>67d1d4b8-eefb-4b83-b7ef-c5b2a1f17bba</uuid>
            <device_id>67d1d4b8-eefb-4b83-b7ef-c5b2a1f17bba</device_id>
            <be_run>true</be_run>
            <nickname>测试设备别名</nickname>
            <run_status>0</run_status>
        </content>
        <request_id>null</request_id>
        <error_code>200</error_code>
        <error_msg>null</error_msg>
        <success>true</success>
    </result>
</alibaba_campus_device_openapi_getsimpledevice_response>

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

智慧园区API

alibaba.campus.device.openapi.getsimpledevice (获取单个设备的基础信息(仅包含设备id,code,是否启用,位置信息,描述等基础信息))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ