文档中心 > API类目 > 社区物业API

alipay.eco.cplife.roominfo.query (查询小区房屋信息列表)

开发者调用该接口查询之前帮助物业公司上传的小区房屋信息列表

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.cplife.roominfo.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 256 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
community_id String 必须 32 传入该小区在支付宝社区物业平台中的唯一编号,通过小区创建和查询接口获取。 AJ5OFJC443301
page_num Number 可选 8 分页查询的页码数,分页从1开始计数。该参数不传入的时候,默认为1 1
page_size Number 可选 8 分页查询的每页最大数据条数。默认为200 100

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
total_room_number Number 必填 10 该小区下已上传的房间总数 2000
room_info CplifeRoomDetail [] 选填 - 符合条件的小区房屋信息列表.
  • └ out_room_id
  • String
  • 必填
  • 64
  • 商户系统小区房屋唯一ID标示.
  • 20160427110001006778440713
  • └ room_id
  • String
  • 必填
  • 64
  • 支付宝系统房间唯一标示.
  • APCN4644RON5113220100102
  • └ group
  • String
  • 选填
  • 32
  • 房屋所在的组团名称。例如“一期”,“东区”,“香桂苑”等
  • 一期
  • └ building
  • String
  • 选填
  • 32
  • 房屋所在楼栋名称。例如“1栋”,“1幢”等
  • 1栋
  • └ unit
  • String
  • 选填
  • 32
  • 房屋所在单元名称。例如“一单元”,“二单元”等
  • 1单元
  • └ room
  • String
  • 选填
  • 64
  • 房屋所在房号。例如“1101室”,“11B室”等
  • 1101室
  • └ address
  • String
  • 选填
  • 128
  • 房间完整门牌地址
  • 一期2栋1单元2202室

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEcoCplifeRoominfoQueryRequest request = new AlipayEcoCplifeRoominfoQueryRequest();
request.setBizContent("{" +
"\"community_id\":\"AJ5OFJC443301\"," +
"\"page_num\":1," +
"\"page_size\":100" +
"  }");
AlipayEcoCplifeRoominfoQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_eco_cplife_roominfo_query_response":{
		"msg":"Success",
		"code":"10000",
		"total_room_number":2000,
		"room_info":[
			{
				"room_id":"APCN4644RON5113220100102",
				"unit":"1单元",
				"address":"一期2栋1单元2202室",
				"out_room_id":"20160427110001006778440713",
				"building":"1栋",
				"room":"1101室",
				"group":"一期"
			}
		]
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

  • JSON示例
{
	"alipay_eco_cplife_roominfo_query_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误。 根据接口文档校验并修改参数后重新请求。
SYSTEM_ERROR 系统繁忙 请稍后重试。
COMMUNITY_NOT_EXISTING 请求的支付宝小区编号在指定的物业账号名下不存在 请通过小区查询接口确认授权物业公司账号名下是否存在该小区编号。请修改小区编号并重试。
INVALID_PAGE_SIZE 分页查询的每页最大记录条数非法。 如传入page_size,page_size的有效取值范围为1~500。请修改后重试。
INVALID_PAGE_NUM 传入的页码非法,页码需从1开始计数。 如传入页码,需从1开始计数,请修改并重试。

公共错误码

返回
顶部