converted XML docu from iso-8859-1 to utf-8, fixed source code link
This commit is contained in:
following
+61
-62
@@ -1,22 +1,21 @@
|
||||
<html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Dokumentation Opencaching XML-Interface Version 1.1</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
||||
<meta name="vs_showGrid" content="True">
|
||||
</head>
|
||||
<body>
|
||||
<h1>Dokumentation Opencaching XML-Interface Version 1.1</h1>
|
||||
<p>
|
||||
Das XML-Interface dient zum automatisierten abfragen aller Caches, Logeinträge,
|
||||
Benutzer und/oder Bilder. Dieses Interface ist nicht für Endbenutzer gedacht,
|
||||
sondern primär für Website-Entwickler.
|
||||
Das XML-Interface dient zum automatisierten abfragen aller Caches, Logeinträge,
|
||||
Benutzer und/oder Bilder. Dieses Interface ist nicht für Endbenutzer gedacht,
|
||||
sondern primär für Website-Entwickler.
|
||||
</p>
|
||||
<h2>Ausgabeformat</h2>
|
||||
<p>
|
||||
Die Ausgabe ist eine oder mehrere xml,zip,gz oder bz2-Dateien. Es stehen 2
|
||||
Übertragungsmodi bereit: in Paketen zu je 500 Datensätzen oder in
|
||||
Übertragungsmodi bereit: in Paketen zu je 500 Datensätzen oder in
|
||||
einer Datei.
|
||||
<P>Die folgenden XML-Abschnitte stehen zur Verfügung. Sie werden immer in dieser
|
||||
<P>Die folgenden XML-Abschnitte stehen zur Verfügung. Sie werden immer in dieser
|
||||
Reihenfolge ausgegeben:
|
||||
<ol>
|
||||
<li>
|
||||
@@ -26,28 +25,28 @@
|
||||
<li>
|
||||
cachedesc (Cachebeschreibungen)
|
||||
<li>
|
||||
cachelog (Logeinträge)
|
||||
cachelog (Logeinträge)
|
||||
<li>
|
||||
picture (Bilder)
|
||||
<li>
|
||||
removedobject (gelöschte Objekte)</li>
|
||||
removedobject (gelöschte Objekte)</li>
|
||||
</ol>
|
||||
<P></P>
|
||||
<h3>Allgemeine XML-Elemente</h3>
|
||||
<h4>lastmodified</h4>
|
||||
<p>Datum an dem dieser Datensatz zuletzt geändert wurde. Es werden keine
|
||||
Abhängigkeiten berücksichtigt. D.h. Wenn eine Cachebeschreibung geändert wird,
|
||||
ändert sich nur deren lastmodified, nicht jedoch das des Caches. Datumsangaben
|
||||
<p>Datum an dem dieser Datensatz zuletzt geändert wurde. Es werden keine
|
||||
Abhängigkeiten berücksichtigt. D.h. Wenn eine Cachebeschreibung geändert wird,
|
||||
ändert sich nur deren lastmodified, nicht jedoch das des Caches. Datumsangaben
|
||||
sind immer in der Form "yyyy-mm-dd hh:mm:ss" oder "yyyy-mm-dd"</p>
|
||||
<h4>datecreated</h4>
|
||||
<p>Datum an dem dieser Datensatz angelegt wurde.</p>
|
||||
<h4>id</h4>
|
||||
<p>Zu unterscheiden ist die id (identifier) und die uuid (universal unique
|
||||
identifier). Die id (Zahl) ist ein nur auf der jeweiligen Webseite gültiger
|
||||
identifier, während die uuid (alphanumerische Folge) auf jeder Seite die
|
||||
Opencaching-Daten verwendet gültig sein sollte. Beispiel: bei dem Datenabgleich
|
||||
<p>Zu unterscheiden ist die id (identifier) und die uuid (universal unique
|
||||
identifier). Die id (Zahl) ist ein nur auf der jeweiligen Webseite gültiger
|
||||
identifier, während die uuid (alphanumerische Folge) auf jeder Seite die
|
||||
Opencaching-Daten verwendet gültig sein sollte. Beispiel: bei dem Datenabgleich
|
||||
von www.opencaching.de und devel.opencaching.de wird auf devel.opencaching.de
|
||||
eine neue id für den Datensatz erzeugt und die uuid beibhalten.</p>
|
||||
eine neue id für den Datensatz erzeugt und die uuid beibhalten.</p>
|
||||
<h3>Attributliste</h3>
|
||||
<p><attrlist><br />
|
||||
<attr id="1" icon_large="http://www.opencaching.de/images/attributes/night.gif"<br />
|
||||
@@ -68,7 +67,7 @@
|
||||
<attr id="8" icon_large="http://www.opencaching.de/images/attributes/letterbox.gif"<br />
|
||||
icon_no="http://www.opencaching.de/images/attributes/letterbox-no.gif"<br />
|
||||
icon_undef="http://www.opencaching.de/images/attributes/letterbox-undef.gif"><br />
|
||||
<![CDATA[Letterbox (benötigt Stempel)]]><br />
|
||||
<![CDATA[Letterbox (benötigt Stempel)]]><br />
|
||||
</attr><br />
|
||||
</attrlist><br />
|
||||
</p>
|
||||
@@ -83,7 +82,7 @@
|
||||
<h4>username</h4>
|
||||
<p>Benutzername</p>
|
||||
<h4>pmr</h4>
|
||||
<p>1: Der Benutzer hat angegeben ein PMR-Funkgerät auf Kanal 2 mit auf Tour zu
|
||||
<p>1: Der Benutzer hat angegeben ein PMR-Funkgerät auf Kanal 2 mit auf Tour zu
|
||||
nehmen.<br>
|
||||
0: Keine Angabe</p>
|
||||
<h3>cache (Caches)</h3>
|
||||
@@ -97,7 +96,7 @@
|
||||
<type id="2" short="Trad."><![CDATA[normaler
|
||||
Cache]]></type><br>
|
||||
<status id="2"><![CDATA[Momentan nicht
|
||||
verfügbar]]></status><br>
|
||||
verfügbar]]></status><br>
|
||||
<country id="DE"><![CDATA[Deutschland]]></country><br>
|
||||
<size id="2"><![CDATA[mikro]]></size><br>
|
||||
<desclanguages>DE</desclanguages><br>
|
||||
@@ -136,7 +135,7 @@
|
||||
<lastmodified>2005-12-24 14:38:13</lastmodified><br>
|
||||
</cachedesc>
|
||||
</p>
|
||||
<h3>cachelog (Logeinträge)</h3>
|
||||
<h3>cachelog (Logeinträge)</h3>
|
||||
<p>
|
||||
<cachelog><br>
|
||||
<id id="13037">F0DAC335-0FA6-3479-45AF-03E2F6BC28B9</id><br>
|
||||
@@ -171,7 +170,7 @@
|
||||
<lastmodified>2005-12-24 01:01:38</lastmodified><br>
|
||||
</picture>
|
||||
</p>
|
||||
<h3>removedobject (gelöschte Objekte)</h3>
|
||||
<h3>removedobject (gelöschte Objekte)</h3>
|
||||
<p>
|
||||
<removedobject><br>
|
||||
<id id="748" /><br>
|
||||
@@ -182,13 +181,13 @@
|
||||
</p>
|
||||
<h2>Datenauswahl</h2>
|
||||
<p>Die Auswahl erfolgt zum einen durch den Paramter modifiedsince, mit dem
|
||||
inkrementelle Updates gesteuert werden, zum anderen über eine Gebietsauswahl.</p>
|
||||
<h3>Zu übertragende Daten auswählen</h3>
|
||||
<p>Folgende Parameter stehen zur Verfügung um die zu übertragenden Daten
|
||||
auszuwählen.</p>
|
||||
<p>Die Werte dürfen 1 oder 0 sein, Default ist 0.<br />
|
||||
0=Datensätze nicht übertragen<br />
|
||||
1=Datensätze übertragen</p>
|
||||
inkrementelle Updates gesteuert werden, zum anderen über eine Gebietsauswahl.</p>
|
||||
<h3>Zu übertragende Daten auswählen</h3>
|
||||
<p>Folgende Parameter stehen zur Verfügung um die zu übertragenden Daten
|
||||
auszuwählen.</p>
|
||||
<p>Die Werte dürfen 1 oder 0 sein, Default ist 0.<br />
|
||||
0=Datensätze nicht übertragen<br />
|
||||
1=Datensätze übertragen</p>
|
||||
<ul>
|
||||
<li>user</li>
|
||||
<li>cache</li>
|
||||
@@ -197,30 +196,30 @@
|
||||
<li>picture</li>
|
||||
<li>removedobject</li></ul>
|
||||
<h3>modifiedsince</h3>
|
||||
<p>Alle Datensätz übertragen, die nach diesem Datum angelegt oder modifiziert
|
||||
<p>Alle Datensätz übertragen, die nach diesem Datum angelegt oder modifiziert
|
||||
wurden. Das Datumsformat ist yyyymmddhhnnss</p>
|
||||
<h3>Gebietsauswahl</h3>
|
||||
<p>Es muss keine Gebietsauswahl getroffen werden. Eine Kombination von Land,
|
||||
Koordinaten oder cacheid ist nicht möglich.</p>
|
||||
Koordinaten oder cacheid ist nicht möglich.</p>
|
||||
<h4>Nach Land</h4>
|
||||
<p>Parameter country ... wird dieser Parameter angegeben, werden nur Datensätz
|
||||
übertragen, die mit Caches in Zusammenhang stehen, die in diesem Land versteckt
|
||||
wurden. User-Records werden nicht übertragen, removedobjects werden alle
|
||||
übetragen.</p>
|
||||
<p>Für Bilder muss dabei angegeben werden, ob nur Bilder übertragen werden die
|
||||
<p>Parameter country ... wird dieser Parameter angegeben, werden nur Datensätze
|
||||
übertragen, die mit Caches in Zusammenhang stehen, die in diesem Land versteckt
|
||||
wurden. User-Records werden nicht übertragen, removedobjects werden alle
|
||||
übetragen.</p>
|
||||
<p>Für Bilder muss dabei angegeben werden, ob nur Bilder übertragen werden die
|
||||
von Caches stammen oder auch von Cachelogs:<br/>
|
||||
Paramter: picturefromcachelog = 0/1, default 0</p>
|
||||
<h4>Nach Koordinaten</h4>
|
||||
<p>Parameter lat, lon, distance ... werden diese Parameter angegeben,
|
||||
werden nur Datensätz übertragen, die mit Caches in Zusammenhang stehen, die in
|
||||
diesem Gebiet versteckt wurden. User-Records werden nicht übertragen,
|
||||
removedobjects werden alle übetragen.</p>
|
||||
werden nur Datensätz übertragen, die mit Caches in Zusammenhang stehen, die in
|
||||
diesem Gebiet versteckt wurden. User-Records werden nicht übertragen,
|
||||
removedobjects werden alle übetragen.</p>
|
||||
<h4>Nach cacheid</h4>
|
||||
<p>Parameter cacheid ... wird dieser Parameter angegeben,
|
||||
werden nur Datensätz übertragen, die mit Cache in Zusammenhang stehen.
|
||||
User-Records werden nicht übertragen,
|
||||
removedobjects werden alle übetragen.</p>
|
||||
<p>Für Bilder muss dabei angegeben werden, ob nur Bilder übertragen werden die
|
||||
werden nur Datensätz übertragen, die mit Cache in Zusammenhang stehen.
|
||||
User-Records werden nicht übertragen,
|
||||
removedobjects werden alle übetragen.</p>
|
||||
<p>Für Bilder muss dabei angegeben werden, ob nur Bilder übertragen werden die
|
||||
von Caches stammen oder auch von Cachelogs:<br/>
|
||||
Paramter: picturefromcachelog = 0/1, default 0</p>
|
||||
<h4>Nach Wegpunkt</h4>
|
||||
@@ -244,7 +243,7 @@
|
||||
sind<br/>
|
||||
<a>http://www.opencaching.de/xml/ocxml11.php?modifiedsince=<date>&picture=1&country=DE</a>&picturefromcachelog=1</p>
|
||||
<p>Diese Anfragen werden mit einem kurzen XML-Stream beantwortet, der die
|
||||
XML-Session-Id zurückgibt. Mit dieser Id können dann die Daten abgerufen
|
||||
XML-Session-Id zurückgibt. Mit dieser Id können dann die Daten abgerufen
|
||||
werden.</p>
|
||||
<p><?xml version="1.0"?><br/>
|
||||
<ocxmlsession><br/>
|
||||
@@ -252,12 +251,12 @@
|
||||
<records user="193" cache="211" cachedesc="235" cachelog="439"
|
||||
picture="108" removeobject="19" /><br/>
|
||||
</ocxmlsession></p>
|
||||
<p>Die Sessionid ist 24h gültig, danach muss eine neue sessionid angefordert
|
||||
werden. Die Anzahl der Datensätz muss nicht exakt mit den übertragenen
|
||||
übereinstimmen - mehr Datensätze werden jedoch auf keinen Fall übertragen. Die
|
||||
Summe der Datensätze ist in diesem Beispiel 1205 - es werden also 3 Aufrufe
|
||||
benötigt (500, 500, 205 Datensätze).</p>
|
||||
<p>Die Daten können dann mit folgender Anfrage abgerufen werden:<br/>
|
||||
<p>Die Sessionid ist 24h gültig, danach muss eine neue sessionid angefordert
|
||||
werden. Die Anzahl der Datensätz muss nicht exakt mit den übertragenen
|
||||
übereinstimmen - mehr Datensätze werden jedoch auf keinen Fall übertragen. Die
|
||||
Summe der Datensätze ist in diesem Beispiel 1205 - es werden also 3 Aufrufe
|
||||
benötigt (500, 500, 205 Datensätze).</p>
|
||||
<p>Die Daten können dann mit folgender Anfrage abgerufen werden:<br/>
|
||||
<a>http://www.opencaching.de/xml/ocxml11.php?sessionid=12345&file=1</a><br/>
|
||||
<a>http://www.opencaching.de/xml/ocxml11.php?sessionid=12345&file=2</a><br/>
|
||||
<a>http://www.opencaching.de/xml/ocxml11.php?sessionid=12345&file=3</a></p>
|
||||
@@ -267,14 +266,14 @@
|
||||
<p>Beispeil:<br/>
|
||||
<a>http://www.opencaching.de/xml/ocxml11.php?modifiedsince=<date>&user=1&cache=1&cachedesc=1&cachelog=1&picture=1&removedobject=1&session=0</a></p>
|
||||
<h3>Dateikomprimierung einstellen</h3>
|
||||
<p>Dei Dateikomprimierung kann mit dem Paramter zip eingestellt weren. Mögliche
|
||||
<p>Dei Dateikomprimierung kann mit dem Paramter zip eingestellt weren. Mögliche
|
||||
Werte sind 0, zip, bzip2, gzip. Null bedeutet hier keine Kompression. Wird
|
||||
keine Kompression angegeben, wird zip verwendet.</p>
|
||||
<p>Beispeil:<br/>
|
||||
<a>http://www.opencaching.de/xml/ocxml11.php?modifiedsince=<date>&user=1&cache=1&cachedesc=1&cachelog=1&picture=1&removedobject=1&session=0&zip=bzip2</a><br/>
|
||||
<a>http://www.opencaching.de/xml/ocxml11.php?sessionid=12345&file=1&zip=gzip</a></p>
|
||||
<h3>XML-Optionen</h3>
|
||||
<p>Die folgenden XML-Optionen müssen bei jedem Aufruf übergeben
|
||||
<p>Die folgenden XML-Optionen müssen bei jedem Aufruf übergeben
|
||||
werden.</p>
|
||||
<p>xmldecl ... 0 = keine Xml-Deklaration / (Default) 1=Xml-Deklaration<br>
|
||||
doctype ... 0 = keine Xml-Document-Type-Definition /
|
||||
@@ -291,12 +290,12 @@
|
||||
<h3>Sonstige Bemerkungen</h3>
|
||||
<ul>
|
||||
<li>
|
||||
Für den ersten Aufruf des Interface muss als modifiedsince das Datum 1.8.2005
|
||||
um 00:00:00 Uhr angegeben werden. Es gibt keine Datensätze die vor diesem Datum
|
||||
Für den ersten Aufruf des Interface muss als modifiedsince das Datum 1.8.2005
|
||||
um 00:00:00 Uhr angegeben werden. Es gibt keine Datensätze die vor diesem Datum
|
||||
angelegt wurden.</li>
|
||||
<li>
|
||||
Um Probleme wegen Differenzen der Uhrzeit zwischen Client und Server zu
|
||||
umgehen, muss für den nächsten Inkrementellen Abruf der Daten das Datum um Kopf
|
||||
umgehen, muss für den nächsten Inkrementellen Abruf der Daten das Datum um Kopf
|
||||
der XML-Datei minus 1 Sekunde angeben werden:<br/>
|
||||
<span class="m"><br/><?</span><span class="pi">xml version="1.0" encoding="iso-8859-1"
|
||||
standalone="no" </span><span class="m">?></span>
|
||||
@@ -308,20 +307,20 @@
|
||||
22:02:42<span class="m">"</span><span class="m">></span><br /><br />
|
||||
</li>
|
||||
<li>Zeitverschiebungen / unterschiedliche Zeitzonen zwischen Client und Server
|
||||
werden nicht unterstützt.</li>
|
||||
<li>Das XML-Dokument enthält folgende DTD (Document Type Definition):
|
||||
werden nicht unterstützt.</li>
|
||||
<li>Das XML-Dokument enthält folgende DTD (Document Type Definition):
|
||||
http://www.opencaching.de/xml/ocxml11.dtd</li>
|
||||
<li>Der Quellcode ist hier erhältlich: <a href="https://github.com/OpencachingDeutschland/oc-server3/tree/master/htdocs/xml">
|
||||
https://github.com/OpencachingDeutschland/oc-server3/tree/master/htdocs/xml</a></li>
|
||||
<li>Der Quellcode ist hier erhältlich: <a href="https://github.com/OpencachingDeutschland/oc-server3/tree/stable/htdocs/xml">
|
||||
https://github.com/OpencachingDeutschland/oc-server3/tree/stable/htdocs/xml</a></li>
|
||||
<li>Eine Referenzimplementierung kann hier downgeloadet werden: <s>
|
||||
http://devel.opencaching.de/viewcvs/viewcvs.cgi/html/util/ocxml11client/</s> (neue Adresse folgt ...)</li>
|
||||
<li>Fragen zum Interface können im Opencaching-Forum gestellt werden: <a href="http://forum.opencaching-network.org/">http://forum.opencaching-network.org/</a></a></li>
|
||||
<li>Fragen zum Interface können im Opencaching-Forum gestellt werden: <a href="http://forum.opencaching-network.org/">http://forum.opencaching-network.org/</a></a></li>
|
||||
</ul>
|
||||
<p>Lizenz:</p>
|
||||
<ul>
|
||||
<li>Der Quellcode steht unter der GNU Gerneral Public License Version 2 und später.</li>
|
||||
<li>Der Quellcode steht unter der GNU Gerneral Public License Version 2 und später.</li>
|
||||
<li>
|
||||
Für Daten die über das XML-Interface abgerufen werden, gelten die
|
||||
Für Daten die über das XML-Interface abgerufen werden, gelten die
|
||||
Nutzungsbedingungen von Opencaching.de: <a href="http://www.opencaching.de/articles.php?page=impressum#tos">
|
||||
http://www.opencaching.de/articles.php?page=impressum#tos</a></li></ul>
|
||||
<p> </p>
|
||||
|
||||
Reference in New Issue
Block a user