Popis API pro jídelníčky menz ČVUT - JAPI ver. 2
Adresa JAPI: https://agata.suz.cvut.cz/jidelnicky/JAPIV2/json_API.php?Funkce=GetJidla&Podsystem=1&api=Klic&SecondID=1&Lang=cs
Seznam funkcí a tříd.
Podsystémy: funkce pro podsystémy (Menzy, Výdejny, Bufety ...)
Výdejny: funkce pro výdejny (Jídelna, Restaurace, Jídelna1, Pokladna ...)
Kategorie (typ stravy): funkce pro kategorie (Polévka, Hlavní jídlo, specialita, ....)
Piktogramy: funkce pro piktogramy
Jídla: funkce pro jídla denních jídelníčků
Snídaně: funkce pro stálou nabídku snídaní na menze Strahov a Technické menze
Informace : funkce pro informace o podsystémech
Otevírací doby: funkce pro otevírací doby
Kontakty a Adresy: funkce pro kontakty a adresy
Odkazy: funkce pro webové odkazy - ubvedené pod jídelníčky jednotlivých provozů
Týdenní jídelníčky: funkce pro týdenní jídelníčky
Restaurace menzy Strahov
function GetPodsystemyCount():int
Funkce vrací počet podsystému aktivních
Příklad použití:
Funkce: GetPodsystemyCount
Podsystem: není vyžadováno
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetPodsystemyCount &api=Klic
načítám
function GetPodsystemyHash():string
Tato funkce vrací hash - string - indikace zmeny
Příklad použití:
Funkce: GetPodsystemyHash
Podsystem: není vyžadováno
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetPodsystemyHash &api=Klic
načítám
id
int
index podsystému
popis
string
popisný název podsystému (pro popis na webu jidelníčků se používá popiska z objektu TInfo - podsystem_web)
otevreno
bool
false - Zavřeno, true - Otevřeno - jedná se o dlouhodobý údaj o otevření či uzavření provozu např. prázdniny
jidelnicek_denni
bool
podsystém vystavuje denní jídelní lístek: true, false
jidelnicek_tydenni
bool
podsystém vystavuje týdenní jídelní listek: true, false
poradi
int
poradi podsystémů jako na webu
function GetPodsystemy(Podsystemy):Podsystemy
Tato funkce vrací JSON formátované pole objektů TPodsystem daty o podsystémech ze serveru.
Příklad použití:
Funkce: GetPodsystemy
Podsystem: není vyžadováno
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetPodsystemy &api=Klic
načítám
function GetVydejnyCount(Podsystem):int
Podsystem
index podsystému
Funkce vrací počet výdejen pro daný podsystém
Příklad použití:
Funkce: GetVydejnyCount
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetVydejnyCount &api=Klic&Podsystem=1
načítám
function GetVydejnyHash(Podsystem):string
Podsystem
index podsystému
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetVydejnyHash
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetVydejnyHash &api=Klic&Podsystem=1
načítám
id
int
index výdejny
podsystem_id
int
index podsystému ke kterému výdejna náleží
nazev
string
název výdejny
popis
string
popisný název výdejny - používá se na webovém jídelníčku jako popiska výdejny
zkratka
string
zkratka výdejny - používá se na webovém jídelníčku (R - Restaurace, J - Jídelna)
function GetVydejny(Podsystem):Vydejny
Podsystem
index podsystému
Tato funkce vrací JSON formátované pole objektů TVydejna daty o výdejnách pro daný podsystém ze serveru
Příklad použití:
Funkce: GetVydejny
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetVydejny &api=Klic&Podsystem=1
načítám
function GetKategorieCount(Podsystem):int
Podsystem
index podsystému
Funkce vrací počet kategorií pro daný podsystém
Příklad použití:
Funkce: GetKategorieCount
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetKategorieCount &api=Klic&Podsystem=1
načítám
function GetKategorieHash(Podsystem) : string
Podsystem
index podsystému
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetKategorieHash
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetKategorieHash &api=Klic&Podsystem=1
načítám
id
int
index kategorie
podsystem_id
int
index podsystému ke kterému kategorie náleží
nazev
string
název kategorie
popis
string
popisný název kategorie - používá se na webovém jídelníčku jako popiska
poradi
int
pořadí podle kterého jsou kategorie vypisovýny na webovém jídelníčku
function GetKategorie(Podsystem):Kategorie;
Podsystem
index podsystému
Tato funkce vrací JSON formátované pole objektů TTypStravy daty o kategoriích pro daný podsystém ze serveru
Příklad použití:
Funkce: GetKategorie
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetKategorie &api=Klic&Podsystem=1
načítám
function GetPiktogramyCount():int - zatím není funkční
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetPiktogramyCount
Podsystem: není vyžadován
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetPiktogramyCount &api=Klic
načítám
function GetPiktogramyHash():string
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetPiktogramyHash
Podsystem: není vyžadován
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetPiktogramyHash &api=Klic
načítám
id
int
index
nazev
string
název piktogramu
function GetPiktogramy():Piktogramy
Tato funkce vrací JSON formátované pole objektů TPiktogram daty o piktogramech
Příklad použití: >
Funkce: GetPiktogramy
Podsystem: není vyžadován
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetPiktogramy &api=Klic
načítám
function GetJidlaCount(Podsystem):int
Podsystem
index podsystemu
Funkce vrací počet jídel na dnešní den pro danný podsystém
Příklad použití:
Funkce: GetJidlaCount
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetJidlaCount &api=Klic&Podsystem=1
načítám
function GetJidlaHash(Podsystem):string
Podsystem
index podsystemu
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetJidlaHash
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetJidlaHash &api=Klic&Podsystem=1
načítám
id
int
index jídla
podsystem_id
int
index podsystému ke kterému jídlo náleží
datum
string
datum - ve formátu 'YYYY-MM-DD'
vydejny
int array
seznam výdejen (indexů) na kterých je jídlo vydáváno
kategorie
int
index kategorie - Polévka, Hlavní jídlo, atd
vaha
string/null
váha zobrazovaná na webovém jídelníčku, pokud není uvedeno vrací null
nazev
string/null
název jídla
priloha_a
string/null
název jídla: priloha A
priloha_b
string/null
název jídla: priloha B
cena_stud
float
studentská cena
cena
float
cena
alergerny
int array
alergeny
foto
string/null
file name jidlo foto - pouziti: jidelnicky/showfotoG.php?clPodsystem=1&xFile="foto"
piktogramy
int array
seznam indexu piktogramu
aktivni
boolean
specifikuje, zda se jidlo vydava (true) nebo již došlo (false)
function GetJidla(Podsystem):Jidla
Podsystem
index podsystemu
Tato funkce vrací JSON formátované pole objektů TJidlo daty o jídlech ze serveru
Příklad použití:
Funkce: GetJidla
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetJidla &api=Klic&Podsystem=1
načítám
function GetSnidaneHash(Podsystem):string
Podsystem
index podsystemu
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetSnidaneHash
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetSnidaneHash &api=Klic&Podsystem=1
načítám
id
int
index snídaně
podsystem_id
int
index podsystému ke kterému jídlo náleží
nazev
string/null
název snídaně
cena_stud
float
studentská cena
cena
float
cena
alergerny
int array
alergeny
foto
string
odkaz na funkci pro stazeni Fota (PNG): json_API.php?Funkce=GetSnidaneFoto&api=Klic&SecondID=ID, kde SecondID je index snidane
function GetSnidane(Podsystem):Snidane
Podsystem
index podsystemu
Tato funkce vrací JSON formátované pole objektů TJSnidane daty o snídaních ze serveru
Příklad použití:
Funkce: GetSnidane
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetSnidane &api=Klic&Podsystem=1
načítám
function GetGlobalInfoHash():string
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetGlobalInfoHash
Podsystem: není vyžadován
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetGlobalInfoHash &api=Klic
načítám
function GetGlobalInfo():string/null
Tato funkce vrací HTML kód informace pokud existuje nebo null pokud neexistuje aktuálně žádné globální info
Příklad použití:
Funkce:GetGlobalInfo
Podsystem: není vyžadován
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetGlobalInfo &api=Klic
načítám
function GetAktualityHash(Podsystem):string
Podsystem
index podsystému
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetAktualityHash
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetAktualityHash &api=Klic&Podsystem=1
načítám
function GetAktuality(Podsystem):string/null
Podsystem
Index podsystému
Tato funkce vrací HTML kód aktuality dle podsystému
Příklad použití:
Funkce: GetAktuality
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetAktuality &api=Klic&Podsystem=5
načítám
function GetAktualityS(Podsystem):string/null
Podsystem
Index podsystému
Vrací čistý text aktuality pro danný podsystém nebo null pokud neexistuje
Příklad použití:
Funkce: GetAktualityS
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetAktualityS &api=Klic&Podsystem=5
načítám
function GetInfoHash(Podsystem):string
$PodsystemID
index podsystému
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetInfoHash
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetInfoHash &api=Klic&Podsystem=1
načítám
id
int
index informace
podsystem_id
int
index podsystému ke kterému informace náleží
podsystem_web
string
popisný název podsystému používaný na webovém jídelníčku
text_dole
string/null
text zobrazovaný na webovém jídelníčku dole modré orámování - FORMÁT PROSTÝ TEXT
menu
int
aktuální výdej (0-obědy, 1-večeře)
function GetInfo(Podsystem):Infos
$PodsystemID
index podsystému
Tato funkce vrací JSON formátované pole objektů TInfo daty o informacích pro daný podsystém ze serveru
Příklad použití:
Funkce: GetInfo
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetInfo &api=Klic&Podsystem=1
načítám
function GetOtDobyCount(Podsystem):int
Podsystem
index podsystému
Funkce vrací počet radku otevírací doby pro daný podsystém
Příklad použití:
Funkce: GetOtDobyCount
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetOtDobyCount &api=Klic&Podsystem=1
načítám
function GetOtDobyHash(Podsystem):string
Podsystem
index podsystému
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetOtDobyHash
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetOtDobyHash &api=Klic&Podsystem=1
načítám
id
int
index OD
podsystem_id
int
index podsystému ke kterému OD náleží
vydejna_id
int
index výdejny ke které se OD váže
vydejna_nazev
string
popisující název výdejny - používá se na webovém jídelníčku jako popiska výdejny
vydejna_zkratka
string
zkratka výdejny (R - Restaurace, VJ - velka jidelna)
vydejna_poradi
int
pořadí podle kterého se výdejny vypisují na webovém jídelníčku v sekci Otevírací doby
od_popisek
string/null
popisek řádku OD (snídaně, večeře)
od_poradi
int
pořadí podle kterého se řádky OD vypisují u výdejen na webovém jídelníčku
od_den_od
string/null
Den od (Po, Út, St,...)
od_den_do
string/null
Den do (Po, Út, St,...)
od_cas_od
string
Čas od jako string např 10:00
od_cas_do
string
Čas do jako string např 20:00
function GetOtDoby(Podsystem):OtDoby
Podsystem
index podsystému
Tato funkce vrací JSON formátované pole objektů TOtDoba daty o otevíracích dobách pro daný podsystém ze serveru
Příklad použití:
Funkce: GetOtDoby
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetOtDoby &api=Klic&Podsystem=1
načítám
function GetKontaktyHash():string
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetKontaktyHash
Podsystem: není vyžadován
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetKontaktyHash &api=Klic
načítám
id
int
index
podsystem_id
int
index podsystému ke kterému kontakt náleží
maps
string
GPS souřadnice ve tvaru(např): 50.105612,14.388666
poradi
int
pořadí podle kterého se kontakty vypisují na webovém jídelníčku v sekci kontakty
pozice
string/null
název pozice kontaktní osoby
jmeno
string/null
jméno kontaktní osoby
telefon
string/null
telefon
email
string/null
email
function GetKontakty():Kontakty
Tato funkce vrací JSON formátované pole objektů TKontakt daty o kontaktech pro vsechny podsystemy
Příklad použití:
Funkce: GetKontakty
Podsystem: není vyžadován
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetKontakty &api=Klic
načítám
function GetKontaktyP(Podsystem):Kontakty
Podsystem
index Podsystému
Tato funkce vrací JSON formátované pole objektů TKontakt daty o kontaktech pro daný podsystemy
Příklad použití:
Funkce: GetKontaktyP
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetKontaktyP &api=Klic&Podsystem=1
načítám
function GetAdresyHash():string
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetAdresyHash
Podsystem: není vyžadován
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetAdresyHash &api=Klic
načítám
id
int
index
podsystem_id
int
index podsystému ke kterému informace náleží
podsystem_nazev
string
název podsystému
adresa
string
adresa podsystému
mapag
string
GPS souřadnice ve tvaru(např): 50.105612,14.388666 : pro google maps: https://www.google.com/maps/search/?api=1&query=50.105612,14.388666
GetAdresy():Adresy
Tato funkce vrací JSON formátované pole objektů TAdresy daty o adresach a GPS souradnicich pro vsechny podsystemy
Příklad použití:
Funkce: GetAdresy
Podsystem: není vyžadován
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetAdresy &api=Klic
načítám
GetAdresyP(Podsystem):Adresy
Podsystem
index Podsystému
Tato funkce vrací JSON formátované pole objektů TAdresy daty o adresach a GPS souradnicich pro daný podsystemy
Příklad použití:
Funkce: GetAdresyP
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetAdresyP &api=Klic&Podsystem=1
načítám
function GetOdkazyHash(Podsystem):string
Podsystem
index podsystému
Tato funkce vrací hash - indikace zmeny
Příklad použití:
Funkce: GetOdkazyHash
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetOdkazyHash &api=Klic&Podsystem=1
načítám
id
int
index
podsystem_id
int
index podsystému ke kterému odkaz náleží
podsystem_nazev
string
název podsystému
ico
string
link
string
popis
string
function GetOdkazy(Podsystem):Links
Podsystem
index podsystému
Tato funkce vrací JSON formátované pole objektů TLink
Příklad použití:
Funkce: GetOdkazy
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetOdkazy &api=Klic&Podsystem=1
načítám
id
int
index týdne
popis
string
popisný název týdne
platnost_od
string
platnost od data - ve formátu 'YYYY-MM-DD'
platnost_do
string
platnost do data - ve formátu 'YYYY-MM-DD'
function GetTydny(Podsystem):Tydny
Podsystem
index podsystemu
Tato funkce vrací JSON formátované pole objektů TTyden daty o týdnech které jsou pro danný podsystém přístupné nebo null
Příklad použití:
Funkce: GetTydny
Podsystem: id podsystemu - viz GetPodsystemy()
api: Klic uzivatele
SecondID : není vyžadován
..../JAPIV2/json_API.php?Funkce=GetTydny &api=Klic&Podsystem=1
načítám
id
int
index jídla
id_tyden
int
index týdnu ke kterému jídlo náleží
datum
string
datum - ve formátu 'YYYY-MM-DD'
den
int
číslo dne v týdnu 0 - Po, 1-Ut ....
typstravy
int
index typstravy - Polévka, Hlavní jídlo, atd
nazev
string/null
název jídla
vaha
string/null
váha zobrazovaná na webovém jídelníčku
typstravy_nazev
string
název typustravy
function GetSkupinyMinutkyHash():string
Tato funkce vrací hash - string - indikace zmeny
Příklad použití:
Funkce: GetSkupinyMinutkyHash
Podsystem: není vyžadováno
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetSkupinyMinutkyHash &api=Klic
načítám
id
int
index skupiny
skupina_poradi
int
pořadí podle kterého jsou skupiny vypisovýny na webovém jídelníčku restaurace Strahov
skupina_nazev
string
název skupiny (překlad Lang = en/cs)
function GetSkupinyMinutky():MinutkySkupiny
Tato funkce vrací JSON formátované pole objektů TMinutkySkupina daty o skupinach minutek strahovske menzy ze serveru
Příklad použití:
Funkce: GetSkupinyMinutky
Podsystem: není vyžadováno
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetSkupinyMinutky &api=Klic
načítám
function GetMinutkySHHash():string
Tato funkce vrací hash - string - indikace zmeny
Příklad použití:
Funkce: GetMinutkySHHash
Podsystem: není vyžadováno
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetMinutkySHHash &api=Klic
načítám
id
int
index minutky
skupina_id
int
index skupiny
skupina_nazev
string
název skupiny (překlad Lang = en/cs)
skupina_poradi
int
pořadí ve kterém se skupina zobrazuje na webovém jídelníčku restaurace menzy Strahov
poradi
int
pořadí ve skupine ve kterém se skupina zobrazuje na webovém jídelníčku restaurace menzy Strahov
cislo
int
číslo minutky
vaha
string/null
váha + jednotka zobrazovaná na webovém jídelníčku (překlad Lang = en/cs)
nazev
string/null
název minutky (překlad Lang = en/cs)
cena
float
cena
cena_stud
float
Studentská cena
alergerny
int array
alergeny
foto
string/null
název souboru fotografie minutky - pouziti: jidelnicky/showfotoMG.php?&xFile="foto"
function GetMinutkySH():Minutky
Tato funkce vrací JSON formátované pole objektů TMinutka daty o minutkach restaurace menzy Strahov ze serveru
Příklad použití:
Funkce: GetMinutkySH
Podsystem: není vyžadováno
api: Klic uzivatele
SecondID : není vyžadováno
..../JAPIV2/json_API.php?Funkce=GetMinutkySH &api=Klic
načítám