Geocache API teszt verzió v1.0 by gusty A jelenlegi funkciók az általam fontosabbnak tartott adatok lekérdezését teszik lehetővé a teljesség igénye nélkül. CACHE API (Geoláda adatok lekérdezése) Elérési út (tesztelés alatt) : geocaching.hu/geomap/api/caches.php?parameter1=value1¶meter2=value2.... Opcionális paraméterek: id=list
a listában (id-k) szereplő ládák adatai
dateid=list
a listában szereplő sorszámú ládák adatai
code=list
a listában szereplő rövid nevű ládák adatai
type=list
szűrés típusra: 1 - hagyományos, 2 - multi, 3 - virtuális, 4 - esemény, 6 - mozgó
status=list
szűrés állapotra: 1 - kereshető, 2 - beteg, 3 - megszűnt
uid=n
a lekérdezés a felhasználó szempontjából történik pl. megtalálások (azonosító alapján)
username=text
mint az előző, csak felhasználó névvel megadva
owner=n
megadott felhasználó ládáinak szűrése id-val
ownername=text
megadott felhasználó ládáinak szűrése névvel
lat1,lat2=float
a megadott szélességek közé eső ládákat adja vissza. A rejtési szabályok szerinti értelmezési tartomány: [41.833333 - 51.066667]
lon1,lon2=float
a megadott hosszúságok közé eső ládákat adja vissza. A rejtési szabályok szerinti értelmezési tartomány: [9.516667 - 29.733333]
state=text_list
szűrés ország|megye szerint. Választható: Ausztria Bács-Kiskun Baranya Békés Borsod-Abaúj-Zemplén Bosznia-Hercegovina Budapest Bulgária Csehország Csongrád Fejér Győr-Moson-Sopron Hajdú-Bihar
Heves Horvátország Jász-Nagykun-Szolnok Komárom-Esztergom külföld Lengyelország Montenegró Nógrád Olaszország Pest Románia Somogy Szabolcs-Szatmár-Bereg Szerbia Szlovákia Szlovénia Tolna Ukrajna Vas Veszprém Zala talalat=xyz
ahol x,y,z 0 vagy 1, jelentésük sorrendben az alábbi (csak felhasználó megadással együtt): saját ládák igen|nem megtalált ládák igen|nem még meg nem talált ládák igen|nem
lat,lon=float
A távolság számításhoz szükséges pozíciótól való távolság lekérése esetén szükséges, az aktuális pozíció koordinátái
log=n
Az utolsó n db log adatai n=0 esetén az összes log (Csak óvatosan!)
images=n
A paraméter megadása esetén csak az utolsó n db kép adatait adja meg. (A mozgó ládák miatt, ahol sok kép van a láda oldalon.)
logimages
A logokhoz tartozó képek (Csak a log paraméter együtt van értelme.)
order=colname
A visszaadott tömb sorrendjét meghatározó mező
direction=[asc|desc]
A rendezés iránya
limit=n
A visszaadott rekordok száma
offset=n
A kezdő rekord sorszáma
datemodified=dátum
Az utolsó módosítás dátuma a megadott időpont után történt. A dátum formátuma: yyyy-mm-dd
cols=text_list
az eredményben szereplő mezők listája - id a láda id
- dateid - lat - lon - type - status - code - name - owner - member - mps
- wps
- found
- altitude - state - placer - dateposted - difficulty_rating - terrain_rating - attributes - rating_place - rating_cache - rating_web - rating - rating_db - length - userphone - images - logs
- distance
- ignored - datemodified - fulldesc - db_l
a láda sorszáma Szélesség Hosszúság Láda típusa A láda állapota Rövid név Teljes név A láda gazda felhasználói id-je A láda gazda felhasználó neve A multi pontok adatait tartalmazó tömb, nem multi esetén, vagy ha a leírás nem tartalmaz multi pont adatokat, akkor az értéke NULL [no,lat,lon,altitude,description,type] Ha meg van adva, akkor a segéd pontok adatait is megkapjuk. Ha a leírás nem tartalmaz segéd pont adatokat, akkor az értéke NULL [no,lat,lon,altitude,description,icon] A megtalálások száma, ha a felhasználó meg lett adva, különben mindig nulla. A found értéke mozgó láda esetén 1-nél nagyobb is lehet. magasság ország/megye rejtő(k) megjelenés nehézség terep attributumok (a láda oldal jobb oldalán a +/- rész) értékelés környezet értékelés rejtés értékelés web értékelés teljes átlag értékelések száma úthossz a ládagazda telefonszáma a ládaoldal fotóinak adatai (url,title) a logok adatai [logid,date,logtype,uid,user,notes,logimages] - logimages a képek adatai (url, title) a láda távolsága a megadott pozíciótól (lat,lon). Ha nincs megadva pozíció, akkor a profilban megadott koordinátákkal számol. Ebben az esetben csak a felhasználó megadással (uid vagy username) együtt van értelme. az egyéni kizárás állapotát adja vissza utolsó módosítás dátuma a teljes leírás mező tartalma Összes log
- db_m - db_j - db_n - db_o
Megtaláltam log Jelszó nélküli megtalálás log Nem találtam meg log Egyéb log
enum
A paraméter megadása esetén az enum típusú mezők értékeit szövegesen kapjuk vissza (láda típus, állapot, log típusa)
ignored=[0|1]
Ha a paraméter meg van adva, akkor figyelembe veszi egyéni kizárásokat. A paraméter megadása hiányában a kizárásra vonatkozó beállítások nem kerülnek figyelembe vételre. Csak user azonosítás esetén van értelme. ignored=1 csak a kizárt ládákat adja vissza ignored=0 az eredmény nem tartalmazza a kizárt ládákat
out=[list|xml|json]
A kimenet formátuma - list csak az id listát adja vissza - xml letölthető xml fájlt ad vissza a megadott tartalommal - json egy asszociatív json_encode tömböt ad vissza A paraméter megadása nélkül egy mező nevek nélküli json_encode tömböt kapunk vissza. Az adat átvitel csökkentése miatt javasolt a használata. Az adatokat mindig a cols paraméterben megadott sorrendben kapjuk vissza (kivéve logimages, mivel ez a logokba ágyazott adat).
text
A paraméter megadása esetén a teljes leírásból eltávolításra kerül az összes html tag.
POINTS API (közeli geoláda pontok lekérdezése) Fejlesztés alatt! Elérési út (tesztelés alatt) : geocaching.hu/geomap/api/points.php?parameter1=value1¶meter2=value2.... Opcionális paraméterek: type=list
szűrés típusra: 1 - hagyományos, 2 - multi, 3 - virtuális, 4 - esemény, 6 - mozgó
status=list
szűrés állapotra: 1 - kereshető, 2 - beteg, 3 - megszűnt
uid=n
a lekérdezés a felhasználó szempontjából történik pl. megtalálások (azonosító alapján)
username=text
mint az előző, csak felhasználó névvel megadva
talalat=xyz
ahol x,y,z 0 vagy 1, jelentésük sorrendben az alábbi (csak felhasználó megadással együtt): saját ládák igen|nem megtalált ládák igen|nem még meg nem talált ládák igen|nem
lat,lon=float
A távolság számításhoz szükséges, az aktuális pozíció koordinátái
limit=n
A visszaadott rekordok száma
offset=n
A kezdő rekord sorszáma
cols=text_list
az eredményben szereplő mezők listája - id a láda id - dateid a láda sorszáma - no a multi pont sorszáma - lat szélesség - lon hosszúság - alt magasság - type a láda típusa - status a láda állapota - code rövid név - name teljes név - description pont leírás - fulldesc a teljes leírás mező tartalma - owner a láda gazda felhasználói id-je - member a láda gazda felhasználó neve - userphone a láda gazda telefonszáma - found a megtalálások száma [0|1], értéke mozgó esetén [n] - distance a láda távolsága a megadott pozíciótól - difficulty_rating nehézség - terrain_rating terep
enum
A paraméter megadása esetén az enum típusú mezők értékeit szövegesen kapjuk vissza (láda típus, állapot, log típusa)
out=[json]
A kimenet formátuma - json
egy asszociatív json_encode tömböt ad vissza
A paraméter megadása nélkül egy mező nevek nélküli json_encode tömböt kapunk vissza. Az adat átvitel csökkentése miatt javasolt a használata. Az adatokat mindig a cols paraméterben megadott sorrendben kapjuk vissza. text
A paraméter megadása esetén a teljes leírásból eltávolításra kerülnek a html tagek.
LOG API (log adatok lekérdezése) Elérési út (tesztelés alatt) : geocaching.hu/geomap/api/logs.php?parameter1=value1¶meter2=value2.... Opcionális paraméterek: logid=n
egy log adatainak lekérdezése a log id megadásával
uid=n
egy felhasználó logjainak lekérdezése user id megadásával
username=text
egy felhasználó logjainak lekérdezése felhasználói név megadásával
cache=n
egy láda logjainak lekérdezése láda id megadásával
dateid=n
egy láda logjainak lekérdezése a sorszám megadásával
code=GCxxxx
egy láda logjainak lekérdezése a rövid név megadásával
logtype=lista
szűrés logtípus szerint (1 - ‘Megtaláltam’, 2 - ‘Jelszó nélküli megtalálás’, 3 - ‘Nem találtam meg’, 4 - ‘Egyéb’, 5 - ‘Nettaláltam’)
start=yyyy-mm-dd
szűrés kezdő dátum szerint
end=yyyy-mm-dd
szűrés záró dátum szerint
order=colname
rendezés szempontja
direction=[asc|desc]
a rendezés iránya
limit=n
lekérdezendő rekordok száma
offset=x
kezdő rekord sorszáma
enum
az enum típusú mezők értékeit szövegesen adja vissza (logtype)
out=param
- json - xml
esetén az eredmény json asszociatív tömb lesz letölthető xml fájlt kapunk eredményül
a paraméter megadása nélkül az eredmény egy json_encode tömb lesz mező nevek nélkül cols=mező lista
vesszővel elválasztott lista, az eredményben szereplő mezők listája. Megadható mező nevek: - logid - userid - username - cache - date - notes - logtype - rating_place - rating_cache
log id a megtaláló user id a megtaláló felhasználó neve cache id log dátuma log szövege log típusa környezet értékelése rejtés értékelése
- rating_web - code - name - owner - member - logimages
webes megjelenés értékelése láda rövid neve a láda neve a láda gazda id-je a láda gazda felhasználó neve a log fotók adatai tömbben (title, url)
GPX generálása Elérési út (tesztelés alatt) : geocaching.hu/geomap/api/gpx.php?parameter1=value1¶meter2=value2.... A visszaadott érték a gpx fájl. Opcionális paraméterek: id=list
a lekérendő ládák id-je
uid=n
A felhasználó user id-je (megtalálások, saját ládák szempontja)
username=text
A felhasználó neve (megtalálások, saját ládák szempontja)
logs=n
az utolsó n db log (nettaláltam nélkül) hozzáadása
mps
az összes multi pont hozzáadása
wps
az összes segéd pont hozzáadása
full
Az összes adat megjelenik minden multi pontnál (teljes leírás, logok), különben a teljes leírás és a logok csak a multi első pontjánál jelennek meg.
USER API (user adatok lekérdezése) Elérési út (tesztelés alatt) : geocaching.hu/geomap/api/users.php?parameter1=value1¶meter2=value2.... Opcionális paraméterek: id=n
egy felhasználó adatainak lekérdezése a userid megadásával
member=text
egy felhasználó adatainak lekérdezése felhasználói név megadásával
out=param
- json - xml
esetén az eredmény json asszociatív tömb lesz letölthető xml fájlt kapunk eredményül
a paraméter megadása nélkül az eredmény egy json_encode tömb lesz mező nevek nélkül cols=mező lista
vesszővel elválasztott lista, az eredményben szereplő mezők listája. Megadható mező nevek: - id - member - fullname - userphone - useremail - birthyear - city - registered - lastlogin - db_l - db_m - db_j - db_n - db_o - elsolog - utolsolog - rating_place - rating_cache - rating_web - rating - rating_db
a user id a felhasználó név a felhasználó teljes neve log dátuma log szövege log típusa a felhasználó települése regisztráció dátuma utolsó belépés dátuma logok száma megtaláltam logok száma jelszó nélküli logok száma nem találtam meg logok száma egyéb logok száma első log dátuma utolsó log dátuma környezet értékelések átlaga rejtés értékelések átlaga webes megjelenés értékelések átlaga értékelések átlaga értékelések száma
