-
Notifications
You must be signed in to change notification settings - Fork 9
API Terminologie
Die Offenes Köln API soll eine nachvollziehbare und wohlüberlegte Terminologie verwenden. Dies ist die Dokumentation dazu.
Ein Tagesordnungspunkt einer Sitzung
Anlage bzw. Anhang eines Dokuments, z.B. eine PDF-Datei.
Ein Gremium
Beratung eines Themas in einer Sitzung.
Vorlage (Antrag, Mitteilung, Beschlussvorlage, ...)
TODO. Bislang ist noch nicht klar, ob es den Begriff "id" in der API noch geben wird, da verschiedene IDs für verschiedene Dinge im Umlauf sind.
Latitude bzw. Breitengrad-Komponente einer Geo-Koordinate
Longitude bzw. Längengrad-Komponente einer Geo-Koordinate
Ein Geo-Koordinatenpaar aus lat und long
Bestimmt, welche Eigenschaften beim Aufruf einer API-Methode ausgegeben werden sollen. Welche Eigenschaften hier angegeben werden können, ist den Beschreibungen der jeweiligen API-Methode zu entnehmen.
Freier Suchbegriff bzw. Suchbegriffe
Radius um einen Punkt (eine location), immer in Metern
Die Kennung eines Dokuments (document), z.B: AN/1234/2011. Üblicherweise ist dies eindeutig, d.h. zu den meisten Werten gibt es nur ein Dokument. In der Praxis (Kölner Ratsinformationssystem) gibt es jedoch auch Fälle, wo mehrere Dokumente dieselbe Kennung haben. Warum das so ist, bleibt ein Rätsel.
Straße, Platze oder Weg
Stichwort
HTTP-Sitzung eines Nutzers, nicht zu verwechseln mit session
Vorschaubild für einen Dokumenten-Anhang