Versions Compared

Old Version 1

changes.mady.by.user Jessica Karkoschka

Saved on

compared with

New Version 2

changes.mady.by.user Jessica Karkoschka

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Mithilfe der PEIQ Cloud-Connect APIs(engl. Application Programming Interfaces, Programmierschnittstellen) können Verlage Teile ihrer bestehenden Systeme und Produkte mit dem PEIQ PORTAL verbinden. Alle Cloud-Connect APIs sind nach der REST-Architektur aufgebaut. Der Zugriff wird dabei über die Standard HTTP-Methoden GET, POST, PUT und DELETE gesteuert. Die Zugriffskontrolle erfolgt hierbei über eine Implementierung nach OAuth V2 Standard.

Mit der Aktionen API können alle Aktionsformen angelegt, editiert und gelöscht werden. Zudem können Sie Aktionen Bild-Assets abrufen und hinzufügen, oder Teilnehmer:innen-Informationen abrufen, hinzufügen und entfernen.

...

Mit der Aktionen API können externe Systeme die Aktionsformen /wiki/spaces/CORE/pages/45385770, /wiki/spaces/CORE/pages/45450887, /wiki/spaces/CORE/pages/45450872, /wiki/spaces/CORE/pages/46629457 und /wiki/spaces/CORE/pages/78349836 Verlosung , Umfrage , Frage beantworten , Fotowettbewerb und Texteinsendung anlegen, editieren und löschen, sowie relevante Informationen über diese Aktionen abrufen.

...

Die API-Dokumentation ist als interaktive Dokumentation für berechtigte Admins direkt im jeweiligen PORTAL unter /admin/api/v2/doc?module=participation erreichbar.

...

Verfügbare Endpunkte

Participation Event

  • Status
    colourBlue
    titleget
    /participation/events: Gibt eine paginierte Liste an Aktionsformen nach den gesetzten Filtern aus.

  • Status
    colourBlue
    titleget
    /participation/events/{event_id}: Gibt eine durch die ID spezifizierte Aktionsform zurück.

  • Status
    colourGreen
    titlePOST
    /participation/events: Erstellt eine neue Aktionsform.

  • Status
    colourYellow
    titlePUT
    /participation/events/{event_id}: Aktualisiert die im Request Body angegebenen Informationen der durch die ID spezifizierten Aktionsform.

  • Status
    colourRed
    titleDELETE
    /participation/events/{event_id}: Löscht die durch die ID spezifizierte Aktionsform unwiderruflich.

Participation User Entry

  • Status
    colourBlue
    titleget
    /participation/events/{event_id}/userentries: Gibt die Teilnehmerinformationen der durch die ID spezifizierten Aktionsform zurück.

  • Status
    colourGreen
    titlePOST
    /participation/events/{event_id}/userentries: Erstellt eine neue Teilnehmerinformation für eine durch die ID spezifizierte Aktionsform.

  • Status
    colourRed
    titleDELETE
    /participation/userentries/{user_entry_id}: Löscht eine durch die ID spezifizierte Teilnehmerinformation.

Verwandte Seiten

Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
showSpacefalse
reversefalse
cqllabel in ( "api" , "api-dokumentation" , "cloud-connect" ) and space = "PUPKB"

Include Page
Disclaimer der PEIQ PORTAL - Produktdokumentation
Disclaimer der PEIQ PORTAL - Produktdokumentation

Nur für PEIQ-Mitarbeiter:

/wiki/spaces/CORE/pages/1739882497

...