出租屋信息管理系统二期接口文档Word文档格式.docx
《出租屋信息管理系统二期接口文档Word文档格式.docx》由会员分享,可在线阅读,更多相关《出租屋信息管理系统二期接口文档Word文档格式.docx(38页珍藏版)》请在冰豆网上搜索。
照片的URL地址,相对路径,就是数据库中保存的路径<
照片,没有为null<
publicbyte[]PDAGetimage(stringloginId,stringpassword,stringimageurl)
returnimage;
1.4参数说明
CMD:
为业务请求标识,根据标识的不同,实现不同的功能。
XMLParams:
不同的业务请求具有不同的参数,除登录名和密码之外的所有的参数以XML组织封装,都为string类型,结构如下:
<
CDATA>
<
param1description=”参数名,根据不同的参数有不同的名称,如userid、password等”>
XXX<
/param1>
param2description=”此参数的值”>
/param2>
……
/CDATA>
Image:
人员照片,没有时为null。
Imageurl:
照片的URL地址,相对路径,就是数据库中保存的路径
1.5返回值说明
以XML组织的返回,结构与参数类似,不同的请求具有不同的子节点:
param1description=”此节点说明”>
param2description=”此节点说明”>
返回byte[]型。
2接口一和二的详细请求与返回值
此接口中所有下接框(数据字典)的值,传递时都只传主键,不传中文。
2.1测试网络
●说明:
测试PDA与市办服务器网络是否连接正确
●调用接口:
PDAInterfaceXML
●CMD命令字:
Test
●参数:
Test<
●返回值:
OK<
2.2用户登录
验证用户合法性
Login
loginiddescription="
帐号"
admin<
/loginid>
passworddescription="
密码"
1234<
/password>
XML
successdescription="
登录是否成功,1为成功,0为失败"
1<
/success>
errmsgdescription="
错误信息"
/errmsg>
usernamedescription="
用户姓名"
test<
/username>
careadescription="
服务管理中心"
虎门镇<
/carea>
careaiddescription="
服务管理中心id"
1<
/careaid>
czonedescription="
服务站"
东山<
/czone>
czoneiddescription="
服务站id"
2<
/czoneid>
depttypedescription="
用户类型,1为市办,2镇区,3服务站"
/depttype>
2.3出租屋登记与修改
登记新出租屋
HouseInsert
●参数:
!
--以下是字段定义,主键统一使用fid-->
sbbfiddescription="
主键,为空时将会新建,不为空时执行修改操作"
/sbbfid>
mhddescription="
子命令,’create’为新建,’update’为更新"
/mhd>
登陆用户"
张三<
lessordescription="
出租人"
/lessor>
lessoridcdescription="
出租人身份证号"
/lessoridc>
lessorteldescription="
出租人电话"
/lessortel>
lessoraddrdescription="
出租人住址"
/lessoraddr>
managerdescription="
经营管理人"
/manager>
manageridcdescription="
经营管理人身份证号"
/manageridc>
managerteldescription="
经营管理人电话"
/managertel>
manageraddrdescription="
经营管理人住址"
/manageraddr>
lesseedescription="
承租人"
/lessee>
lesseeidcdescription="
承租人身份证号"
/lesseeidc>
lesseeteldescription="
承租人电话"
/lesseetel>
lesseeaddrdescription="
承租人住址"
/lesseeaddr>
itypedescription="
产权分类,1:
表一;
2:
表二"
/itype>
镇区"
镇区id"
streetdescription="
街道/路/巷"
/street>
sbbnodescription="
租赁证号"
/sbbno>
groupfiddescription="
村/居民小组"
/groupfid>
doorplatedescription="
门(楼)牌号"
/doorplate>
roomnodescription="
详址(房间号)"
/roomno>
framedescription="
房屋结构"
/frame>
roomcountdescription="
间数"
/roomcount>
bidepersonsdescription="
租住人数"
/bidepersons>
housetypedescription="
房屋类型,见数据字典"
/housetype>
buildareadescription="
建筑面积"
/buildarea>
selfareadescription="
自住面积"
/selfarea>
layercountdescription="
层数"
/layercount>
--layer1description="
一层,见数据字典"
/layer1-->
--layer2description="
二层以上,见数据字典"
/layer2-->
housekinddescription="
户型分类,见数据字典"
/housekind>
housedescdescription="
户型说明"
/housedesc>
emptypedescription="
重点户分类,见附件"
/emptype>
safehousenodescription="
安全文明出租屋编号"
/safehouseno>
thsmtypedescription="
三小出租屋,见数据字典"
/thsmtype>
thsmdescdescription="
三小屋说明"
/thsmdesc>
thsmoperatordescription="
三小屋联系人"
/thsmoperator>
thsmoperatorteldescription="
三小屋联系电话"
/thsmoperatortel>
isvideodescription="
是否安装监控"
/isvideo>
videofloordescription="
监控安装楼层,一层到五层"
/videofloor>
videopositiondescription="
安装位置"
/videoposition>
videocountdescription="
安装数量"
/videocount>
videodatedescription="
安装日期"
/videodate>
issafetydescription="
是否购买意外险"
/issafety>
safetyareadescription="
保险面积"
/safetyarea>
safetycountdescription="
被保人数"
/safetycount>
buysafedatedescription="
购买保险日期"
/buysafedate>
tractnodescription="
土地证编号"
/tractno>
housedroitnodescription="
房屋所有权证编号"
/housedroitno>
housedroitregdescription="
房屋所有权证登记证号"
/housedroitreg>
realtynodescription="
房地产权证编号"
/realtyno>
realtyregdescription="
房地产权证登记证号"
/realtyreg>
ishavebidedescription="
是否具备居住条件,见数据字典"
/ishavebide>
dipropertydisdescription="
是否有产权争议,见数据字典"
/dipropertydis>
housebycontractdescription="
商品买卖合同"
/housebycontract>
housesourcedescription="
房屋来源,见数据字典"
/housesource>
proverdescription="
证明人签名"
/prover>
groupideadescription="
村民小组意见"
/groupidea>
groupunderdescription="
组长签名"
/groupunder>
groupdatedescription="
组长签名日期"
/groupdate>
villageideadescription="
村委会主任意见"
/villageidea>
villageunderdescription="
主任签名"
/villageunder>
villagedatedescription="
主任签名日期"
/villagedate>
●返回值:
XML
操作是否成功,1为成功,0为失败"
0<
错误信息"
不具备操作权限<
2.4出租屋简要信息查询
通过组合查询条件,查询符合条件的所有出租屋列表,返回多条记录
HouseSelect
pagesizedescription="
用于分页时每页的显视记录条数"
15<
/pagesize>
currentpagedescription="
当前要查询的页码,从0开始"
/currentpage>
--以下只列出了具体要查询的字段,字段名请在上面已列出。
每次查询必须要传镇区和服务站的中文名称-->
letaddrdescription="
出租屋地址,是组合值,街道/路/巷+门牌/楼号+详址/房间号"
/letaddr>
出租人身份证"
房屋结构:
1-钢混;
2-砖混;
3-砖木;
4-简易"
房屋类型:
1-平房;
2-楼房;
3-商品房;
4-其它"
housekinddescription=”户型分类1:
一般户;
2:
安全文明出租屋;
3:
重点户”>
层数,大于0时有效"
房间数,大于0时有效"
三小出租屋类型1:
小娱乐场所2:
小作坊3:
小档口"
没有权限:
不具备权限<
allcountdescription="
总记录数"
/allcount>
没有记录:
有记录时:
100<
rowsdescription="
表示一条记录"
<
主键"
房屋租赁证编号"
HBO1234432452345345<
出租屋地址"
东城XXXXX<
isemphousedescription="
是否重点户,是为1,否为0"
/isemphouse>
/rows>
…………
2.5出租屋详细信息查询
通过房屋租赁证号,查询此出租屋详细信息,只返回一条记录
HouseSelectMore
租赁证号,没有sbbfid时,才使用sbbno查询"
租赁证FID,优先使用sbbfid作查询条件"
DataSet
--字段名称见出租屋登记模块,主键统一使用fid-->
layer1description="
/layer1>
layer2description="
/layer2>