Mittels unserer Event-API können Sie die veröffentlichten Datensätze auslesen, um sie z.B. auf Ihrer Homepage zu präsentieren

Das Beispiel-Skript welches Sie hier zum Download finden, ist umfangreich kommentiert.
Wenn Sie Fragen haben, können Sie uns gerne kontaktieren.

 

Dokumentation

Einführung

Unsere Event-API bietet drei Endpoints, mittels denen die Daten abgeholt werden können.

1) "EventCriteriaServiceEndpoint" - Die Abfrage der Matching-Kategorien und Kriterien (zum erzeugen der Filter)

2) "EventMatchingServiceEndpoint" - Die Listenansicht der veröffentlichten Events

3) "EventServiceEndpoint" - die Detailansicht eines veröffentlichten Events

Übersicht der Parameter

Bsp

EventCriteriaServiceEndpoint

Endpoint für die Matchingkategorien und -kriterien
https://freinet-online.de/query/api/EventCriteriaServiceEndpoint.php
agencyID
(int)
[required] 		ID der Agentur
accessKey
(string)
[required] 		ApiAccessKey
Optionale Parameter
matching_category_filter
(string)
 Um nicht alle Kategorien erzeugen zu müssen, können Sie die notwendigen Kategorien filtern. Nicht notwendig, aber ressourcenschonend.
load_definition_text
(string)
 Neben dem Titel eines Kriteriums gibt es in manchen Fällen noch kleine Hilftexte.
Mit diesem Parameter werden diese Texte mit ausgegeben.
Bsp

EventMatchingServiceEndpoint

Endpoint für die Listenansicht der Events
https://freinet-online.de/query/api/EventMatchingServiceEndpoint.php
agencyID
(int)
[required] 		ID der Agentur
accessKey
(string)
[required] 		ApiAccessKey
Optionale Parameter
accessKeyInternal
(string)
 Um erweiterten Zugriff auf Events zu bekommen, benötigen Sie den internen AccessKey. Damit haben Sie Zugriff auch auf „nicht veröffentlichte Events“
MatchingKategorien,
(int, CSV)

z.B.
- arbeitsweisen
- zielgruppen
- handlungsfelder
- globalbereiche
- mtffa(1-6) 		CSV z.B:
&arbeitsweisen=1,5,155

Freinet bietet ca 30 mögliche Kategorien an.
Welche Sie im einzelnen nutzen können, erfahren Sie von Ihrer Freiwilligenagentur. Sie können hierzu auch die stats-Seite nutzen
plz
(int)

Umkreis
(int)
 Int in km
projekt_id_inc
(int, CSV)
 CSV Liste von ProjektID´s, in denen die Events „Teilnehmern“ sein müssen
(bekommen sie bei Bedarf von der Freiwilligenagentur)
projekt_id_ex
(int, CSV)
 CSV Liste, von ProjektID´s, in denen die Events NICHT sein dürfen
(bekommen sie bei Bedarf von der Freiwilligenagentur)
suchmodus
(string)
 wenn „und“ übergeben wird, werden die MatchingKategorien „Und“ verknüpft
suchbegriff
(string)
 Freitextsuche
Die Freitextsuche unterstützt die Begriffe ›UND‹, ›NICHT‹ und Anführungszeichen ““ um Begriffe einzuschliessen.
startdatum_von
(DATE_ISO8601)
 DATE_ISO8601
zum einschränken von zeitlich limitierten Engagements
startdatum_bis
(DATE_ISO8601)
 DATE_ISO8601
startdatum
(DATE_ISO8601)
 DATE_ISO8601,DATE_ISO8601
Alternative Möglichkeit, die Zeiten zu filtern.
Hier können Sie den Zeitraum des Startdatums mit einem ›von‹ und ›bis‹-Wert eingrenzen. Diese Angaben werden durch ein › , ‹ separiert. z.B: &startdatum=2022-01-01,2022-01-15
publishing_status
(string)
 Nur in Verbindung mit Parameter „AccessKeyInternal“ um auch auf nicht öffentliche Events zuzugreifen.
(Nur in speziellen Anforderungen und mit Rücksprache)
PUBLISHED; UNPUBLISHED; ALL
page
(int)
 SeitenZahl
limit
(int)
 Limit, z.B:
&page=2&limit=10&page=3
sortierung
(string)
 - wertigkeit (Standard): In Kombination mit Matchingfiltern werden die besten Events ›oben‹ angezeigt
   Alle übrigen Events werden nach ›zuletzt bearbeitet‹ angezeigt.
- veranstaltung_name_ASC: Eventstitel ⇑ aufsteigend
- veranstaltung_name_DESC: Eventstitel ⇓ absteigend
- einrichtung_name_ASC: Einrichtungstitel ⇑ aufsteigend
- einrichtung_name_DESC: Einrichtungstitel ⇓ absteigend
- dateline: Datum
- termine_ASC: Termine ⇑ aufsteigend
- termine_DESC: Termine ⇓ absteigend
Struktur der Inhalte
Merkmale eines Events in der Übersichtsliste
<eventsliste>

    <event eventId="{n}">

        <veranstalter_name /> /* Name des Veranstalters */

        <event_titel /> /* Titel des Events */

        <datum_start_einfach /> /* Event Start */

        <datum_ende_einfach /> /* Event Ende */

        <weitere_termine_freitext /> /* Mögliche Termine als einfacher Freitext */

        <uhr_von /> /* Mögliche Zeiten als Freitexteingabe */

        <uhr_bis /> /* Mögliche Zeiten als Freitexteingabe */

        <naechster_termin /> /* In einer Serie von Durchführungen ist hier der nächste kommende Termine genannt */

        <ist_dauertermin /> /* Einfaches Merkmal für einen fortlaufenden Termin */

        <termine /> /* Array von Durchführungen */

        <beschreibung /> /* Beschreibung des Events */

        <wertigkeit /> /* Matchingkennzahl bei verknüpften Filtern */

        <strasse />

        <plz />

        <ort />

        <kontaktierbar /> /* Wenn Event direkt kontaktierbar ist */

        <avatar /> /* direkter Bildpfad */

        <anzahl_gesuche /> /* Anzahl der Plätze */

        <anzahl_aktueller_vermittlungen /> /* Anzahl bereits angemeldeter Stellen */

        <geo_breite />

        <geo_laenge />

        <ortsteil />

        <bearbeitet />

        <erstellt />

        <preis_betrag /> /* Text */

        <preis_zahldauer />  /* Text */

        <anmeldeschluss_datum />  /* Text */

        <anmeldung_erlauben /> /* bool, ob der anmeldelink erscheinen darf */

        <zahl_min_gesuchter />  /* int */

        <zahl_max_gesuchter />  /* int */

    </event>    

</eventsliste>
Bsp

EventServiceEndpoint

Endpoint für die Detailansicht eines Events
https://freinet-online.de/query/api/EventServiceEndpoint.php
agencyID
(int)
[required] 		ID der Agentur
accessKey
(string)
[required] 		ApiAccessKey
eventID
(int)
[required] 		Id des Events
Struktur der Inhalte
Merkmale eines Events in der Detailansicht
(erweiterte Anmerkungen siehe unterhalb des folgenden Listings)
<event version="1.0">

    <veranstaltung_details>

        <event_titel>Event 2023</event_titel>

        <datum_start_einfach>2015-04-11T00:00:00+02:00</datum_start_einfach> /* [anmerk1] */

        <datum_ende_einfach>2015-04-11T00:00:00+02:00</datum_ende_einfach>

        <weitere_termine_freitext />

        <uhr_von />

        <uhr_bis />

        <ist_dauertermin>0</ist_dauertermin>

        <naechster_termin>2015-04-11T00:00:00+02:00</naechster_termin>

        <termine> /* Array mehrerer Durchführungstermine */

            <termin>

                <termin_id>322542</termin_id>

                <termin_foreign_key>0</termin_foreign_key>

                <termin_second_foreign_key>0</termin_second_foreign_key>

                <termin_titel />

                <termin_desc />

                <termin_intern_memo />

                <date_start>2023-01-07T19:00:00+01:00</date_start>

                <date_end>2023-01-07T19:30:00+01:00</date_end>

                <bewerbung_start />

                <bewerbung_ende />

                <termin_anmeldung_min />

                <termin_anmeldung_max />

                <termin_anz_tn>0</termin_anz_tn>

                <termin_treffpunkt_id>0</termin_treffpunkt_id>

                <termin_treffpunkt_raum_id>0</termin_treffpunkt_raum_id>

                <termin_strasse />

                <termin_plz />

                <termin_ort />

                <termin_ortsteil />

                <termin_barrierefrei />

                <termin_intervall_id>639278dde925b</termin_intervall_id>

            </termin>

            <termin>

                <termin_id>322543</termin_id>

                <termin_foreign_key>0</termin_foreign_key>

                <termin_second_foreign_key>0</termin_second_foreign_key>

                <termin_titel />

                <termin_desc />

                <termin_intern_memo />

                <date_start>2023-01-14T19:00:00+01:00</date_start>

                <date_end>2023-01-14T19:30:00+01:00</date_end>

                <bewerbung_start />

                <bewerbung_ende />

                <termin_anmeldung_min />

                <termin_anmeldung_max />

                <termin_anz_tn>0</termin_anz_tn>

                <termin_treffpunkt_id>0</termin_treffpunkt_id>

                <termin_treffpunkt_raum_id>0</termin_treffpunkt_raum_id>

                <termin_strasse />

                <termin_plz />

                <termin_ort />

                <termin_ortsteil />

                <termin_barrierefrei />

                <termin_intervall_id>639278dde925b</termin_intervall_id>

            </termin>

        </termine>

        <vorname>Markus</vorname>

        <nachname>Muster</nachname>

        <strasse>Hauptstrasse 2</strasse>

        <plz>26125</plz>

        <ort>Oldenburg</ort>

        <geo_x>53.047565</geo_x>

        <geo_y>8.496606</geo_y>

        <email />

        <homepage />

        <telefon />

        <fax />

        <sprechzeiten />

        <beschreibung>Beschreibung des Events</beschreibung>

        <avatar>114608_avatar_19_251849.png</avatar> /* Einfacher Pfad zum Avatar */

        <avatarinfo> /* Umfangreichere Infos zum Avatar */

            <medium_datei>114608_avatar_19_251849.png</medium_datei>

            <medium_title></medium_title>

            <medium_quelle></medium_quelle>

            <medium_info />

            <medium_beschreibung></medium_beschreibung>

            <medium_aufgenommen_von></medium_aufgenommen_von>

        </avatarinfo>

        <behindertengerecht />

        <barrierefreiheit />

        <befristet />

        <zeitlicherrahmen />

        <leistungen />

        <anforderungen />

        <bearbeitet>1670543616</bearbeitet>

        <erstellt>1670543580</erstellt>

        <sprachen />

        <stadtteile />

        <umgebung />

        <mtffa1 />

        <mtffa2 />

        <mtffa3 />

        <mtffa4 />

        <mtffa5 />

        <mtffa6 />

        <kontaktierbar />

        <veroeffentlichung>19</veroeffentlichung>

        <anmeldung_erlaubt />

        <anmeldung_erlaubt_freinet_link /> /* anmeldelink, wenn anmeldung_erlaubt == 1 */

        <anzahl_gesuche />

        <anzahl_aktueller_vermittlungen />

        <veranstaltung_turnus />

        <veranstaltung_uhr_von />

        <veranstaltung_uhr_bis />

        <preis_betrag>0.00</preis_betrag>

        <preis_zahldauer>0</preis_zahldauer>

        <preis_memo>Kosten</preis_memo>

        <preis_einrichtungspauschale />

        <voraussetzungen>weitere Hinweise</voraussetzungen>

        <veranstaltung_programmablauf></veranstaltung_programmablauf>

        <veranstaltung_ort />

        <veranstaltung_kontakt></veranstaltung_kontakt>

        <veranstaltung_zielgruppen></veranstaltung_zielgruppen>

        <veranstaltung_tags />

        <veranstaltung_referent></veranstaltung_referent>

        <veranstaltung_kooperationspartner></veranstaltung_kooperationspartner>

        <anmeldeschlussdate />

        <anmeldung_erlauben />

        <anmeldung_multitermin_checkbox_or_radio>1</anmeldung_multitermin_checkbox_or_radio>

        <zahl_min_gesuchter>5</zahl_min_gesuchter>

        <zahl_max_gesuchter>10</zahl_max_gesuchter>

        <status />

    </veranstaltung_details>

    <traeger_details id="{traeger_id}"> /* Informationen zum Träger */

        <anrede>1</anrede>

        <name>ADRZ Tests</name>

        <strasse>Auricher Strasse 33</strasse>

        <plz>26721</plz>

        <ort>Oldenburg</ort>

        <geo_x>53.382198</geo_x>

        <geo_y>7.20731</geo_y>

        <bundesland>0</bundesland>

        <email>mail@example.org</email>

        <vorname>Peter</vorname>

        <nachname>Petersson</nachname>

        <beschreibung />

    </traeger_details>

    <veranstalter_details id="{veranstalter_id}"> /* Informationen zum Veranstalter */

        <anrede />

        <name>Veranstalter &quot;TESTosteron e.V.&quot;</name>

        <strasse />

        <plz />

        <ort />

        <geo_x />

        <geo_y />

        <bundesland>9</bundesland>

        <email />

        <homepage />

        <telefon />

        <fax />

        <sprechzeiten>Sprechzeiten des Veranstalters</sprechzeiten>

        <vorname />

        <nachname />

        <beschreibung>Beschreibung des Veranstalters</beschreibung>

        <avatar>27994_avatar_18_69656.jpeg</avatar>

        <avatarinfo>

            <medium_datei>27994_avatar_18_69656.jpeg</medium_datei>

            <medium_title />

            <medium_quelle />

            <medium_info />

            <medium_beschreibung />

            <medium_aufgenommen_von />

        </avatarinfo>

        <logo />

        <logoinfo>

            <medium_datei />

            <medium_title />

            <medium_quelle />

            <medium_info />

            <medium_beschreibung />

            <medium_aufgenommen_von />

        </logoinfo>

    </veranstalter_details>

    <agentur_details id="{agentur_id}"> /* Informationen zur ›Agentur‹ (dem Freinet-Mandanten) */

        <anrede>1</anrede>

        <name>Musteragentur</name>

        <strasse>Hauptstrasse 12</strasse>

        <plz>26121</plz>

        <ort>Oldenburg</ort>

        <geo_x>53.1339</geo_x>

        <geo_y>8.20224</geo_y>

        <bundesland>9</bundesland>

        <email>musteragentur@freinet-online.de</email>

        <homepage>http://www.freinet-online.com</homepage>

        <telefon>0815 7411</telefon>

        <vorname>Wilhelm</vorname>

        <nachname>Muster</nachname>

        <beschreibung />

        <avatar>20262_avatar_1_52.jpg</avatar>

        <avatarinfo>

            <medium_datei>20262_avatar_1_52.jpg</medium_datei>

            <medium_title />

            <medium_quelle />

            <medium_info />

            <medium_beschreibung />

            <medium_aufgenommen_von />

        </avatarinfo>

        <logo>80605_logo_1_52.png</logo>

        <logoinfo>

            <medium_datei>80605_logo_1_52.png</medium_datei>

            <medium_title />

            <medium_quelle />

            <medium_info />

            <medium_beschreibung />

            <medium_aufgenommen_von />

        </logoinfo>

    </agentur_details>

</event>