Zum Inhalt springen
Developer

Feedback Boards

Medien / Feedback-Boards

Medien6 EndpunkteMedia / Feedback Boards

Liefert eine Liste der Feedback-Boards (dreistufige Sichtbarkeit).

GET/api/media/feedback_board

Query-Parameter

publicKeystringStabiler Schlüssel für die öffentliche URL und die Widget-Einbettung. Vom Server vergeben, wird nie über API-Eingaben gesetzt — absichtlich nicht in den oaInput-Gruppen enthalten. Eine Änderung würde jede Seite brechen, die dieses Board bereits einbettet. | Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
sortOrderstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE
namestringInterner Name, wird nur in der Admin-Oberfläche angezeigt. | Benötigt Zugriffs-Tag: SCOPE
visibilityTypestring
allowNewEntriesboolean
allowVotingboolean
allowCommentsboolean
allowGuestEntriesboolean
allowGuestVotesboolean
allowGuestCommentsboolean
createdstring
updatedstring
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der MediaFeedbackBoard-Objekte.array<MediaFeedbackBoard>

Felder anzeigen (21)
  • is_publicboolean

    Wahr, wenn das Board selbst ohne Sitzung an Aufrufer ausgeliefert werden darf.

  • idinteger

    Primärschlüssel des Feedback-Boards. Interne ID.

  • namestring

    Interner Name, wird nur in der Admin-Oberfläche angezeigt.

  • public_titlestring

    Titel des Boards, das öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung des Boards, die öffentlich angezeigt wird.

  • public_keystring

    Stabiler Schlüssel für die öffentliche URL und die Widget-Einbettung. Vom Server vergeben, wird nie über API-Eingaben gesetzt — absichtlich nicht in den oaInput-Gruppen enthalten. Eine Änderung würde jede Seite brechen, die dieses Board bereits einbettet.

  • image_urlstring

    URL des Bildes des Boards.

  • sort_orderinteger

    Sortierreihenfolge des Boards in Listen.

  • allow_new_entriesboolean

    Mitglieder können neue Einträge anlegen.

  • allow_votingboolean

    Mitglieder können über Einträge abstimmen.

  • allow_commentsboolean

    Mitglieder können Einträge kommentieren.

  • allow_guest_entriesboolean

    Gäste können neue Einträge anlegen.

  • allow_guest_votesboolean

    Gäste können über Einträge abstimmen.

  • allow_guest_commentsboolean

    Gäste können Einträge kommentieren.

  • moderation_requiredboolean

    Board-spezifische Überschreibung der globalen Moderationseinstellung. Null bedeutet „die globale Einstellung verwenden“ – deshalb ist es nullable und kein einfacher bool.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • ucatsarray<UnifiedCategory30>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (32)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory30>

      Untergeordnete Kategorien.

    • parentUnifiedCategory30

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage12>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser55

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/media/feedback_board \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "public_title": "Beispiel",
    "public_description": "Text",
    "image_url": "https://vynst.de",
    "is_public": true,
    "public_key": "string",
    "sort_order": 1,
    "allow_new_entries": true,
    "allow_voting": true
  }
]

Erstellt ein Feedback-Board.

POST/api/media/feedback_board

Request-Body application/json

  • dataMediaFeedbackBoard2
    Felder anzeigen (14)
    • namestring

      Interner Name, wird nur in der Admin-Oberfläche angezeigt.

    • public_titlestring

      Titel des Boards, das öffentlich angezeigt wird.

    • public_descriptionstring

      Beschreibung des Boards, die öffentlich angezeigt wird.

    • image_urlstring

      URL des Bildes des Boards.

    • sort_orderinteger

      Sortierreihenfolge des Boards in Listen.

    • allow_new_entriesboolean

      Mitglieder können neue Einträge anlegen.

    • allow_votingboolean

      Mitglieder können über Einträge abstimmen.

    • allow_commentsboolean

      Mitglieder können Einträge kommentieren.

    • allow_guest_entriesboolean

      Gäste können neue Einträge anlegen.

    • allow_guest_votesboolean

      Gäste können über Einträge abstimmen.

    • allow_guest_commentsboolean

      Gäste können Einträge kommentieren.

    • moderation_requiredboolean

      Board-spezifische Überschreibung der globalen Moderationseinstellung. Null bedeutet „die globale Einstellung verwenden“ – deshalb ist es nullable und kein einfacher bool.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

Antworten

200MediaFeedbackBoard neu anlegenMediaFeedbackBoard

Felder anzeigen (21)
  • is_publicboolean

    Wahr, wenn das Board selbst ohne Sitzung an Aufrufer ausgeliefert werden darf.

  • idinteger

    Primärschlüssel des Feedback-Boards. Interne ID.

  • namestring

    Interner Name, wird nur in der Admin-Oberfläche angezeigt.

  • public_titlestring

    Titel des Boards, das öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung des Boards, die öffentlich angezeigt wird.

  • public_keystring

    Stabiler Schlüssel für die öffentliche URL und die Widget-Einbettung. Vom Server vergeben, wird nie über API-Eingaben gesetzt — absichtlich nicht in den oaInput-Gruppen enthalten. Eine Änderung würde jede Seite brechen, die dieses Board bereits einbettet.

  • image_urlstring

    URL des Bildes des Boards.

  • sort_orderinteger

    Sortierreihenfolge des Boards in Listen.

  • allow_new_entriesboolean

    Mitglieder können neue Einträge anlegen.

  • allow_votingboolean

    Mitglieder können über Einträge abstimmen.

  • allow_commentsboolean

    Mitglieder können Einträge kommentieren.

  • allow_guest_entriesboolean

    Gäste können neue Einträge anlegen.

  • allow_guest_votesboolean

    Gäste können über Einträge abstimmen.

  • allow_guest_commentsboolean

    Gäste können Einträge kommentieren.

  • moderation_requiredboolean

    Board-spezifische Überschreibung der globalen Moderationseinstellung. Null bedeutet „die globale Einstellung verwenden“ – deshalb ist es nullable und kein einfacher bool.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • ucatsarray<UnifiedCategory30>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (32)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory30>

      Untergeordnete Kategorien.

    • parentUnifiedCategory30

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage12>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser55

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/media/feedback_board \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "public_title": "Beispiel",
    "public_description": "Text",
    "image_url": "https://vynst.de",
    "sort_order": 1,
    "allow_new_entries": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "public_description": "Text",
  "image_url": "https://vynst.de",
  "is_public": true,
  "public_key": "string",
  "sort_order": 1,
  "allow_new_entries": true,
  "allow_voting": true
}

Liefert ein einzelnes Feedback-Board.

GET/api/media/feedback_board/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes MediaFeedbackBoard-Objekt.MediaFeedbackBoard

Felder anzeigen (21)
  • is_publicboolean

    Wahr, wenn das Board selbst ohne Sitzung an Aufrufer ausgeliefert werden darf.

  • idinteger

    Primärschlüssel des Feedback-Boards. Interne ID.

  • namestring

    Interner Name, wird nur in der Admin-Oberfläche angezeigt.

  • public_titlestring

    Titel des Boards, das öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung des Boards, die öffentlich angezeigt wird.

  • public_keystring

    Stabiler Schlüssel für die öffentliche URL und die Widget-Einbettung. Vom Server vergeben, wird nie über API-Eingaben gesetzt — absichtlich nicht in den oaInput-Gruppen enthalten. Eine Änderung würde jede Seite brechen, die dieses Board bereits einbettet.

  • image_urlstring

    URL des Bildes des Boards.

  • sort_orderinteger

    Sortierreihenfolge des Boards in Listen.

  • allow_new_entriesboolean

    Mitglieder können neue Einträge anlegen.

  • allow_votingboolean

    Mitglieder können über Einträge abstimmen.

  • allow_commentsboolean

    Mitglieder können Einträge kommentieren.

  • allow_guest_entriesboolean

    Gäste können neue Einträge anlegen.

  • allow_guest_votesboolean

    Gäste können über Einträge abstimmen.

  • allow_guest_commentsboolean

    Gäste können Einträge kommentieren.

  • moderation_requiredboolean

    Board-spezifische Überschreibung der globalen Moderationseinstellung. Null bedeutet „die globale Einstellung verwenden“ – deshalb ist es nullable und kein einfacher bool.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • ucatsarray<UnifiedCategory30>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (32)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory30>

      Untergeordnete Kategorien.

    • parentUnifiedCategory30

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage12>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser55

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/media/feedback_board/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "public_description": "Text",
  "image_url": "https://vynst.de",
  "is_public": true,
  "public_key": "string",
  "sort_order": 1,
  "allow_new_entries": true,
  "allow_voting": true
}

Feedback-Board aktualisieren.

PUT/api/media/feedback_board/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataMediaFeedbackBoard2
    Felder anzeigen (14)
    • namestring

      Interner Name, wird nur in der Admin-Oberfläche angezeigt.

    • public_titlestring

      Titel des Boards, das öffentlich angezeigt wird.

    • public_descriptionstring

      Beschreibung des Boards, die öffentlich angezeigt wird.

    • image_urlstring

      URL des Bildes des Boards.

    • sort_orderinteger

      Sortierreihenfolge des Boards in Listen.

    • allow_new_entriesboolean

      Mitglieder können neue Einträge anlegen.

    • allow_votingboolean

      Mitglieder können über Einträge abstimmen.

    • allow_commentsboolean

      Mitglieder können Einträge kommentieren.

    • allow_guest_entriesboolean

      Gäste können neue Einträge anlegen.

    • allow_guest_votesboolean

      Gäste können über Einträge abstimmen.

    • allow_guest_commentsboolean

      Gäste können Einträge kommentieren.

    • moderation_requiredboolean

      Board-spezifische Überschreibung der globalen Moderationseinstellung. Null bedeutet „die globale Einstellung verwenden“ – deshalb ist es nullable und kein einfacher bool.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

Antworten

200MediaFeedbackBoard aktualisierenMediaFeedbackBoard

Felder anzeigen (21)
  • is_publicboolean

    Wahr, wenn das Board selbst ohne Sitzung an Aufrufer ausgeliefert werden darf.

  • idinteger

    Primärschlüssel des Feedback-Boards. Interne ID.

  • namestring

    Interner Name, wird nur in der Admin-Oberfläche angezeigt.

  • public_titlestring

    Titel des Boards, das öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung des Boards, die öffentlich angezeigt wird.

  • public_keystring

    Stabiler Schlüssel für die öffentliche URL und die Widget-Einbettung. Vom Server vergeben, wird nie über API-Eingaben gesetzt — absichtlich nicht in den oaInput-Gruppen enthalten. Eine Änderung würde jede Seite brechen, die dieses Board bereits einbettet.

  • image_urlstring

    URL des Bildes des Boards.

  • sort_orderinteger

    Sortierreihenfolge des Boards in Listen.

  • allow_new_entriesboolean

    Mitglieder können neue Einträge anlegen.

  • allow_votingboolean

    Mitglieder können über Einträge abstimmen.

  • allow_commentsboolean

    Mitglieder können Einträge kommentieren.

  • allow_guest_entriesboolean

    Gäste können neue Einträge anlegen.

  • allow_guest_votesboolean

    Gäste können über Einträge abstimmen.

  • allow_guest_commentsboolean

    Gäste können Einträge kommentieren.

  • moderation_requiredboolean

    Board-spezifische Überschreibung der globalen Moderationseinstellung. Null bedeutet „die globale Einstellung verwenden“ – deshalb ist es nullable und kein einfacher bool.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • ucatsarray<UnifiedCategory30>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (32)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory30>

      Untergeordnete Kategorien.

    • parentUnifiedCategory30

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage12>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser55

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/media/feedback_board/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "public_title": "Beispiel",
    "public_description": "Text",
    "image_url": "https://vynst.de",
    "sort_order": 1,
    "allow_new_entries": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "public_description": "Text",
  "image_url": "https://vynst.de",
  "is_public": true,
  "public_key": "string",
  "sort_order": 1,
  "allow_new_entries": true,
  "allow_voting": true
}

Feedback-Board aktualisieren.

PATCH/api/media/feedback_board/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataMediaFeedbackBoard2
    Felder anzeigen (14)
    • namestring

      Interner Name, wird nur in der Admin-Oberfläche angezeigt.

    • public_titlestring

      Titel des Boards, das öffentlich angezeigt wird.

    • public_descriptionstring

      Beschreibung des Boards, die öffentlich angezeigt wird.

    • image_urlstring

      URL des Bildes des Boards.

    • sort_orderinteger

      Sortierreihenfolge des Boards in Listen.

    • allow_new_entriesboolean

      Mitglieder können neue Einträge anlegen.

    • allow_votingboolean

      Mitglieder können über Einträge abstimmen.

    • allow_commentsboolean

      Mitglieder können Einträge kommentieren.

    • allow_guest_entriesboolean

      Gäste können neue Einträge anlegen.

    • allow_guest_votesboolean

      Gäste können über Einträge abstimmen.

    • allow_guest_commentsboolean

      Gäste können Einträge kommentieren.

    • moderation_requiredboolean

      Board-spezifische Überschreibung der globalen Moderationseinstellung. Null bedeutet „die globale Einstellung verwenden“ – deshalb ist es nullable und kein einfacher bool.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

Antworten

200MediaFeedbackBoard aktualisierenMediaFeedbackBoard

Felder anzeigen (21)
  • is_publicboolean

    Wahr, wenn das Board selbst ohne Sitzung an Aufrufer ausgeliefert werden darf.

  • idinteger

    Primärschlüssel des Feedback-Boards. Interne ID.

  • namestring

    Interner Name, wird nur in der Admin-Oberfläche angezeigt.

  • public_titlestring

    Titel des Boards, das öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung des Boards, die öffentlich angezeigt wird.

  • public_keystring

    Stabiler Schlüssel für die öffentliche URL und die Widget-Einbettung. Vom Server vergeben, wird nie über API-Eingaben gesetzt — absichtlich nicht in den oaInput-Gruppen enthalten. Eine Änderung würde jede Seite brechen, die dieses Board bereits einbettet.

  • image_urlstring

    URL des Bildes des Boards.

  • sort_orderinteger

    Sortierreihenfolge des Boards in Listen.

  • allow_new_entriesboolean

    Mitglieder können neue Einträge anlegen.

  • allow_votingboolean

    Mitglieder können über Einträge abstimmen.

  • allow_commentsboolean

    Mitglieder können Einträge kommentieren.

  • allow_guest_entriesboolean

    Gäste können neue Einträge anlegen.

  • allow_guest_votesboolean

    Gäste können über Einträge abstimmen.

  • allow_guest_commentsboolean

    Gäste können Einträge kommentieren.

  • moderation_requiredboolean

    Board-spezifische Überschreibung der globalen Moderationseinstellung. Null bedeutet „die globale Einstellung verwenden“ – deshalb ist es nullable und kein einfacher bool.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • ucatsarray<UnifiedCategory30>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (32)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory30>

      Untergeordnete Kategorien.

    • parentUnifiedCategory30

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage12>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser55

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/media/feedback_board/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "public_title": "Beispiel",
    "public_description": "Text",
    "image_url": "https://vynst.de",
    "sort_order": 1,
    "allow_new_entries": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "public_description": "Text",
  "image_url": "https://vynst.de",
  "is_public": true,
  "public_key": "string",
  "sort_order": 1,
  "allow_new_entries": true,
  "allow_voting": true
}

Löscht ein Feedback-Board logisch.

DELETE/api/media/feedback_board/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Ein MediaFeedbackBoard löschenMediaFeedbackBoard

Felder anzeigen (21)
  • is_publicboolean

    Wahr, wenn das Board selbst ohne Sitzung an Aufrufer ausgeliefert werden darf.

  • idinteger

    Primärschlüssel des Feedback-Boards. Interne ID.

  • namestring

    Interner Name, wird nur in der Admin-Oberfläche angezeigt.

  • public_titlestring

    Titel des Boards, das öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung des Boards, die öffentlich angezeigt wird.

  • public_keystring

    Stabiler Schlüssel für die öffentliche URL und die Widget-Einbettung. Vom Server vergeben, wird nie über API-Eingaben gesetzt — absichtlich nicht in den oaInput-Gruppen enthalten. Eine Änderung würde jede Seite brechen, die dieses Board bereits einbettet.

  • image_urlstring

    URL des Bildes des Boards.

  • sort_orderinteger

    Sortierreihenfolge des Boards in Listen.

  • allow_new_entriesboolean

    Mitglieder können neue Einträge anlegen.

  • allow_votingboolean

    Mitglieder können über Einträge abstimmen.

  • allow_commentsboolean

    Mitglieder können Einträge kommentieren.

  • allow_guest_entriesboolean

    Gäste können neue Einträge anlegen.

  • allow_guest_votesboolean

    Gäste können über Einträge abstimmen.

  • allow_guest_commentsboolean

    Gäste können Einträge kommentieren.

  • moderation_requiredboolean

    Board-spezifische Überschreibung der globalen Moderationseinstellung. Null bedeutet „die globale Einstellung verwenden“ – deshalb ist es nullable und kein einfacher bool.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • ucatsarray<UnifiedCategory30>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (32)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory30>

      Untergeordnete Kategorien.

    • parentUnifiedCategory30

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage12>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser55

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/media/feedback_board/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "public_description": "Text",
  "image_url": "https://vynst.de",
  "is_public": true,
  "public_key": "string",
  "sort_order": 1,
  "allow_new_entries": true,
  "allow_voting": true
}