Általános tudnivalók

Az API különböző funkcióit az URL-ben meghatározott végpontokon kresztül érjük el. A paramétereket mindig POST-ban küldjük, a válasz pedig minden esetben egy JSON objektum lesz. A válasz hiba esetén így néz ki: {"status":-1,"message":"ErrorMessage"} Ez bármely funkció hívása esetén igaz, így a túloldalon elég csak a status értékét figyelni. Ez bármilyen hiba esetén -1, sikeres lekérdezés esetén pedig 1 lesz. A sikeres lekérdezések mindegyike a következő szerkezettel tér vissza: {"status":1,"message":"OK","data":_____} Mivel a status és a message értéke mindig fix, a következő szekcióban már csak a data tartalmát nézzük. Ennek értéke és formátuma lekérdezésenként változhat. A funkciók leírásának sorrendje logikailag megegyezik a folyamatéval, a lekérdezések szükséges input paramétereit egy azt megelőző lekérdezésből tudjuk meg. A folyamat megvalósítására egy alternatív sorrend is létezik, ebben az esetben az első lépés a listDistinctBeavatkozasOnline, a második pedig a listFelhasznaloSzakrendelesByDistinctBeavatkozas lekérdezése. Ezek után a megszerzett FelhasznaloSzakrendelesID-t már a listRendelesiNapFree kapja, így innentől kezdve azonos a működés. Postman projekt a teszteléshez IDE KATTINTVA letölthető!

Elérhető funkciók listája

Végpont	POST paraméter	Leírás
/login	Email	Egy valós (akár technikai) DokiRex.NET felhasználó E-mail címe
	Password	A felhasználó jelszava
Visszatérési értéke	{"token":"_____"}
Leírás	A token-t elégséges naponta egyszer lekérni, az érvényessége mindig adott napra szól. Minden további kéréshez szükséges csatolni a műveleketek végrehajtásához.
/getPaciensByAll	searchString	Kombinált keresés szövege (név, születési dátum, azonosító, és mobiltelefonszám alapján)
	page	Oldalszám (egy oldal 25 tételt tartalmaz)
Visszatérési értéke	[   {     "PaciensID": __,     "Nev": "_______",     "SzuletesiDatum": "__________",     "Azonosito": "_________",     "Mobiltelefon": "_________",     "Email": "_________",     "Telefon": "_________",     "Mobiltelefon": "_________",     "Iranyitoszam": "_________",     "Telepules": "_________",     "Cim": "_________",     "Megjegyzes": "_________",     "Aktiv": "____",   },   ... ]
Leírás	A lista mindig maximum 25 páciens objektumot tartalmaz, további pácienseket a page paraméter növelésével kérdezhetünk le.
/listFelhasznaloSzakrendeles	token	A bejelentkezéskor kapott token
Visszatérési értéke	[   {     "FelhasznaloSzakrendelesID": __,     "FelhasznaloNev": "_____",     "SzakrendelesNev": "_____"   },   ... ]
Leírás	A programban a felhasználók beazonosítása nem csupán egy felhasználó azonosítóval, hanem egy ún. Felhasználó-Szakrendelés azonosítóval törtnéik. Ennek oka, hogy egy orvos több rendelésen is rendelhet, eltérő renelési időkkel és vizsgálat típusokkal. A FelhasznaloSzakrendelesID mező értéke lesz az, amit paraméterként át kell adnunk a következő lépésben.
/listBeavatkozasOnline	token	A bejelentkezéskor kapott token
	FelhasznaloSzakrendelesID	A kiválasztott Felhasználó-Szakrendelés azonosítója
Visszatérési értéke	[   {     "BeavatkozasID": __,     "BeavatkozasNev": "_____",     "Intervallum": "_____"   },   ... ]
Leírás	A lista a megadott Felhasználó-Szakrendeléshez tartozó, online előjegyezhető beavatkozásokat tartalmazza. Az Intervallum mező értékét a szabad időpontok kereséséhez, a BeavatkozasID-t pedig az előjegyzés beszúrásához kell felhasználnunk.
/listRendelesiNapFree	token	A bejelentkezéskor kapott token
	FelhasznaloSzakrendelesID	A kiválasztott Felhasználó-Szakrendelés azonosítója
	DateFrom	Keresés első napja (ÉÉÉÉ-HH-NN)
	DateTo	Keresés utolsó napja (ÉÉÉÉ-HH-NN)
	Intervallum	Mekkora szabad időintervallumot keresünk. A Beavatkozás listából kapott értéket használjuk!
Visszatérési értéke	[   {     "RendelesiNapID": __,     "Nap": "__________",     "Tol": "_____",     "Ig": "_____"   },   ... ]
Leírás	A lista azokat a rendelési napokat tartalmazza, ahol időszükségletét tekintve elfér a kiválasztott beavatkozás. A konkrét szabad időpontok meghatározásához listáznunk kell az előjegyzéseket is az adott napra, ebből kiszámolható hol van még szabad hely.
/listElojegyzesByRendelesiNap	token	A bejelentkezéskor kapott token
	RendelesiNapID	A kiválasztott rendelési nap azonosítója
Visszatérési értéke	[   {     "Tol": "_____",     "Ig": "_____"   },   ... ]
Leírás	A lista az adott rendelési nap foglalt időpontjait tartalmazza. Ebből, és az előzőleg lekért nap hosszából kiszámolhatjuk a szabad időpontok pontos helyét.
/insertOnlineElojegyzes	token	A bejelentkezéskor kapott token
	FelhasznaloSzakrendelesID	A kiválasztott Felhasználó-Szakrendelés azonosítója
	BeavatkozasID	A kiválasztott beavatkozás azonosítója
	RendelesiNapID	A kiválasztott rendelési nap azonosítója
	Idopont	A kiválasztott időpont Ó:PP formátumban
	Nev	Páciens neve
	Azonosito	Páciens TAJ száma
	SzuletesiDatum	Páciens születési dátuma
	Email	Páciens E-mail címe
	Telefon	Páciens telefonszáma
	Iranyitoszam	Páciens irányítószáma
	Telepules	Páciens lakhelye (település)
	Cim	Páciens címe
	Megjegyzes	Páciens megjegyzése
Visszatérési értéke	{"LastID":__}
Leírás	Ha az előjegyzés beszúrása sikeres, akkor annak azonosítóját a LastID paraméterben visszakapjuk. Ezt később felhasználhatjuk az előjegyzés törlésére.
/insertOnlineElojegyzesMedicall	token	A bejelentkezéskor kapott token
	FelhasznaloSzakrendelesID	A kiválasztott Felhasználó-Szakrendelés azonosítója
	BeavatkozasID	A kiválasztott beavatkozás azonosítója
	RendelesiNapID	A kiválasztott rendelési nap azonosítója
	Idopont	A kiválasztott időpont Ó:PP formátumban
	Nev	Páciens neve
	Azonosito	Páciens TAJ száma
	SzuletesiDatum	Páciens születési dátuma
	Email	Páciens E-mail címe
	Telefon	Páciens telefonszáma
	Iranyitoszam	Páciens irányítószáma
	Telepules	Páciens lakhelye (település)
	Cim	Páciens címe
	AnyjaNeve	Páciens anyja neve
	SzuletesHely	Páciens születési helye (település)
	NemID	Páciens neme: 1 = Férfi 2 = Nő 3 = Nem ismert
	Megjegyzes	Páciens megjegyzése
Visszatérési értéke	{"LastID":__}
Leírás	Ha az előjegyzés beszúrása sikeres, akkor annak azonosítóját a LastID paraméterben visszakapjuk. Ezt később felhasználhatjuk az előjegyzés törlésére.
/listDistinctBeavatkozasOnline	token	A bejelentkezéskor kapott token
Visszatérési értéke	[   {     "BeavatkozasNev": "_______",     "Intervallum": "_______",     "Csoport": "_______"   },   ... ]
Leírás	A data az online előjegyezhető beavatkozások listáját tartalmazza. A BeavatkozasNev és Intervallum paramétereket felhasználva gyűjthetjük le a FelhasznaloSzakrendelesID-kat a következő metódus használatával.
/listFelhasznaloSzakrendelesByDistinctBeavatkozas	token	A bejelentkezéskor kapott token
	BeavatkozasNev	Az beavatkozás neve
	Intervallum	Az beavatkozás időszükséglete
Visszatérési értéke	[   {     "FelhasznaloSzakrendelesID": __,     "BeavatkozasID": ___,     "Nev": "_______",     "FelhasznaloNev": "_______",     "SzakrendelesNev": "_______",   },   ... ]
Leírás	A data azokat a FelhasznaloSzakrendeles objektumokat listázza, melyekhez előjegyezhető a kérdéses beavatkozás. Innentől a folyamat listRendelesiNapFree metódussal folytatódik, a kiválasztott FelhasznaloSzakrendelesID-val.
/deleteElojegyzes	token	A bejelentkezéskor kapott token
	ElojegyzesID	Az előjegyzés azonosítója
Visszatérési értéke	""
Leírás	A data tartalma üres, így a status, vagy a message alapján tudjuk eldőnteni hogy sikerült-e a művelet
/sendSMS	token	A bejelentkezéskor kapott token
	ElojegyzesID	Az előjegyzés azonosítója
Visszatérési értéke	_
Leírás	A data tartalma siker esetén 1, egyéb esetben egy negatív hiba azonosító (-1 ha nincs mobilszám, -2 ha elfogyott az SMS limit).
/sendCronMail	token	A bejelentkezéskor kapott token
	gid	CronMail csoport azonosító
	name	Név
	email	E-mail cím
	param1	CronMail egyedi paraméter #1
	param2	CronMail egyedi paraméter #2
	param3	CronMail egyedi paraméter #3
	param4	CronMail egyedi paraméter #4
	param5	CronMail egyedi paraméter #5
	param6	CronMail egyedi paraméter #6
Visszatérési értéke	"{\"code\":_,\"message\":\"_______\"}"
Leírás	A data tartalma a CronMail API-tól kapott válasz, JSON stringként.