REST metody

Export je realizován protokolem REST, který volá vzdálené procedury. Protokol při komunikaci přeloží data do formatu JSON a tyto data pak dále přenáší protokolem HTTP

Upozorňujeme, že v případě realitních serverů, je potřeba implementovat všechny dostupné metody. Především pak možnost stahování statistik a poptávek zpět do našeho systému.

Datové typy s * jsou povinné parametry.

Datové typy

Typ	Popis
date	Formát YYYY-MM-DD. Pattern by měl odpovídat "^[0-9]{4}-[0-9]{2}-[0-9]{2}$."
datetime	Formát YYYY-MM-DD HH:ii:ss. Pattern by měl odpovídat "^[0-9]{4}-[0-9]{2}-[0-9]{2}[\s]{1}[0-9]{2}[\:][0-9]{2}[\:][0-9]{2}$."
string	Text
bool	Boolean. Hodnoty true, false případně 1 a 0
float	Numerické hodnoty s desetinou čárkou
array	Pole hodnot
[]	Pole dle typu
string(binary)	Binarní data souboru

Nabidky

/ads/stats

GET

Koncový bod pro načítání celkových statistik nabídek, které patří aktuálnímu uživateli.

Query parametry

parameter	typ	vysvětlení
advertisingCompanyId	string	ID společnosti
advertiserId	string	ID makléře
adId	string	ID nabídky
tag	string	Tag
page	float	Stránka při stránkování u statstik. Minimální hodnota je 1. Výchozí hodnota je 1.
dateFrom	date	Počáteční datum statistik.
dateTo	date	Konečné datum statistik.
fakeData	bool	Mají se vrátit testovací data ?

Odpověď

200

parameter	typ	vysvětlení
data	array
adId	string*	ID nabídky na serveru
adThirdPartyId	string*	ID RK nabídky
advertiserId	string	ID makléře na serveru
advertiserThirdPartyId	string	ID RK makléře
advertisingCompanyId	string	ID realitní kanceláře na serveru
advertisingCompanyThirdPartyId	string	ID RK realitní kanceláře
stats	array
listViews	float	Počet vylistování nabídky
detailViews	float	Počet detailního zobrazení nabídky

/ads/{adId}/stats/daily

GET

Koncový bod pro načítání denních statistik nabídek, které patří aktuálnímu uživateli.

Query parametry

parameter	typ	vysvětlení
adId	string*	ID nabídky
tag	string	Tag
page	float	Stránka při stránkování u statstik. Minimální hodnota je 1. Výchozí hodnota je 1.
dateFrom	date	Počáteční datum statistik.
dateTo	date	Konečné datum statistik.
order	string	Řazení výsledků. Povolená hodnota je asc, desc. Vychozí hodnota je desc
fakeData	bool	Mají se vrátit testovací data ?

Odpověď

200

parameter	typ	vysvětlení
data	array
date	date	Datum.
data	array
listViews	float	Počet vylistování nabídky
detailViews	float	Počet detailního zobrazení nabídky

/ads/{adId}

GET

Koncový bod pro načtění nabídky.

Query parametry

parameter	typ	vysvětlení
adId	string*	ID nabídky

Odpověď

200

parameter	typ	vysvětlení
data	array	Vracení dat nabídky.

404

/ads/{adId}

DELETE

Koncový bod pro odstranění nabídky.

Query parametry

parameter	typ	vysvětlení
adId	string*	ID nabídky

Odpověď

200

404

/ads/{adId}

PATCH

Metoda vychazí z metody "add_ads", ale slouží pro aktualizaci nabídky.

/ads

GET

Koncový bod pro načtění nabídek.

Query parametry

parameter	typ	vysvětlení
advertisingCompanyId	string	ID společnosti
advertiserId	string	ID makléře
tag	string	Tag
statuses	array	Parametry pro filtrování nabídek dle stavu. V případě použití parametru je nutné použít alespoň 1 element. Hodnoty jsou "open", "reserved", "sold", "lost" nebo "inactive".
simplified	bool	Vracení zjednodušených záznamů.

Odpověď

200

/ads

POST

Body parametry

parameter	typ	vysvětlení
thirdPartyId	string	Volitelné vlastní ID, které může být použito pro budoucí aktualizaci nebo mazání nabídky.
status	string	Toto pole řídí stav publicity nabídky. Nabídka se stavem "open" a "reserved" budou veřejně viditelné. Ostatní budou skryty. Pokud byla inzerovaná nemovitost prodána, použijte stav "sold". Pokud se inzerovaná nemovitost nepodařilo prodat a měla by být skryta, použijte stav "lost". Pokud nemáte informaci o tom, zda byla nemovitost prodána či neprodána nebo ji chcete z jiného důvodu skrýt, použijte stav "inactive". Pokud není při vložení poskytnuta, ve výchozím nastavení se "open".
type	string*	Hodnoty jsou "sell" - prodej, "rent" - pronájem, "auction" - aukce nebo "share" - výměna.
advertiserId	string*	ID makléře. Je to buď id, které bylo poskytnuto v odpovědi koncového bodu vložení, nebo to může být thirdPartyId, pokud bylo poskytnuto v těle požadavku koncového bodu add_advertisers.
advertisingCompanyId	string\|null	ID společnosti. Je to buď id, které bylo poskytnuto v odpovědi koncového bodu vložení, nebo to může být thirdPartyId, pokud bylo poskytnuto v těle požadavku koncového bodu add_company.
price	float\|null	Koncová cena pro prodej, nebo měsiční pro pronájem.
currency	string\|null	Hodnoty jsou "czk", "usd" nebo "eur".
priceNote	string\|null	Poznámka k ceně
location	string*	Nejpřesnější popis polohy místa. Nejlépe přesnou adresu ve formátu běžném pro danou zemi. Pokud to není možné, poskytněte nám co nejpřesnější popis polohy. (např. "{název ulice}, {město}")
locationAccuracy	string\|null	Přesnost zadaného umístění. Pokud není při vložení poskytnuto, bude výchozí nastavení "exact". Pokud přesnost chybí nebo je nastavena přesně, zobrazíme přesnou polohu, která byla poskytnuta. Pokud je přesnost nastavena na jinou hodnotu, pokusíme se najít nejbližší entitu zadaného typu, pokud ji nenajdeme, zobrazíme nejbližší nepřesnou entitu, kterou najdeme (např. ulice). Hodnoty jsou "exact", "street", "municipality_part", "municipality", "cadastral_area" nebo "nearest_non_exact_geo_entity".
description	string\|null	Popis u nabídky.
referenceId	string\|null	Také známo jako "advert_code" při XML-RPC.
matterportUrl	string\|null	URL na virtuální prohlídku
possibleMoveInDate	date\|null	Datum možného nastěhování.
estimatedOtherCosts	float\|null	Odhadované další náklady.
point	array
latitude	float*	Zeměpisná šířka
longitude	float*	zeměpisná délka
property	array
type	string*	Hodnota je: "flat" - byt, "building" - budova, "commercial" - komerční, "parcel" - parcela nebo "other" - ostatní
subType	string*	Hodnoty jsou pro byty: "flat", "atelier", "non_residential_space", "project" nebo "other" budovy: "family_house", "recreational_building", "hut", "cottage", "farmstead", "project", "villa" nebo "other" komerční: "apartment_building", "factory", "warehouse", "storage_unit", "office", "commercial_space", "restaurant", "housing", "agricultural", "virtual_office", "doctors_office" nebo "other" parcela: "building_plot", "commercial_land", "field", "meadow", "forest", "pond", "garden", "vineyard", "orchard" nebo "other" ostatní: "parking_spot", "garage" nebo "other"
floor	float\|null	Pouze pro: byt Podlaží
ownership	string\|null	Vlastnictví. Hodnoty jsou "private" - osobní vlastnictví, "collective" - družstevní, "national_or_municipal" - obecní nebo státní, "mixed" nebo "other".
disposition	string\|null	Pouze pro: byt Pole je pouze pro byty. Hodnoty jsou nasledujicí "1+kk", "1+1", "2+kk", "2+1", "3+kk", "3+1", "4+kk", "4+1", "5+kk", "5+1", "larger" - větší nebo "atypic" - atypický.
area	float\|null	Pouze pro: parcela Plocha
floorArea	float\|null	Pouze pro: byt budova komerční Podlahová plocha
utilityArea	float\|null	Pouze pro: byt budova komerční Užitná plocha
landArea	bool\|null	Pouze pro: budova Plocha pozemku
builtupArea	bool\|null	Pouze pro: budova Zastavěná plocha
constructionType	string\|null	Pouze pro: byt budova komerční Konstrukční typ stavby, hodnoty jsou "brick" - cihelná stavba, "panel" - panelák, "wooden" - dřevostavba, "stone" - kámená stavba, "skelet" - skeletová stavba, "prefabricated" - prefabrikovaná stavba nebo "other" - ostatní.
elevator	bool\|null	Pouze pro: byt budova komerční Výtah
floorsCount	float\|null	Pouze pro: byt budova komerční Počet podlaží
balcony	bool\|null	Pouze pro: byt budova komerční Balkón
balconyArea	float\|null	Pouze pro: byt budova komerční Plocha balkónu
loggia	bool\|null	Pouze pro: byt budova komerční Lodžie
loggiaArea	float\|null	Pouze pro: byt budova komerční Plocha lodžie
cellar	bool\|null	Pouze pro: byt budova komerční Sklep
cellarArea	float\|null	Pouze pro: byt budova komerční Plocha sklepu.
terrace	bool\|null	Pouze pro: byt budova komerční Terasa
terraceArea	float\|null	Pouze pro: byt budova komerční Plocha terasy
pool	bool\|null	Pouze pro: budova Bazén
poolType	string\|null	Pouze pro: budova Typ bazénu. Hodnoty jsou "sunken" - zapuštěný, "semi_sunken" - částečně zapuštěný nebo "above_ground" - nadzemní.
pergola	bool\|null	Pouze pro: budova Pergola
pergolaType	string\|null	Pouze pro: budova Typ pergoly. Hodnoty jsou "classic" - klasická, "glassed" - zasklená nebo "bioclimatic" - bioklimatická.
heatPump	bool\|null	Pouze pro: budova Tepelné čerpadlo
heatPumpType	string\|null	Pouze pro: budova Typ tepelného čerpadla. Hodnoty jsou "air_air" - vzduch-vzduch, "air_water" - voda-vzduch, "water_water" - voda-voda nebo "ground_water" - zeme-voda.
solarPanels	bool\|null	Pouze pro: budova komerční Solarní panely
solarPanelsArea	float\|null	Pouze pro: budova komerční Plocha solarních panelů
parkingSpace	bool\|null	Pouze pro: byt budova komerční Parkovací místo
parkingSpaceCount	float\|null	Pouze pro: byt budova komerční Počet parkovacích míst
accessibility	bool\|null	Pouze pro: byt budova komerční Přistupnost
separation	bool\|null	Pouze pro: budova Typ budovy. Hodnoty jsou nasledujicí "terraced" - řadový, "corner" - rohový nebo "stand_alone" - samostatný.
heatingKind	string[]\|null	Pouze pro: byt budova komerční Vytápění. Hodnoty jsou nasledujici "solid_fuels" - tuhá paliva, "gas" - plyn, "electric" - elektrické, "heat_pump" - tepelné čerpadlo, "stove_fireplace" - krb, "heat_network" - rozvody tepla, "other" - ostatní nebo "under_floor" - podlahové.
energyClass	string\|null	Pouze pro: byt budova komerční Energetická třída. Hodnoty jsou A, B, C, D, E, F nebo G.
sauna	bool\|null	Pouze pro: byt budova komerční Sauna
fireplace	bool\|null	Pouze pro: byt budova komerční Krb
electricityConnection	bool\|null	Pouze pro: budova komerční parcela Elektrická přípojka
gasConnection	bool\|null	Pouze pro: budova komerční parcela Plynová přípojka
sewerageConnection	bool\|null	Pouze pro: budova komerční parcela Odpadní přípojka

/ads/{adId}/images/

GET

Query parametry

parameter	typ	vysvětlení
adId	string	ID nabídky

/ads/{adId}/images

POST

Query parametry

parameter	typ	vysvětlení
adId	string	ID nabídky
thirdPartyId	string	ID RK fotografie
orderd	float	Pořadí fotografie

Body parametry

parameter	typ	vysvětlení
file	string(binary)	Fotografie

/ads/{adId}/images/{imageId}

GET

Query parametry

parameter	typ	vysvětlení
adId	string	ID nabídky
imageId	string	ID fotografie

/ads/{adId}/images/{imageId}

PATCH

Endpoint pro změnu informací o fotografii.

Query parametry

parameter	typ	vysvětlení
adId	string*	ID nabídky
imageId	string*	ID fotografie

Body parametry

parameter	typ	vysvětlení
order	float	Pořadí fotografii

/ads/{adId}/images/{imageId}

DELETE

Query parametry

parameter	typ	vysvětlení
adId	string*	ID nabídky
videoId	string*	ID fotografie

/ads/{adId}/videos/

GET

Query parametry

parameter	typ	vysvětlení
adId	string	ID nabídky

/ads/{adId}/videos/

POST

Query parametry

parameter	typ	vysvětlení
adId	string	ID nabídky
thirdPartyId	string	ID RK videa
orderd	float	Pořadí videa

Body parametry

parameter	typ	vysvětlení
file	string(binary)	Videosoubor

/ads/{adId}/videos/{videoId}

GET

Query parametry

parameter	typ	vysvětlení
adId	string	ID nabídky
videoId	string	ID videa

/ads/{adId}/videos/{videoId}

PATCH

Endpoint pro změnu informací o videu.

Query parametry

parameter	typ	vysvětlení
adId	string*	ID nabídky
videoId	string*	ID videa

Body parametry

parameter	typ	vysvětlení
order	float	Pořadí videa

/ads/{adId}/videos/{videoId}

DELETE

Query parametry

parameter	typ	vysvětlení
adId	string*	ID nabídky
videoId	string*	ID videa

Firmy

/companies/{companyId}

GET

Koncový bod pro načtění poboček.

Query parametry

parameter	typ	vysvětlení
companyId	string*	ID pobočky

Odpověď

200

parameter	typ	vysvětlení
data	array	Vracení dat pobočky.

404

/companies/{companyId}

DELETE

Koncový bod pro odstranění pobočky.

Query parametry

parameter	typ	vysvětlení
companyId	string*	ID pobočky

Odpověď

200

404

/companies/{companyId}

PATCH

Metoda vychazí z metody "add_company", ale slouží pro aktualizaci pobočky.

/companies/

GET

Koncový bod pro načtění poboček.

Query parametry

parameter	typ	vysvětlení
tag	string	Tag
page	float	Stránka při stránkování u poboček. Minimální hodnota je 1. Výchozí hodnota je 1.
simplified	bool	Vracení zjednodušených záznamů.

Odpověď

200

/companies/

POST

Body parametry

parameter	typ	vysvětlení
thirdPartyId	string	Volitelné vlastní ID, které může být použito pro budoucí aktualizaci nebo mazání pobočky.
name	string*	Název pobočky
email	string*	Kontaktní email pobočky
tags	array\|string\|null	Tagy jsou řetězce, které lze použít ke kategorizaci entit a poté je filtrovat v koncových bodech seznamu. Pokud máte například více společností nebo inzerentů, kteří jsou součástí větší franšízy, můžete přiřadit značku, která bude odkazovat na tuto franšízu, a poté ji použít v koncových bodech seznamu k nalezení pouze subjektů, které jsou součástí této franšízy.
websiteUrl	string\|null	Webové stránky
phoneNumber	string\|array\|null	Telefoní čísla
location	string\|null	Nejpřesnější popis polohy místa. Nejlépe přesnou adresu ve formátu běžném pro danou zemi. Pokud to není možné, poskytněte nám co nejpřesnější popis polohy. (např. "{název ulice}, {město}")
locationAccuracy	string\|null	Přesnost zadaného umístění. Pokud není při vložení poskytnuto, bude výchozí nastavení "exact". Pokud přesnost chybí nebo je nastavena přesně, zobrazíme přesnou polohu, která byla poskytnuta. Pokud je přesnost nastavena na jinou hodnotu, pokusíme se najít nejbližší entitu zadaného typu, pokud ji nenajdeme, zobrazíme nejbližší nepřesnou entitu, kterou najdeme (např. ulice). Hodnoty jsou "exact", "street", "municipality_part", "municipality", "cadastral_area" nebo "nearest_non_exact_geo_entity".
ico	string\|null	IČO
dic	string\|null	DIČ

/companies/{companyId}/profile-image

PATCH

Endpoint pro změnu fotografie.

Query parametry

parameter	typ	vysvětlení
companyId	string*	ID pobočky

Body parametry

parameter	typ	vysvětlení
image	string(binary)	Fotografie pobočky

Makleri

/advertisers/{advertiserId}

GET

Koncový bod pro načtění uživatelů.

Query parametry

parameter	typ	vysvětlení
advertiserId	string*	ID makléře

Odpověď

200

parameter	typ	vysvětlení
data	array	Vracení dat makléře.

404

/advertisers/{advertiserId}

DELETE

Koncový bod pro odstranění makléře.

Query parametry

parameter	typ	vysvětlení
advertiserId	string*	ID makléře

Odpověď

200

404

/advertisers/{advertiserId}

PATCH

Metoda vychazí z metody "add_seller", ale slouží pro aktualizaci makléře.

/advertisers/

GET

Koncový bod pro načtění poboček.

Query parametry

parameter	typ	vysvětlení
page	float	Stránka při stránkování u poboček. Minimální hodnota je 1. Výchozí hodnota je 1.
advertisingCompanyId	string	ID společnosti
advertiserId	string	ID makléře
tag	string	Tag

Odpověď

200

/advertisers/

POST

Body parametry

parameter	typ	vysvětlení
thirdPartyId	string	Volitelné vlastní ID, které může být použito pro budoucí aktualizaci nebo mazání makléře.
advertisingCompanyId	string	ID společnosti
fullName	string*	Celé jméno makléře
email	string*	Kontaktní email makléře
tags	array\|string\|null	Tagy jsou řetězce, které lze použít ke kategorizaci entit a poté je filtrovat v koncových bodech seznamu. Pokud máte například více společností nebo inzerentů, kteří jsou součástí větší franšízy, můžete přiřadit značku, která bude odkazovat na tuto franšízu, a poté ji použít v koncových bodech seznamu k nalezení pouze subjektů, které jsou součástí této franšízy.
phoneNumber	string\|array\|null	Telefoní čísla
ico	string\|null	IČO
dic	string\|null	DIČ
location	string\|null	Nejpřesnější popis polohy místa. Nejlépe přesnou adresu ve formátu běžném pro danou zemi. Pokud to není možné, poskytněte nám co nejpřesnější popis polohy. (např. "{název ulice}, {město}")
locationAccuracy	string\|null	Přesnost zadaného umístění. Pokud není při vložení poskytnuto, bude výchozí nastavení "exact". Pokud přesnost chybí nebo je nastavena přesně, zobrazíme přesnou polohu, která byla poskytnuta. Pokud je přesnost nastavena na jinou hodnotu, pokusíme se najít nejbližší entitu zadaného typu, pokud ji nenajdeme, zobrazíme nejbližší nepřesnou entitu, kterou najdeme (např. ulice). Hodnoty jsou "exact", "street", "municipality_part", "municipality", "cadastral_area" nebo "nearest_non_exact_geo_entity".

/advertisers/{advertiserId}/profile-image

PATCH

Endpoint pro změnu fotografie.

Query parametry

parameter	typ	vysvětlení
advertiserId	string*	ID makléře

Body parametry

parameter	typ	vysvětlení
image	string(binary)	Fotografie pobočky

/inquiries/

GET

Endpoint pro stahování zpráv.

Query parametry

parameter	typ	vysvětlení
advertisingCompanyId	string	ID společnosti
advertiserId	string	ID makléře
adId	string	ID nabídky
tag	string	Tag
page	float	Stránka při stránkování u zpráv. Minimální hodnota je 1. Výchozí hodnota je 1.
dateFrom	date	Počáteční datum zpráv.
dateTo	date	Konečné datum zpráv.
fakeData	bool	Mají se vrátit testovací data ?