Über MiFaZ
Kontakt
Service/Hilfe
FAQ

MiFAZ-GET-Schnittstelle Dokumentation

Inhalt

Allgemeines zum Aufruf

Der Abruf erfolgt über folgende Basis-URL: http://www.mifaz.de/ws/MifazInterface.php

An diese werden GET-Parameter angehängt, um die Anfrage zu spezifizieren:

der Parameter f spezifiziert die aufzurufende Funktion. getEntries ist die Funktion für die Suchanfrage. Diese liefert eine Liste von Einträgen auf Basis weiterer Parameter zurück.

Suchanfrage Variante 1: Übergabe von Ortsnamen

  • startloc - z.B. 'Berlin'
  • goalloc - z.B. 'München'

Beispiel-Anfragestring: http://www.mifaz.de/ws/MifazInterface.php?f=getEntries&startloc=berlin&goalloc=münchen

Ob Groß- oder Kleinschrift spielt für die Übergabe der Ortsnamen keine Rolle. Es kann auch umlaute-frei 'muenchen' übergeben werden. Wenn die Orte eindeutig sind, wird eine Liste passender Inserate zurückgeliefert. Ist mindestens ein Ort uneindeutig (z.B. Neustadt), wird eine Liste aller gefundenen Orte zurückgeliefert, inklusive einer eindeutigen Orts-ID. Viele Orte werden bereits dadurch eindeutig bestimmt, in dem man Zusätze mit eingibt: z.B. Neustadt an der Glonn

Suchanfrage Variante 2: Übergabe von Orts-IDs

Hat man Ortslisten mit eindeutigen IDs erhalten, kann die Abfrage mit diesen IDs mit folgenden Parametern erfolgen:

  • startID - z.B. 8 (München)
  • goalID - z.B. 12 (Berlin) oder 16481 - Zehdenick

Beispiel-Anfragestring: http://www.mifaz.de/ws/MifazInterface.php?f=getEntries&startID=8&goalID=12

Da die Orte mit der ID eindeutig spezifiziert sind, liefert diese Anfrage auf jeden Fall eine Ergebnisliste (die natürlich auch leer sein kann)

Suchanfrage Variante 3: Übergabe von Geodaten

  • startlatitude - geographische Breite - z.B. 51.332671
  • startlongitude - geographische Länge - z.B. 12.401733
  • goallatitude - geographische Breite - z.B. 51.332671
  • goallongitude - geographische Länge - z.B. 12.401733

Beispiel-Anfragestring: http://www.mifaz.de/ws/MifazInterface.php?f=getEntries&startlatitude=48.139&startlongitude=11.574&goallatitude=52.522&goallongitude=13.410

Optionale Parameter für die Suchanfrage

  • radius - Radius für den Umkreis, in dem um die Orte gesucht wird. Kann entweder eine Zahl sein (Kilometerangabe) oder ein Prozentwert, der sich auf die Streckenlänge bezieht.
  • journeydate - Tag der Fahrt im Format yyyy-mm-dd
  • tolerance - Toleranz in Tagen um den ebenfalls übergebenen journeydate, z.B. 5 (schaut 5 Tage VOR UND NACH journeydate)

Folgende Parameter sind noch nicht implementiert:
  • type - 0 - nur Fahrangebote 1 - nur Fahrtengesuche 2 - beides (Standard) - demnächst verfügbar
  • smoker - y,n Rauchen OK?
  • sex - gewünschtes Geschlecht: f oder m - nur weibliche/männliche Fahrer/Mitfahrer

Werden diese Parameter oder andere von Ihnen dringend benötigt, kontaktieren Sie uns bitte.

Teilortabfrage

  • locationPart - z.B. 'Mu'
  • maxLocations - z.B. 10 - Maximale Anzahl der zurückzugebenen Orte (10 ist der Standard)

Die aufrufufende Funktion ist f=getLocationsFromPart

Beispiel-Anfragestring: http://www.mifaz.de/ws/MifazInterface.php?f=getLocationsFromPart&locationPart=mu&maxLocations=5

liefert alles, was mit Mu (und Mü) beginnt sortiert wird nach population absteigend, d.h. die 5 gröten Orte werden zurückgeliefert.

Rückgabe von Ortslisten

Die zurückgelieferte(n) Ortsliste(n) haben den Namen 'startlocations' und/oder 'goallocations'.

Jeder Ort der Liste besteht aus folgenden Parametern:

  • name - z.B. Ovelgönne - Neustadt
  • locID - z.B. 9012
  • population - Einwohnerzahl. Ist. -999, wenn keine Angabe vorhanden
  • kreis - der landkreis in dem der Ort liegt z.B. Wesermarsch
  • postcode -die Postleitzahl falls vorhanden
  • near_location - ein Ort>10.000 Einwohner in der Nähe. Z.B. Brake (Unterweser)
  • completeString - Eine Text-Repräsentation des Ortes mit vollständigen Namen und ggf. PLZ, für die Ortsauswahl direkt verwendbar

Sind Startort und Zielort uneindeutig, werden ZWEI Ortslisten zurückgeliefert. Ist nur ein Ort uneindeutig, wird für den anderen Ort die ID mitgeliefert (startid oder goalid)

Rückgabe einer Ergebnisliste

Wenn Einträge gefunden werden, wird die Eintragsliste zurückgeliefert und trägt den Namen 'entries'.

Ein Eintrag hat folgende Parameter:

Name Beschreibung Beispiel
id Identifikator des Eintrags 14694
url Der Link auf die Details des Eintrages 'http://www.mifaz.de/ottobrunn/biete.html?showdetails=true&id=5IWdjyzG61k%3D'
startID Identifikator des Startorts 4312
startloc Name des Startorts Unterhaching
startcoord Geokoordinaten des Startorts 51.3326 12.4017
goalID Identifikator des Zielorts '8'
goalloc Name des Zielorts 'München
goalcoord Geokoordinaten des Zielorts 51.3326 12.4017
stopovernames Namen der Zwischenhalte Augsburg, Ulm
stopovercoords Geokoordinaten der Zwischenhalte 51.4326 12.5017, 51.6340 12.7022
creationdate Erstellungsdatum '2009-10-12 17:25:32'
lastupdate letze Änderung oder Bestätigung, dass das Angebot noch aktuell ist. '2009-11-12 19:30:10'
viewed Anzahl der Aufrufe des Eintrags 77
regularly ist entweder 0 (regelmäßige Fahrt) oder 1 (Einmalige Fahrt) 1
type Der type bestimmt, ob es sich um ein Gesuch (type=0), Gebot (type=1)oder beides (Fahrer wünscht abwechselnde Fahrgemeinschaft, mal fährt der eine, mal der andere) (type=2) handelt. 2
username Benutzername Marianne
imageUrl URL zum Bild des Nutzers http://www.mifaz.de/userpics/user1164.jpg
times gibt die Wochentage (Mo,Di,Mi,Do,Fr,Sa,So) zurück, wenn es ein regelmäßiger Eintrag ist, oder unknown, wenn nichts angegeben wurde z.B 'Mo,Di,Mi'
journeydate Liefert das Fahrtdatum bei einmaligen Fahrten '2009-12-17'
tolerance Wie viel Tage Toleranz für die Fahrt sind. Nur bei einmaligen Fahrten 3
starttimebegin Früheste Startzeit '17:30'
starttimeend Späteste Startzeit '18:30'
journeydateback Liefert das Fahrtdatum der Rückfahrt bei einmaligen Fahrten wenn vorhanden '2009-12-23'
toleranceback Wie viel Tage Toleranz für die Rückfahrt sind. Nur bei einmaligen Fahrten wenn vorhanden 1
returntimebegin Früheste Startzeit der Rückfahrt wenn vorhanden '17:30'
returntimeend Späteste Startzeit der Rückfahrt wenn vorhanden '18:30'

Rückgabeformat spezifizieren

  • xml - liefert XML zurück (Standard, wenn nichts angegeben)
  • json - liefert JSON zurück
  • serialized - liefert serialisierte assoziative PHP-Arrays zurück

Parameter: format z.B. &format=json an den Anfragestring hängen

Die Ergebnisse werden im Unicode zurückgeliefert