Dokumentacija - Dobro jem API V2

Restavracije Restavracija Registracija Prijava Prijava preko socialnih omrežij Komentiranje Ocenjevanje Priljubljeno Iskanje Offline
Možnost Privzeta vrednost Opis
limit Omeji število poslanih restavracij v aplikacijo
lat 0 Zemljepisna širina uporabnika
lng 0 Zemljepisna dolžina uporabnika
order distance_asc Razvrsti restavracije po danem ključu

Možnosti:

  • distance_asc - Razvrsti restavracije po oddaljenosti od uporabnika naraščujoče (od najbližje do najbolj oddaljene)
  • distance_desc - Razvrsti restavracije po oddaljenosti od uporabnika (od najbolj oddaljene do najbližje)
  • name_asc - Razvrsti restavracije po imenu (od A do Ž)
  • name_desc - Razvrsti restavracije po imenu (od Ž do A)
  • rating_asc - Razvrsti restavracije po povprečni skupni oceni naraščujoče
  • rating_desc - Razvrsti restavracije po povprečni skupni oceni padajoče
  • id_asc - Razvrsti restavracije po internem ID-ju baze naraščujoče
  • id_desc - Razvrsti restavracije po internem ID-ju baze padajoče
restaurants | array
Ključ Opis
id int
Interni ID v podatkovni bazi
original_id string
Hash, ki povezuje restavracijo z menijem, oceno, komentarjem, priljubljenim
name string
Ime restavracije
address string
Naslov restavracije
price string
Cena doplačila ob uporabi študentskega bona
city string
Mesto v katerem se nahaja restaracija
lat double
Zemljepisna širina restavracije
lng double
Zemljepisna dolžina restavracije
phones array
Vse telefonske številke restavracije
distance string
Razdalja med uporabnikom in restavracijo (zračna razdalja)
rating float
Povprečna ocena restavracije
comments NOVO integer
Številko komentarjev restavracije
time_remaning string
Zapisano koliko je še do odprtja/zaprtja restavracije
opened bool | null
Stanje restavracije (odprta, zaprta, nimamo podatka)
Možnost Privzeta vrednost Opis
lat 0 Zemljepisna širina uporabnika
lng 0 Zemljepisna dolžina uporabnika
logged false V primeru da je (logged == true) so v rezulatu vključeni še klomentarji restavracije
restaurant | array
Ključ Opis
id int
Interni ID v podatkovni bazi
original_id string
Hash, ki povezuje restavracijo z menijem, oceno, komentarjem, priljubljenim
name string
Ime restavracije
address string
Naslov restavracije
price string
Cena doplačila ob uporabi študentskega bona
city string
Mesto v katerem se nahaja restaracija
weekdays string
Odpiralni čas restavracije med tednom
saturdays string
Odpiralni čas restavracije ob sobotah
sundays string
Odpiralni čas restavracije ob nedeljah in praznikih
lat double
Zemljepisna širina restavracije
lng double
Zemljepisna dolžina restavracije
phones array
Vse telefonske številke restavracije
distance string
Razdalja med uporabnikom in restavracijo (zračna razdalja)
rating float
Povprečna ocena restavracije
time_remaning string
Zapisano koliko je še do odprtja/zaprtja restavracije
opened bool | null
Stanje restavracije (odprta, zaprta, nimamo podatka)
menus array | string
Vsebuje vse menije na voljo v restavraciji ali pa string 'Ni dnevnih menijev!'
ratings array
Vsebuje polje vseh posameznih ocen za vsako izmed kategorij
comments array
Vsebuje polje vseh komentarjev restavracije (avtor, vsebina, datum). To polje je vključeno v rezultat le če je uporabnik prijavljen!
Možnost Privzeta vrednost Opis
email E-naslov uporabnika
password Geslo uporabnika
password_verify Ponovljeno geslo uporabnika
register | array
Ključ Opis
response bool
Vsebuje rezutat ali je bila kacija izvedena uspešno ali ne
message string
Vsebuje sporočilo ob izvšeni akciji
Možnost Privzeta vrednost Opis
email E-naslov uporabnika
password Geslo uporabnika
login | array
Ključ Opis
name string
Ime in priimek uporabnika
address string
Naslov uporabnika, če ga je vnesel
username string
Uporabniško ime, če ga je vnesel
email string
E-naslov uporabnika
lat double
Zemljepisna širina uporabnika, če ima vnešen naslov
lng double
Zemljepisna dolžina uporabnika, če ima vnešen naslov
Možnost Privzeta vrednost Opis
provider Ime socialnega omrežja preko katerega se je uporabnik prijavil

Možnosti:

  • facebook
  • twitter
  • github
provider_id ID uporabnika na tem socialnem omrežju
email E-naslov uporabnika na izbranem socialnem omrežju.
name null Ime in priimek uporabnika na socialnem omrežju
social | array
Ključ Opis
response bool
Vsebuje rezutat ali je bila kacija izvedena uspešno ali ne
message string
Vsebuje sporočilo ob izvšeni akciji
Možnost Privzeta vrednost Opis
user ID uporabnika
restaurant Original ID restavracije
comment Vsebina komentarja
comment | array
Ključ Opis
response bool
Vsebuje rezutat ali je bila kacija izvedena uspešno ali ne
message string
Vsebuje sporočilo ob izvšeni akciji
Možnost Privzeta vrednost Opis
user ID uporabnika
restaurant Original ID restavracije
rate Ocena od 1 do 5
type Tip ocene

Možnosti:

  • quality - Kvaliteta hrane
  • clean - Čistoča restavracije
  • service - Kvaliteta strežbe
  • ambient - Ambient v restavraciji
rate | array
Ključ Opis
response bool
Vsebuje rezutat ali je bila kacija izvedena uspešno ali ne
message string
Vsebuje sporočilo ob izvšeni akciji
Možnost Privzeta vrednost Opis
user ID uporabnika
restaurant Original ID restavracije
favourite | array
Ključ Opis
response bool
Vsebuje rezutat ali je bila kacija izvedena uspešno ali ne
message string
Vsebuje sporočilo ob izvšeni akciji
type bool
Če je true, potem je restavracijo dodal med priljubljene, drugače odstranil
Možnost Privzeta vrednost Opis
search Iskalni niz
user null ID uporabnika ki je zahteval iskanje
order id_asc Razvrstitev rezultatov

Možnosti:

  • id_asc - ID naraščujoče
  • id_desc - ID padajoče
  • price_asc - Cena naraščujoče
  • price_desc - Cena padajoče
lat 0 Zemljepisna širina uporabnika
lng 0 Zemljepisna dolžina uporabnika
search | array
Ključ Opis
id int
Interni ID v podatkovni bazi
original_id string
Hash, ki povezuje restavracijo z menijem, oceno, komentarjem, priljubljenim
name string
Ime restavracije
address string
Naslov restavracije
price string
Cena doplačila ob uporabi študentskega bona
city string
Mesto v katerem se nahaja restaracija
lat double
Zemljepisna širina restavracije
lng double
Zemljepisna dolžina restavracije
phones array
Vse telefonske številke restavracije
distance string
Razdalja med uporabnikom in restavracijo (zračna razdalja)
rating float
Povprečna ocena restavracije
comments NOVO integer
Števlio komentarjev, ki jih ima restavracija.
time_remaning string
Zapisano koliko je še do odprtja/zaprtja restavracije
opened bool | null
Stanje restavracije (odprta, zaprta, nimamo podatka)
Možnost Privzeta vrednost Opis
limit Omeji število poslanih restavracij v aplikacijo
offline | array
Ključ Opis
id int
Interni ID v podatkovni bazi
original_id string
Hash, ki povezuje restavracijo z menijem, oceno, komentarjem, priljubljenim
name string
Ime restavracije
address string
Naslov restavracije
price string
Cena doplačila ob uporabi študentskega bona
city string
Mesto v katerem se nahaja restaracija
lat double
Zemljepisna širina restavracije
lng double
Zemljepisna dolžina restavracije
phones array
Vse telefonske številke restavracije