文档中心 > API类目 > 开放生态API

alipay.eco.renthouse.room.dispersion.sync (分散式(整租/合租)房源同步)

新增/编辑分散式房源

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.renthouse.room.dispersion.sync
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
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_code String 必须 11 小区Code和小区请求号必输入其一
小区Code,详见文档
http://ecopublic.oss-cn-hangzhou.aliyuncs.com/eco/tpmogo/CommunityInfos/CommunityInfos.xls
530023
room_code Number 必须 10 KA内部存储的房源编号 4003
floor_count Number 必须 2 所在楼层 数值范围:1-99,不能大于房屋总楼层 23
total_floor_count String 必须 2 房屋总楼层
数值范围:1-99,不能小于所在楼层
21
flat_building String 必须 6 门牌-栋(楼号) 2
flat_unit String 可选 6 门牌-单元 1
room_num String 必须 6 门牌-室 201
room_name String 可选 1 分散式合租房间内对应每个卧室名称。A_Z字母之一表示。
根据rent_type区分是否必填,合租必填,整租否。
A
ali_short_num String 可选 20 阿里短号 阿里短号:17011111111
room_face Number 可选 1 分散式合租房间内对应每个卧室朝向
根据rent_type区分是否必填,合租必填,整租否。
1:东 2:南 3:西 4:北 5:东南 6:东北 7:西南 8:西北
comm_req_id String 可选 11 小区同步请求号 小区同步接口返回值
bedroom_count Number 必须 2 户型-房
数值范围:1-26
2
parlor_count Number 必须 2 户型-厅
数值范围:0-10
2
toilet_count Number 必须 2 户型-卫
数值范围:0-10
2
flat_area String 必须 6 公寓面积 数值范围:5.00㎡-300.00㎡,支持小数点后面2位 120
room_area String 必须 6 房间面积 数值范围:5.00㎡-300.00㎡,支持小数点后面2位 120.00
rent_status Number 必须 1 出租状态 数值范围:1未租、2已租 1
intro String 可选 400 房源描述 好房
flat_configs String [] 可选 100 分散式合租公共区域物品配置,分散式整租不用设置
1:WIFI;3:热水器;4:洗衣机;5:冰箱;6:电视;7:微波炉;8:燃气灶;9:抽油烟机;10:电磁炉;14:沙发;
1
room_configs String [] 可选 100 分散式房间物品配置:
分散式整租房间配置
2:空调;3:热水器;4:洗衣机;5:冰箱;6:电视;7:微波炉;8:燃气灶;9:抽油烟机;10:电磁炉;11:床;11:WIFI;12:书桌;13:衣柜;14:沙发;15:阳台;
分散式合租房间配置
2:空调;6:电视;11:床;12:书桌;13:衣柜;15:阳台;16:独卫;
2
pay_type Number 必须 2 付款方式-付
1:付一,2:付二
1
room_amount Price 必须 8 租金 数值范围:¥100.00 - ¥35000.00 ,支持小数点后面2位 100.00
foregift_amount Price 必须 9 押金 数值范围:0-¥420000.00 1000
other_amount EcoRenthouseOtherAmount [] 可选 - 其它费用
  • └ name
  • String
  • 可选
  • 15
  • 费用名称
  • 门卡费
  • └ amount
  • Price
  • 可选
  • 8
  • 30
  • 费用金额
  • └ unit
  • String
  • 可选
  • 5
  • 费用单位
free_begin_date String 可选 10 免押金开始时间 YYYY-MM-dd 2017-03-10
free_end_date String 可选 10 免押金结束时间 YYYY-MM-dd 2017-08-10
images String [] 必须 4000 通过"文件上传"接口返回的房源图片url路径。房间照片可录入0~10张,目前仅支持jpg、png、jpeg格式 ["http://ecopublic-dev.img-cn-hangzhou.aliyuncs.com/PicSerTest/pic/uploadPicTest.jpg"]
owners_name String 必须 15 管家姓名 sam
owners_tel String 必须 20 管家手机号码,必须为400开头 400-xxxxx
checkin_time String 必须 10 可入住时间 YYYY-MM-DD 2010-10-08
room_status Number 可选 1 房源初始上下架状态
上架状态租房平台会展示该房间信息,下架状态反之
1:上架 0:下架
rent_type Number 必须 1 出租类型 1:整租,2:合租 1

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值

请求示例

  • 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");
AlipayEcoRenthouseRoomDispersionSyncRequest request = new AlipayEcoRenthouseRoomDispersionSyncRequest();
request.setBizContent("{" +
"\"community_code\":\"530023\"," +
"\"room_code\":4003," +
"\"floor_count\":23," +
"\"total_floor_count\":\"21\"," +
"\"flat_building\":\"2\"," +
"\"flat_unit\":\"1\"," +
"\"room_num\":\"201\"," +
"\"room_name\":\"A\"," +
"\"ali_short_num\":\"阿里短号:17011111111\"," +
"\"room_face\":1.00," +
"\"comm_req_id\":\"小区同步接口返回值\"," +
"\"bedroom_count\":2," +
"\"parlor_count\":2," +
"\"toilet_count\":2," +
"\"flat_area\":\"120\"," +
"\"room_area\":\"120.00\"," +
"\"rent_status\":1," +
"\"intro\":\"好房\"," +
"      \"flat_configs\":[" +
"        \"1\"" +
"      ]," +
"      \"room_configs\":[" +
"        \"2\"" +
"      ]," +
"\"pay_type\":1," +
"\"room_amount\":100.00," +
"\"foregift_amount\":1000," +
"      \"other_amount\":[{" +
"        \"name\":\"门卡费\"," +
"\"amount\":1.00," +
"\"unit\":\"元\"" +
"        }]," +
"\"free_begin_date\":\"2017-03-10\"," +
"\"free_end_date\":\"2017-08-10\"," +
"      \"images\":[" +
"        \"[\\\"http://ecopublic-dev.img-cn-hangzhou.aliyuncs.com/PicSerTest/pic/uploadPicTest.jpg\\\"]\"" +
"      ]," +
"\"owners_name\":\"sam\"," +
"\"owners_tel\":\"400-xxxxx\"," +
"\"checkin_time\":\"2010-10-08\"," +
"\"room_status\":1.00," +
"\"rent_type\":1" +
"  }");
AlipayEcoRenthouseRoomDispersionSyncResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_eco_renthouse_room_dispersion_sync_response":{
		"msg":"Success",
		"code":"10000"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误参数无效 检查输入参数的正确性
REPEAT_ROOM 您当前录入的房源已存在于系统中 您当前录入的房源已存在于系统中 "整租房源检查小区名+行政区+门牌号(门牌-栋、门牌-单元、门牌-室)是否重复 合租房源检查小区名+行政区+门牌号(门牌-栋、门牌-单元、门牌-室)+合租房间号是否重复"
INVALID_ROOMFLOORCOUNT 所在楼层数不能大于总楼层数 所在楼层数不能大于总楼层数
INVALID_COMMUNITYCODE 小区编码错误 录入正确的小区编码
OVER_ROOMCOUNT 同一房源录入的合租房间信息过多,最大支持26间 合租房源单间个数不能超过26间
EXIST_ROOMNUM 房间号已经被占用,请检查数据 合租房源单间房间号不能重复
INVALID_IMAGEURL 图片地址不合法 使用支付宝租房平台提供的文件上传链接
INVALID_IMAGETYPE 图片格式不正确,仅支持jpg、png、jpeg格式 输入正确的图片格式
INVALID_ROOMAREA 您录入的房间面积与整套房源总面积存在较大出入,请核对后重新输入 合租房源所有单间面积之和不能超过总套面积的35%
INVALID_FREEDATE 免押金开始结束时间不合理 输入合理的时间

公共错误码

返回
顶部