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

alipay.eco.cplife.community.modify (变更物业小区信息)

开发者通过该接口帮助物业公司或其他小区管理主体变更其所管理的小区信息。

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.cplife.community.modify
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 支付宝社区小区统一编号,必须在物业账号名下存在。 AJ5OFJC124403
community_name String 可选 32 小区名称,最长不超过32个字符。 金海湾花园
community_address String 可选 128 小区主要详细地址,不需要包含省市区名称。 福荣路46号
district_code String 可选 10 区县编码,国标码,详见国家统计局数据 点此下载 440304
city_code String 可选 10 地级市编码,国标码,详见国家统计局数据 点此下载 440300
province_code String 可选 10 省份编码,国标码,详见国家统计局数据 点此下载 440000
community_locations String [] 可选 150 小区所在的经纬度列表(注:需要是高德坐标系),每对经纬度用"|"分隔,经度在前,纬度在后,经纬度小数点后不超过6位。

注:若新建的小区覆盖多个片区,最多包含5组经纬度,其中第一组作为主经纬度。

经纬度是小区搜索和用户推广的重要参数,录入时请确保经纬度参数准确。
高德经纬度查询接口:http://lbs.amap.com/api/webservice/guide/api/search/

高德坐标系转换接口:http://lbs.amap.com/api/webservice/guide/api/convert/
114.032395|22.519725,114.032469|22.519336
associated_pois String [] 可选 160 若开发者录入的物业小区需要精确对应地图上多个小区(比如物业系统中的小区包含类似一期二期、或东区西区的组团结构),以便后续线上推广时覆盖到对应小区的住户,可以指定关联的高德地图中住宅、住宿或地名地址等小区相关类型的POI(地图兴趣点)ID列表。
若传入该参数且参数值合法,则该参数的优先级高于传入的地理位置经纬度。

注:最多包含10组poiid。

高德POI ID的获取接口:
http://lbs.amap.com/api/webservice/guide/api/search/
B02F37VVFP,B0FFFQB4Y4
hotline String 可选 20 需要提供物业服务热线或联系电话,便于用户在需要时联系物业。 0571-87654321
out_community_id String 可选 32 小区在物业系统中的唯一编号。 12345

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
status String 选填 64 若小区信息变更成功,则返回当前状态。 OFFLINE
next_action String 选填 64 小区变更成功后,若从当前状态到下一状态需要完成下一步条件代码。则返回该字段,否则不返回。
格式为“条件代码|操作主体”。
操作主体有:
INVOKER - 接口调用方
MERCHANT - 物业公司
AUDITOR - 平台审核方
条件代码包括但不限于:
WAIT_SERVICE_PROVISION - 等待基础服务初始化
WAIT_PROD_VERIFICATION - 等待在生产环境通过自测
WAIT_ONLINE_APPLICATION - 等待提起上线申请
WAIT_OFFLINE_APPLICATION - 等待提起下线申请
WAIT_CONFIRMATION - 等待相关方确认
WAIT_AUDITING - 等待审核
WAIT_SERVICE_PROVISION|INVOKER

请求示例

  • 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");
AlipayEcoCplifeCommunityModifyRequest request = new AlipayEcoCplifeCommunityModifyRequest();
request.setBizContent("{" +
"\"community_id\":\"AJ5OFJC124403\"," +
"\"community_name\":\"金海湾花园\"," +
"\"community_address\":\"福荣路46号\"," +
"\"district_code\":\"440304\"," +
"\"city_code\":\"440300\"," +
"\"province_code\":\"440000\"," +
"      \"community_locations\":[" +
"        \"114.032395|22.519725\",\"114.032469|22.519336\"" +
"      ]," +
"      \"associated_pois\":[" +
"        \"B02F37VVFP\",\"B0FFFQB4Y4\"" +
"      ]," +
"\"hotline\":\"0571-87654321\"," +
"\"out_community_id\":\"12345\"" +
"  }");
AlipayEcoCplifeCommunityModifyResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_eco_cplife_community_modify_response":{
		"msg":"Success",
		"code":"10000",
		"next_action":"WAIT_SERVICE_PROVISION|INVOKER",
		"status":"OFFLINE"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误。 检查请求参数,修改后重新发起请求。
SYSTEM_ERROR 系统繁忙 系统可能还在处理中,请稍后调用查询单个物业小区信息接口确认小区是否处理成功。若未成功,请稍后重试。
COMMUNITY_NOT_EXISTING 请求的小区编号在当前物业账号名下不存在。 请通过小区查询接口确认授权物业公司账号名下是否存在该小区编号。请修改小区编号并重试。
INCONSISTENT_LOCATIONS 提交的小区地址与地理位置差距太大,请修改 调整小区地址、经纬度或关联的高德POIID,重新创建。
INVALID_AREACODE 省、市、区国标码不合法。 检查省市区编码填写是否正确,修改并重试。
OUT_COMMUNITY_ID_NONUNIQUE 传入的物业小区编号已被当前物业使用,请修改。 调用小区查询接口确认小区编号唯一性,修改并重试。
INVALID_POIID 高德poiid不合法或不存在,请修改。 请调用高德接口校验并获取实际存在的高德poiid,修改并重试。
INVALID_COMMUNITY_LOCATIONS 小区地理位置经纬度格式非法,请修改。 传入的小区地理位置经纬度格式非法,请查看接口文档说明,修改请重试。
INVALID_HOTLINE 物业服务热线电话格式非法,请修改。 请使用国内电话格式,修改并重试。
POIIDS_EXCEED_MAX_NUM 传入的poiid个数超过上限 请按照接口文档减少poiid个数,只保留住宅区等相关类型的poi的id,修改并重试。
LOCATIONS_EXCEED_MAX_NUM 传入的经纬度个数超过上限 请按照文档减少经纬度个数并重试。

公共错误码

返回
顶部