Adressen
Veranstaltungsadressenverwaltung
| API | Beschreibung |
|---|---|
| GET api/adressen/typ/{typ} |
Gibt alle Adressen nach Typ zurück, die bei allen online verfügbaren Veranstaltungen vorkommen z.B. die Stammdaten aller Referenten. |
| GET api/adressen/typ/{typ}/{id} |
Gibt eine Adresse zurück |
Veranstaltungen
Veranstaltungsverwaltung
| API | Beschreibung |
|---|---|
| GET api/veranstaltungen/find/parameter |
Liefert eine Liste möglicher Filter für die 'find' Methode |
| GET api/veranstaltungen |
Gibt alle online verfügbaren Veranstaltungen zurück. |
| GET api/veranstaltungen?seite={seite}&zeilen={zeilen} |
Gibt alle online verfügbaren Veranstaltungen paginiert zurück. |
| GET api/veranstaltungen?datum={datum} |
Liefert geänderte Veranstaltungen ab {datum} |
| GET api/veranstaltungen/{id} |
Liefert eine bestimmte Veranstaltung. |
| GET api/veranstaltungen/datum/{beginn}/{ende} |
Gibt die laufenden online verfügbaren Veranstaltungen innerhalb eines bestimmten Zeitraums zurück. |
| GET api/veranstaltungen/Find?filter={filter}&seite={seite}&zeilen={zeilen} |
Liefert Veranstaltungen, welche einem Filter entsprechen, paginiert zurück. |
| POST api/veranstaltungen/Find |
Sucht nach übereinstimmenden Veranstaltungen |
| GET api/veranstaltungen/{id}/termine |
Gibt die Einzeltermine einer Veranstaltung zurück. |
| POST api/veranstaltungen/status |
Liefert des Status zu einer oder mehreren Veranstaltungen. |
| POST api/veranstaltungen/{id}/anmeldung |
Meldet einen Teilnehmer an einer Veranstaltung an. Für diese Funktion sind besondere Berechtigungen erforderlich. |
Buchungen
Angebots- und Buchungsverwaltung
| API | Beschreibung |
|---|---|
| GET api/buchungen/anfrage/{id} |
Gibt ein bereits erstelltes Angebot zurück. Abgelaufene Angebote werden nicht berücksichtigt! |
| POST api/buchungen/anfrage |
Erzeugt ein Buchungsangebot. |
| PUT api/buchungen/anfrage/{id} |
Möglichkeit zum Ändern einer Anfrage |
| POST api/buchungen/fixierung/{id} |
Fixiert ein Angbebot welches zuvor über [POST]*/anfrage erstellt wurde. |
Lehrgaenge
| API | Beschreibung |
|---|---|
| GET api/Lehrgaenge |
Gibt alle verfügbaren Lehrgänge zurück. |
| GET api/Lehrgaenge/{id} |
Gibt einen Lehrgang anhand seiner Id zurück. |
Teilnehmer
Teilnehmerverwaltung
| API | Beschreibung |
|---|---|
| POST api/teilnehmer |
Fügt einen Teilnehmer einer Veranstaltung hinzu und setzt das Teilnahmekennzeichen. In den Adressstammdaten werden bereits vorhandene Teilnehmer aktualisiert z.B. Telefon und E-Mail. Ein Teilnehmer kann nur einmal einer Veranstaltung zugeordnet werden. Weitere Versuche werden mit Status 409 beantwortet. Nicht vorhandene Teilnehmer werden neu angelegt.Stornierten Veranstaltungen konnen keine Teilnehmer hinzugefügt werden und würden mit Status 400 beantwortet.Werden Buchungen übergeben, so werden diese nach erfogreichen POST mit den tatsächlich gebuchten Positionen zurück geliefert. |
Belegung
Belegungsverwaltung
| API | Beschreibung |
|---|---|
| GET api/belegungen/raeume/{beginn}/{ende} |
Liefert alle Raumbuchungen innerhalb eines bestimmten Zeitraums. |
| GET api/belegungen/kapazitaet/{beginn}/{ende} |
Liefert tageweise die Zimmerkapazitäten innerhalb eines bestimmten Zeitraums (max. 90 Tage) |
| GET api/belegungen/kapazitaet/{id}/{beginn}/{ende} |
Liefert für eine bestimmte Zimmerkategorrie tageweise die Zimmerkapazitäten innerhalb eines bestimmten Zeitraums (max. 90 Tage) |
Qualitaetsmanagement
Controller für Fragen des Qualitätsmanagements
| API | Beschreibung |
|---|---|
| GET api/qualitaet/{id} |
Liefert zu einer Veranstaltung Fragen des Qualitätsmanagements an die Teilnehmer |
| POST api/qualitaet/{id}/{teilnehmerId} |
Dient zum Beantworten der Fragen an das Qualitätsmanagement. Bei relevanten Anmeldungen wird ein Link mitgeliefert. |
Feedback
| API | Beschreibung |
|---|---|
| GET api/feedback/veranstaltung/{id} |
Liefert Umfragen zu einer Veranstaltung |
| POST api/feedback/veranstaltung/{id} |
Dient zum Beantworten einer Veranstaltungsumfrage |
Stichworte
Stichwortverwaltung
| API | Beschreibung |
|---|---|
| GET api/stichworte |
Gibt die verfügbaren Stichworte zurück |
| GET api/stichworte/{id} |
Gibt ein Stichwort zurück |
| GET api/stichworte/typen/{typid} |
Gibt Stichworte eines bestimmten Typs zurück |
| GET api/stichworte/typen |
Gibt die verfügbaren Stichworttypen zurück |
Speisen
Veranstaltungsverwaltung
| API | Beschreibung |
|---|---|
| GET api/speisen/datum/{beginn} |
Liefert Speisen für einen Tag |
| GET api/speisen/datum/{beginn}/{ende} |
Gibt die Tageskarten innerhalb eines bestimmten Zeitraums zurück. |
Sync
Bietet Funktionen für den Komplettimport in andere Datenbanken.
| API | Beschreibung |
|---|---|
| GET api/sync/veranstaltungen/{beginn}/{ende} |
Gibt Veranstaltungen innerhalb des Zeitfensters zurück. Im Gegensatz zu */api/veranstaltungen werden Veranstaltungen unabhängig ihrers On-Offlinedatums oder Buchungsstatus geliefert. |
| GET api/sync/veranstaltungen/seit/{ab} |
Gibt geänderte Veranstaltungen ab einen bestimmten Zeitpunkt zurück. Im Gegensatz zu */api/veranstaltungen werden Veranstaltungen unabhängig ihres On-Offlinedatums oder Buchungsstatus geliefert. |
Konfiguration
Steuert und liefert wichtige Eigenschaften und Listen
| API | Beschreibung |
|---|---|
| GET api/config/laender |
Liefert eine Auflistung der in semiQ hinterlegten Länder. |
| GET api/config/version |
Gibt die aktuelle Schnittstellenversion zurück. |
| GET api/config/adressentypen |
Gibt die verfügbaren VeranstaltungsAdresstypen zurück z.B. Veranstalter, Referent,.. |
| GET api/config/teilnahmekennzeichen |
Gibt die möglichen Teilnahmekennzeichen zurück. |
| GET api/config/veranstaltungsarten |
Gibt die verfügbaren Veranstaltungsarten zurück. |
| GET api/config/felder |
Gibt die Bezeichnung aller Felder zurück, deren Beschriftung individuell eingestellt werden kann z.B. Telefonfelder bei der Adresse. |
| GET api/config/zimmerKategorien |
Gibt die verfügbaren Zimmerkategorien zurück |
| GET api/config/felder/{key} |
Gibt die Bezeichnung eines Feldes zurück. |
| GET api/config/menuefolgen |
Gibt die Menüfolgen zurück |
| GET api/config/zusatzstoffe |
Liefert eine Liste im Speiseplan verwendbarer Zusatzstoffe |
| GET api/config/allergene |
Liefert eine Liste im Speiseplan verwendbarer Allergene |
| GET api/config/artikelTypen |
Liefert eine Liste im Speiseplan verwendbarer Allergene |
| GET api/config/dokumentenTypen |
Liefert eine Auflistung der Dokumententypen |
LWK
Spezifische Funktionen für LWK
| API | Beschreibung |
|---|---|
| GET api/LWK/adressen/{id} |
Gibt eine Adresse zurück |
| GET api/LWK/adressen/{id}/betriebsnummer |
Liefert die zugehörige(n) Betriebsnummer(n) zu einer Adresse |
| POST api/LWK/adressen/{id}/betriebsnummer/{betriebsnummer} |
Legt für eine Adresse eine Betriebsnummer an. |
| DELETE api/LWK/adressen/{id}/betriebsnummer/{betriebsnummer} |
Entfernt die Betriebsnummer einer Adresse |
| GET api/LWK/adressen/external/{id} |
Gibt eine Adresse unter Angabe einer externen Adressnummer/Id zurück. Diese Funktion erfordert spezielle Berechtigungen und müssen durch den semiQ-Support erteilt werden. |
| GET api/LWK/adressen/external/since?datum={datum} |
Liefert für einem externen Dienstleister geänderte Adressen ab {datum}. Diese Funktion erfordert spezielle Berechtigungen und müssen durch den semiQ-Support erteilt werden. |
| GET api/LWK/adressen/{id}/veranstaltungen |
Liefert Veranstaltungsteilnahmen zur Adresse. Für diese Funktion sind besondere Berechtigungen erforderlich. |
| PUT api/LWK/adressen/{id} |
Aktualisiert eine Adresse. Diese Funktion erfordert spezielle Berechtigungen und müssen durch den semiQ-Support erteilt werden. |
| PUT api/LWK/adressen/{id}/feld |
Aktualisiert eine bestimmtes Adressenfeld welches i.d.R. NICHT in Entity 'Adresse' enthalten ist. |
| POST api/LWK/adressen/link |
Aktualisiert oder erstellt einen Verknüpfungsparter. Diese Funktion erfordert spezielle Berechtigungen und müssen durch den semiQ-Support erteilt werden. |
| DELETE api/LWK/adressen/link |
Entfernt einen Verknüpfungsparter. Diese Funktion erfordert spezielle Berechtigungen und müssen durch den semiQ-Support erteilt werden. |
| GET api/LWK/adressen/{id}/ausbildungen |
Liefert alle Ausbildungen zu einer Adresse |
| GET api/LWK/ausbildungen/{id}/noten |
Liefert die Noten zu einer Ausbildung |
| GET api/LWK/elfi/{id}/portalname |
Liefert den eLFI Portalbenutzernamen zu einer semiQ-Adresse |
| POST api/LWK/adressen/find |
Liefert eine Liste übereinstimmender Adressen. Diese Funktion erfordert spezielle Berechtigungen und müssen durch den semiQ-Support erteilt werden. |
| POST api/LWK/adressen |
Legt einen neuen Datensatz an. Diese Funktion erfordert spezielle Berechtigungen und müssen durch den semiQ-Support erteilt werden. |
| GET api/LWK/betriebsnummer/{betriebsnummer}/adressen |
Liefert Adressen zu einer Betriebsnummer |
| GET api/LWK/betriebsnummer/{betriebsnummer}/veranstaltungen |
Liefert Veranstaltungsteilnahmen zu einer Betriebsnummer |
| GET api/LWK/buchungsstati |
Liefert eine Auflistung möglicher Buchungsstati |
| GET api/LWK/berichte/teilnehmer/{veranstaltungId}/{adresseId}/{reportname} |
Liefert einen PDF-Bericht zurück. Die Angabe des Accept-Headers ist erforderlich. Gültige Werte: Application/pdf, Application/base64 Damit der Bericht generiert wird müssen folgende Bedingungen zutreffen: - Die Veranstaltung ist vorbei - Die Veranstaltung darf nicht storniert sein - Der Buchungsstatus muss hierfür konfiguriert sein (Flag-WebOptionen:1) - Die Adresse muss als Teilnehmer der Veranstltung zugeordnet sein |