Status

colour	Purple
title	zur abnahme

Former user (Deleted)

Zusammenfassung

Webservice

REST

Objekt

JSON

Trigger

GET, POST, PUT, DELETE

Anbieter

PEIQ

Syntax

Eventcalendar-API

Info
Die API des Eventcalendar Moduls kann zum Abrufen, Erstellen, Editieren und Löschen von Veranstaltungen verwendet werden. Bilder werden asynchron importiert.

Produkt (Label)

Portal

Übergeordnetes Modul (Label)

API, Veranstaltungen

Funktionalitäten des/der [Moduls/Features/Funktion/Schnittstelle]

Mit den in der Location API genannten Endpunkten können die im Portal vorliegenden Veranstaltungen, ihre Bilder und Kommentare ausgelesen, angelegt, geändert oder gelöscht werden.
Zur Aktivierung des Features ist eine Beauftragung seitens des Kunden notwendig.

Inhaltsverzeichnis

Expand

title	Inhaltsverzeichnis anzeigen

Table of Contents

maxLevel	4

Interne

Detaillierte Beschreibung

Basis URL

Code Block

language	text

https://yourdomain.com/api/v2/eventitems

Die Veranstaltungskalender API ist der API Endpunkt für /wiki/spaces/CORE/pages/45383950 Veranstaltungen . Über die unten genannten Endpunkte können die im Portal vorliegenden Veranstaltungen, ihre Bilder und Kommentare ausgelesen, angelegt, geändert oder gelöscht werden.

Verfügbare Endpunkte für Eventitems

Veranstaltungen werden vom System als Eventitems bezeichnet. Ein Eventitem enthält verschiedene Parameter zur Festlegung des Ortes und des Zeitpunkts der Veranstaltung.

Status

colour	Blue
title	get

Get All Eventitems by Filters
- status (Available values: draft, published, rejected, scheduled, deleted)
- date_filter_type (Available values: published, created, updated ; Default value: published)
- date_start
- date_end
- location_ids
- user_id
- user_segment
- category_id
- statig_tags (Available value: commercial)
Get Eventitem by Id
- eventitem_id

Response

Code Block

language	json

{
  "total_results": 234,
  "total_pages": 12,
  "page": 1,
  "page_size": 20,
  "data": [
    {
      "id": "1",
      "url": "https://www.example.com/event/augsburg/c-category-a/test-event-1_e1",
      "poi_data": {
        "id": "1",
        "name": "Rathaus",
        "street": "Maximilianstraße",
        "city": "Augsburg",
        "zipcode": "86150",
        "lat": "41.4123541",
        "lng": "10.213123412",
        "url": "https://goo.gl/maps/9sEHVqx6jSA2"
      },
      "status": "draft",
      "created": "2019-03-07T00:00:00+00:00",
      "published": "2019-03-07T00:00:00+00:00",
      "updated": "2019-03-07T00:00:00+00:00",
      "title": "Test Event #1",
      "description": "This is the description of Test Event #1",
      "eventitem_dates": [
        "2019-03-30T18:30:00",
        "2019-04-31T12:30:00"
      ],
      "static_tags": [
        "commercial"
      ],
      "user_id": 1,
      "category_id": 1,
      "location_id": 17,
      "thumbnail": {
        "url": "https://www.example.com/resources/mediadb/event/2019/03/04/1/1_XL.jpg",
        "remote_id": "1234",
        "id": "12"
      },
      "image_count": "5",
      "visit_count": "1235",
      "like_count": "15",
      "tags": [
        "Tagger",
        "I'm a Tag"
      ]
    }
  ]
}

Status

colour	Green
title	post

Create Eventitem

Status

colour	Yellow
title	PUT

Update Eventitem by Id
- eventitem_id

Status

colour	Red
title	delete

Delete Eventitem by Id
- eventitem_id

Request Body

Code Block

language	json

{
  "poi_data": {
    "id": "1",
    "name": "Rathaus",
    "street": "Maximilianstraße",
    "city": "Augsburg",
    "zipcode": "86150",
    "lat": "41.4123541",
    "lng": "10.213123412",
    "url": "https://goo.gl/maps/9sEHVqx6jSA2"
  },
  "status": "draft",
  "created": "2019-03-07T00:00:00+00:00",
  "published": "2019-03-07T00:00:00+00:00",
  "title": "Test Event #1",
  "description": "This is the description of Test Event #1",
  "eventitem_dates": [
    "2019-03-30T18:30:00",
    "2019-04-31T12:30:00"
  ],
  "static_tags": [
    "commercial"
  ],
  "user_id": 1,
  "category_id": 1,
  "location_id": 17,
  "tags": [
    "Tagger",
    "I'm a Tag"
  ]
}

HTTP Status Codes

Code Block

language	text

200 - Success             Alles hat wie erwartet funktioniert
201 - Eventitem Successfully created / deleted
204 - Eventitem Successfully updated
400 - Bad Reqest          Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Eventitem Not Found Die Veranstaltung mit der angegebenen ID scheint nicht zu existieren

Verfügbare Endpunkte für Eventitem Categories

Dieser Endpunkt bildet einen speziellen Endpunkt zum einfacheren Auslesen der Veranstaltungs-Kategorien.

Code Block
https://yourdomain.com/api/v2/eventitems/categories

Status

colour	Blue
title	get

Get All Eventitem Categories
Get Eventitem Category by Id
- category_id

Response

Code Block

language	json

[
  {
    "id": "1",
    "name": "Sport",
    "name_norm": "sport"
  }
]

HTTP Status Codes

Code Block

200 - Success             Alles hat wie erwartet funktioniert
400 - Bad Reqest          Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Eventitem Not Found Die Veranstaltung mit der angegebenen ID scheint nicht zu existieren

Verfügbare Endpunkte für Eventitem Comments

Dieser Endpunkt bildet einen speziellen Endpunkt für /wiki/spaces/CORE/pages/50889901 an Veranstaltungen.Kommentare an Veranstaltungen.

Code Block

language	text

https://yourdomain.com/api/v2/eventitems/{eventitem_id}/comments

Status

colour	Blue
title	get

Get Eventitem Comments
- eventitem_id

Response

Code Block

language	json

{
  "total_results": 234,
  "total_pages": 12,
  "page": 1,
  "page_size": 20,
  "data": [
    {
      "id": "1",
      "author_id": 1,
      "text": "This is a test comment!",
      "status": "published",
      "position": "1",
      "created": "2019-03-07T00:00:00+00:00",
      "updated": "2019-03-07T00:00:00+00:00"
    }
  ]
}

Status

colour	Green
title	post

Create Eventitem Comment
- eventitem_id

Status

colour	Yellow
title	put

Update Eventitem Comment
- comment_id

Status

colour	Red
title	delete

Delete Eventitem Comment
- comment_id

Request Body

Code Block

language	json

[
  {
    "author_id": 1,
    "text": "This is a test comment!",
    "created": "2019-03-07T00:00:00+00:00"
  }
]

HTTP Status Codes

Code Block

200 - Success             Alles hat wie erwartet funktioniert
201 - Eventitem Comment Successfully created / deleted
204 - Eventitem Comment Successfully updated
400 - Bad Reqest          Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Not Found   	      Die Veranstaltung/Der Kommentar mit der angegebenen ID scheint nicht zu existieren

Verfügbare Endpunkte für Eventitem Images

Dieser Endpunkt bildet einen speziellen Endpunkt für Bilder von Veranstaltungen. Mit dem Parameter caption kann eine Bildunterschrift vergeben werden. Der Parameter copyright befüllt die Information zum Urheber.

Code Block

language	text

https://yourdomain.com/api/v2/eventitems/{eventitem_id}/images

Status

colour	Blue
title	get

Get all Images for a specific Eventitem
- eventitem_id
Get Eventitem Image by image_id
- image_id

Response

Code Block

language	json

[
  {
    "id": "1",
    "url_set": {
      "NATIVE": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_NATIVE.jpg",
      "T": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_T.jpg",
      "XS": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_XS.jpg",
      "S": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_S.jpg",
      "M": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_M.jpg",
      "L": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_L.jpg",
      "XL": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_XL.jpg",
      "XXL": "https://www.example.com/resources/mediadb/event/2019/03/27/1/1_XXL.jpg"
    },
    "user_id": 1,
    "created": "2019-03-07T00:00:00+00:00",
    "modified": "2019-03-07T00:00:00+00:00",
    "caption": "Test Image Caption",
    "copyright": "Test Image Copyright",
    "focus_x": "2",
    "focus_y": "3"
  }
]

Status

colour	Green
title	post

Upload Images for a specific Eventitem
- eventitem_id

Status

colour	Yellow
title	put

Update Eventitem Image by image_id
- image_id

Status

colour	Red
title	delete

Delete Eventitem Image by image_id
- image_id

Request Body

Code Block

language	json

[
  {
    "url": "https://www.example.com/resources/mediadb/event/2019/03/04/1/1_XL.jpg",
    "user_id": 1,
    "creation_date": "2019-03-07T00:00:00+00:00",
    "caption": "Test Image Caption",
    "copyright": "Test Image Copyright",
    "focus_x": "2",
    "focus_y": "3"
  }
]

HTTP Status Codes

Code Block

language	text

200 - Success             Alles hat wie erwartet funktioniert
201 - Eventitem Image Successfully uploaded / deleted
204 - Eventitem Image Successfully updated
400 - Bad Reqest          Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Not Found   	      Die Veranstaltung/Das Bild mit der angegebenen ID scheint nicht zu existieren

Setup & Konfiguration

Aktivierung Feature

Aufwand Technik

Als Change Request (Releaseunabhängig)

https://docs.google.com/document/d/1loSYAex--vFIdZ0OAAfcw8buiiCKFlZpdm3QpkvcIr0/edit?ts=5d9c7c36#heading=h.9blbyv4a4qgm

0,25PH

Zur Aktivierung des Features ist eine Beauftragung seitens des Kunden notwendig.
Die API 2.0 Dokumentation ist in jedem Portal vorhanden. Zugang erhält man mit der Berechtigung “Zugang zur API Dokumentation”

Der Zugang zur /wiki/spaces/CORE/pages/44400763 selbst ist jedoch pro Modul aktivierbar. Siehe hierfür die jeweiligen Angaben zum Setup.

Konfigurationsparameter

Warning
Es sind keine Konfigurationsmöglichkeiten für die Schnittstelle vorhanden.

Bekannte Einschränkungen

Note
s. allgemeine Bekannte Einschränkungen der PEIQ API Anbindung

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

https://peiq.atlassian.net/browse/PORTAL-44

Modul im Einsatz bei

Alte Version (V1) genutzt von:

[KIRCHENZTG] (meine-kirchenzeitung.de)
Status
colour Yellow
title Version V1
[SIEGEN] (siegener-zeitung.de)
Status
colour Yellow
title Version V1

Ansprechpartner

Teil 2 - EXTERN für Kunden & Interessenten
Status
colour Green
title extern

Note

In diesem Teil werden über sogenannte Auszüge Snippets für die extern zugänglichen Dokumente und Seiten erstellt. Diese Auszüge werden vom Customer Success auf weitere Seiten kuratiert.

Neue Auszüge können über /auszug erstellt werden.

Änderungen an bereits bestehenden Auszügen dürfen nicht vorgenommen werden. Siehe hierzu die Anleitung /wiki/spaces/CORE/pages/44204087.

Allgemeine Beschreibung
Status
colour Green
title extern

Note
Beschreibt in wenigen Sätzen die Ziele bzw. Vorteile des Moduls / Features sowie als Stichwortliste dessen Leistungsumfang. Die Allgemeine Beschreibung ist als Einstieg für den Kunden zu verstehen und beantwortet folgende Fragen: Warum brauche ich das? Was kann das?

Excerpt

Details
Status
colour Green
title extern

Note
Externe Produktdokumentation für die Kunden (Customer Success): Inhalt der aktuell FAQ benannten Dokumente, aber nicht als Frage-Antwort, sondern einfach als Dokumentation für den (potenziellen) Kunden (ohne kritische interne Hinweise, ohne Aufwände, vor allem ohne Links auf die interne CORE-Umgebung).

Excerpt

Vorläufig übertragen aus Extern (Externe Seite gelöscht)

Die API des Eventcalendar Moduls kann zum Abrufen, Erstellen, Editieren und Löschen von Veranstaltungen verwendet werden. Bilder werden asynchron importiert.

Bei der Veranstaltungs-API handelt es sich um ein Feature, welches releaseunabhängig im Rahmen einer Änderungsanfrage aktiviert werden kann.

Die API 2.0 Dokumentation dagegen ist auch ohne Aktivierung vorhanden.

Funktionalitäten der Veranstaltungskalender-API

Diverse Endpunkte für den Veranstaltungskalender
Trigger: GET, PUT, POST, DELETE

Die Basis URL

Code Block
https://yourdomain.com/api/v2/eventitems

Die Veranstaltungskalender API ist der API Endpunkt für Veranstaltungen . Über die unten genannten Endpunkte können die im Portal vorliegenden Veranstaltungen, ihre Bilder und Kommentare ausgelesen, angelegt, geändert oder gelöscht werden.

Verfügbare Endpunkte für Eventitems (Veranstaltung)

Veranstaltungen werden vom System als Eventitems bezeichnet. Ein Eventitem enthält verschiedene Parameter zur Festlegung des Ortes und des Zeitpunkts der Veranstaltung.

GET

Get All Eventitems by Filters
- status (Available values: draft, published, rejected, scheduled, deleted)
- date_filter_type (Available values: published, created, updated ; Default value: published)
- date_start
- date_end
- location_ids
- user_id
- user_segment
- category_id
- statig_tags (Available value: commercial)
Get Eventitem by Id
- eventitem_id

POST

Create Eventitem

PUT

Update Eventitem by Id
- eventitem_id

DELETE

Delete Eventitem by Id
- eventitem_id

Response Body

Code Block

{
  "total_results": 234,
  "total_pages": 12,
  "page": 1,
  "page_size": 20,
  "data": [
    {
      "id": "1",
      "url": "https://www.example.com/event/augsburg/c-category-a/test-event-1_e1",
      "poi_data": {
        "id": "1",
        "name": "Rathaus",
        "street": "Maximilianstraße",
        "city": "Augsburg",
        "zipcode": "86150",
        "lat": "41.4123541",
        "lng": "10.213123412",
        "url": "https://goo.gl/maps/9sEHVqx6jSA2"
      },
      "status": "draft",
      "created": "2019-03-07T00:00:00+00:00",
      "published": "2019-03-07T00:00:00+00:00",
      "updated": "2019-03-07T00:00:00+00:00",
      "title": "Test Event #1",
      "description": "This is the description of Test Event #1",
      "eventitem_dates": [
        "2019-03-30T18:30:00",
        "2019-04-31T12:30:00"
      ],
      "static_tags": [
        "commercial"
      ],
      "user_id": 1,
      "category_id": 1,
      "location_id": 17,
      "thumbnail": {
        "url": "https://www.example.com/resources/mediadb/event/2019/03/04/1/1_XL.jpg",
        "remote_id": "1234",
        "id": "12"
      },
      "image_count": "5",
      "visit_count": "1235",
      "like_count": "15",
      "tags": [
        "Tagger",
        "I'm a Tag"
      ]
    }
  ]
}

^{Der Response-Body - Struktur einer Veranstaltung}

HTTP Status Codes

Code Block

200 - Success             Alles hat wie erwartet funktioniert
201 - Eventitem Successfully created / deleted
204 - Eventitem Successfully updated
400 - Bad Reqest          Der Request war nicht akzeptabel. Das liegt oft an einem fehlenden Parameter. Checken Sie hierfür den gesendeten Request Body.
404 - Eventitem Not Found Die Veranstaltung mit der angegebenen ID scheint nicht zu existieren

^{HTTP Status Codes}

Verfügbare Endpunkte für Eventitem Categories

Dieser Endpunkt bildet einen speziellen Endpunkt zum einfacheren Auslesen der Veranstaltungs-Kategorien.

Code Block
https://yourdomain.com/api/v2/eventitems/categories

GET

Get All Eventitem Categories
Get Eventitem Category by Id
- category_id

Verfügbare Endpunkte für Eventitem Comments

Dieser Endpunkt bildet einen speziellen Endpunkt für Kommentare an Veranstaltungen.

Code Block
https://yourdomain.com/api/v2/eventitems/{eventitem_id}/comments

GET

Get Eventitem Comments
- eventitem_id

POST

Create Eventitem Comment
- eventitem_id

PUT

Update Eventitem Comment
- comment_id

DELETE

Delete Eventitem Comment
- comment_id

Verfügbare Endpunkte für Eventitem Images

Dieser Endpunkt bildet einen speziellen Endpunkt für Bilder von Veranstaltungen. Mit dem Parameter caption kann eine Bildunterschrift vergeben werden. Der Parameter copyright befüllt die Information zum Urheber.

Code Block
https://yourdomain.com/api/v2/eventitems/{eventitem_id}/images

GET

Get all Images for a specific Eventitem
- eventitem_id
Get Eventitem Image by image_id
- image_id

POST

Upload Images for a specific Eventitem
- eventitem_id

PUT

Update Eventitem Image by image_id
- image_id

DELETE

Delete Eventitem Image by image_id
- image_id

Release-Notes
Status
colour Green
title extern

Excerpt

Monat 202X - Zusammenfassung

Text

Excerpt

Monat 202X - Zusammenfassung

Text

Anleitung zum Setup
Status
colour Green
title extern

Excerpt

Historie

change-history

Filter by label (Content by label)

showLabels	false
showSpace	false
cql	label in ( "api" , "schnittstellen" , "veranstaltungen" ) and space = "PPSD"

Version	Old Version 1	New Version 2
Changes made by	Boris Braun	Boris Braun
Saved on	2020-09-27	2020-09-27

Page Comparison

Versions Compared

Key

Zusammenfassung

Inhaltsverzeichnis

Detaillierte Beschreibung

Basis URL

Verfügbare Endpunkte für Eventitems

Response

Request Body

HTTP Status Codes

Verfügbare Endpunkte für Eventitem Categories

Response

HTTP Status Codes

Verfügbare Endpunkte für Eventitem Comments

Response

Request Body

HTTP Status Codes

Verfügbare Endpunkte für Eventitem Images

Response

Request Body

HTTP Status Codes

Setup & Konfiguration

Konfigurationsparameter

Bekannte Einschränkungen

Entwicklungsverlauf

Links zu Issues, Tickets, etc. Neueste zuerst:

Epics

Modul im Einsatz bei

Alte Version (V1) genutzt von:

Verwandte Themen

Ansprechpartner

Teil 2 - EXTERN für Kunden & Interessenten StatuscolourGreentitleextern

Allgemeine Beschreibung StatuscolourGreentitleextern

Details StatuscolourGreentitleextern

Die Basis URL

Verfügbare Endpunkte für Eventitems (Veranstaltung)

Verfügbare Endpunkte für Eventitem Categories

Verfügbare Endpunkte für Eventitem Images

Release-Notes StatuscolourGreentitleextern

Monat 202X - Zusammenfassung

Monat 202X - Zusammenfassung

Anleitung zum Setup StatuscolourGreentitleextern

Historie

Teil 2 - EXTERN für Kunden & Interessenten
Status
colour Green
title extern

Allgemeine Beschreibung
Status
colour Green
title extern

Details
Status
colour Green
title extern

Release-Notes
Status
colour Green
title extern

Anleitung zum Setup
Status
colour Green
title extern