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

alipay.eco.cplife.community.batchquery (批量查询支付宝小区编号)

开发者批量查询自己帮助物业创建成功的小区编号列表

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.cplife.community.batchquery
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
status String 可选 32 如传入该参数,则返回指定状态的小区,支持的状态值:
PENDING_ONLINE 待上线
ONLINE - 上线
MAINTAIN - 维护中
OFFLINE - 下线

不传该值则默认返回所有状态的小区。
ONLINE
page_num Number 可选 8 分页查询的当前页码数,分页从1开始计数。
该参数不传入的时候,默认为1。
2
page_size Number 可选 8 分页查询的每页最大数据条数,取值范围1-500。
不传该参数默认为200。
300

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
current_page_num Number 必填 8 当前页码 1
total_community_count Number 必填 8 开发者帮助物业创建成功并符合查询条件的小区总数。
若不传入app_auth_token参数,则返回开发者代创建成功的所有小区总数。
若传入app_auth_token参数,则返回对应开发者帮助该授权物业公司创建成功的小区总数。
123
community_list CPCommunitySet [] 选填 - 若查询到符合条件的小区,返回物业小区摘要信息列表
  • └ community_id
  • String
  • 必填
  • 32
  • 支付宝社区小区统一编号。
  • AJ5OFJC124403
  • └ merchant_pid
  • String
  • 必填
  • 32
  • 小区对应的物业公司支付宝账号PID(合作伙伴partner id)。物业公司给开发者做第三方应用授权后,开发者可获取物业公司PID。
  • 2088501624560333
  • └ status
  • String
  • 必填
  • 64
  • 小区当前状态,状态值:
    PENDING_ONLINE 待上线
    ONLINE - 上线
    MAINTAIN - 维护中
    OFFLINE - 下线
  • OFFLINE
  • └ out_community_id
  • String
  • 选填
  • 32
  • 小区在物业系统中的唯一编号。若开发者传入过,则返回。
  • 123456

请求示例

  • 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");
AlipayEcoCplifeCommunityBatchqueryRequest request = new AlipayEcoCplifeCommunityBatchqueryRequest();
request.setBizContent("{" +
"\"status\":\"ONLINE\"," +
"\"page_num\":2," +
"\"page_size\":300" +
"  }");
AlipayEcoCplifeCommunityBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_eco_cplife_community_batchquery_response":{
		"msg":"Success",
		"community_list":[
			{
				"merchant_pid":"2088501624560333",
				"community_id":"AJ5OFJC124403",
				"out_community_id":"123456",
				"status":"OFFLINE"
			}
		],
		"code":"10000",
		"total_community_count":123,
		"current_page_num":1
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误。 检查请求参数,修改后重新发起请求。
SYSTEM_ERROR 系统繁忙 稍后重试。
INVALID_STATUS 传入的状态值不合法。 请参考接口文档确认传入的状态值是否在支持范围内。
INVALID_PAGE_SIZE 分页查询的每页最大记录条数非法。 如传入page_size,page_size的有效取值范围为1~500。请修改后重试。
INVALID_PAGE_NUM 传入的页码非法,页码需从1开始计数。 如传入页码,需从1开始计数,请修改并重试。

公共错误码

返回
顶部