出租屋信息管理系统二期接口文档

1、出租屋信息管理系统二期接口文档V1.01接口定义1.1说明为了方便接口的统一和方便的使用，所有功能都采用两个固定接口来实现，通过功能标识 (CMD来区别不同的业务请求1.2接口类型WebService 接口。此接口由中大出租屋信息管理系统提供，灵动出租屋信息管理系统二期调用。1.3接口原型接口一：/ / 所有功能集中在一个接口里，通过CM区别是实现什么功能/ / vparam name=loginld 登录帐号 / vparam name=password 登录密码 / vparam name=CMD于区别实现什么功能的命令字/ vparam name=XMLParams以XM组织的除登录名和

2、密码之外的参数/ vparam name=image 照片，没有为 null / vreturns xml格式 v/returnspublic string PDAInterfaceXML( string loginld, string password, string CMD, string XMLParams, byte image)return xmlstring;接口二：/ vsummaryIll根据URL取得照片III Ill vparam name=loginld登录帐号 Ill vparam name=password 登录密码 Ill vparam name=imageurl

3、照片的UR地址，相对路径，就是数据库中保存的路径Ill vreturns 照片，没有为 null vlreturnspublic byte PDAGetimage( string loginld,string password, string imageurl)return image;1.4参数说明接口CMD为业务请求标识，根据标识的不同，实现不同的功能。XMLParams不同的业务请求具有不同的参数，除登录名和密码之外的所有的参数以XM组织封装，都为stri ng类型，结构如下：vCDATAvparaml description= ”参数名，根据不同的参数有不同的名称 ，如userid、p

4、assword等”XXX param2 description= ” 此参数的值 ”XXXXXXv/param1 vparam2 description= ” 此节点说明 ”XXXv/param2 vl CDATA接口二：返回byte型。2接口一和二的详细请求与返回值此接口中所有下接框（数据字典）的值，传递时都只传主键，不传中文。2.1测试网络说明：测试PDA与市办服务器网络是否连接正确调用接口： PDAI ntefaceXMLCMD命令字：Test参数：CDATATest CDATA返回值：CDATAOKCDATA2.2用户登录说明：验证用户合法性调用接口： PDAI ntefaceXMLC

5、MD命令字：Login参数：vCDATAVoginiddescription =帐号admin1234/ CDATA返回值：XMLCDATA1test 虎门镇 1 东山 2 / CDATA2.3出租屋登记与修改说明：登记新出租屋调用接口： PDAI ntefaceXMLCMD 命令字：Houselnsert 参数：vCDATAvsbbfid description =主键，为空时将会新建,不为空时执行修改操作1 v/sbb fid vmhd description= 子命令， reate 为新建pdate 为更新v/mhdvusername description =登陆用户 张三 vless

6、oridcdescription=出租人身份证号 vlessorteldescription=出租人电 话vlessoraddr description =出租人住 址 vmanager description =经营管理人v/manager vmanageridc description =经营管理人身份证号 v/ manageridc vmanagertel description =经营管理人电 话v/managertel vmanageraddr description=经营管理人住 址v/ manageraddrvlessee description =承租人v/ lessee vl

7、esseeidc description =承租人身份证号 v/ lesseeidc vlesseetel description =承租人电 话v/ lesseetel vlesseeaddr description =承租人住 址v/lesseeaddr vitype description=产权分类,1:表一；2：表二v/ itype vcarea description =镇区v/ carea vcareaid description =镇区 id v/careaid vczone description =服务站v/ czone vczoneid description =服务站 i

8、d v/ czoneid vstreet description =街道 / 路/ 巷v/ street vsbbno description=租赁证号v/sbbnovgroupfid description=村/ 居民小组v/groupfid vdoorplate description=门（楼）牌号v/ doorplate vroomno description =详址（房间号）v/ roomno vframe description=房屋结构v/frame vroomcount description =间 数v/ roomcount vbidepersons description =

9、租住人数 v/ bidepersons vhousetype description =房屋类型,见数据字典 v/ housetype vbuildarea description =建筑面积v/buildarea vselfarea description =自住面积v/ selfarea vlayercount description =层 数v/layercount vhousekind description =户型分类，见数据字典v/housekind vhousedesc description =户型说明v/housedesc vemptype description =重点户分

10、类,见附件v/ emptype vsafehouseno description =安全文明出租屋编号v/safehouseno v/thsmtype vthsmoperator description =三小屋联系人 vthsmoperatortel description=三小屋联系电话 visvideo description =是否安装监控 vvideofloor description =监控安装楼层 ,一层至U五层 vvideoposition description =安装位置 vvideocount description=安装数量v/ videocount vvideodat

11、e description=安装日期 v/videodate vissafety description =是否购买意夕卜险 v/ issafety vsafetyarea description =保险面积 v/ safetyarea vsafetycount description =被保人数 v/ safetycount vbuysafedate description=购买保险日期 v/ buysafedate vtractno description = 土地证编号v/tractno vhousedroitno description =房屋所有权证编号v/ housedroitno

12、 vhousedroitreg description =房屋所有权证登记证号 v/housedroitreg vrealtyno description =房地产权证编号 v/ realtyno vrealtyreg description=房地产权证登记证号 v/ realtyreg vishavebide description=是否具备居住条件，见数据字典v/ishavebide vdipropertydis description =是否有产权争议 ,见数据字典 v/dipropertydis vhousebycontract description =商品买卖合同v/houseby

13、contract vhousesource description =房屋来源,见数据字典 v/ housesource vprover description=证明人签名v/ prover vgroupidea description=村民小组意见v/groupidea vgroupunder description=组长签名 v/groupunder vgroupdate description=组长签名日期 v/groupdate vvillageidea description=村委会主任意见 v/villageidea vvillageunder description =主任签名v

14、/ villageunder vvillagedate description=主任签名日期 v/ villagedate v/ CDATA返回值：XMLvCDATAvsuccess description=操作是否成功，1 为成功，0为失败0v/success verrmsg description = 错误信息 不具备操作权限 v/ errmsg v/ CDATA2.4出租屋简要信息查询说明：通过组合查询条件，查询符合条件的所有出租屋列表，返回多条记录调用接口： PDAI ntefaceXML CMD 命令字：HouseSelect 参数： vCDATA150 !-以下只列岀了具体要查询的

15、字段，字段名请在上面已列岀。每次查询必须要传镇区和服务站的中文名称carea descriptionczone description=服务站=租赁证号vletaddr description =出租屋地址，是组合值，街道/路/巷+门牌/楼号+详址/房间号Vessor description =出租人vlessoridc description =出租人身份证 vframe description =房屋结构：1 钢混；2砖混；3砖木；4 简易vhousetype description =房屋类型：1 平房；2楼房；3商品房；4其它 vhousekind description= ”户型分类

16、1 ： 一般户；2 :安全文明出租屋；3 :重点户Vayercount description =层数，大于 0时有效vroomcountdescription =房间数,大于 0时有效vthsmtype description =三小出租屋类型 1 ：小娱乐场所 2 :小作坊 3 :小档口 visvideo description=是否安装监控 v/ isvideo v/ CDATA返回值:XML没有权限：vCDATAvsuccess description=操作是否成功，1 为成功，0为失败0v/success verrmsg description = 错误信息不具备权限 v/ errm

17、sg vallcount description =总记录数0v/ allcount v/ CDATA没有记录：vCDATAvsuccess description =操作是否成功，1 为成功，0为失败1v/success verrmsg description = 错误信息 v/ errmsg vallcount description =总记录数0v/ allcount v/ CDATA有记录时：1verrmsg description = 错误信息vallcount description=总记录数100vrows description =表示一条记录vsbbfid descripti

18、on =主键1vsbbno description =房屋租赁证编号HBO1234432452345345：/sbbnoVetaddrdescription =出租屋地址 东城 XXXXX/ letaddr Vessor description =出租人 张三 v/ lessor visemphouse description =是否重点户，是为 1，否为 00v/ isemphouse v/ rows v/ CDATA2.5出租屋详细信息查询说明：通过房屋租赁证号，查询此出租屋详细信息，只返回一条记录调用接口： PDAI nterfaceXMLCMD 命令字：HouseSelectMore参

19、数：vCDATAvsbbno description =租赁证号，没有 sbbfid 时，才使用 sbbno查询v/sbbno vsbbfid description =租赁证 FID，优先使用 sbbfid 作查询条件v/sbb fid v/ CDATA返回值:DataSet没有权限：vCDATAvsuccess description =操作是否成功，1 为成功，0为失败0v/success verrmsg description = 错误信息不具备权限 v/ errmsg v/ CDATA没有记录:vCDATAvsuccess description=操作是否成功，1为成功，0为失败1v

20、/success verrmsg descriptionv/ CDATA=错误信息不具备权限 v/errmsg有记录时:vCDATAv!-字段名称见岀租屋登记模块，主键统一使用fid -vsuccess description=操作是否成功，1 为成功，0为失败1v/success vsbbfid description =主键1张三 Vessoridc description =出租人身份证号 Vessortel description =出租人电 话 Vessoraddr description =出租人住 址 Vessee description =承租人Vesseeidc descri

21、ption =承租人身份证号 Vesseetel description =承租人电 话 Vesseeaddr description =承租人住 址Vtype description =产权分类,1:表一；2 :表二 Vayercount description =层 数Vayer1 description =一 层，见数据字典Vayer2 description =二层以上,见数据字典 Vhsmtype description=三小出租屋,见数据字典Vhsmdesc description=三小屋说明 Vhsmoperatordescription =三小屋联系人Vhsmoperatort

22、el description=三小屋联系电话 Vsvideodescription =是否安装监控 Vssafetydescription=是否购买意夕卜险 Vshavebidedescription =是否具备居住条件，见数据字典/ CDATA2.6出租屋删除（注销）说明：删除（注销）出租屋调用接口： PDAI nterfaceXMLCMD 命令字：HouseDelete参数：CDATA / CDATA返回值:XMLCDATA1 / CDATA2.7出租屋动态信息添加与修改说明：登记重点户动态信息调用接口： PDAI ntefaceXMLCMD 命令字：HouseDTInsert参数：vCD

23、ATA vmhd description= vcarea description =镇区 vcareaid description =镇区 id vczone description =服务站 vczoneid description =服务站 id vsbbno description=房屋租赁证编号 v/ sbbnovletaddr description =出租屋地址 v/ letaddr vrelperson description =相关人员 v/ relperson vrelpersonidc description=相关人员身份证 v/ relpersonidc vproblem

24、type description=发现的问题分类 v/ problemtype vproblemdesc description=问题描述 v/ problemdesc veventdesc description =具体事件 v/ eventdesc vzoneactor description =服务站处理人 v/ zoneactor vzonetrandate description=处理日期 v/ zonetrandate v/ CDATA返回值:XMLvCDATAvsuccess description =操作是否成功，1 为成功，0为失败1v/success verrmsg des

25、cription = 错误信息 v/ errmsg v/ CDATA2.8出租屋动态信息查询说明：查询动态信息，返回多条记录 调用接口： PDAI ntefaceXMLCMD 命令字：HouseDTSelect参数:vCDATA Vetaddrdescription=出租屋地址 / CDATA返回值:XML没有权限：vCDATA0errmsg description = 错误信息不具备权限 0/ CDATA没有记录：vCDATA10/ CDATA有记录时：CDATA1 verrmsg description = 错误信息100 Vetaddr description =出租屋地址 / CDAT

26、A2.9出租屋动态信息详细信息查询说明：查询某一条动态信息的详细信息，返回一条记录 调用接口： PDAI ntefaceXMLCMD 命令字：HouseDTSelectMore参数：CDATA0v/success verrmsg description v/ CDATA=错误信息不具备权限 v/errmsg 没有记录:vCDATA1精选word范本!verrmsg description= 错误信息/ CDATA有记录时：vCDATAvsuccess description =操作是否成功，1 为成功，0为失败 1 verrmsg description =错误信息 vfid descript

27、ion =主键1vbaseinfofid description =出租屋主键 vcarea description=镇区vcareaid description =镇区 id vczone description=服务站vczoneid description =服务站 id vsbbno description =房屋租赁证编号 vletaddr description =出租屋地址 vproblemtype description =发现的问题分类 vproblemdesc description =问题描述 veventdesc description =具体事件 vzoneactor

28、 description =服务站处理人 / CDATA2.10人员（包含同住人）登记与修改说明：登记新莞人调用接口：PDAI ntefaceXMLCMD 命令字：Personinsert参数：vCDATAbfid description =人员id,为空时将会新建，不为空时执行修改操作.varchar2(36)vpnewimag description= 照片 Vayercountdescription = 楼层.varchar2(50) v/fnameVnsurecount description =是否购买出租屋人身意夕卜保险.integer Vnsuredate description

29、 = 保险购买日期 .date vfivekindtype viscancelcheckdescription =巡查情况-具体情况，多种情况用逗号分隔开.varchar2(50) v/ fivekindtype description =是否取消巡查 .integer v/ iscancelcheck vcancelremarkdescription =取消巡查说明.varchar2(1000) v/cancelremark vhouseadmindescription =出租屋管理员 .varchar2(50) v/ houseadminvcheckdatedescription =巡查日期.date v/ checkdate vcreatordescription=创建人.varchar2(50) v/ creator / CDATA