Angebot-API
Mittels unserer Angebot-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 Angebot-API bietet drei Endpoints, mittels denen die Daten abgeholt werden können.
1) "CriteriaServiceEndpoint" - Die Abfrage der Matching-Kategorien und Kriterien (zum erzeugen der Filter)
2) "MatchingServiceEndpoint" - Die Listenansicht der veröffentlichten Angebote
3) "OfferServiceEndpoint" - die Detailansicht eines veröffentlichten Angebotes
Übersicht der Parameter
Bsp
CriteriaServiceEndpointEndpoint für die Matchingkategorien und -kriterien
|
|
|
https://lachnit-software.de/query/api/CriteriaServiceEndpoint.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
MatchingServiceEndpointEndpoint für die Listenansicht der Angebote
|
|
|
https://lachnit-software.de/query/api/MatchingServiceEndpoint.php
|
|
|
agencyID
(int)
[required]
|
ID der Agentur |
|
accessKey
(string)
[required]
|
ApiAccessKey |
| Optionale Parameter | |
|
accessKeyInternal
(string)
|
Um erweiterten Zugriff auf Angebote zu bekommen, benötigen Sie den internen AccessKey. Damit haben Sie Zugriff auch auf „nicht veröffentlichte Angebote“ |
|
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 Angebote „Teilnehmern“
sein müssen (bekommen sie bei Bedarf von der Freiwilligenagentur) |
|
projekt_id_ex
(int, CSV)
|
CSV Liste, von ProjektID´s, in denen die Angebote 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 müssen Sie Start- und EndDatum durch den senkrechten Strich („Pipe“) verbinden. |
|
publishing_status
(string)
|
Nur in Verbindung mit Parameter „AccessKeyInternal“ um auch auf
nicht öffentliche Angebote 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 |
|
additional_infos
(string)
|
- matching_kategorie: Zeigt in der Listenansicht die Matchingkategorien eines Angebotes an |
|
show_matching_kategorien (in Verbindung mit Parameter additional_infos=matching_kategorie) (string)
|
- CSV Liste der Matchingkategorien, die angezeigt werden sollen, z.B. &additional_infos=matching_kategorie&show_matching_kategorien=zielgruppen,globalbereiche |
|
sortierung
(string)
|
- wertigkeit (Standard): In Kombination mit Matchingfiltern werden die besten Angebote ›oben‹ angezeigt Alle übrigen Angebote werden nach ›zuletzt bearbeitet‹ angezeigt. - angebot_name_ASC: Angebotstitel ⇑ aufsteigend - angebot_name_DESC: Angebotstitel ⇓ absteigend - einrichtung_name_ASC: Einrichtungstitel ⇑ aufsteigend - einrichtung_name_DESC: Einrichtungstitel ⇓ absteigend - dateline: Datum - termine_ASC: Termine ⇑ aufsteigend - termine_DESC: Termine ⇓ absteigend |
Bsp
OfferServiceEndpointEndpoint für die Detailansicht eines Angebots
|
|
|
https://lachnit-software.de/query/api/OfferServiceEndpoint.php
|
|
|
agencyID
(int)
[required]
|
ID der Agentur |
|
accessKey
(string)
[required]
|
ApiAccessKey |
|
offerID
(int)
[required]
|
Id des Angebotes |
|
show_detailed_matching_criteria
(bool)
[optional]
|
Zeigt die Matching-Kriterien mit ID und Titel |