Geocache API teszt verzió v1.0 by gusty

Átírás

1 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&parameter2=value2... Opcionális paraméterek: id= list dateid= list code= list type= list status= list uid= n username= text owner= n ownername= text lat1,lat2= float lon1,lon2= float state= text_list a listában (id-k) szereplő ládák adatai a listában szereplő sorszámú ládák adatai a listában szereplő rövid nevű ládák adatai szűrés típusra: 1 - hagyományos, 2 - multi, 3 - virtuális, 4 - esemény, 6 - mozgó szűrés állapotra: 1 - kereshető, 2 - beteg, 3 - megszűnt a lekérdezés a felhasználó szempontjából történik pl. megtalálások (azonosító alapján) mint az előző, csak felhasználó névvel megadva megadott felhasználó ládáinak szűrése id-val megadott felhasználó ládáinak szűrése névvel a megadott szélességek közé eső ládákat adja vissza. A rejtési szabályok szerinti értelmezési tartomány: [ ] a megadott hosszúságok közé eső ládákat adja vissza. A rejtési szabályok szerinti értelmezési tartomány: [ ] 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

2 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 lat,lon= float log= n images= n logimages order= colname direction= [asc desc] limit= n offset= n datemodified= dátum cols= text_list 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 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 Az utolsó n db log adatai n=0 esetén az összes log (Csak óvatosan!) 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.) A logokhoz tartozó képek (Csak a log paraméter együtt van értelme.) A visszaadott tömb sorrendjét meghatározó mező A rendezés iránya A visszaadott rekordok száma A kezdő rekord sorszáma 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 az eredményben szereplő mezők listája - id a láda id

3 - dateid a láda sorszáma - lat Szélesség - lon Hosszúság - type Láda típusa - status A láda állapota - code Rövid név - name Teljes név - owner A láda gazda felhasználói id-je - member A láda gazda felhasználó neve - mps 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] - wps 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] - found 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. - altitude magasság - state ország/megye - placer rejtő(k) - dateposted megjelenés - difficulty_rating nehézség - terrain_rating terep - attributes attributumok (a láda oldal jobb oldalán a +/- rész) - rating_place értékelés környezet - rating_cache értékelés rejtés - rating_web értékelés web - rating értékelés teljes átlag - rating_db értékelések száma - length úthossz - userphone a ládagazda telefonszáma - images a ládaoldal fotóinak adatai (url,title) - logs a logok adatai [logid,date,logtype,uid,user,notes,logimages] - logimages a képek adatai (url, title) - distance 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. - ignored az egyéni kizárás állapotát adja vissza - datemodified utolsó módosítás dátuma - fulldesc a teljes leírás mező tartalma - db_l Összes log

4 - db_m Megtaláltam log - db_j Jelszó nélküli megtalálás log - db_n Nem találtam meg log - db_o Egyéb log enum ignored= [0 1] out= [list xml json] 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) 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 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.

5 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&parameter2=value2... Opcionális paraméterek: type= list status= list uid= n username= text talalat= xyz lat,lon= float limit= n offset= n cols= text_list szűrés típusra: 1 - hagyományos, 2 - multi, 3 - virtuális, 4 - esemény, 6 - mozgó szűrés állapotra: 1 - kereshető, 2 - beteg, 3 - megszűnt a lekérdezés a felhasználó szempontjából történik pl. megtalálások (azonosító alapján) mint az előző, csak felhasználó névvel megadva 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 A távolság számításhoz szükséges, az aktuális pozíció koordinátái A visszaadott rekordok száma A kezdő rekord sorszáma 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

6 enum out= [json] 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) 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.

7 LOG API (log adatok lekérdezése) Elérési út (tesztelés alatt) : geocaching.hu/geomap/api/logs.php?parameter1=value1&parameter2=value2... Opcionális paraméterek: logid= n uid= n username= text cache= n dateid= n code= GCxxxx logtype= lista start= yyyy-mm-dd end= yyyy-mm-dd order= colname direction= [asc desc] limit= n offset= x enum egy log adatainak lekérdezése a log id megadásával egy felhasználó logjainak lekérdezése user id megadásával egy felhasználó logjainak lekérdezése felhasználói név megadásával egy láda logjainak lekérdezése láda id megadásával egy láda logjainak lekérdezése a sorszám megadásával egy láda logjainak lekérdezése a rövid név megadásával 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 ) szűrés kezdő dátum szerint szűrés záró dátum szerint rendezés szempontja a rendezés iránya lekérdezendő rekordok száma kezdő rekord sorszáma az enum típusú mezők értékeit szövegesen adja vissza (logtype) out= param - json esetén az eredmény json asszociatív tömb lesz - xml 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 log id - userid a megtaláló user id - username a megtaláló felhasználó neve - cache cache id - date log dátuma - notes log szövege - logtype log típusa - rating_place környezet értékelése - rating_cache rejtés értékelése

8 - rating_web webes megjelenés értékelése - code láda rövid neve - name a láda neve - owner a láda gazda id-je - member a láda gazda felhasználó neve - logimages a log fotók adatai tömbben (title, url)

9 GPX generálása Elérési út (tesztelés alatt) : geocaching.hu/geomap/api/gpx.php?parameter1=value1&parameter2=value2... A visszaadott érték a gpx fájl. Opcionális paraméterek: id= list uid= n username= text logs= n mps wps full a lekérendő ládák id-je A felhasználó user id-je (megtalálások, saját ládák szempontja) A felhasználó neve (megtalálások, saját ládák szempontja) az utolsó n db log (nettaláltam nélkül) hozzáadása az összes multi pont hozzáadása az összes segéd pont hozzáadása 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.

10 USER API (user adatok lekérdezése) Elérési út (tesztelés alatt) : geocaching.hu/geomap/api/users.php?parameter1=value1&parameter2=value2... Opcionális paraméterek: id= n member= text egy felhasználó adatainak lekérdezése a userid megadásával egy felhasználó adatainak lekérdezése felhasználói név megadásával out= param - json esetén az eredmény json asszociatív tömb lesz - xml 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 a user id - member a felhasználó név - fullname a felhasználó teljes neve - userphone log dátuma - user log szövege - birthyear log típusa - city a felhasználó települése - registered regisztráció dátuma - lastlogin utolsó belépés dátuma - db_l logok száma - db_m megtaláltam logok száma - db_j jelszó nélküli logok száma - db_n nem találtam meg logok száma - db_o egyéb logok száma - elsolog első log dátuma - utolsolog utolsó log dátuma - rating_place környezet értékelések átlaga - rating_cache rejtés értékelések átlaga - rating_web webes megjelenés értékelések átlaga - rating értékelések átlaga - rating_db értékelések száma