Webové služby. pro párování inzerátů

Transkript

1 OctopusPro s.r.o. Webové služby pro párování inzerátů Verze: 1.0 Datum vytvoření: Datum poslední aktualizace: Copyright OctopusPro s.r.o, Praha,

2 Obsah: 1 Úvod Základní popis Služby Seznam použitých webových služeb ws_octop_pairing - Párování inzerátů Datové typy Data transfer objekty thitdto OfferTypeDTO CategoryDTO SubCategoryDTO RegionDTO SubRegionDTO CommercialModeDTO CountryDTO OwnershipDTO PairingAttributeCategoryIdDTO PairingAttributeSubCategoryIdDTO SubCategoryBytDTO SubCategoryParcelaDTO SubCategoryKomercniProstorDTO PairingAttributeOfferTypeIdDTO PairingAttributeCommercialModeIdDTO PairingAttributeCountryIdDTO PairingAttributeSubRegionIdDTO PairingAttributeMunicipalityDTO PairingAttributeStreetDTO PairingAttributeBuildingNumberDTO PairingAttributeCoordinateDTO PairingAttributeAreaDTO PairingAttributePriceDTO PairingAttributeOwnershipIdDTO PairingAttributeFulltextDTO Číselníky CC_Category CC_SubCategory CC_CommercialMode... 18

3 3.27 CC_OfferType CC_Region Abecední řazení CC_SubRegion CC_Country CC_Vlastnictvi CC_ProfileType Příklady ASP.NET aplikace Pomocná třída pro vytváření jednotlivých requestů na webovou službu: Ukázka volání některých služeb z repository ASP.NET aplikace Vytvoření XML z navrácených dat:... 25

4 1 ÚVOD Úkolem webových služeb poskytovaných společností OctopusPro s.r.o. je zpřístupnění dat pro software třetích stran. Jejich využívání je podmíněno vytvořením aplikace na straně klienta, který bude poskytnutá data dále zpracovávat. 1.1 Základní popis Webové služby jsou veřejně dostupné na následující adrese. K úspěšnému přihlášení do webové služby je nutné zažádat o přístupové údaje přímo u společnosti OctopusPro s.r.o. Jedná se o WCF služby, které jsou přístupné pouze s platným SSL certifikátem. Správné nastavení služeb je dále popsáno v příkladech, případně v kapitole Nastavení služeb. 1.2 Algoritmus párování Pomocí kolekce atributů (cpairingattribute) definujících nemovitost se definuje zdrojová nemovitost (ohit source). Tato kolekce univerzálně popisuje všechny typy nemovitostí. Atributy z kolekce cpairingattribute jsou dvojího typu. Povinné a nepovinné. Povinné atributy cpairingattributerequired musí být vždy definovány jako jediná hodnota (bez intervalu hodnot), která nesmí být NULL. Ostatní atributy (cpairingattributeoptional - nepovinné) nemusí být definovány vůbec a mohou být reprezentovány hodnotou NULL. Klíčový atribut pro párování je atribut s názvem OfferTypeId, s hodnotami (nabídka nebo poptávka). Pro potřeby párování je definována množina různých nemovitostí chit target, které mají být spárovány se zdrojovou nemovitostí ohit source podle níže uvedených pravidel. Výsledkem procesu párování je seznam nemovitostí chit paired, jako podmnožina chit target, splňující podmínky pro párování. Podmnožinou atributů cpairingattribute jsou tzv. klíčové atributy cpairingattributekey. Tyto atributy nabývají pouze diskrétních hodnot (z číselníků) a v procesu párování musí být identické jak v ohit source tak v ohit target a nesmí nabývat hodnot NULL ani na jedné straně páru (source-target) Párovací toleranční okno Podmnožinu atributů z kolekce cpairingattribute, které nejsou z kolekce cpairingattributerequired, definujeme jako cpairingattributeoptional. Tyto atributy nabývají převážně libovolné hodnoty, vždy mohou mít hodnotu NULL. Obecně platným párovacím pravidlem pro tuto kolekci atributů je skutečnost, že hodnoty těchto atributů v páru (source-target) jsou identické nebo blízké. Míru "blízkosti" definuje pro každý atribut párovací okno (oatributoptionalwindow), což je v podstatě interval nejnižší a nejvyšší povolené hodnoty oatributoptionalwindow.low, oatributoptionalwindow.high. Aby byl považován určitý Atribut (páru source-target) za zpárovaný musí být splněna podmínka: oatributoptional target ϵ oatributoptionalwindow.low, oatributoptionalwindow.high kde hodnoty oatributoptionalwindow.low, oatributoptionalwindow.high jsou derivovány od hodnoty oatributoptional source podle následujícho pravidla: oatributoptionalwindow.low = oatributoptional source (1 - oatributoptionalwindow.px)

5 oatributoptionalwindow.high = oatributoptional source (1 + oatributoptionalwindow.px) kde hodnota oatributoptionalwindow.px reprezentuje pro každý atribut z kolekce oatributoptional procenta šířky tolerančního okna. Tyto hodnoty jsou určeny implicitně (automatická volba párování) nebo je nastavuje uživatel (manuální párování) Lokalizační atributy nemovitosti Pro mechanizmus párování hraje speciální roli vymezení lokality a řídí se jinými pravidly než ostatní atributy cpairingattributeoptional popsané výše. Atributy lokalizace nemovitosti (lokalizační atributy) jsou detailně popsány v tabulce níže. Atribut IdCountry je vždy povinný (kolekce cpairingattributerequired). Ostatní lokalizační atributy nemovitosti jsou z kolekce cpairingattributeoptional. Dále platí následující sekvenční pravidla definující hierarchii významu jednotlivých lokalizačních atributů nemovitosti: Párování s hierarchickými lokalizačními atributy Pokud není definován atribut coordinate (tedy coordinate.x a coordinate.y jsou NULL), jsou pro párování použity tzv. hierarchické lokalizační atributy. Ty jsou seřazeny podle významu lokalizace nemovitosti následovně: IdCountry subregion municipality street building_cp nebo building_co. Pokud ohit source některý z těchto atributů nemá (je NULL), s tím, že se test realizuje seshora od IdCountry, započne proces párování se všemi lokalizačními atributy od IdCountry až do atributu předešlému od tohoto atributu. Během párování se v ohit target sledují všechny tyto lokalizační atributy. Pokud je v sledovaném ohit target některý z těchto atributů NULL, je nemovitost pro párování diskvalifikována. Z výše uvedeného vyplývá pro ohit source : Pokud je atribut subregion NULL, je lokalizace párována pouze na úrovni IdCountry. Pokud je atribut municipality NULL, je lokalizace párována pouze na úrovni subregion. Pokud je atribut street NULL, je lokalizace párována pouze na úrovni municipality. Pokud je atribut building_cp and building_co NULL, je lokalizace párována pouze na úrovni street. příklad: pro ohit source jsou definovány lokalizační atributy: (IdCounty=1, subregion=1, municipality='praha', street='americká') pro chit target budou například vyřazeny: ohit target : (IdCounty=1, subregion=1, municipality='praha', street='lodecká') ohit target : (IdCounty=1, subregion=1, municipality='brno', street='americká') ohit target : (IdCounty=1, subregion=1, municipality=null, street='americká') ohit target : (IdCounty=1, subregion=2, municipality='praha', street='lodecká') ohit target : (IdCounty=1, subregion=null, municipality='praha', street='lodecká')

6 Párování s lokalizační atributem coordinate Pokud je definován atribut coordinate (coordinate.x a coordinate.y jsou různý od NULL), je realizováno párování s jediným lokalizačním atributem coordinate. Všechny nemovitosti z chit target, které neleží v oblasti definované kružnici se středem coordinate.x a coordinate.y a poloměrem coordinate.radius nebudou zpárovány s ohit source Pravidla párování Každá z nemovitostí ohit target v kolekci chit target, která má být párovatelná s ohit source, musí splňovat následující kritéria: a) atribut offertypeid pro ohit source musí být u všech zpárovaných ohit target opačný b) atributy cpairingattributekey pro ohit source musí být u všech zpárovaných ohit target identický c) všechny atributy cpairingattributerequired pro ohit target nesmí být NULL d) všechny cpairingattributeoptional v ohit source, které nemají hodnotu NULL, nesmí mít hodnotu NULL také v ohit target (v programu bude možné tuto podmínku volitelně ignorovat) e) všechny cpairingattributeoptional (kromě Lokalizačních atributů) v ohit source, které nemají hodnotu NULL, musejí splňovat podmínku: oatributoptional target ϵ oatributoptionalwindow.low, oatributoptionalwindow.high. Pokud některý atribut nepadne do tolerančního okna, k zpárování (source-target) nedojde. Pokud je podmínka d) ignorována, pak jsou testovány pouze ty atributy z cpairingattributeoptional, které jsou v ohit target různé od NULL a zároveň jsou v ohit source různé od NULL. f) Lokalizační atributy se párují speciálním algoritmem popsaným v kapitole: "Lokalizační atributy nemovitosti "

7 oatribute popis oatributrequired oatributkey oatributoptional oatributoptional Window.px CategoryId kategorie nemovitosti ano ano - - SubCategoryId podkategorie (další dělení Kategorie): SubCategoryID bit mask Kategorie CategoryID význam oatributrequired oatributkey oatributoptional 6 16 byt ano ano ano ano ano ano ano ano ano ano > ano ano Garsoniéra ano ano parcela 4 Stavební - ano ano Ostatní - ano ano 24 1 Komerční 6 Obchodní - ano ano 25 2 prostora 6 Sklad - ano ano Výroba - ano ano OfferTypeId nabídka/poptávka ano CommercialModeId prodej/pronájem ano ano - - CountryId kód země ano ano - - lokalizační atributy SubRegionId Municipality kód pro okres nebo obvod (velké město) číselník OctopusPro - ano ano - jméno obce - ano ano - Street jméno ulice - ano ano - BuildingNumber číslo popisné, číslo orientační - ano ano - Coordinate X,Y souřadnice (WGS. JTSK - RUIAN) Poloměr (radius) v m od středu (X,Y) - - ano -

8 Area 2 plocha nemovitosti - - ano 35 Price 3 cena nemovitosti - - ano 35 OwnershipId kód vlastnictví - ano ano - FullText volný text - ano ano - 1) atribut je kalkulován v procesu párování pouze pro IdCategory (byt, dům) 2) atribut je v jednotkách m 2 3) atribut je platný pro všechny kategorie, pro commercialmode=prodej jsou hodnoty atributu absolutní, pro commercialmode=pronájem, jsou hodnoty relativní, vztažené na 1 měsíc.

9 2 SLUŽBY Všechny webové služby mají jeden vstupní a jeden výstupní parametr. Vstupní parametr tzv. request parametr je odvozený od základní třídy RequestBase. Výstupní parametr tzv. response je odvozený od třídy ResponseBase. Popis jednotlivých parametrů následuje: RequestBase základní třída pro vstupní parametr web.služby ClientTag string - Identifikace klienta WS ClientTag je přidělen společně s přístupovými údaji k WS ClientUsername string - Uživatelské jméno klienta přístupové údaje k WS ClientPassword string - Uživatelské heslo klienta přístupové údaje k WS RequestId string - Unikatni GUID requestu, který ho identifikuje LoadOptions string[] - Nepovinné pole parametrů udávající doplňující požadavky na vrácená data. Např. načtení číselníku k vráceným datům atd. Action String - Nepovinné pole pomocí něhož je možné vyvolat speciální akce definované u jednotlivých služeb ResponseBase základní třída pro výstupní parametr web.služby Acknowledge AcknowledgeType Success, Failed Udává výsledek volání webové služby. V případě chyby vrací Failed Message String - V případě chyby (Acknowledge) je zde možné nalézt detailnější popis, proč se volání nezdařilo ComparationId string - Unikatni GUID requestu, pro který byl votvořen tento response RowsAffected int - Počet navrácených záznamů, pokud to vzhledem k charakteru WS dává smysl Version string - Verze WS Build string - Build WS ReservationId string - Vyhrazeno pro dlouhotrvající requesty, zatím nepoužito ReservationExpires Datetime - Vyhrazeno pro dlouhotrvající requesty, zatím nepoužito 2.1 Seznam použitých webových služeb Jméno služby ws_octop_pairing Poznámka Služba pro párování inzerce

10 2.2 ws_octop_pairing - Párování inzerátů [WsdlDocumentation("Služba pro párování inzerátu podle daných pravidel s využitím PairingAttributes")] thitresponse ws_octop_pairing(ws_pairing_request request); Služba pro párování nemovitostí. Vlastní párování probíhá podle dokumentu Párování OCTOPUSPRO. Ve ws_pairing_request do metody vstupují párovací atributy, které popisují párovanou nemovitost. Prostřednictvím thitresponse jsou následně vráceny napárované inzeráty. ws_pairing_request vstupní parametry povinné atributy jsou označeny tučně IdUser Int Identifikace uživatele, který provádí párování ResultAgeDays int (0, 365> Maxilmální počet dní pro stáří párovaného inzerátu PairingSourceType Int 1-soukromá inzerce, 2- inzerce RK 4 obojí Zdroj inzerátů pro párování CategoryId PairingAttributeCategoryIdDTO CC_Category Párovací atribut kategorie nemovitosti SubCategoryId PairingAttributeSubCategoryIdDTO Nepovinný subkategorie nemovitosti OfferTypeId PairingAttributeOfferTypeIdDTO CC_OfferType Povinný atribut. Nabídka / poptávka CommercialModeId PairingAttributeCommercialModeIdDTO CC_CommercialMode Povinný atribut druh transakce. Prodej / pronájem CountryId PairingAttributeCountryIdDTO CC_Country Povinný atribut země SubRegionId PairingAttributeSubRegionIdDTO CC_SubRegion Nepovinný atribut okres nebo obvod Municipality PairingAttributeMunicipalityDTO Nepovinný atribut Obec Street PairingAttributeStreetDTO Nepovinný atribut Ulice BuildingNumber PairingAttributeBuildingNumberDTO Cislo popisné nebo evidenční stavby Coordinate PairingAttributeCoordinateDTO Nepovinný atribut souřadnice nemovitosti. Tento atrbut má přednost před hledáním podle ostatních atributů lokality SubRegionId, Municipality, Street, BuildingNumber Area PairingAttributeAreaDTO Nepovinný atribut plocha Price PairingAttributePriceDTO Nepovinný atribut cena OwnershipId PairingAttributeOwnershipIdDTO CC_Vlastnictvi Nepovinný atribut Vlastnictví Fulltext PairingAttributeFulltextDTO Nepovinný atribut Fulltext thitresponse výstupní parametry

11 thits thitdto[] - Pole thitdto seznam záznamů (inzerátů) TotalRecords Int Počet vrácených záznamů

12 3 DATOVÉ TYPY DATA TRANSFER OBJEKTY 3.1 thitdto Transfer objekt pro záznam monitoringu realit. IdHit int - Id záznamu Type int 1 Typ záznamu monitoring realit IdCategory int CC_Category Kategorie nemovitosti SubCategory int CC_SubCategory Upřesnění kategorie nemovitosti OfferType int CC_OfferType Nabídka / poptávka CommercialMode int CC_CommercialMode Prodej / pronájem IdRegion Int? CC_Region Kraj SubRegion Int? CC_SubRegion Část kraje IdPortal int Číselník Id zdroje BodyText string - Text inzerátu BodyStampHash int - Hash textu inzerátu Phone1 Long? - Telefon 1 Phone2 Long? - Telefon 2 Phone3 Long? - Telefon 3 DateOfFirstRelease DateTime? - Datum zadání inzerátu DateOfLastChange DateTime? - Datum poslední změny inzerátu DetailURL string - Url inzerátu ClientSMS string - Volné pole Price int? - Cena DateOfGrab Datetime - Datum vygrabování AdvertID string - ID inzerátu na zdrojovém portálu IdRA int? Číselník Id realitní kanceláře Locality string - Lokalita - ulice Area int? - Plocha nemovitosti namera string - Název realitní kanceláře IdCountry int? CC_Country Země inzerátu IdVlastnictvi int? CC_Vlastnictvi Typ vlastnictví HitRepeatCount Int? - Počet opakování inzerátu string - Publisher string - Jméno vydavatele PhoneRepeatCount int? - Počet opakování tel.čísla jtskx Long? - Souřadnice na mapě - X jtsky Long? - Souřadnice na mapě - Y kodkatastraluzemi Int? - Kód katastrálního území Obec string - Obec 3.2 OfferTypeDTO Transfer objekt pro záznam číselníku OfferType. OfferType int CC_OfferType ID OfferType OfferTypeName string CC_OfferType Název OfferType

13 3.3 CategoryDTO Transfer objekt pro záznam číselníku Category. IdCategory int CC_Category Id kategorie Category int CC_Category Bitová hodnota kategorie CategoryName string CC_Category Název kategorie CategoryAbbrev string CC_Category Zkratka názvu kategorie 3.4 SubCategoryDTO Transfer objekt pro záznam číselníku SubCategory. IdSubCategory int CC_SubCategory Id sub kategorie vždy unikátní SubCategory int CC_SubCategory Bitová hodnota dané sub kategorie unikátní v rámci jedné kategorie IdCategory Int CC_SubCategory Id hlavní kategorie SubCategoryName string CC_SubCategory Název sub kategorie SubCategoryAbbrev string CC_SubCategory Zkratka názvu sub kategorie 3.5 RegionDTO Transfer objekt pro záznam číselníku Region. IdRegion int CC_Region Id regionu Region int CC_Region Bitová hodnota regionu RegionName string CC_Region Název regionu 3.6 SubRegionDTO Transfer objekt pro záznam číselníku SubRegion. IdSubRegion int CC_SubRegion Id subregionu IdRegion int CC_SubRegion Id regionu SubRegionName string CC_SubRegion Název subregionu 3.7 CommercialModeDTO Transfer objekt pro záznam číselníku CommercialMode. IdCommercialMode int CC_CommercialMode Id typu obchodu CommercialMode int CC_CommercialMode Bitová hodnota typu obchodu CommercialModeName string CC_CommercialMode Název typu obchodu 3.8 CountryDTO transfer objekt pro specifikaci země

14 IdCountry int CC_Country Id země CountryName string CC_Country Název země 3.9 OwnershipDTO Transfer objekt objekt pro specifikaci vlastnictví IdOwnership int CC_Vlastnictvi Id vlastnictví OwnershipName string CC_Vlastnictvi Název vlastnictví 3.10 PairingAttributeCategoryIdDTO Transfer objekt pro párovací atribut kategorie nemovitosti AttributeName string CategoryId Název atributu IsRequired bool true Je vyžadovaný? Category CategoryDTO CC_Category Číselník kategorie nemovitosti 3.11 PairingAttributeSubCategoryIdDTO Transfer objekt pro párovací atribut subkategorie nemovitosti AttributeName string SubCategoryId Název atributu IsRequired bool false Je vyžadovaný? SubCategoryByt SubCategoryBytDTO - Subkategorie bytu viz. CC_SubCategory. SubCategoryParcela SubCategoryParcelaDTO - Subkategorie parcely viz CC_SubCategory SubCategoryKomercniProstor SubCategoryKomercniProstorDTO - Subkategorie komerčního prostoru viz. CC_SubCategory SubCategoryBytDTO Transfer objekt pro párovací atribut subkategorie bytu DispositionGarsoniera bool True/false Párovat garsoniery Disposition11 bool True/false Párovat 1+1 Disposition21 bool True/false Párovat 2+1 Disposition31 bool True/false Párovat 3+1 Disposition41 bool True/false Párovat 4+1 Disposition51 bool True/false Párovat 5+1 DispositionGreaterThan51 bool True/false Párovat > SubCategoryParcelaDTO Transfer objekt pro párovací atribut subkategorie parcely Stavebni Bool? True/false/null Párovat stavební pozemky Ostatni Bool? True/false/null Párovat ostatní pozemky SubCategoryKomercniProstorDTO Transfer objekt pro párovací atribut subkategorie komerční prostory

15 Obchodni Bool? True/false/null Párovat obchodní prostory Sklad Bool? True/false/null Párovat sklady Vyroba Bool? True/false/null Párovat výrobu 3.12 PairingAttributeOfferTypeIdDTO Transfer objekt pro párovací atribut offer type (nabídka / poptávka) AttributeName string OfferTypeId Název atributu IsRequired bool true Je vyžadovaný? OfferType OfferTypeDTO Číselník offertype viz. CC_OfferType 3.13 PairingAttributeCommercialModeIdDTO Transfer objekt pro párovací atribut commercialmode nemovitosti (prodej / pronájem) AttributeName string CommercialModeId Název atributu IsRequired bool true Je vyžadovaný? CommercialMode CommercialModeDTO Číselník CommercialMode viz. CC_CommercialMode 3.14 PairingAttributeCountryIdDTO Transfer objekt pro párovací atribut země nemovitosti AttributeName string CountryId Název atributu IsRequired bool true Je vyžadovaný? Country CountryDTO Číselník zemí viz. CC_Country 3.15 PairingAttributeSubRegionIdDTO Transfer objekt pro párovací atribut commercialmode nemovitosti (prodej / pronájem) AttributeName string SubRegionId Název atributu IsRequired bool false Je vyžadovaný? SubRegions SubRegionDTO[] Číselník SubRegionDTO viz PairingAttributeMunicipalityDTO Transfer objekt pro párovací atribut Obec AttributeName string Municipality Název atributu IsRequired bool false Je vyžadovaný? Municipality string Název obce

16 3.17 PairingAttributeStreetDTO Transfer objekt pro párovací atribut ulice AttributeName string Street Název atributu IsRequired bool false Je vyžadovaný? Street string Název ulice 3.18 PairingAttributeBuildingNumberDTO Transfer objekt pro párovací atribut číslo popisné/orientační AttributeName string BuildingCpCo Název atributu IsRequired bool false Je vyžadovaný? Cp string Číslo popisné Co string Číslo orientační 3.19 PairingAttributeCoordinateDTO Transfer objekt pro párovací atribut souřadnice nemovitosti AttributeName string Coordinate Název atributu IsRequired bool false Je vyžadovaný? X Double Souřadnice X Y Double Souřadnice Y CoordinateType icoordinatetype JTSK,WSG84 Typ zadaných souřadnic Radius double Radius v (m) 3.20 PairingAttributeAreaDTO Transfer objekt pro párovací atribut plocha AttributeName string Area Název atributu IsRequired bool false Je vyžadovaný? Area int Plocha WindowPx double Odchylka v procentech od zadané hdontoy (defaultně 35% 3.21 PairingAttributePriceDTO Transfer objekt pro párovací atribut cena AttributeName string Price Název atributu IsRequired bool false Je vyžadovaný? Price decimal Cena WindowPx double Odchylka v procentech od zadané hdontoy (defaultně 35% 3.22 PairingAttributeOwnershipIdDTO Transfer objekt pro párovací atribut vlastnictví

17 AttributeName string OwnershipId Název atributu IsRequired bool false Je vyžadovaný? OfferType OfferTypeDTO Číselník vlastnictví viz. CC_Vlastnictvi 3.23 PairingAttributeFulltextDTO Transfer objekt pro párovací atribut fulltext AttributeName string OwnershipId Název atributu IsRequired bool false Je vyžadovaný? Fulltext string Volný text pro párování

18 ČÍSELNÍKY CC_Category IdCategory Category CategoryName CategoryAbbrev CategoryDescription 1 1 Byty BYT 2 2 Domy DUM Rodinné domy, činžovní domy, hotely 4 4 Pozemky POZ Stavební pozemky, pole, lesy 5 8 Chaty CHAT 6 16 Komerční prostory KP 7 32 Kanceláře KANC 8 64 Garáže GAR Developerské projekty DEV 3.25 CC_SubCategory IdSubCategory SubCategory IdCategory SubCategoryName SubCategoryAbbrev < 40 m2 B40 Byty prodej m2 B40_ m2 B60_ > 100 m2 B B1a B2a B3a B4a B5a > Bup5a Garsoniera Bgars < 10 tis. R10 pronájem tis. R10_ > 20 tis. R < 2 mil. D2 Domy mil. D2_ > 5 mil. D Stavební PSTAV Pozemky Ostatní POST < 0.5 mil. CH5 Chaty mil. CH5_ > 1 mil. CH Obchodní KPOBCH Komerční prostory Sklad KPSKLAD Výroba KPVYR Kanceláře Garáže 3.26 CC_CommercialMode IdCommercialMode CommercialMode CommercialModeName 1 1 Prodej 2 2 Pronájem 3.27 CC_OfferType IdOfferType OfferType OfferTypeName 1 1 Nabídka 2 2 Poptávka

19 3.28 CC_Region IdRegion Region RegionName 1 1 Praha 2 2 Středočeský 3 4 Jihočeský 4 8 Plzeňský 5 16 Karlovarský 6 32 Ústecký 7 64 Liberecký Královéhradecký Pardubický Vysočina Jihomoravský Olomoucký Moravskoslezský Zlínský Abecední řazení IdRegion Region RegionName 3 4 Jihočeský Jihomoravský 5 16 Karlovarský Královéhradecký 7 64 Liberecký Moravskoslezský Olomoucký Pardubický 4 8 Plzeňský 1 1 Praha 2 2 Středočeský 6 32 Ústecký Vysočina Zlínský 3.29 CC_SubRegion IdSubRegion IdRegion RegionName IdSubRegion IdRegion RegionName nepřiřazeno Nový Jičín 49 1 Praha Opava 58 1 Praha Ostrava 50 1 Praha Ostrava - město 51 1 Praha Kroměříž 52 1 Praha nepřiřazeno 53 1 Praha Uherské Hradiště 54 1 Praha Vsetín 55 1 Praha Zlín 56 1 Praha Bratislava 57 1 Praha Bratislava I 88 1 Praha hl.m Bratislava II 59 2 Benešov Bratislava III 60 2 Beroun Bratislava IV 61 2 Kladno Bratislava V 62 2 Kolín Malacky 63 2 Kutná Hora nepřiřazeno 64 2 Mělník Pezinok 65 2 Mladá Boleslav Senec nepřiřazeno Dunajská Streda 66 2 Nymburk Galanta 69 2 Praha-východ Hlohovec 70 2 Praha-západ nepřiřazeno 68 2 Příbram Piešťany

20 71 2 Rakovník Senica 1 3 České Budějovice Skalica 2 3 Český Krumlov Trnava 3 3 Jindřichův Hradec Bánovce nad Bebravou nepřiřazeno Ilava 4 3 Písek Myjava 5 3 Prachatice nepřiřazeno 6 3 Strakonice Nové Mesto nad Váhom 7 3 Tábor Partizánske 42 4 Domažlice Považská Bystrica 43 4 Klatovy Prievidza nepřiřazeno Púchov 90 4 Plzeň Trenčín 46 4 Plzeň-jih Komárno 44 4 Plzeň-město Levice 45 4 Plzeň-sever nepřiřazeno 47 4 Rokycany Nitra 48 4 Tachov Nové Zámky 15 5 Cheb Šaľa 16 5 Karlovy Vary Topoľčany nepřiřazeno Zlaté Moravce 17 5 Sokolov Bytča 72 6 Děčín Čadca 73 6 Chomutov Dolný Kubín 74 6 Litoměřice Kysucké Nové Mesto 75 6 Louny Liptovský Mikuláš 76 6 Most Martin nepřiřazeno Námestovo 77 6 Teplice nepřiřazeno 78 6 Ústí nad Labem Ružomberok 23 7 Česká Lípa Turčianske Teplice 93 7 Jablonec n/n Tvrdošín 24 7 Jablonec nad Nisou Žilina 25 7 Liberec Banská Bystrica nepřiřazeno Banská Štiavnica 26 7 Semily Brezno 18 8 Hradec Králové Detva 19 8 Jičín Krupina 20 8 Náchod Lučenec nepřiřazeno nepřiřazeno 21 8 Rychnov nad Kněžnou Poltár 22 8 Trutnov Revúca 38 9 Chrudim Rimavská Sobota nepřiřazeno Veľký Krtíš 39 9 Pardubice Zvolen 40 9 Svitavy Žarnovica 41 9 Ústí nad Orlicí Žiar nad Hronom Havlíčkův Brod Bardejov Jihlava Humenné nepřiřazeno Kežmarok Pelhřimov Levoča Třebíč Medzilaborce Žďár nad Sázavou nepřiřazeno 8 11 Blansko Poprad Brno Prešov Brno-město Sabinov 9 11 Brno-venkov Snina Břeclav Stará Ľubovňa Hodonín Stropkov nepřiřazeno Svidník

21 13 11 Vyškov Vranov nad Topľou Znojmo Gelnica Jeseník Košice I nepřiřazeno Košice II Olomouc Košice III Prostějov Košice IV Přerov Košice V Šumperk Košice-okolie Bruntál Michalovce Frýdek Místek Moldava nad Bodvou Karviná nepřiřazeno nepřiřazeno Rožňava Sobrance Spišská Nová Ves Trebišov 3.30 CC_Country IdOfferType OfferType 1 CZ 2 SK 3 NĚMECKO 4 RAKOUSKO 5 CHORVATSKO 6 ITÁLIE 7 ŠPANĚLSKO 8 BULHARSKO 9 EGYPT 10 MAĎARSKO 99 ZAHRANIČÍ 3.31 CC_Vlastnictvi IdVlastnictví Vlastnictví 1 družstevní 2 nájem 3 obecni 4 osobni 3.32 CC_ProfileType Typ služby, výstupních nebo vyhledávaných dat IdService Service 1 SoukromaInzerce 2 Exekuce 3 Drazby 4 Privatizace 5 HlidacLV 6 HlidacCenNemovitosti 7 TipovaHypotek 8 PodobnaNemovitostvOkoli 9 VyhledavacVlastnikaNemovitosti 10 HlidacNemovitostiVlastnika 11 Párování nemovitostí 117 ESO_ BezplatnaInzerce 118 ESO_OsobniMakler

22 119 ESO_openMLS 120 ESO_CenoveMapy

23 4 PŘÍKLADY 4.1 ASP.NET aplikace Všechny ukázky kódu jsou součástí demo aplikace, která je ke stažení na internetových stránkách společnosti OctopusPro. Projekt demo aplikace pro párování inzerátů je v namespace Octop.Pairing.Web. Demo aplikaci je možné stáhnout na adrese Pomocná třída pro vytváření jednotlivých requestů na webovou službu: public static class RequestHelper { /// <summary> /// The Client Tag. /// </summary> public static string ClientTag { get; private set; public static string ClientUsername { get; private set; public static string ClientPassword { get; private set; /// <summary> /// Static constructor. Reads from web.config and then stores it in memory. /// </summary> static RequestHelper() { ClientTag = ConfigurationManager.AppSettings.Get("ClientTag"); ClientUsername = ConfigurationManager.AppSettings.Get("ClientUsername"); ClientPassword = ConfigurationManager.AppSettings.Get("ClientPassword"); public static T Prepare<T>(this T request) where T : RequestBase { request.requestid = RequestId; request.clienttag = ClientTag; request.clientusername = ClientUsername; request.clientpassword = ClientPassword; return request; /// <summary> /// Generates unique request identifier (a Guid) /// </summary> public static string RequestId { get { return Guid.NewGuid().ToString(); Ukázka volání některých služeb z repository ASP.NET aplikace /// <summary> /// Metoda pro vytvoreni requestu pro volani metody parovani z povinných atributů /// </summary> /// <param name="iduser"></param> /// <param name="maxadvertagedays"></param> /// <param name="idcategory"></param> /// <param name="idoffertype"></param> /// <param name="idcommercialmode"></param> /// <param name="idcountry"></param> /// <returns></returns> public ws_pairing_request PreparePairingRequest(int IdUser,

24 { int MaxAdvertAgeDays, int IdCategory, int IdOfferType, int IdCommercialMode, int IdCountry) //vytvor request ws_pairing_request request = new ws_pairing_request().prepare(); request.iduser = IdUser; request.resultagedays = MaxAdvertAgeDays; request.categoryid = new PairingAttributeCategoryIdDTO() { Category = new CategoryDTO() { IdCategory = IdCategory ; request.offertypeid = new PairingAttributeOfferTypeIdDTO() { OfferType = new OfferTypeDTO() {OfferType = IdOfferType ; request.commercialmodeid = new PairingAttributeCommercialModeIdDTO() { CommercialMode = new CommercialModeDTO() { IdCommercialMode = IdCommercialMode ; request.countryid = new PairingAttributeCountryIdDTO() { Country = new CountryDTO() { IdCountry = 1 ; return request; /// <summary> /// Metoda vykonavajici vlastni parovani /// </summary> /// <param name="request"></param> /// <returns></returns> public thitdto[] ProcessPairing(ws_pairing_Request request) { //zavolej WS var response = Client.ws_octop_pairing(request); Correlate(request, response); if (response.acknowledge == AcknowledgeType.Failure) { throw new ApplicationException(response.Message); return response.thits; /// <summary> /// Metoda pro získání číselníku subregionů (možnost filtrace podle IdRegion) /// </summary> public SubRegionDTO[] Get_LOV_SubRegion(int? idregion) { LOV_SubRegionRequest request = new LOV_SubRegionRequest().Prepare(); request.idregion = idregion; var response = Client.ws_octop_get_LOV_SubRegion(request); Correlate(request, response); if (response.acknowledge == AcknowledgeType.Failure) { throw new ApplicationException(response.Message); return response.subregions; /// <summary> /// Metoda pro získání číselníku regionů (možnost filtrace podle IdRegion) /// </summary> public RegionDTO[] Get_LOV_Region(int? idregion) { LOV_RegionRequest request = new LOV_RegionRequest().Prepare();

25 request.idregion = idregion; var response = Client.ws_octop_get_LOV_Region(request); Correlate(request, response); if (response.acknowledge == AcknowledgeType.Failure) { throw new ApplicationException(response.Message); return response.regions; Ukázka práce s atributy Přidání atributu souřadnic (hodnoty jsou v příkladu nenastavené): private void CoordinateExample() { int IdUser = -1; int ResultAgeDays = 365; int IdCategory = 1; int IdOfferType = 1; int IdCommercialMode = 1; int IdCountry = 1; double X, Y, Radius = 0; //priprava zakladniho requestu var request = octorepository.preparepairingrequest(iduser, ResultAgeDays, IdCategory, IdOfferType, IdCommercialMode, IdCountry ); //moznost volby typu souradnic icoordinatetype.wgs84 nebo icoordinatetype.jtsk request.coordinate = new PairingAttributeCoordinateDTO() { CoordinateType = icoordinatetype.jtsk, X = X, Y = Y, Radius = Radius ; Vytvoření XML z navrácených dat: string CreateXml(tHitDTO ohit) { XmlSerializer serializer = new XmlSerializer(oHit.GetType()); MemoryStream ms = new MemoryStream(); XmlTextWriter xmlwriter = new XmlTextWriter(ms, Encoding.UTF8); serializer.serialize(xmlwriter, ohit); ms = (MemoryStream)xmlWriter.BaseStream; ms.seek(0, SeekOrigin.Begin); string xml = ""; using (StreamReader reader = new StreamReader(ms)) { xml = HttpUtility.HtmlEncode(reader.ReadToEnd()); xmlwriter.close(); ms.close(); return xml;

26