goalio Documentation Release goalio UG

Transkript

1 goalio Documentation Release goalio UG

2

3 Inhaltsverzeichnis 1 Erste Schritte mit goalio Benutzeroberfläche Suche Modul Referenz Finanzen Kochbuch Kochbuch Entwickler Book and Play Verzeichnisse 11 HTTP Routing Table 13 i

4 ii

5 KAPITEL 1 Erste Schritte mit goalio 1.1 Benutzeroberfläche Einleitung Hat man die grundlegenden Prinzipien der goalio-benutzeroberfläche einmal verstanden, so können selbst komplexe Operationen problemlos durchgeführt werden. Um also sicherzustellen, dass Sie bei der Benutzung von goalio keine Probleme haben, möchten wir Sie mit diesem Leitfaden in die wesentlichen Bedienelemente einführen Navigation Das zentrale Steuerelement in goalio ist die gelbe/graue Menüleiste, welche sich über dem Seiteninhalt befindet. Bewegen Sie Ihren Mauszeiger auf einen der Einträge, um die verfügbaren Unterseiten angezeigt zu bekommen. Die momentan geöffnete Seite wird dabei blau hinterlegt. Bemerkung: Sollte das Menü nicht oder nicht richtig dargestellt werden, so stellen Sie bitte sicher, dass Javascript in Ihrem Browser aktiviert ist. Eine Anleitung dazu finden Sie hier Vorschaufunktion Haben Sie eine Seite geöffnet, blablubb 1

6 goalio Documentation, Release Tastenkürzel Strg+A Alt+B Shift+C Shift+D Eingaben Ausgaben STRG A Drucken Alt B Löschen Shift C Speichern Shift D Neu 1.2 Suche Einleitung Die goalio Suche ist ein nützliches Werkzeug, um Informationen gezielt schnell und übersichtlich darzustellen. Sie kann durch einen Klick auf die entsprechende Schaltfläche rechts über einer Liste aufgerufen werden und passt sich dynamisch den Gegebenheiten des Vereins an. Sollten Sie also beispielsweise zusätzliche, vereinsspezifische Daten zu jedem Mitglied speichern, ist die Suche dazu in der Lage, diese ebenfalls zu filtern Voraussetzungen Vorhandensein von Daten, welche durchsucht werden können (Mitglieder, Abteilungen,...) Anwendungsbeispiele I) Wie kann ich inaktive Mitglieder ausblenden? 1. Öffnen Sie die Suche durch einen Klick auf die entsprechende Schaltfläche 2 Kapitel 1. Erste Schritte mit goalio

7 goalio Documentation, Release Gehen Sie in das Feld Kündigungsdatum, geben Sie das aktuelle Datum ein und wählen Sie als Operator größer oder gleich aus. Dadurch werden nur jene Mitglieder dargestellt, deren Kündigungsdatum entweder in der Zukunft liegt, oder nicht eingetragen wurde. 3. Die Mitgliederliste sollte sich nun automatisch aktualisieren und die Suche kann geschlossen werden. Bemerkung: Haben Sie einen Suchfilter aktiviert, so wird er beispielsweise von der Exportfunktion übernommen Suche 3

8 goalio Documentation, Release Kapitel 1. Erste Schritte mit goalio

9 KAPITEL 2 Modul Referenz 2.1 Finanzen Lorem ipsum Bemerkung: Ein Hinweis im Kasten Beiträge Lorem ipsum Konten Lorem ipsum Spenden Lorem ipsum Mahnwesen Foo Bar Baz Buchungslauf Lorem ipsum 5

10 goalio Documentation, Release Kapitel 2. Modul Referenz

11 KAPITEL 3 Kochbuch 3.1 Kochbuch Im goalio Kochbuch finden sie Rezepte für ihre täglichen und nicht so alltäglichen Aufgaben. Schritt für Schritt erklären wir Ihnen an einem konkreten Beispiel, wie Sie am besten vorgehen Beitragseinzug von Mitglieder Lorem ipsum Eingegangene Zahlung verbuchen Lorem ipsum 7

12 goalio Documentation, Release Kapitel 3. Kochbuch

13 KAPITEL 4 Entwickler 4.1 Book and Play Authentifizierung POST /oauth/token Mit Hilfe des bei BOOKANDPLAY hinterlegten Client ID und Client Secrets einen Access Token bei der goalio Applikation beantragen. Beispiel request: GET /oauth/token HTTP/1.1 Authorization: Basic Ym9va2FuZHBsYXk6MTIzNDU2 grant_type=client_credentials&scope=bap_users+bap_booking Beispiel response: HTTP/ OK Content-Type: application/json { "access_token":"f3b626f3fce4e24ce0ea5f706be2c08bf880a717", "expires_in":3600, "token_type":"bearer", "scope":"bap_users bap_booking" } Query Parameters grant_type (string) Ist immer client_credentials scope (string) Ist immer bap_users bap_booking Request Headers Authorization Basic authentication mit base64 kodiertem Client ID udn Client Secret Response Headers Content-Type this depends on Accept header of request Response JSON Object access_token (string) Token das bei folgenden Reuqests genutzt werden muss expires_in (int) Gültigkeit des Tokens in Sekunden 9

14 goalio Documentation, Release token_type (string) Typ des Tokens. In diesem Fall immer Bearer scope (string) Token ist gültig für diese Scopes Status Codes 200 OK Kein Error 404 Not Found there s no user Spieler Buchung 10 Kapitel 4. Entwickler

15 KAPITEL 5 Verzeichnisse glossary genindex search 11

16 goalio Documentation, Release Kapitel 5. Verzeichnisse

17 HTTP Routing Table /oauth POST /oauth/token, 9 13