Zum Inhalt springen
Developer

Media Groups

Medien / Mediengruppen

Medien5 EndpunkteMedia / Media Groups

Liefert eine Liste der Medien-Gruppen.

GET/api/media/mediagroup

Query-Parameter

namestringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE
tokenstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE
publicTitlestringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE
groupTypestringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE
slugIdentifierstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE
createdstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE
updatedstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE
orderintegerErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE
itemOfTheDaybooleanDiese Eigenschaft markiert eine Entität als Artikel des Tages. | Benötigtes Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE
idinteger
archivedboolean
addonData_shopify_product_idstring
addonData_vimeo_idstring
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 Medien-Gruppen.array<MediaGroup>

Felder anzeigen (29)
  • idinteger

    Primärschlüssel der Medengruppe. Interne ID.

  • group_typestring

    Art der Gruppe, zum Beispiel Podcast oder Album.

  • view_modestring

    Anzeigemodus der Gruppe, zum Beispiel Liste oder Raster.

  • tokenstring

    Öffentlicher Token der Gruppe. Anstelle der ID verwendet.

  • public_titlestring

    Titel, der öffentlich angezeigt wird.

  • public_linkstring

    Öffentlicher Link zur Gruppe.

  • public_link_rssstring

    Link zum RSS-Feed der Gruppe.

  • public_copyrightstring

    Urheberrechtstext, der mit der Gruppe angezeigt wird.

  • public_language_codestring

    Sprache der Gruppe, zum Beispiel de.

  • public_subtitlestring

    Untertitel, der öffentlich angezeigt wird.

  • public_authorstring

    Öffentlich angezeigter Autor.

  • public_summarystring

    Kurze Zusammenfassung, die öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung, die öffentlich angezeigt wird.

  • public_owner_namestring

    Name des Besitzers im Podcast-Feed.

  • public_owner_mailstring

    E-Mail-Adresse des Besitzers im Podcast-Feed.

  • public_explicitboolean

    Der Inhalt ist als explizit gekennzeichnet.

  • public_thumbnailstring

    URL des Titelbildes.

  • public_keywordsstring

    Schlüsselwörter der Gruppe.

  • public_categorystring

    Kategorie der öffentlich angezeigten Gruppe.

  • public_itunes_typestring

    Typ im iTunes-Feed, zum Beispiel episodic oder serial.

  • public_guidstring

    Global eindeutige ID der Gruppe, in Feeds verwendet.

  • auto_reload_timeinteger

    Zeit in Sekunden, nach der die Gruppe automatisch neu geladen wird.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • unified_cat_idsobject

    IDs der vereinheitlichten Kategorien.

  • unified_cat_namesobject

    Namen der vereinheitlichten Kategorien.

  • slug_identifierstring

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

  • orderinteger

    Position des Datensatzes in der Reihenfolge.

  • item_of_the_dayboolean

    Diese Eigenschaft markiert eine Entität als Artikel des Tages.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/media/mediagroup \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "public_title": "Beispiel",
    "public_description": "Text",
    "public_owner_name": "Beispiel",
    "public_owner_mail": "lena.hartmann@example.org",
    "group_type": "string",
    "view_mode": "string",
    "token": "string",
    "public_link": "string",
    "public_link_rss": "string"
  }
]

MediaGroup neu anlegen

POST/api/media/mediagroup

Request-Body application/json

  • dataMediaGroup2
    Felder anzeigen (27)
    • group_typestring

      Art der Gruppe, zum Beispiel Podcast oder Album.

    • view_modestring

      Anzeigemodus der Gruppe, zum Beispiel Liste oder Raster.

    • archivedboolean

      Die Gruppe ist archiviert.

    • namestring

      Interner Name der Gruppe.

    • descriptionstring

      interne Beschreibung

    • public_titlestring

      Titel, der öffentlich angezeigt wird.

    • public_linkstring

      Öffentlicher Link zur Gruppe.

    • public_link_rssstring

      Link zum RSS-Feed der Gruppe.

    • public_copyrightstring

      Urheberrechtstext, der mit der Gruppe angezeigt wird.

    • public_language_codestring

      Sprache der Gruppe, zum Beispiel de.

    • public_subtitlestring

      Untertitel, der öffentlich angezeigt wird.

    • public_authorstring

      Öffentlich angezeigter Autor.

    • public_summarystring

      Kurze Zusammenfassung, die öffentlich angezeigt wird.

    • public_descriptionstring

      Beschreibung, die öffentlich angezeigt wird.

    • public_owner_namestring

      Name des Besitzers im Podcast-Feed.

    • public_owner_mailstring

      E-Mail-Adresse des Besitzers im Podcast-Feed.

    • public_explicitboolean

      Der Inhalt ist als explizit gekennzeichnet.

    • public_thumbnailstring

      URL des Titelbildes.

    • public_keywordsstring

      Schlüsselwörter der Gruppe.

    • public_categorystring

      Kategorie der öffentlich angezeigten Gruppe.

    • public_itunes_typestring

      Typ im iTunes-Feed, zum Beispiel episodic oder serial.

    • public_guidstring

      Global eindeutige ID der Gruppe, in Feeds verwendet.

    • auto_reload_timeinteger

      Zeit in Sekunden, nach der die Gruppe automatisch neu geladen wird.

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

    • slug_identifierstring

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

    • orderinteger

      Position des Datensatzes in der Reihenfolge.

    • item_of_the_dayboolean

      Diese Eigenschaft markiert eine Entität als Artikel des Tages.

Antworten

200MediaGroup neu anlegenMediaGroup3

Felder anzeigen (33)
  • idinteger

    Primärschlüssel der Medengruppe. Interne ID.

  • group_typestring

    Art der Gruppe, zum Beispiel Podcast oder Album.

  • view_modestring

    Anzeigemodus der Gruppe, zum Beispiel Liste oder Raster.

  • tokenstring

    Öffentlicher Token der Gruppe. Anstelle der ID verwendet.

  • archivedboolean

    Die Gruppe ist archiviert.

  • namestring

    Interner Name der Gruppe.

  • descriptionstring

    interne Beschreibung

  • public_titlestring

    Titel, der öffentlich angezeigt wird.

  • public_linkstring

    Öffentlicher Link zur Gruppe.

  • public_link_rssstring

    Link zum RSS-Feed der Gruppe.

  • public_copyrightstring

    Urheberrechtstext, der mit der Gruppe angezeigt wird.

  • public_language_codestring

    Sprache der Gruppe, zum Beispiel de.

  • public_subtitlestring

    Untertitel, der öffentlich angezeigt wird.

  • public_authorstring

    Öffentlich angezeigter Autor.

  • public_summarystring

    Kurze Zusammenfassung, die öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung, die öffentlich angezeigt wird.

  • public_owner_namestring

    Name des Besitzers im Podcast-Feed.

  • public_owner_mailstring

    E-Mail-Adresse des Besitzers im Podcast-Feed.

  • public_explicitboolean

    Der Inhalt ist als explizit gekennzeichnet.

  • public_thumbnailstring

    URL des Titelbildes.

  • public_keywordsstring

    Schlüsselwörter der Gruppe.

  • public_categorystring

    Kategorie der öffentlich angezeigten Gruppe.

  • public_itunes_typestring

    Typ im iTunes-Feed, zum Beispiel episodic oder serial.

  • public_guidstring

    Global eindeutige ID der Gruppe, in Feeds verwendet.

  • auto_reload_timeinteger

    Zeit in Sekunden, nach der die Gruppe automatisch neu geladen wird.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage3>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

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

    • userUser46

      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

  • ucatsarray<UnifiedCategory22>

    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<UnifiedCategory22>

      Untergeordnete Kategorien.

    • parentUnifiedCategory22

      Ü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

  • slug_identifierstring

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

  • orderinteger

    Position des Datensatzes in der Reihenfolge.

  • item_of_the_dayboolean

    Diese Eigenschaft markiert eine Entität als Artikel des Tages.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/media/mediagroup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "description": "Text",
    "public_title": "Beispiel",
    "public_description": "Text",
    "public_owner_name": "Beispiel",
    "public_owner_mail": "lena.hartmann@example.org"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "public_title": "Beispiel",
  "public_description": "Text",
  "public_owner_name": "Beispiel",
  "public_owner_mail": "lena.hartmann@example.org",
  "group_type": "string",
  "view_mode": "string",
  "token": "string"
}

Liefert eine einzelne Medien-Gruppe mit der angegebenen ID oder dem angegebenen Token.

GET/api/media/mediagroup/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert eine einzelne Medien-Gruppe mit der angegebenen ID oder dem angegebenen Token.MediaGroup3

Felder anzeigen (33)
  • idinteger

    Primärschlüssel der Medengruppe. Interne ID.

  • group_typestring

    Art der Gruppe, zum Beispiel Podcast oder Album.

  • view_modestring

    Anzeigemodus der Gruppe, zum Beispiel Liste oder Raster.

  • tokenstring

    Öffentlicher Token der Gruppe. Anstelle der ID verwendet.

  • archivedboolean

    Die Gruppe ist archiviert.

  • namestring

    Interner Name der Gruppe.

  • descriptionstring

    interne Beschreibung

  • public_titlestring

    Titel, der öffentlich angezeigt wird.

  • public_linkstring

    Öffentlicher Link zur Gruppe.

  • public_link_rssstring

    Link zum RSS-Feed der Gruppe.

  • public_copyrightstring

    Urheberrechtstext, der mit der Gruppe angezeigt wird.

  • public_language_codestring

    Sprache der Gruppe, zum Beispiel de.

  • public_subtitlestring

    Untertitel, der öffentlich angezeigt wird.

  • public_authorstring

    Öffentlich angezeigter Autor.

  • public_summarystring

    Kurze Zusammenfassung, die öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung, die öffentlich angezeigt wird.

  • public_owner_namestring

    Name des Besitzers im Podcast-Feed.

  • public_owner_mailstring

    E-Mail-Adresse des Besitzers im Podcast-Feed.

  • public_explicitboolean

    Der Inhalt ist als explizit gekennzeichnet.

  • public_thumbnailstring

    URL des Titelbildes.

  • public_keywordsstring

    Schlüsselwörter der Gruppe.

  • public_categorystring

    Kategorie der öffentlich angezeigten Gruppe.

  • public_itunes_typestring

    Typ im iTunes-Feed, zum Beispiel episodic oder serial.

  • public_guidstring

    Global eindeutige ID der Gruppe, in Feeds verwendet.

  • auto_reload_timeinteger

    Zeit in Sekunden, nach der die Gruppe automatisch neu geladen wird.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage3>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

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

    • userUser46

      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

  • ucatsarray<UnifiedCategory22>

    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<UnifiedCategory22>

      Untergeordnete Kategorien.

    • parentUnifiedCategory22

      Ü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

  • slug_identifierstring

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

  • orderinteger

    Position des Datensatzes in der Reihenfolge.

  • item_of_the_dayboolean

    Diese Eigenschaft markiert eine Entität als Artikel des Tages.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/media/mediagroup/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "public_title": "Beispiel",
  "public_description": "Text",
  "public_owner_name": "Beispiel",
  "public_owner_mail": "lena.hartmann@example.org",
  "group_type": "string",
  "view_mode": "string",
  "token": "string"
}

MediaGroup aktualisieren

PUT/api/media/mediagroup/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataMediaGroup2
    Felder anzeigen (27)
    • group_typestring

      Art der Gruppe, zum Beispiel Podcast oder Album.

    • view_modestring

      Anzeigemodus der Gruppe, zum Beispiel Liste oder Raster.

    • archivedboolean

      Die Gruppe ist archiviert.

    • namestring

      Interner Name der Gruppe.

    • descriptionstring

      interne Beschreibung

    • public_titlestring

      Titel, der öffentlich angezeigt wird.

    • public_linkstring

      Öffentlicher Link zur Gruppe.

    • public_link_rssstring

      Link zum RSS-Feed der Gruppe.

    • public_copyrightstring

      Urheberrechtstext, der mit der Gruppe angezeigt wird.

    • public_language_codestring

      Sprache der Gruppe, zum Beispiel de.

    • public_subtitlestring

      Untertitel, der öffentlich angezeigt wird.

    • public_authorstring

      Öffentlich angezeigter Autor.

    • public_summarystring

      Kurze Zusammenfassung, die öffentlich angezeigt wird.

    • public_descriptionstring

      Beschreibung, die öffentlich angezeigt wird.

    • public_owner_namestring

      Name des Besitzers im Podcast-Feed.

    • public_owner_mailstring

      E-Mail-Adresse des Besitzers im Podcast-Feed.

    • public_explicitboolean

      Der Inhalt ist als explizit gekennzeichnet.

    • public_thumbnailstring

      URL des Titelbildes.

    • public_keywordsstring

      Schlüsselwörter der Gruppe.

    • public_categorystring

      Kategorie der öffentlich angezeigten Gruppe.

    • public_itunes_typestring

      Typ im iTunes-Feed, zum Beispiel episodic oder serial.

    • public_guidstring

      Global eindeutige ID der Gruppe, in Feeds verwendet.

    • auto_reload_timeinteger

      Zeit in Sekunden, nach der die Gruppe automatisch neu geladen wird.

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

    • slug_identifierstring

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

    • orderinteger

      Position des Datensatzes in der Reihenfolge.

    • item_of_the_dayboolean

      Diese Eigenschaft markiert eine Entität als Artikel des Tages.

Antworten

200MediaGroup aktualisierenMediaGroup3

Felder anzeigen (33)
  • idinteger

    Primärschlüssel der Medengruppe. Interne ID.

  • group_typestring

    Art der Gruppe, zum Beispiel Podcast oder Album.

  • view_modestring

    Anzeigemodus der Gruppe, zum Beispiel Liste oder Raster.

  • tokenstring

    Öffentlicher Token der Gruppe. Anstelle der ID verwendet.

  • archivedboolean

    Die Gruppe ist archiviert.

  • namestring

    Interner Name der Gruppe.

  • descriptionstring

    interne Beschreibung

  • public_titlestring

    Titel, der öffentlich angezeigt wird.

  • public_linkstring

    Öffentlicher Link zur Gruppe.

  • public_link_rssstring

    Link zum RSS-Feed der Gruppe.

  • public_copyrightstring

    Urheberrechtstext, der mit der Gruppe angezeigt wird.

  • public_language_codestring

    Sprache der Gruppe, zum Beispiel de.

  • public_subtitlestring

    Untertitel, der öffentlich angezeigt wird.

  • public_authorstring

    Öffentlich angezeigter Autor.

  • public_summarystring

    Kurze Zusammenfassung, die öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung, die öffentlich angezeigt wird.

  • public_owner_namestring

    Name des Besitzers im Podcast-Feed.

  • public_owner_mailstring

    E-Mail-Adresse des Besitzers im Podcast-Feed.

  • public_explicitboolean

    Der Inhalt ist als explizit gekennzeichnet.

  • public_thumbnailstring

    URL des Titelbildes.

  • public_keywordsstring

    Schlüsselwörter der Gruppe.

  • public_categorystring

    Kategorie der öffentlich angezeigten Gruppe.

  • public_itunes_typestring

    Typ im iTunes-Feed, zum Beispiel episodic oder serial.

  • public_guidstring

    Global eindeutige ID der Gruppe, in Feeds verwendet.

  • auto_reload_timeinteger

    Zeit in Sekunden, nach der die Gruppe automatisch neu geladen wird.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage3>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

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

    • userUser46

      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

  • ucatsarray<UnifiedCategory22>

    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<UnifiedCategory22>

      Untergeordnete Kategorien.

    • parentUnifiedCategory22

      Ü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

  • slug_identifierstring

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

  • orderinteger

    Position des Datensatzes in der Reihenfolge.

  • item_of_the_dayboolean

    Diese Eigenschaft markiert eine Entität als Artikel des Tages.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/media/mediagroup/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "description": "Text",
    "public_title": "Beispiel",
    "public_description": "Text",
    "public_owner_name": "Beispiel",
    "public_owner_mail": "lena.hartmann@example.org"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "public_title": "Beispiel",
  "public_description": "Text",
  "public_owner_name": "Beispiel",
  "public_owner_mail": "lena.hartmann@example.org",
  "group_type": "string",
  "view_mode": "string",
  "token": "string"
}

MediaGroup aktualisieren

PATCH/api/media/mediagroup/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataMediaGroup2
    Felder anzeigen (27)
    • group_typestring

      Art der Gruppe, zum Beispiel Podcast oder Album.

    • view_modestring

      Anzeigemodus der Gruppe, zum Beispiel Liste oder Raster.

    • archivedboolean

      Die Gruppe ist archiviert.

    • namestring

      Interner Name der Gruppe.

    • descriptionstring

      interne Beschreibung

    • public_titlestring

      Titel, der öffentlich angezeigt wird.

    • public_linkstring

      Öffentlicher Link zur Gruppe.

    • public_link_rssstring

      Link zum RSS-Feed der Gruppe.

    • public_copyrightstring

      Urheberrechtstext, der mit der Gruppe angezeigt wird.

    • public_language_codestring

      Sprache der Gruppe, zum Beispiel de.

    • public_subtitlestring

      Untertitel, der öffentlich angezeigt wird.

    • public_authorstring

      Öffentlich angezeigter Autor.

    • public_summarystring

      Kurze Zusammenfassung, die öffentlich angezeigt wird.

    • public_descriptionstring

      Beschreibung, die öffentlich angezeigt wird.

    • public_owner_namestring

      Name des Besitzers im Podcast-Feed.

    • public_owner_mailstring

      E-Mail-Adresse des Besitzers im Podcast-Feed.

    • public_explicitboolean

      Der Inhalt ist als explizit gekennzeichnet.

    • public_thumbnailstring

      URL des Titelbildes.

    • public_keywordsstring

      Schlüsselwörter der Gruppe.

    • public_categorystring

      Kategorie der öffentlich angezeigten Gruppe.

    • public_itunes_typestring

      Typ im iTunes-Feed, zum Beispiel episodic oder serial.

    • public_guidstring

      Global eindeutige ID der Gruppe, in Feeds verwendet.

    • auto_reload_timeinteger

      Zeit in Sekunden, nach der die Gruppe automatisch neu geladen wird.

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

    • slug_identifierstring

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

    • orderinteger

      Position des Datensatzes in der Reihenfolge.

    • item_of_the_dayboolean

      Diese Eigenschaft markiert eine Entität als Artikel des Tages.

Antworten

200MediaGroup aktualisierenMediaGroup3

Felder anzeigen (33)
  • idinteger

    Primärschlüssel der Medengruppe. Interne ID.

  • group_typestring

    Art der Gruppe, zum Beispiel Podcast oder Album.

  • view_modestring

    Anzeigemodus der Gruppe, zum Beispiel Liste oder Raster.

  • tokenstring

    Öffentlicher Token der Gruppe. Anstelle der ID verwendet.

  • archivedboolean

    Die Gruppe ist archiviert.

  • namestring

    Interner Name der Gruppe.

  • descriptionstring

    interne Beschreibung

  • public_titlestring

    Titel, der öffentlich angezeigt wird.

  • public_linkstring

    Öffentlicher Link zur Gruppe.

  • public_link_rssstring

    Link zum RSS-Feed der Gruppe.

  • public_copyrightstring

    Urheberrechtstext, der mit der Gruppe angezeigt wird.

  • public_language_codestring

    Sprache der Gruppe, zum Beispiel de.

  • public_subtitlestring

    Untertitel, der öffentlich angezeigt wird.

  • public_authorstring

    Öffentlich angezeigter Autor.

  • public_summarystring

    Kurze Zusammenfassung, die öffentlich angezeigt wird.

  • public_descriptionstring

    Beschreibung, die öffentlich angezeigt wird.

  • public_owner_namestring

    Name des Besitzers im Podcast-Feed.

  • public_owner_mailstring

    E-Mail-Adresse des Besitzers im Podcast-Feed.

  • public_explicitboolean

    Der Inhalt ist als explizit gekennzeichnet.

  • public_thumbnailstring

    URL des Titelbildes.

  • public_keywordsstring

    Schlüsselwörter der Gruppe.

  • public_categorystring

    Kategorie der öffentlich angezeigten Gruppe.

  • public_itunes_typestring

    Typ im iTunes-Feed, zum Beispiel episodic oder serial.

  • public_guidstring

    Global eindeutige ID der Gruppe, in Feeds verwendet.

  • auto_reload_timeinteger

    Zeit in Sekunden, nach der die Gruppe automatisch neu geladen wird.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage3>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

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

    • userUser46

      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

  • ucatsarray<UnifiedCategory22>

    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<UnifiedCategory22>

      Untergeordnete Kategorien.

    • parentUnifiedCategory22

      Ü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

  • slug_identifierstring

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

  • orderinteger

    Position des Datensatzes in der Reihenfolge.

  • item_of_the_dayboolean

    Diese Eigenschaft markiert eine Entität als Artikel des Tages.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/media/mediagroup/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "description": "Text",
    "public_title": "Beispiel",
    "public_description": "Text",
    "public_owner_name": "Beispiel",
    "public_owner_mail": "lena.hartmann@example.org"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "public_title": "Beispiel",
  "public_description": "Text",
  "public_owner_name": "Beispiel",
  "public_owner_mail": "lena.hartmann@example.org",
  "group_type": "string",
  "view_mode": "string",
  "token": "string"
}