Importní rozhraní manuál - Metody nemovitostí

Metody nemovitostí

addAdvert( session_id as string, advert_data as struct )

Přidání / editace inzerátu.

Metodě se předává slovník advert_data, který v sobě nese veškeré číselníkové i nečíselníkové údaje o inzerátu. Možné atributy inzerátu jsou vypsány Zde. Pokud chybí povinná položka, addAdvert končí s chybou. Pozor, některé položky jsou povinné v závislosti na typu (kategorii) inzerátu.

Pozor, datová struktura advert_data nemusí obsahovat všechny předepsané atributy, jsou vyžadovány pouze povinné atributy. Pokud atribut není ve slovníku obsažen, server odpovídající položku nechává nedotčenou. Tedy nemění samovolně její hodnotu.

Metoda vrací status a advert_id, které je vhodné si uchovat pro další operace s uloženým inzerátem. Pokud je vyplněn parametr advert_rkid, musí být v rámci inzerce konkrétního klienta unikátní. Tento parametr obsahuje vlastní identifikátor inzerátu a tento identifikátor lze v budoucnu použít pro práci s inzerátem přes importní rozhraní, kde plně zastupuje advert_id. Editace inzerátu se zajistí vyplněním advert_id již uloženého inzerátu, nebo je možno zadat existující advert_rkid (viz úvod). Adresu inzerátu lze vyplnit více způsoby: klasické zadání, RUIAN(UIR-ADR), GPS souřadnice, viz zdávání adresy.

Pokud zadáte cenu 0 nebo 1, bude místo ceny zobrazeno Info o ceně u RK.
struct
{
	int status 			Status (200=OK
						404=Inzerát pro tuto RK neexistuje
						407=Neplatné přihlášení
						452=Nekompletní data k inzeratu
						461=Makleř neexistuje
					)
	string statusMessage 		Slovní popis statusu.
	array struct output
	(
		int advert_id 	Číslo inzerátu
	)
}

delAdvert( session_id as string, advert_id as int, advert_rkid as string )

Vymazání inzerátu.

Pomocí advert_id nebo advert_rkid se identifikuje inzerát ( viz úvod). Uložené fotografie u inzerátu a statistiky budou smazány. Pokud inzerát neexistuje bude vrácen status OK (200).

Inzeráty nejsou smazány ihned po zavolání této metody, aktuálně se drží ještě po dobu 21 dní než se opravdu smažou.
struct
{
	int status 			Status (200=OK
					   	407=Neplatné přihlášení
						452=Nejsou vyplněny všechny povinné položky nebo jsou 
						    špatného typu
					)
	string statusMessage 		Slovni popis statusu.
	array struct output
	(
	)
}

listAdvert( session_id as string )

Výpis všech inzerátů přihlášené realitní kanceláře.

V output je vráceno pole, kde každý prvek pole obsahuje strukturu (viz níže). Inzeráty jsou seřazeny podle pořadí vložení.

struct
{
	int status 		Status (200=OK
					   	407=Neplatné přihlášení
					)
	string statusMessage 		Slovni popis statusu.
	array struct output
	(
		int advert_id 		Číslo inzerátu
		string advert_rkid 	Interní číslo realitky
		string advert_url 	Odkaz na detail inzeratu na server realitnitrznice.cz
		int advert_type 	Druh inzerátu (byty, pozemky...) podle dokumentace
		int hash_id verejne 	Číslo inzerátu
		string modified 	Datum poslední editace. (format datumu: YYYY-MM-DD)
		int published 		1=inzerát zveřejněný, 0=inzerát nezveřejněný
		int published_status 	Status kod - důvod nezveřejnění inzerátu
					(viz Status kody inzerátu)
		int top 		inzerát je(1)/není(0) dnes zvýhodněn [0,1]
	)
}

topAdvert( session_id as string, advert_id as int, advert_rkid as string )

Nastavit zvýhodnění inzerátu pro aktuální den

Pomocí advert_id nebo advert_rkid se identifikuje inzerát ( viz úvod). Zvýhodňení inzerátu (tzv. topování) je možnost inzerát umístit do horních pozic ve výpise inzerátu. Topování je zpoplatněno dle aktuálního ceníku. Inzerát lze "topovat" jen jednou denně nebo dle aktuálních podmínek. Nelze topovat v den vložení inzerátu, ani pokud není inzerát zvěrejněn. Nelze zvýhodnit (topovat) nezveřejněný nebo neschválený inzerát.

struct
{
	int status 		Status (200=OK
					   	404=Inzerát nenalezen
					   	407=Neplatné přihlášení
					   	452=Nejsou vyplněny všechny povinné položky nebo jsou 
					   	    špatného typu
					   	477=Nelze topovat v den vloženi
					   	479=Nelze topovat nezveřejněny inzerát
					   	482=Dnes již byl inzerát zvýhodněn
					)
	string statusMessage 		Slovni popis statusu.
	array struct output
	(
	)
}

rejuvenateAdvert( session_id as string, advert_id as int, advert_rkid as string )

Připravujeme

hightliteAdvert( session_id as string, advert_id as int, advert_rkid as string )

Připravujeme