API für pfadis.com

pfadis.com hat ein API bekommen. Ein REST-API, um genau zu sein. Bisher empfängt und liefert es Daten im JSON-Format.

Zum Erforschen des API empfehle ich die Verwendung von Firefox mit JSONView-AddOn. Damit lässt sich wunderbar im Browser sehen und verfolgen, welche Daten und URIs geliefert werden.

Bevor ich lange erzähle, hier ein Beispiel:

http://pfadis.com/app/api/rest/Unit

{
    result : [],
    page: 1,
    rpp: 20,
    total: 8290,
    previous_page: null,
    next_page: "http://pfadis.com/app/api/rest/Unit?page=2",
    q: null
}

Diese URL zeigt alle Units (Stämme, Bezirke, Diözesen aber auch Arbeitskreise und Stufen) an. Der obige Aufruf liefert 20 Einträge pro Seite im (oben leeren) „result“ Array. Mit „previous_page“ und „next_page“ werden die passenden URLs zum durchforsten aller Ergebnisse mitgeliefert.

Fortsetzung „Suche mit dem REST-API“