SOAP - API-Dokumentation

Endpoint URI: http://www.evangelische-termine.de/soap

WSDL URI: http://www.evangelische-termine.de/soap?WSDL

Beispiele für einen PHP-Client finden Sie auf GitHub: https://github.com/vernetztekirche/ET-Soap-Examples

Index

Complex types:

Public methods:

Complex types

channel

Kanal

  • int id (nillable = true, minoccurs = 1, maxoccurs = 1)
    eindeutige ID (primary Key)
  • int userid (nillable = true, minoccurs = 1, maxoccurs = 1)
    Veranstalter-Id
  • string title (nillable = true, minoccurs = 1, maxoccurs = 1)
    Bezeichnung
  • string description (nillable = true, minoccurs = 1, maxoccurs = 1)
    Beschreibung
  • int destination (nillable = true, minoccurs = 1, maxoccurs = 1)
    Reichweite (privat = 0 | regional = 1)

channelArray

This is an array type of channel.

Array der Kanäle

etdate

Termin etdate Terminobject

  • int id (nillable = true, minoccurs = 1, maxoccurs = 1)
    eindeutige Termin-ID (ID)
  • string start (nillable = true, minoccurs = 1, maxoccurs = 1)
    Startdatum im Format YYYY-MM-DD HH:II:SS
  • string end (nillable = true, minoccurs = 1, maxoccurs = 1)
    Enddatum im Format YYYY-MM-DD HH:II:SS
  • string mode (nillable = true, minoccurs = 1, maxoccurs = 1)
    Start-End-Modus vonbis|jeweils
  • mixed eventid (nillable = false, minoccurs = 1, maxoccurs = 1)
    eindeutige Stammdaten-ID (_event_ID)
  • string subtitle (nillable = true, minoccurs = 1, maxoccurs = 1)
    Untertitel
  • string externalid (nillable = true, minoccurs = 1, maxoccurs = 1)
    externe ID

event

Veranstaltung event

  • int id (nillable = true, minoccurs = 1, maxoccurs = 1)
    eindeutige Termin-ID (ID)
  • string externalid (nillable = true, minoccurs = 1, maxoccurs = 1)
    Externe Termin-ID (date)
  • string start (nillable = true, minoccurs = 1, maxoccurs = 1)
    Startdatum im Format YYYY-MM-DD HH:II:SS
  • string end (nillable = true, minoccurs = 1, maxoccurs = 1)
    Enddatum im Format YYYY-MM-DD HH:II:SS
  • string mode (nillable = true, minoccurs = 1, maxoccurs = 1)
    Start-End-Modus vonbis|jeweils
  • int eventid (nillable = true, minoccurs = 1, maxoccurs = 1)
    eindeutige Stammdaten-ID (_event_ID)
  • string eventexternalid (nillable = true, minoccurs = 1, maxoccurs = 1)
    Externe Stammdaten-ID (_event_EXTERNAL_ID)
  • int inputmaskid (nillable = false, minoccurs = 1, maxoccurs = 1)
    Eingabeformular-ID
  • string title (nillable = true, minoccurs = 1, maxoccurs = 1)
    Veranstaltungstitel (_event_TITLE)
  • string subtitle (nillable = true, minoccurs = 1, maxoccurs = 1)
    Veranstaltungs-untertitel (SUBTITLE)
  • string eventtype (nillable = true, minoccurs = 1, maxoccurs = 1)
    Art der Veranstaltung / Kategorie (mit Komma getrennte Ids)
  • string people (nillable = true, minoccurs = 1, maxoccurs = 1)
    Zielgruppe (mit Komma getrennte Ids)
  • string shortdescription (nillable = true, minoccurs = 1, maxoccurs = 1)
    Kurzbeschreibung
  • string longdescription (nillable = true, minoccurs = 1, maxoccurs = 1)
    Ausführliche Beschreibung
  • string link (nillable = true, minoccurs = 1, maxoccurs = 1)
    Internetadresse
  • int kat (nillable = true, minoccurs = 1, maxoccurs = 1)
    Auswahl 1
  • int kat2 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Auswahl 2
  • string email (nillable = true, minoccurs = 1, maxoccurs = 1)
    E-Mailadresse
  • int personid (nillable = true, minoccurs = 1, maxoccurs = 1)
    ID des Ansprechpartners
  • int placeid (nillable = false, minoccurs = 1, maxoccurs = 1)
    ID des Veranstaltungsortes
  • int regionid (nillable = true, minoccurs = 1, maxoccurs = 1)
    ID der Region 1
  • int subregionid (nillable = true, minoccurs = 1, maxoccurs = 1)
    ID der kirchl. Region (Dekanat / Kirchenkreis)
  • int region2id (nillable = true, minoccurs = 1, maxoccurs = 1)
    ID der Region 2 (Freizeitregion o.a.)
  • int region3id (nillable = true, minoccurs = 1, maxoccurs = 1)
    ID der Region 3 (Komm. Region o.a.)
  • string musickatid (nillable = true, minoccurs = 1, maxoccurs = 1)
    Musikalische Kategorie (mit '-' getrennte ids)
  • string textline1 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textzeile 1
  • string textline2 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textzeile 2
  • string textline3 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textzeile 3
  • string textline4 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textzeile 4
  • string textline5 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textzeile 5
  • string textline6 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textzeile 6
  • string textline7 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textzeile 7
  • string textline8 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textzeile 8
  • string textbox1 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textbox 1
  • string textbox2 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textbox 2
  • string textbox3 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Textbox 3
  • string menue1 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Selbstdefinierte Auswahl 1; die Werte müssen der Konfiguration der Veranstaltungstypen entsprechen; mit Komma getrennte Ids
  • string menue2 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Selbstdefinierte Auswahl 2; die Werte müssen der Konfiguration der Veranstaltungstypen entsprechen; mit Komma getrennte Ids
  • string yesno1 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Auswahlmenü 1 Ja|Nein
  • string yesno2 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Auswahlmenü 2 Ja|Nein
  • string yesno3 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Auswahlmenü 3 Ja|Nein|zero
  • string professionid (nillable = true, minoccurs = 1, maxoccurs = 1)
    Berufsgruppe
  • string destination (nillable = true, minoccurs = 1, maxoccurs = 1)
    Öffentlich / Intern (extern|intern)
  • string status (nillable = false, minoccurs = 1, maxoccurs = 1)
    Freigabe (ok|standby)
  • int feedbackid (nillable = true, minoccurs = 1, maxoccurs = 1)
    Rückmeldeformular-ID
  • string highlight (nillable = true, minoccurs = 1, maxoccurs = 1)
    Highlight (low|rhigh|high)
  • string channels (nillable = true, minoccurs = 1, maxoccurs = 1)
    Kanäle

person

Klasse person

  • int id (nillable = true, minoccurs = 1, maxoccurs = 1)
    eindeutige ID (primary Key)
  • int userid (nillable = true, minoccurs = 1, maxoccurs = 1)
    Veranstalter-Id (nur lesbar)
  • string name (nillable = true, minoccurs = 1, maxoccurs = 1)
    Name
  • string email (nillable = true, minoccurs = 1, maxoccurs = 1)
    E-Mailadresse
  • string contact (nillable = true, minoccurs = 1, maxoccurs = 1)
    Kontaktinformationen
  • int position (nillable = true, minoccurs = 1, maxoccurs = 1)
    Position (Reihenfolge der Darstellung, nur lesbar)
  • string destination (nillable = true, minoccurs = 1, maxoccurs = 1)
    Reichweite ('private'|'global')
  • string changed (nillable = true, minoccurs = 1, maxoccurs = 1)
    letzte Änderung (nur lesbar)
  • string externalId (nillable = true, minoccurs = 1, maxoccurs = 1)
    externe ID

personArray

This is an array type of person.

Array der Personen

place

Definition der Klasse place = Veranstaltungsort

  • int id (nillable = true, minoccurs = 1, maxoccurs = 1)
    eindeutige ID (primary Key)
  • int userid (nillable = true, minoccurs = 1, maxoccurs = 1)
    Veranstalter-Id
  • string name (nillable = true, minoccurs = 1, maxoccurs = 1)
    Name
  • string streetNr (nillable = true, minoccurs = 1, maxoccurs = 1)
    Straße und Hausnummer
  • string zip (nillable = true, minoccurs = 1, maxoccurs = 1)
    Postleitzahl
  • string city (nillable = true, minoccurs = 1, maxoccurs = 1)
    postalischer Ort
  • int region (nillable = true, minoccurs = 1, maxoccurs = 1)
    Region
  • string info (nillable = true, minoccurs = 1, maxoccurs = 1)
    Weitere Informationen
  • int kat (nillable = true, minoccurs = 1, maxoccurs = 1)
    Kategorie (10|20|30|40|50|60|70|80|90)
  • string open (nillable = true, minoccurs = 1, maxoccurs = 1)
    Öffnungszeiten
  • string description (nillable = true, minoccurs = 1, maxoccurs = 1)
    Beschreibung der Kirche bei Offenen Kirchen (HTML-Tags erlaubt)
  • string destination (nillable = true, minoccurs = 1, maxoccurs = 1)
    Reichweite (private|global)
  • string image (nillable = true, minoccurs = 1, maxoccurs = 1)
    Bild-Url (nur lesbar)
  • string thumbnail (nillable = true, minoccurs = 1, maxoccurs = 1)
    Thumbnail-Url (nur lesbar)
  • string glat (nillable = true, minoccurs = 1, maxoccurs = 1)
    Geoposition lat
  • string glong (nillable = true, minoccurs = 1, maxoccurs = 1)
    Geoposition long
  • int position (nillable = true, minoccurs = 1, maxoccurs = 1)
    Position (Reihenfolge der Darstellung, nur lesbar)
  • string color (nillable = true, minoccurs = 1, maxoccurs = 1)
    Farbe Format HTML-Hex-Code #XXXXXX
  • string changed (nillable = true, minoccurs = 1, maxoccurs = 1)
    letzte Änderung (nur lesbar)
  • string externalId (nillable = true, minoccurs = 1, maxoccurs = 1)
    externe ID
  • array equip (nillable = true, minoccurs = 1, maxoccurs = 1)
    Angaben zur Barrierefreiheit (1 : Rollstuhlgeeignet, 2 : Induktionsanlage für Hörgeräte, 3 : Behinderten WC, 4 : Behindertenparkplatz)
  • string equiptext (nillable = true, minoccurs = 1, maxoccurs = 1)
    Weitere Angaben zur Barrierefreiheit
  • array kat2 (nillable = true, minoccurs = 1, maxoccurs = 1)
    Kategorien (je nach Definition, z.B. Kirche liegt an folgenden Pilgerwegen; [etparam.placekat2] )
  • int notpublic (nillable = true, minoccurs = 1, maxoccurs = 1)
    für fremde Verwendung freigegeben 0|1

placeArray

This is an array type of place.

Array der Orte

soapresult

Ergebnis soapresult

  • int id (nillable = true, minoccurs = 1, maxoccurs = 1)
    eindeutige ID des jeweiligen Objekts bei saveEvent (ID), savePlace, savePerson
  • int eventid (nillable = true, minoccurs = 1, maxoccurs = 1)
    eindeutige Event-ID (_event_ID) bei saveEvent
  • string error (nillable = true, minoccurs = 1, maxoccurs = 1)
    Fehlermeldung(en)
  • string report (nillable = true, minoccurs = 1, maxoccurs = 1)
    Report
  • string detail (nillable = true, minoccurs = 1, maxoccurs = 1)
    Details

Public methods

addEtDate

soapresult addEtDate (
    etdate etdate,
    bool external
)

Fügt ein neues Datum zu einem Termin hinzu

  • etdate etdate
    Terminobject
  • bool external
    true, wenn die date->eventid die externalId (event) ist

Return value soapresult: Ergebnis

addEventImage

soapresult addEventImage (
    mixed eventid,
    string imageurl,
    bool external
)

Fügt ein Bild zu einer Veranstaltung hinzu. Das Bild muss über das Internet abrufbar sein.
Es wird automatisch auf eine maximale Größe von 300x300 Pixel skaliert.

addEventImageAsEncodedString

soapresult addEventImageAsEncodedString (
    mixed eventid,
    string imagedata,
    bool external
)

Fügt ein Bild zu einer Veranstaltung hinzu. Die Bilddaten werden als base64-codierter String übertragen.
Es wird automatisch auf eine maximale Größe von 300x300 Pixel skaliert.

  • mixed eventid
    id (int) oder externalid (string) der Veranstaltung (event)
  • string imagedata
    Bilddaten als base64-codierter String, png oder jpg
  • bool external
    eventid ist externalid

addPlaceImage

soapresult addPlaceImage (
    mixed placeid,
    string imageurl,
    bool external
)

Fügt ein Bild zu einem Veranstaltungsort hinzu. Das Bild muss über das Internet abrufbar sein.
Es wird automatisch auf eine maximale Größe von 300x300 Pixel skaliert.

addPlaceImageAsEncodedString

soapresult addPlaceImageAsEncodedString (
    mixed placeid,
    string imagedata,
    bool external
)

Fügt ein Bild zu einem Ort hinzu. Die Bilddaten werden als base64-codierter String übertragen.
Es wird automatisch auf eine maximale Größe von 300x300 Pixel skaliert.

  • mixed placeid
    ID (int) oder externalid (string) des Veranstaltungsortes
  • string imagedata
    Bilddaten als base64-codierter String, png oder jpg
  • bool external
    placeid ist externalid

deleteEvent

soapresult deleteEvent (
    mixed id,
    bool external
)

Löscht einen Termin
die $id ist der primary Key oder die externalId des date-Objects
Bei einer Reihe wird nur der Einzeltermin gelöscht, bei einer Einzelveranstaltung auch die Stammdaten

  • mixed id
    ID (int) oder externalId (string) des Termins (date)
  • bool external
    bei true : id ist die externalId

Return value soapresult: Ergebnis

deletePerson

soapresult deletePerson (
    mixed id,
    bool external
)

Löscht einen Ansprechpartner
Nur möglich, wenn der Ansprechpartner nicht mehr mit Veranstaltungen verbunden ist.
Bei Verwendung von $external = true wird der Ansprechpartner anhand der externalId ausgewählt.

  • mixed id
    ID (int) oder externalId (string) des Ansprechpartners
  • bool external
    (optional) externalId verwenden

Return value soapresult: Ergebnis

deletePlace

soapresult deletePlace (
    mixed id,
    bool external
)

Löscht einen Veranstaltungsort
Nur möglich, wenn der Veranstaltungsort nicht mehr mit Veranstaltungen verbunden ist.
Bei Verwendung von $external = true wird der Ort anhand der externalId ausgewählt.

  • mixed id
    ID (int) oder externalId (string) des Veranstaltungsorte
  • bool external
    (optional) externalId verwenden

Return value soapresult: Ergebnis

getParameterValues

mixed getParameterValues ( string key )

Liefert die Werte von festdefinierten Werte wie Veranstaltungsart, Zielgruppen, Regionen, etc.

  • string key
    Name des Parameters, mögliche Werte: eventtype|people|region|region2|region3|musickat|kat|placeregion

Return value mixed: parameter enhält die Rückgabewerte

getPerson

mixed getPerson (
    mixed id,
    bool external
)

Liefert einen Ansprechpartner anhand der eindeutigen ID oder der externalId

  • mixed id
    Id (int) oder externalId (string) des Ansprechpartners
  • bool external
    (optional) externalId verwenden

Return value mixed: ein Ansprechpartner person oder soapresult mit Fehlermeldung

getPlace

mixed getPlace (
    mixed id,
    bool external
)

Liefert einen Ort anhand der eindeutigen ID

  • mixed id
    Id (int) oder externalId (string) des Veranstaltungsortes
  • bool external
    (optional) externalId verwenden, default = false

Return value mixed: ein Veranstaltungsort oder soapresult mit Fehlermeldung

listChannels

channelArray listChannels ( )

Auflistung aller Kanäle

Return value channelArray: der Kanäle

listPersons

personArray listPersons ( )

Auflistung aller angelegten Ansprechpartner eines Veranstalters

Return value personArray: Array der Ansprechpartner

listPlaces

placeArray listPlaces ( )

Auflistung aller angelegten Veranstaltungsorte eines Veranstalters

Return value placeArray: Array der Veranstaltungsorte

removeEventImage

soapresult removeEventImage (
    mixed eventid,
    bool external
)

Löscht ein Bild von einer Veranstaltung

  • mixed eventid
    id (int) oder externalid (string) der Veranstaltung (event)
  • bool external
    eventid ist externalid

removePlaceImage

soapresult removePlaceImage (
    mixed placeid,
    bool external
)

Löscht ein Bild von einem Veranstaltungsort

  • mixed placeid
    id (int) oder externalid (string) des Veranstaltungsortes (place)
  • bool external
    placeid ist externalid

saveEvent

soapresult saveEvent ( event event )

Neue Veranstaltung erstellen oder aktualisieren. Für eine Aktualisierung müssen id und eventid oder externalid angegeben sein.
geeignet.

Return value soapresult: mit Ergebnis oder Fehlermeldung des Funktionsaufrufs

savePerson

soapresult savePerson ( person person )

Speichert einen Ansprechpartner.
Wenn die eindeutige ID gesetzt ist, wird der Eintrag mit den Angaben aktualisiert.
Ohne ID wird ein neuer Datensatz angelegt.
Ein Ansprechpartner kann auch mit einer externen ID (externalId) angelegt und aktualisiert werden.
Pflichtangabe: $person->name
Ab 100 Ansprechpartnern pro Veranstalter können keine weiteren mehr über die SOAP-Schnittstelle angelegt werden.

Return value soapresult: Ergebnis

savePlace

soapresult savePlace ( place place )

Speichert einen Ort
Wenn die eindeutige ID gesetzt ist, wird der Eintrag mit den Angaben aktualisiert.
Ohne ID wird ein neuer Datensatz angelegt.
Pflichtangaben: $place->name, $place->kat, $place->city
Ab 100 Veranstaltungsorten pro Veranstalter können keine weiteren mehr über die SOAP-Schnittstelle angelegt werden.

  • place place
    Veranstaltungsort

Return value soapresult: Ergebnis