出租屋信息管理系統(tǒng)二期接口文檔

1、出租屋信息管理系統(tǒng)二期接口文檔V1.01接口定義1.1說明為了方便接口的統(tǒng)一和方便的使用，所有功能都采用兩個(gè)固定接口來實(shí)現(xiàn)，通過功能標(biāo)識 (CMD來區(qū)別不同的業(yè)務(wù)請求1.2接口類型WebService 接口。此接口由中大出租屋信息管理系統(tǒng)提供，靈動(dòng)出租屋信息管理系統(tǒng)二期調(diào)用。1.3接口原型接口一：/ / 所有功能集中在一個(gè)接口里，通過CM區(qū)別是實(shí)現(xiàn)什么功能/ / vparam name=loginld 登錄帳號 / vparam name=password 登錄密碼 / vparam name=CMD于區(qū)別實(shí)現(xiàn)什么功能的命令字/ vparam name=XMLParams以XM組織的除登錄名和

2、密碼之外的參數(shù)/ vparam name=image 照片，沒有為 null / vreturns xml格式 v/returnspublic string PDAInterfaceXML( string loginld, string password, string CMD, string XMLParams, byte image)return xmlstring;接口二：/ vsummaryIll根據(jù)URL取得照片III Ill vparam name=loginld登錄帳號 Ill vparam name=password 登錄密碼 Ill vparam name=imageurl

3、照片的UR地址，相對路徑，就是數(shù)據(jù)庫中保存的路徑Ill vreturns 照片，沒有為 null vlreturnspublic byte PDAGetimage( string loginld,string password, string imageurl)return image;1.4參數(shù)說明接口CMD為業(yè)務(wù)請求標(biāo)識，根據(jù)標(biāo)識的不同，實(shí)現(xiàn)不同的功能。XMLParams不同的業(yè)務(wù)請求具有不同的參數(shù)，除登錄名和密碼之外的所有的參數(shù)以XM組織封裝，都為stri ng類型，結(jié)構(gòu)如下：vCDATAvparaml description= ”參數(shù)名，根據(jù)不同的參數(shù)有不同的名稱 ，如userid、p

4、assword等”XXX param2 description= ” 此參數(shù)的值 ”XXXXXXv/param1 vparam2 description= ” 此節(jié)點(diǎn)說明 ”XXXv/param2 vl CDATA接口二：返回byte型。2接口一和二的詳細(xì)請求與返回值此接口中所有下接框（數(shù)據(jù)字典）的值，傳遞時(shí)都只傳主鍵，不傳中文。2.1測試網(wǎng)絡(luò)說明：測試PDA與市辦服務(wù)器網(wǎng)絡(luò)是否連接正確調(diào)用接口： PDAI ntefaceXMLCMD命令字：Test參數(shù)：CDATATest CDATA返回值：CDATAOKCDATA2.2用戶登錄說明：驗(yàn)證用戶合法性調(diào)用接口： PDAI ntefaceXMLC

5、MD命令字：Login參數(shù)：vCDATAVoginiddescription =帳號admin1234/ CDATA返回值：XMLCDATA1test 虎門鎮(zhèn) 1 東山 2 / CDATA2.3出租屋登記與修改說明：登記新出租屋調(diào)用接口： PDAI ntefaceXMLCMD 命令字：Houselnsert 參數(shù)：vCDATAvsbbfid description =主鍵，為空時(shí)將會新建,不為空時(shí)執(zhí)行修改操作1 v/sbb fid vmhd description= 子命令， reate 為新建pdate 為更新v/mhdvusername description =登陸用戶 張三 vless

6、oridcdescription=出租人身份證號 vlessorteldescription=出租人電 話vlessoraddr description =出租人住 址 vmanager description =經(jīng)營管理人v/manager vmanageridc description =經(jīng)營管理人身份證號 v/ manageridc vmanagertel description =經(jīng)營管理人電 話v/managertel vmanageraddr description=經(jīng)營管理人住 址v/ manageraddrvlessee description =承租人v/ lessee vl

7、esseeidc description =承租人身份證號 v/ lesseeidc vlesseetel description =承租人電 話v/ lesseetel vlesseeaddr description =承租人住 址v/lesseeaddr vitype description=產(chǎn)權(quán)分類,1:表一；2：表二v/ itype vcarea description =鎮(zhèn)區(qū)v/ carea vcareaid description =鎮(zhèn)區(qū) id v/careaid vczone description =服務(wù)站v/ czone vczoneid description =服務(wù)站 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=房屋結(jié)構(gòu)v/frame vroomcount description =間 數(shù)v/ roomcount vbidepersons description =

9、租住人數(shù) v/ bidepersons vhousetype description =房屋類型,見數(shù)據(jù)字典 v/ housetype vbuildarea description =建筑面積v/buildarea vselfarea description =自住面積v/ selfarea vlayercount description =層 數(shù)v/layercount vhousekind description =戶型分類，見數(shù)據(jù)字典v/housekind vhousedesc description =戶型說明v/housedesc vemptype description =重點(diǎn)戶分

10、類,見附件v/ emptype vsafehouseno description =安全文明出租屋編號v/safehouseno v/thsmtype vthsmoperator description =三小屋聯(lián)系人 vthsmoperatortel description=三小屋聯(lián)系電話 visvideo description =是否安裝監(jiān)控 vvideofloor description =監(jiān)控安裝樓層 ,一層至U五層 vvideoposition description =安裝位置 vvideocount description=安裝數(shù)量v/ videocount vvideodat

11、e description=安裝日期 v/videodate vissafety description =是否購買意夕卜險(xiǎn) v/ issafety vsafetyarea description =保險(xiǎn)面積 v/ safetyarea vsafetycount description =被保人數(shù) v/ safetycount vbuysafedate description=購買保險(xiǎn)日期 v/ buysafedate vtractno description = 土地證編號v/tractno vhousedroitno description =房屋所有權(quán)證編號v/ housedroitno

12、 vhousedroitreg description =房屋所有權(quán)證登記證號 v/housedroitreg vrealtyno description =房地產(chǎn)權(quán)證編號 v/ realtyno vrealtyreg description=房地產(chǎn)權(quán)證登記證號 v/ realtyreg vishavebide description=是否具備居住條件，見數(shù)據(jù)字典v/ishavebide vdipropertydis description =是否有產(chǎn)權(quán)爭議 ,見數(shù)據(jù)字典 v/dipropertydis vhousebycontract description =商品買賣合同v/houseby

13、contract vhousesource description =房屋來源,見數(shù)據(jù)字典 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 = 錯(cuò)誤信息 不具備操作權(quán)限 v/ errmsg v/ CDATA2.4出租屋簡要信息查詢說明：通過組合查詢條件，查詢符合條件的所有出租屋列表，返回多條記錄調(diào)用接口： PDAI ntefaceXML CMD 命令字：HouseSelect 參數(shù)： vCDATA150 !-以下只列岀了具體要查詢的

15、字段，字段名請?jiān)谏厦嬉蚜袑纭Ｃ看尾樵儽仨氁獋麈?zhèn)區(qū)和服務(wù)站的中文名稱carea descriptionczone description=服務(wù)站=租賃證號vletaddr description =出租屋地址，是組合值，街道/路/巷+門牌/樓號+詳址/房間號Vessor description =出租人vlessoridc description =出租人身份證 vframe description =房屋結(jié)構(gòu)：1 鋼混；2磚混；3磚木；4 簡易vhousetype description =房屋類型：1 平房；2樓房；3商品房；4其它 vhousekind description= ”戶型分類

16、1 ： 一般戶；2 :安全文明出租屋；3 :重點(diǎn)戶Vayercount description =層數(shù)，大于 0時(shí)有效vroomcountdescription =房間數(shù),大于 0時(shí)有效vthsmtype description =三小出租屋類型 1 ：小娛樂場所 2 :小作坊 3 :小檔口 visvideo description=是否安裝監(jiān)控 v/ isvideo v/ CDATA返回值:XML沒有權(quán)限：vCDATAvsuccess description=操作是否成功，1 為成功，0為失敗0v/success verrmsg description = 錯(cuò)誤信息不具備權(quán)限 v/ errm

17、sg vallcount description =總記錄數(shù)0v/ allcount v/ CDATA沒有記錄：vCDATAvsuccess description =操作是否成功，1 為成功，0為失敗1v/success verrmsg description = 錯(cuò)誤信息 v/ errmsg vallcount description =總記錄數(shù)0v/ allcount v/ CDATA有記錄時(shí)：1verrmsg description = 錯(cuò)誤信息vallcount description=總記錄數(shù)100vrows description =表示一條記錄vsbbfid descripti

18、on =主鍵1vsbbno description =房屋租賃證編號HBO1234432452345345：/sbbnoVetaddrdescription =出租屋地址 東城 XXXXX/ letaddr Vessor description =出租人 張三 v/ lessor visemphouse description =是否重點(diǎn)戶，是為 1，否為 00v/ isemphouse v/ rows v/ CDATA2.5出租屋詳細(xì)信息查詢說明：通過房屋租賃證號，查詢此出租屋詳細(xì)信息，只返回一條記錄調(diào)用接口： PDAI nterfaceXMLCMD 命令字：HouseSelectMore參

19、數(shù)：vCDATAvsbbno description =租賃證號，沒有 sbbfid 時(shí)，才使用 sbbno查詢v/sbbno vsbbfid description =租賃證 FID，優(yōu)先使用 sbbfid 作查詢條件v/sbb fid v/ CDATA返回值:DataSet沒有權(quán)限：vCDATAvsuccess description =操作是否成功，1 為成功，0為失敗0v/success verrmsg description = 錯(cuò)誤信息不具備權(quán)限 v/ errmsg v/ CDATA沒有記錄:vCDATAvsuccess description=操作是否成功，1為成功，0為失敗1v

20、/success verrmsg descriptionv/ CDATA=錯(cuò)誤信息不具備權(quán)限 v/errmsg有記錄時(shí):vCDATAv!-字段名稱見岀租屋登記模塊，主鍵統(tǒng)一使用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 =產(chǎn)權(quán)分類,1:表一；2 :表二 Vayercount description =層 數(shù)Vayer1 description =一 層，見數(shù)據(jù)字典Vayer2 description =二層以上,見數(shù)據(jù)字典 Vhsmtype description=三小出租屋,見數(shù)據(jù)字典Vhsmdesc description=三小屋說明 Vhsmoperatordescription =三小屋聯(lián)系人Vhsmoperatort

22、el description=三小屋聯(lián)系電話 Vsvideodescription =是否安裝監(jiān)控 Vssafetydescription=是否購買意夕卜險(xiǎn) Vshavebidedescription =是否具備居住條件，見數(shù)據(jù)字典/ CDATA2.6出租屋刪除（注銷）說明：刪除（注銷）出租屋調(diào)用接口： PDAI nterfaceXMLCMD 命令字：HouseDelete參數(shù)：CDATA / CDATA返回值:XMLCDATA1 / CDATA2.7出租屋動(dòng)態(tài)信息添加與修改說明：登記重點(diǎn)戶動(dòng)態(tài)信息調(diào)用接口： PDAI ntefaceXMLCMD 命令字：HouseDTInsert參數(shù)：vCD

23、ATA vmhd description= vcarea description =鎮(zhèn)區(qū) vcareaid description =鎮(zhèn)區(qū) id vczone description =服務(wù)站 vczoneid description =服務(wù)站 id vsbbno description=房屋租賃證編號 v/ sbbnovletaddr description =出租屋地址 v/ letaddr vrelperson description =相關(guān)人員 v/ relperson vrelpersonidc description=相關(guān)人員身份證 v/ relpersonidc vproblem

24、type description=發(fā)現(xiàn)的問題分類 v/ problemtype vproblemdesc description=問題描述 v/ problemdesc veventdesc description =具體事件 v/ eventdesc vzoneactor description =服務(wù)站處理人 v/ zoneactor vzonetrandate description=處理日期 v/ zonetrandate v/ CDATA返回值:XMLvCDATAvsuccess description =操作是否成功，1 為成功，0為失敗1v/success verrmsg des

25、cription = 錯(cuò)誤信息 v/ errmsg v/ CDATA2.8出租屋動(dòng)態(tài)信息查詢說明：查詢動(dòng)態(tài)信息，返回多條記錄 調(diào)用接口： PDAI ntefaceXMLCMD 命令字：HouseDTSelect參數(shù):vCDATA Vetaddrdescription=出租屋地址 / CDATA返回值:XML沒有權(quán)限：vCDATA0errmsg description = 錯(cuò)誤信息不具備權(quán)限 0/ CDATA沒有記錄：vCDATA10/ CDATA有記錄時(shí)：CDATA1 verrmsg description = 錯(cuò)誤信息100 Vetaddr description =出租屋地址 / CDAT

26、A2.9出租屋動(dòng)態(tài)信息詳細(xì)信息查詢說明：查詢某一條動(dòng)態(tài)信息的詳細(xì)信息，返回一條記錄 調(diào)用接口： PDAI ntefaceXMLCMD 命令字：HouseDTSelectMore參數(shù)：CDATA0v/success verrmsg description v/ CDATA=錯(cuò)誤信息不具備權(quán)限 v/errmsg 沒有記錄:vCDATA1精選word范本!verrmsg description= 錯(cuò)誤信息/ CDATA有記錄時(shí)：vCDATAvsuccess description =操作是否成功，1 為成功，0為失敗 1 verrmsg description =錯(cuò)誤信息 vfid descript

27、ion =主鍵1vbaseinfofid description =出租屋主鍵 vcarea description=鎮(zhèn)區(qū)vcareaid description =鎮(zhèn)區(qū) id vczone description=服務(wù)站vczoneid description =服務(wù)站 id vsbbno description =房屋租賃證編號 vletaddr description =出租屋地址 vproblemtype description =發(fā)現(xiàn)的問題分類 vproblemdesc description =問題描述 veventdesc description =具體事件 vzoneactor

28、 description =服務(wù)站處理人 / CDATA2.10人員（包含同住人）登記與修改說明：登記新莞人調(diào)用接口：PDAI ntefaceXMLCMD 命令字：Personinsert參數(shù)：vCDATAbfid description =人員id,為空時(shí)將會新建，不為空時(shí)執(zhí)行修改操作.varchar2(36)vpnewimag description= 照片 Vayercountdescription = 樓層.varchar2(50) v/fnameVnsurecount description =是否購買出租屋人身意夕卜保險(xiǎn).integer Vnsuredate description

29、 = 保險(xiǎn)購買日期 .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=創(chuàng)建人.varchar2(50) v/ creator / CDATA