addDevel(session_id as string, devel_data as struct, advert_id as array, rkid as array) as struct

Přidání / editace developerského projektu.

Metodě se předají parametry podle dále definovaných datových struktur Developer (devel_data) a pole spárovaných inzerátů za pomoci advert_id nebo rkid. Zpět je vrácen status a developer_id, které je dobré si uchovat pro další operace s uloženým developerským projektem. Pokud je vyplněn parametr devel_rkid, musí být v rámci inzerce konkrétního klienta unikátní. Je ho možné také použít při práci s importním rozhraním, kde opět zastupuje developer_id. Editace inzerátu se zajistí vyplněním developer_id již uloženého projektu, nebo je možno zadat existující devel_rkid (viz. odstavec 1.1). Spárovat k devel. projektu inzerát je též možné v metodě addAdvert vyplněním položek developer_id nebo devel_rkid. Devel. projekt již musí existovat, jinak spárování neproběhne. Při editaci devel. projektu je nutné uvádět v poli parametru advert_id nebo rkid všechny inzeráty, které projektu patří, jinak bude vazba mezi devel. projektem a inzerátem zrušena.

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).

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
                                    452=Nekompletni data k devel. projektu,
                                    500=Inzerat pro tuto RK neexistuje!)
    string statusMessage    Slovni popis statusu.
    struct output
    (
        int developer_id    cislo devel. projektu
        array validationNotices pole validacnich hlaseni
    )
}

delDevel (session_id as string, developer_id as int, devel_rkid as string) as struct

Vymazání devel. projektu.

Pomocí developer_id čísla nebo devel_rkid řetězce je devel. projekt smazán. Uložené fotografie budou smazány. Všechny navázané inzeráty zůstanou beze změny, pouze ztratí vazbu na devel. projekt.

Vrácená struktura

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

listDevel(session_id as string ) as struct

Výpis všech developerských projektů přihlášené realitní kanceláře.

V output je vráceno pole, kde každý prvek pole obsahuje developer_id, devel_rkid, advert_id (záznamy oddělené středníkem) a rkid (záznamy oddělené středníkem).

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)
    struct output
    (
        int developer_id    cislo devel. projektu
        string devel_rkid   interni cislo realitky
        string advert_id    prirazene inzeraty
        string rkid         prirazene inzeraty
    )
}

addDevelPhoto(session_id as string, developer_id as int, devel_rkid as string, data as base64, main as int, alt as string, photo_rkid as string ) as struct

Vložení fotografie k již uloženému deleveloperskému projektu.

Vstupními parametry jsou developer_id nebo devel_rkid, JPEG soubor zakódovaný pomocí base64, příznak, zda jde o hlavní či vedlejší fotografie (main = 1 – hlavní, main = 0 – vedlejší) a český popisek obrázku (alt). Pomocí developer_id nebo devel_rkid slouží k identifikaci. Vždy má přednost developer_id před devel_rkid (viz. odstavec 1.1). Výstupem je photo_id, které je vhodné si uložit pro mazání fotografie. 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
    )
}

delDevelPhoto(session_id as string, photo_id as int, photo_rkid as string ) as struct

Vymazání fotografie.

Identifikací fotografie je photo_rkid nebo photo_id, které má přednost. Pokud je mazána hlavní fotografie, hlavní se automaticky stane první vedlejší.

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
                                    476=Fotografie nenalezena)
    string statusMessage    Slovni popis statusu.
    array output
    (
    )
}

listDevelPhoto(session_id as string, developer_id as int, devel_rkid as string ) as struct

Výpis fotografie existujícího developerského projektu.

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,
                                    500=Inzerat nenalezen,
                                    407=Neautorizovany pristup)
    string statusMessage    Slovni popis statusu.
    struct output
    (
        int photo_id        cislo fotografie
        int main            hlavni fotografie
        string photo_rkid   identifikace fotografie
    )
}