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

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

《出租屋信息管理系统二期接口文档.docx》由会员分享，可在线阅读，更多相关《出租屋信息管理系统二期接口文档.docx（38页珍藏版）》请在冰豆网上搜索。

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

出租屋信息管理系统二期

接口文档

V1.0

1接口定义

1.1说明

为了方便接口的统一和方便的使用，所有功能都采用两个固定接口来实现，通过功能标识（CMD来区别不同的业务请求

1.2接口类型

WebService接口。

此接口由中大《出租屋信息管理系统》提供，灵动《出租屋信息管理系统二期》调用。

1.3接口原型

接口一：

///

///vparamname="loginld">登录帐号

///vparamname="password">登录密码

///vparamname="CMD">^于区别实现什么功能的命令字

///vparamname="XMLParams">以XM组织的除登录名和密码之外的参数

///vparamname="image">照片，没有为null

///vreturns>xml格式v/returns>

publicstringPDAInterfaceXML（stringloginld,stringpassword,stringCMD,stringXMLParams,byte[]image）

{

returnxmlstring;

}

接口二：

///vsummary>

Ill根据URL取得照片

III

Illvparamname="loginld">登录帐号

Illvparamname="password">登录密码

Illvparamname="imageurl">照片的UR地址，相对路径，就是数据库中保存的路径

Illvreturns>照片，没有为nullvlreturns>

publicbyte[]PDAGetimage（stringloginld,stringpassword,stringimageurl）

{

returnimage;

}

1.4参数说明

接口

CMD为业务请求标识，根据标识的不同，实现不同的功能。

XMLParams不同的业务请求具有不同的参数，除登录名和密码之外的所有的参数以XM组织封装，都为

string类型，结构如下：

vCDATA

vparamldescription=”参数名，根据不同的参数有不同的名称，如userid、password等”〉XXX

Image：

人员照片，没有时为null

接口二：

Imageurl:

照片的URL地址，相对路径，就是数据库中保存的路径

1.5返回值说明

接口一：

以XML组织的返回，结构与参数类似，不同的请求具有不同的子节点:

vCDATA

vparamldescription=”此节点说明">XXXv/param1>vparam2description=”此节点说明”〉XXXv/param2>vlCDATA

接口二：

返回byte[]型。

2接口一和二的详细请求与返回值

此接口中所有下接框（数据字典）的值，传递时都只传主键，不传中文。

2.1测试网络

说明：

测试PDA与市办服务器网络是否连接正确

调用接口：

PDAIntefaceXML

CMD命令字：

Test

参数：

＜CDATATest＜CDATA

返回值：

＜CDATAOKCDATA

2.2用户登录

说明：

验证用户合法性

调用接口：

PDAIntefaceXML

CMD命令字：

Login

参数：

vCDATA

Voginiddescription='帐号">admin

1234

返回值：

XML

1

test

虎门镇

1

东山

2

2.3出租屋登记与修改

说明：

登记新出租屋

调用接口：

PDAIntefaceXML

CMD命令字：

Houselnsert参数：

vCDATA

--以下是字段定义，主键统一使用fid-->

vsbbfiddescription="主键，为空时将会新建

不为空时执行修改操作">1v/sbbfid>

vmhddescription="子命令，'reate'为新建

'pdate'为更新">v/mhd>

vusernamedescription="登陆用户">张三vlessoridcdescription="出租人身份证号">

vlessorteldescription="出租人电话">

vlessoraddrdescription="出租人住址">vmanagerdescription="经营管理人">v/manager〉vmanageridcdescription="经营管理人身份证号">v/manageridc>vmanagerteldescription="经营管理人电话">v/managertel>vmanageraddrdescription="经营管理人住址">v/manageraddr>

vlesseedescription="承租人">v/lessee>vlesseeidcdescription="承租人身份证号">v/lesseeidc>vlesseeteldescription="承租人电话">v/lesseetel>vlesseeaddrdescription="承租人住址">v/lesseeaddr>

vitypedescription="产权分类,1:

表一；2：

表二">v/itype>

vcareadescription="镇区">v/carea>vcareaiddescription="镇区id">v/careaid>vczonedescription="服务站">v/czone>vczoneiddescription="服务站id">v/czoneid>vstreetdescription="街道/路/巷">v/street>vsbbnodescription="租赁证号">v/sbbno>

vgroupfiddescription="村/居民小组">v/groupfid>

vdoorplatedescription='「门（楼）牌号">v/doorplate>

vroomnodescription="详址（房间号）">v/roomno>vframedescription="房屋结构">v/frame>

vroomcountdescription="「间数">v/roomcount>vbidepersonsdescription="租住人数">v/bidepersons>vhousetypedescription="房屋类型,见数据字典">v/housetype>vbuildareadescription="建筑面积">v/buildarea>vselfareadescription="自住面积">v/selfarea>vlayercountdescription="层数">v/layercount>

vhousekinddescription="户型分类，见数据字典">v/housekind>vhousedescdescription="户型说明">v/housedesc>vemptypedescription="重点户分类,见附件">v/emptype>vsafehousenodescription="安全文明出租屋编号">v/safehouseno>

v/thsmtype>

vthsmoperatordescription="三小屋联系人">vthsmoperatorteldescription="三小屋联系电话">

visvideodescription="是否安装监控">

vvideofloordescription="监控安装楼层,一层至U五层">vvideopositiondescription="安装位置">vvideocountdescription="安装数量">v/videocount>

vvideodatedescription='安装日期">v/videodate>

vissafetydescription="是否购买意夕卜险">v/issafety>vsafetyareadescription="保险面积">v/safetyarea>vsafetycountdescription="被保人数">v/safetycount>vbuysafedatedescription="购买保险日期">v/buysafedate>

vtractnodescription="土地证编号">v/tractno>

vhousedroitnodescription="房屋所有权证编号">v/housedroitno>vhousedroitregdescription="房屋所有权证登记证号">v/housedroitreg>vrealtynodescription="房地产权证编号">v/realtyno>vrealtyregdescription='房地产权证登记证号">v/realtyreg>

vishavebidedescription="是否具备