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

Metodě se předají parametry podle dále definovaných datových struktur Advert a pro adekvátní druh. Zpět je vrácen status a advert_id, které je dobré si uchovat pro další operace s uloženým inzerátem. Pokud je vyplněn parametr 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 se bude zobrazovat na webovém serveru místo advert_id. Je ho možné také použít při práci s importním rozhraním, kde opět 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í rkid (viz. identifikace inzerátu). Adresu inzerátu lze vyplnit buď klasicky nebo s použitím UIR-ADR. UIR-ADR má tu výhodu, že se adrese doplní automaticky tak, jak je uvedena v katastru nemovitostí. Více informací je uvedeno v sekci Adresy.

V odpovědi serveru může být též přítomen klíč validationNotices, který obsahuje pole hlášení validátoru (např. v případě neplatné číselníkové hodnoty).

Bližší popis parametrů:
  • advert_data Parametry inzerátu.
  • type_data V tomto poli mohou být uvedena data inzerátu (z důvodu zpětné kompatibity), ale všechny parametry můžete místo v tomto parametru uvést v advert_data.

V případě, že v metodě dojde k jinému stavu než je 200 vrací metoda v parametru output datový typ array.

Vrácená struktura

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 (%s),
                                    453=Nejsou vyplněny všechny povinné položky druhu nebo jsou špatného typu (%s),
                                    454=Typ ceny neodpovídá typu nemovitosti.
                                    455=Neplatný kód UIR-ADR,
                                    457=Neplatný kód UIR-ADR,
                                    461=ID makléře neexistuje,
                                    481=Maximální počet operací přes XML-RPC byl dnes již vyčerpán, operace nebyla provedena,
                                    483=Dosáhli jste maximálního povoleného množství inzerátů v rámci vašeho nastavení,
                                    500=Inzerát pro tuto RK neexistuje!
                                    800=Neplatný obsah ve formátu Base64,
                                    801=Nepovolený typ dat ve formátu Base64)
    string statusMessage    Slovni popis statusu.
    struct output
    (
        int   advert_id         cislo inzeratu
        array validationNotices pole validacnich hlaseni
    )
}
		

Vymazání inzerátu.

Pomocí advert_id čísla nebo rkid řetězce je inzerát smazán. Uložené fotografie u inzerátu budou smazány.

Vrácená struktura

struct
{
    int status              Status (200=OK,
                                    407=Neautorizovany pristup
                                    500=Inzerat nenalezen)
    string statusMessage    Slovni popis statusu.
    array output
    (
    )
}
		

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: advert_id, rkid, advert_type a user_status.

V případě, že v metodě dojde k jinému stavu než je 200 vrací metoda v parametru output datový typ array.

Vrácená struktura

struct
{
    int status              Status (200=OK,
                                    407=Neautorizovany pristup)
    string statusMessage    Slovni popis statusu.
    array of struct output
    (
        int advert_id       cislo inzeratu
        string rkid         interni cislo realitky
        int advert_type     druh inzeratu (byty, pozemnky...) podle dokumentace
        int status_user     status inzeratu (aktnivni, neaktnivi) podle dokumentace
    )
}
		

Vložení fotografie k již uloženému inzerátu.

Vstupními parametry jsou advert_id nebo rkid, JPEG soubor zakódovaný pomocí base64, příznak, zda jde o hlavní či vedlejší fotografie (main = 1 – hlavní, main = 0 – vedlejší) a český nebo anglický popisek obrázku (alt, alt_en). Pomocí advert_id nebo rkid se identifikuje inzerát. Vždy má přednost advert_id. Výstupem je photo_id, které je vhodné si uložit pro mazání fotky. Pokud je vkládána vedlejší fotografie, a přitom není u inzerátu žádná, stává se tato automaticky hlavní fotografií. Pokud je vkládána hlavní fotografie, a přitom u inzerátu již jedna je, stane se hlavní fotografie vedlejší a nová hlavní. Minimální rozlišení fotografie je 640x480 a maximální velikost souboru 100kB. Po překročení této velikosti server vrací chybu a fotografii nezpracuje. Fotografie jsou seřazeny podle pořadí vložení.

V případě, že v metodě dojde k jinému stavu než je 200 vrací metoda v parametru output datový typ array.

Vrácená struktura

struct
{
    int status              Status (200=OK,
                                    407=Neplatne prihlaseni
                                    500=Inzerat nenalezen,
                                    471=Popisek k fotografii je povinny,
                                    470=Neni to JPEG obrazek)
    string statusMessage    Slovni popis statusu.
    struct output
    (
        int photo_id        cislo fotografie
    )
}
		

Vymazání fotografie.

Identifikací fotografie je photo_rkid nebo photo_id, které má přednost. Pokud je mazána hlavní fotografie, bude vybrána nová hlavní automaticky.

Vrácená struktura

struct
{
    int status              Status (200=OK,
                                    407=Neplatne prihlaseni
                                    476=Fotografie nenalezena)
    string statusMessage    Slovni popis statusu.
    array output
    (
    )
}
		

Výpis fotografie existujícího inzerátu.

V output je vráceno pole, kde každý prvek pole obsahuje struktůru: photo_id, main (main = 1 – hlavní fotografie, main = 0 – vedlejší fotografie) a photo_rkid.

Vrácená struktura

struct
{
    int status                  Status (200=OK,
                                        407=Neplatne prihlaseni
                                        500=Inzerat nenalezen,
                                        470=Neni to JPEG obrazek,
                                        705=Inzerat neni v tisku)
    string statusMessage        Slovni popis statusu.
    array of struct output
    (
            int photo_id      id fotografie
            int main          je fotografie hlavni?
            string photo_rkid identifikator fotografie
    )
}
		

Výpis statistiky inzerátu.

V output je vráceno pole s prvky top_current (počet zbývajících kreditů na topování), top_charged (počet nabitých top kreditů), list_yesterday (počet včerejších zobrazení ve výpisech), list_total (počet zobrazení ve výpisech celkem), detail_yesterday (počet zobrazení detailu včera) a detail_total (počet zobrazení detailu celkem).

V případě, že v metodě dojde k jinému stavu než je 200 vrací metoda v parametru output datový typ array.

Vrácená struktura

struct
{
    int status              Status (200=OK,
                                    407=Neautorizovany pristup,
                                    452=Chybejici identifikace inzeratu,
                                    500=Inzerat neexistuje)
    string statusMessage    Slovni popis statusu.
    struct output
    (
        int top_current      pocet zbyvajicich kreditu na topovani
        int top_charged      pocet nabitych top kreditu
        int list_yesterday   pocet vcerejsich zobrazeni ve vypisech
        int list_total       pocet zobrazeni ve vypisech celkem
        int detail_yesterday pocet zobrazeni detailu vcera
        int detail_total     pocet zobrazeni detailu celkem
    )
}
		

Výpis statistik všech inzerátu klienta.

V output je vráceno pole s prvky list_yesterday (počet včerejších zobrazení ve výpisech), list_total (počet zobrazení ve výpisech celkem), detail_yesterday (počet zobrazení detailu včera) a detail_total (počet zobrazení detailu celkem).

V případě, že v metodě dojde k jinému stavu než je 200 vrací metoda v parametru output datový typ array.

Vrácená struktura

struct
{
    int status              Status (200=OK,
                                    407=Neautorizovany pristup,
                                    452=Chybejici identifikace inzeratu,
                                    500=Inzerat neexistuje)
    string statusMessage    Slovni popis statusu.
    struct output
    (
        array stats [
               (
                  int top_current      pocet zbyvajicich kreditu na topovani
                  int top_charged      pocet nabitych top kreditu
                  int list_yesterday   pocet vcerejsich zobrazeni ve vypisech
                  int list_total       pocet zobrazeni ve vypisech celkem
                  int detail_yesterday pocet zobrazeni detailu vcera
                  int detail_total     pocet zobrazeni detailu celkem
                  int advert_id        cislo inzeratu
               )
          ]
    )
}
		

Topování existujícího inzerátu.

Vrácená struktura

struct
{
    int status                  Status (200=OK,
                                        407=Neplatne prihlaseni
                                        500=Inzerat nenalezen,
                                        483=Bohužel nemáte dostatek kreditů. Pro jejich získání kontaktujte Vašeho obchodního zástupce portálu RealityMIX.cz.
                                        )
    string statusMessage        Slovni popis statusu.
}