Bigle API

Inzerátů

Výpis inzerátů

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

Dotaz

GET - /api/v1/advert/list?key=key&id=id

Název

Typ

Popis

Povinný

key

string

Klíč vývojáře

+

id

string

Cislo maklere

 

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

405 - metoda http není povolena

407 - neplatne prihlaseni

453 - nesprávný formát čísla makléře

message

string

Slovni popis statusu

output

array

Pole objektů

{

   advert_id: cislo inzeratu,

   advert_url: odkaz na detail inzeratu,

   advert_type: druh inzeratu (byty, domy),

   published: 1 - zverejneny, 0 - nezverejneny

}

 


 

Přidání inzerátu

Přidání inzerátu

Dotaz

GET - /api/v1/advert/add?key=key&advert=data

Název

Typ

Popis

Povinný

key

string

Klíč vývojáře

+

advert[advert_function]

int

Typ

1 - Prodej

2 - Pronájem

+

advert[advert_price]

double

Cena

+

advert[advert_price_currency]

int

Mena

1 - Kc

2 - USD

3 - EUR

+

advert[advert_type]

int

Kategorie

1 - Byt

2 - Dům

+

advert[description]

string

Popis

+

advert[advert_room_count]

int

Velikost (jen pro dům)

1 - 1 pokoj

2 - 2 pokoje

3 - 3 pokoje

4 - 4 pokoje

5 - 5 pokoje

6 - 6 a více pokojů

+ (pro domy)

advert[advert_subtype]

int

Podkategorie

Pro byty

2 - 1+kk

3 - 1+1

4 - 2+kk

5 - 2+1

6 - 3+kk

7 - 3+1

8 - 4+kk

9 - 4+1

10 - 5+kk

11 - 5+1

12 - 6 a více

Pro domy

33 - Chata

37 - Rodinný

39 - Vila

43 - Chalupa

+

advert[balcony]

bool

Balkón

 

advert[building_condition]

int

Stav objektu

1 - Velmi dobrý

2 - Dobrý

3 - Špatný

4 - Ve výstavbě

5 - Projekt

6 - Novostavba

7 - K demolici

8 - Před rekonstrukcí

9 - Po rekonstrukci

 

advert[building_type]

int

Stavba

1 - Dřevená

2 - Cihlová

3 - Kamenná

4 - Montovaná

5 - Panelová

6 - Skeletová

7 - Smíšená

 

advert[cellar]

bool

Sklep

 

advert[estate_area]

double

Plocha pozemku

 

advert[floor_number]

int

Patro

 

advert[garage]

bool

Garáž

 

advert[locality_latitude]

double

Zemepisná šířka

+

advert[locality_longitude]

double

Zemepisná délka

+

advert[loggia]

bool

Lodžie

 

advert[ownership]

int

Vlastnictví

1 - Osobní

2 - Družstevní

 

advert[parking_lots]

bool

Parkování

 

advert[seller_id]

string

ID maklere u bigle

 

advert[terrace]

bool

Terasa

 

advert[usable_area]

double

Užitná plocha

 

advert[balcony_area]

double

Plocha balkónu

 

advert[building_area]

double

Plocha zastavená

 

advert[ceiling_height]

double

Výška stropu

 

advert[cellar_area]

double

Plocha sklepu

 

advert[easy_access]

int

Bezbariérový

1 - Ano

2 - Ne

 

advert[elevator]

int

Výtah

1 - Ano

2 - Ne

 

advert[energy_efficiency_rating]

int

Energetická nárocnost

1 - A (mimořádne úsporná)

2 - B (velmi úsporná)

3 - C (úsporná)

4 - D (méne úsporná)

5 - E (nehospodárná)

6 - F (velmi nehospodárná)

7 - G (mimořádne nehospodárná)

 

advert[flat_class]

int

Typ bytu

1 - Mezonet

2 - Loft

3 - Podkrovní

 

advert[floor_area]

double

Plocha podlahová

 

advert[floors]

int

Podlaží pocet

 

advert[garage_count]

int

Pocet garáží

 

advert[garden_area]

double

Plocha zahrady

 

advert[gas]

int

Plyn

1 - Individuální

2 - Plynovod

 

advert[gully]

int

Odpad

1 - Veřejná kanalizace

2 - ČOV pro celý objekt

3 - Septik

4 - Jímka

 

advert[heating]

int

Topení

1 - Lokální plynové

2 - Lokální tuhá paliva

3 - Lokální elektrické

4 - Ústřední plynové

5 - Ústřední tuhá paliva

6 - Ústřední elektrické

7 - Ústřední dálkové

8 - Jiné

 

advert[loggia_area]

double

Plocha lodžie

 

advert[parking]

int

Míst k parkování

 

advert[reconstruction_year]

int

Rok rekonstrukce

 

advert[telecommunication]

int[]

Telekomunikace

1 - Telefon

2 - Internet

3 - Satelit

4 - Kabelová televize

 

advert[terrace_area]

double

Plocha terasy

 

advert[water]

int

Voda

1 - Místní zdroj

2 - Dálkový vodovod

 

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

405 - metoda http není povolena

407 - neplatne prihlaseni

452 - nekompletni data

453 - nesprávný formát parametrů

461 - makler nenalezen

message

string

Slovni popis statusu

output

array

Pole

{

   advert_id: cislo inzeratu

}

 


 


 

Vymazání inzerátu

Vymazání inzerátu makléře

Dotaz

POST - /api/v1/advert/del?key=key&id=id

Název

Typ

Popis

key

string

Klíč vývojáře

id

string

Cislo inzeratu

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

405 - metoda http není povolena

407 - neplatne prihlaseni

452 - nekompletni data

453 - nesprávný formát čísla inzerátu

message

string

Slovni popis statusu

output

array

Žádná data

 


 

Vložení fotografie k inzerátu

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

Dotaz

POST - /api/v1/advert/add-photo?key=key&id=id&photo=photo

Název

Typ

Popis

Povinný

key

string

Klíč vývojáře

+

id

string

Cislo inzeratu

+

photo[data]

base64

Vlastní obrázek

+

photo[main]

bool

Hlavní fotka

1 - hlavní

0 - ostatní

+

photo[alt]

string

Popisek obrázku

 

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

405 - metoda http není povolena

407 - neplatne prihlaseni

452 - nekompletni data

453 - nesprávný formát čísla inzerátu

message

string

Slovni popis statusu

output

array

Pole

{

   photo_id: cislo fotografie

}

 


 


 

Vymazání fotografie

Vymazání fotografie

Dotaz

POST - /api/v1/advert/del-photo?key=key&id=id

Název

Typ

Popis

key

string

Klíč vývojáře

id

string

Cislo fotografie

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

405 - metoda http není povolena

407 - neplatne prihlaseni

452 - nekompletni data

453 - nesprávný formát čísla fotografie

message

string

Slovni popis statusu

output

array

Žádná data

 


 

Výpis fotografie

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

Dotaz

GET - /api/v1/advert/list-photos?key=key&id=id

Název

Typ

Popis

key

string

Klíč vývojáře

id

string

Сislo inzeratu

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

407 - neplatne prihlaseni

452 - nekompletni data

453 - nesprávný formát čísla inzerátu

message

string

Slovni popis statusu

output

array

Pole objektů

{

    id: cislo fotografie,

    ext: foto rozšíření,

    main: hlavni fotografie (1 - ano, 0 - ne),

    date: časové razítko pro vytvoření fotografie,

}

 


 

Výpis statistiky inzerátu

Výpis statistiky inzerátu

Dotaz

GET - /api/v1/advert/stat?key=key&id=id

Název

Typ

Popis

key

string

Klíč vývojáře

id

string

Сislo inzeratu

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

407 - neplatne prihlaseni

452 - nekompletni data

453 - nesprávný formát čísla inzerátu

message

string

Slovni popis statusu

output

array

Pole

{

    advert_id: cislo inzeratu,

    total_views: celkova navstevnost,

    total_price: cena

}

 

Výpis denní statistiky inzerátu

Výpis denní statistiky inzerátu

Dotaz

GET - /api/v1/advert/daily-stat?key=key&id=id

Název

Typ

Popis

key

string

Klíč vývojáře

id

string

Сislo inzeratu

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

407 - neplatne prihlaseni

452 - nekompletni data

453 - nesprávný formát čísla inzerátu

message

string

Slovni popis statusu

output

array

Pole objektů

{

    date: datum dne,

    views: pocet shlednuti,

    price: cena

}

 

Výpis statistiky všech inzerátů

Výpis statistiky všech inzerátů daného klienta za konkrétní den

Dotaz

GET - /api/v1/advert/all-daily-stat?key=key&date=date

Název

Typ

Popis

key

string

Klíč vývojáře

date

date

Datum (dd.mm.yyyy)

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

407 - neplatne prihlaseni

452 - nekompletni data

453 - nesprávný formát čísla inzerátu

message

string

Slovni popis statusu

output

array

Pole objektů

{

    advert_id: cislo inzeratu,

    views: navstevnost,

    advert_price: cena

}

 

Makléř

Výpis makléřů

Výpis všech makléřů vytvořených uživatelem se zadaným klíčem

Dotaz

GET - /api/v1/seller/list?key=key

Název

Typ

Popis

key

string

Klíč vývojáře

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

407 - neplatne prihlaseni

452 - nekompletni data

message

string

Slovni popis statusu

output

array

Pole objektů

{

    seller_id: cislo maklere,

    client_name: jmeno a prijmeni,

    client_login: login (email) maklere,

    photo: 1 - ano, 0 - ne

}

 

Přidání nového makléře

Přidání nového makléře

Dotaz

GET - /api/v1/seller/add?key=key&seller=data

Název

Typ

Popis

Povinný

key

string

Klíč vývojáře

+

seller[client_login]

string

Email pro login

+

seller[client_name]

string

Jmeno a prijmeni

+

seller[contact_phone]

string

Telefon

 

seller[contact_email]

string

Email

+

seller[client_ic]

int

IČO makléře

+

seller[client_is_employee]

bool

Makléř je zaměstnanec

 

seller[broker_specialization]

int[]

Seller specialization

0 - Prodej

1 - Pronájem

2 - Správa nemovitostí

3 - Výkup

4 - Oceňování nemovitostí

5 - Daňové poradenství

6 - Prodej nových budov

7 - Komerční nemovitosti

8 - Pozemky

9 - Investice do nemovitostí

10 - Ostatní

 

seller[makler_note]

string

Poznámka

 

seller[photo]

base64

Obrázek makléře

 

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

407 - neplatne prihlaseni

452 - nekompletni data

message

string

Slovni popis statusu

output

array

Pole

{

    seller_id: seller id,

}

 

Odebrání makléře

Odebrání existujícího makléře

Dotaz

POST - /api/v1/seller/del?key=key&id=id

Název

Typ

Popis

key

string

Klíč vývojáře

id

string

Cislo maklere

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

405 - metoda http není povolena

407 - neplatne prihlaseni

452 - nekompletni data

453 - nesprávný formát čísla makléře

message

string

Slovni popis statusu

output

array

Žádná data

 

Výpis statistik makléře

Výpis denních statistik inzerátů jednoho makléře. Cas je zadán uzavřeným intervalem

Dotaz

GET - /api/v1/seller/stat?key=key&from=date&till=date&seller=seller

Název

Typ

Popis

key

string

Klíč vývojáře

seller

string

Cislo maklere

from

date

Od data (dd.mm.yyyy)

till

date

K datu (dd.mm.yyyy)

 

Odpověď

Název

Typ

Popis

status

int

Status

200 - OK

407 - neplatne prihlaseni

452 - nekompletni data

453 - nesprávný formát čísla makléře

message

string

Slovni popis statusu

output

array

Pole objektů

{

    date: datum dne,

    advert_count: pocet inzeratu,

    views: pocet shlednuti inzeratu

}