Media Files

Medien / Mediendateien

Medien6 EndpunkteMedia / Media Files

Diese Methode liefert alle MediaFileInfo-Objekte

GET/api/media/media/file

Query-Parameter

`name`string	interner Name \| Erforderliches Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicTitle`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicSubtitle`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicKeywords`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicDate`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicOrder`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicSeason`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicFileMime`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`addonData_customFilter`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`archived`boolean
`generatedId3`boolean
`id`integer
`created`string
`updated`string
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

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

Felder anzeigen (31)

idinteger
Primärschlüssel der Mediendatei. Interne ID.
media_file_typestring
Art der Mediendatei, zum Beispiel Audio, Video oder Bild.
archivedboolean
Die Datei ist archiviert.
namestring
interner Name
descriptionstring
interne Beschreibung
public_titlestring
Titel, der öffentlich angezeigt wird.
public_subtitlestring
Untertitel, der öffentlich angezeigt wird.
public_linkstring
Öffentlicher Link zur Datei.
public_authorstring
Öffentlich angezeigter Autor.
public_summarystring
Kurze Zusammenfassung, die öffentlich angezeigt wird.
public_descriptionstring
Beschreibung, die öffentlich angezeigt wird.
public_explicitboolean
Der Inhalt ist als explizit gekennzeichnet.
public_thumbnailstring
URL der Vorschau.
public_keywordsstring
Schlüsselwörter der Datei.
public_file_urlstring
URL der Datei.
public_file_namestring
Name der Datei.
public_file_mimestring
MIME-Typ der Datei.
public_file_sizeinteger
Größe der Datei in Bytes.
public_durationinteger
Dauer von Audio oder Video in Sekunden.
public_dimension_xinteger
Breite des Bildes oder Videos in Pixel.
public_dimension_yinteger
Höhe des Bildes oder Videos in Pixeln.
public_datestring (date-time)
Veröffentlichungsdatum der Datei.
public_orderinteger
Reihenfolge der Datei innerhalb ihrer Gruppe.
public_episode_typestring
Episodentyp für Podcasts, zum Beispiel full oder trailer.
public_seasonstring
Staffel für Podcasts.
generated_id3boolean
ID3-Tags wurden aus der Datei erzeugt.
guidstring
Global eindeutige ID der Datei, in Feeds verwendet.
display_start_hourinteger
Stunde, ab der die Datei angezeigt wird.
display_end_hourinteger
Stunde, bis zu der die Datei angezeigt wird.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/media/media/file \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/media/media/file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/media/file"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/media/media/file', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/media/file"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/media/file")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/media/file"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/media_file_info_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaFileInfoController.getAll();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "name": "Beispiel",
    "description": "Text",
    "public_title": "Beispiel",
    "public_description": "Text",
    "public_file_url": "https://vynst.de",
    "public_file_name": "Beispiel",
    "media_file_type": "string",
    "archived": true,
    "public_subtitle": "string"
  }
]

MediaFileInfo neu anlegen

POST/api/media/media/{groupIdentifier}/file

Pfad-Parameter

groupIdentifierPflichtstring

Request-Body application/json

dataMediaFileInfo2

Antworten

200MediaFileInfo neu anlegenMediaFileInfo

Felder anzeigen (31)

idinteger
Primärschlüssel der Mediendatei. Interne ID.
media_file_typestring
Art der Mediendatei, zum Beispiel Audio, Video oder Bild.
archivedboolean
Die Datei ist archiviert.
namestring
interner Name
descriptionstring
interne Beschreibung
public_titlestring
Titel, der öffentlich angezeigt wird.
public_subtitlestring
Untertitel, der öffentlich angezeigt wird.
public_linkstring
Öffentlicher Link zur Datei.
public_authorstring
Öffentlich angezeigter Autor.
public_summarystring
Kurze Zusammenfassung, die öffentlich angezeigt wird.
public_descriptionstring
Beschreibung, die öffentlich angezeigt wird.
public_explicitboolean
Der Inhalt ist als explizit gekennzeichnet.
public_thumbnailstring
URL der Vorschau.
public_keywordsstring
Schlüsselwörter der Datei.
public_file_urlstring
URL der Datei.
public_file_namestring
Name der Datei.
public_file_mimestring
MIME-Typ der Datei.
public_file_sizeinteger
Größe der Datei in Bytes.
public_durationinteger
Dauer von Audio oder Video in Sekunden.
public_dimension_xinteger
Breite des Bildes oder Videos in Pixel.
public_dimension_yinteger
Höhe des Bildes oder Videos in Pixeln.
public_datestring (date-time)
Veröffentlichungsdatum der Datei.
public_orderinteger
Reihenfolge der Datei innerhalb ihrer Gruppe.
public_episode_typestring
Episodentyp für Podcasts, zum Beispiel full oder trailer.
public_seasonstring
Staffel für Podcasts.
generated_id3boolean
ID3-Tags wurden aus der Datei erzeugt.
guidstring
Global eindeutige ID der Datei, in Feeds verwendet.
display_start_hourinteger
Stunde, ab der die Datei angezeigt wird.
display_end_hourinteger
Stunde, bis zu der die Datei angezeigt wird.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/media/media/42/file \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://eure-instanz.iw-erp.de/api/media/media/42/file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/media/42/file"

payload = {}
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/media/media/42/file', [
  'body' => '{}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/media/42/file"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/media/42/file")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/media/42/file"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/media_file_info_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_file_info.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaFileInfoController.post('42', MediaFileInfo.fromJson({}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "public_title": "Beispiel",
  "public_description": "Text",
  "public_file_url": "https://vynst.de",
  "public_file_name": "Beispiel",
  "media_file_type": "string",
  "archived": true,
  "public_subtitle": "string"
}

Diese Methode liefert eine einzelne MediaFileInfo mit der angegebenen ID

GET/api/media/media/{fileIdentifier}/file

Pfad-Parameter

fileIdentifierPflichtstring

Antworten

200Liefert ein einzelnes MediaFileInfo-Objekt.MediaFileInfo

Felder anzeigen (31)

idinteger
Primärschlüssel der Mediendatei. Interne ID.
media_file_typestring
Art der Mediendatei, zum Beispiel Audio, Video oder Bild.
archivedboolean
Die Datei ist archiviert.
namestring
interner Name
descriptionstring
interne Beschreibung
public_titlestring
Titel, der öffentlich angezeigt wird.
public_subtitlestring
Untertitel, der öffentlich angezeigt wird.
public_linkstring
Öffentlicher Link zur Datei.
public_authorstring
Öffentlich angezeigter Autor.
public_summarystring
Kurze Zusammenfassung, die öffentlich angezeigt wird.
public_descriptionstring
Beschreibung, die öffentlich angezeigt wird.
public_explicitboolean
Der Inhalt ist als explizit gekennzeichnet.
public_thumbnailstring
URL der Vorschau.
public_keywordsstring
Schlüsselwörter der Datei.
public_file_urlstring
URL der Datei.
public_file_namestring
Name der Datei.
public_file_mimestring
MIME-Typ der Datei.
public_file_sizeinteger
Größe der Datei in Bytes.
public_durationinteger
Dauer von Audio oder Video in Sekunden.
public_dimension_xinteger
Breite des Bildes oder Videos in Pixel.
public_dimension_yinteger
Höhe des Bildes oder Videos in Pixeln.
public_datestring (date-time)
Veröffentlichungsdatum der Datei.
public_orderinteger
Reihenfolge der Datei innerhalb ihrer Gruppe.
public_episode_typestring
Episodentyp für Podcasts, zum Beispiel full oder trailer.
public_seasonstring
Staffel für Podcasts.
generated_id3boolean
ID3-Tags wurden aus der Datei erzeugt.
guidstring
Global eindeutige ID der Datei, in Feeds verwendet.
display_start_hourinteger
Stunde, ab der die Datei angezeigt wird.
display_end_hourinteger
Stunde, bis zu der die Datei angezeigt wird.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/media/media/42/file \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/media/media/42/file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/media/42/file"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/media/media/42/file', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/media/42/file"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/media/42/file")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/media/42/file"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/media_file_info_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaFileInfoController.get('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "public_title": "Beispiel",
  "public_description": "Text",
  "public_file_url": "https://vynst.de",
  "public_file_name": "Beispiel",
  "media_file_type": "string",
  "archived": true,
  "public_subtitle": "string"
}

MediaFileInfo aktualisieren

PUT/api/media/media/{fileIdentifier}/file

Pfad-Parameter

fileIdentifierPflichtstring

Request-Body application/json

dataMediaFileInfo2

Antworten

200MediaFileInfo aktualisierenMediaFileInfo

Felder anzeigen (31)

idinteger
Primärschlüssel der Mediendatei. Interne ID.
media_file_typestring
Art der Mediendatei, zum Beispiel Audio, Video oder Bild.
archivedboolean
Die Datei ist archiviert.
namestring
interner Name
descriptionstring
interne Beschreibung
public_titlestring
Titel, der öffentlich angezeigt wird.
public_subtitlestring
Untertitel, der öffentlich angezeigt wird.
public_linkstring
Öffentlicher Link zur Datei.
public_authorstring
Öffentlich angezeigter Autor.
public_summarystring
Kurze Zusammenfassung, die öffentlich angezeigt wird.
public_descriptionstring
Beschreibung, die öffentlich angezeigt wird.
public_explicitboolean
Der Inhalt ist als explizit gekennzeichnet.
public_thumbnailstring
URL der Vorschau.
public_keywordsstring
Schlüsselwörter der Datei.
public_file_urlstring
URL der Datei.
public_file_namestring
Name der Datei.
public_file_mimestring
MIME-Typ der Datei.
public_file_sizeinteger
Größe der Datei in Bytes.
public_durationinteger
Dauer von Audio oder Video in Sekunden.
public_dimension_xinteger
Breite des Bildes oder Videos in Pixel.
public_dimension_yinteger
Höhe des Bildes oder Videos in Pixeln.
public_datestring (date-time)
Veröffentlichungsdatum der Datei.
public_orderinteger
Reihenfolge der Datei innerhalb ihrer Gruppe.
public_episode_typestring
Episodentyp für Podcasts, zum Beispiel full oder trailer.
public_seasonstring
Staffel für Podcasts.
generated_id3boolean
ID3-Tags wurden aus der Datei erzeugt.
guidstring
Global eindeutige ID der Datei, in Feeds verwendet.
display_start_hourinteger
Stunde, ab der die Datei angezeigt wird.
display_end_hourinteger
Stunde, bis zu der die Datei angezeigt wird.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/media/media/42/file \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://eure-instanz.iw-erp.de/api/media/media/42/file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/media/42/file"

payload = {}
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://eure-instanz.iw-erp.de/api/media/media/42/file', [
  'body' => '{}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/media/42/file"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/media/42/file")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/media/42/file"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/media_file_info_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_file_info.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaFileInfoController.put(MediaFileInfo.fromJson({}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "public_title": "Beispiel",
  "public_description": "Text",
  "public_file_url": "https://vynst.de",
  "public_file_name": "Beispiel",
  "media_file_type": "string",
  "archived": true,
  "public_subtitle": "string"
}

MediaFileInfo aktualisieren

PATCH/api/media/media/{fileIdentifier}/file

Pfad-Parameter

fileIdentifierPflichtstring

Request-Body application/json

dataMediaFileInfo2

Antworten

200MediaFileInfo aktualisierenMediaFileInfo

Felder anzeigen (31)

idinteger
Primärschlüssel der Mediendatei. Interne ID.
media_file_typestring
Art der Mediendatei, zum Beispiel Audio, Video oder Bild.
archivedboolean
Die Datei ist archiviert.
namestring
interner Name
descriptionstring
interne Beschreibung
public_titlestring
Titel, der öffentlich angezeigt wird.
public_subtitlestring
Untertitel, der öffentlich angezeigt wird.
public_linkstring
Öffentlicher Link zur Datei.
public_authorstring
Öffentlich angezeigter Autor.
public_summarystring
Kurze Zusammenfassung, die öffentlich angezeigt wird.
public_descriptionstring
Beschreibung, die öffentlich angezeigt wird.
public_explicitboolean
Der Inhalt ist als explizit gekennzeichnet.
public_thumbnailstring
URL der Vorschau.
public_keywordsstring
Schlüsselwörter der Datei.
public_file_urlstring
URL der Datei.
public_file_namestring
Name der Datei.
public_file_mimestring
MIME-Typ der Datei.
public_file_sizeinteger
Größe der Datei in Bytes.
public_durationinteger
Dauer von Audio oder Video in Sekunden.
public_dimension_xinteger
Breite des Bildes oder Videos in Pixel.
public_dimension_yinteger
Höhe des Bildes oder Videos in Pixeln.
public_datestring (date-time)
Veröffentlichungsdatum der Datei.
public_orderinteger
Reihenfolge der Datei innerhalb ihrer Gruppe.
public_episode_typestring
Episodentyp für Podcasts, zum Beispiel full oder trailer.
public_seasonstring
Staffel für Podcasts.
generated_id3boolean
ID3-Tags wurden aus der Datei erzeugt.
guidstring
Global eindeutige ID der Datei, in Feeds verwendet.
display_start_hourinteger
Stunde, ab der die Datei angezeigt wird.
display_end_hourinteger
Stunde, bis zu der die Datei angezeigt wird.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage

curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/media/media/42/file \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://eure-instanz.iw-erp.de/api/media/media/42/file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/media/42/file"

payload = {}
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://eure-instanz.iw-erp.de/api/media/media/42/file', [
  'body' => '{}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/media/42/file"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/media/42/file")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/media/42/file"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit package:http (kein Controller im Package iw_erp_api)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://eure-instanz.iw-erp.de/api/media/media/42/file'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({}),
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "public_title": "Beispiel",
  "public_description": "Text",
  "public_file_url": "https://vynst.de",
  "public_file_name": "Beispiel",
  "media_file_type": "string",
  "archived": true,
  "public_subtitle": "string"
}

Liefert eine Liste der Mediendateien einer einzelnen Medien-Gruppe.

GET/api/media/mediagroup/{groupIdentifier}/entries

Pfad-Parameter

groupIdentifierPflichtstring

Query-Parameter

`name`string	interner Name \| Erforderliches Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicTitle`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicSubtitle`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicKeywords`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicDate`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicOrder`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicSeason`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`publicFileMime`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`addonData_customFilter`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`archived`boolean
`generatedId3`boolean
`id`integer
`created`string
`updated`string
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der Mediendateien einer einzelnen Medien-Gruppe.array<MediaFileInfo3>

Felder anzeigen (26)

idinteger
Primärschlüssel der Mediendatei. Interne ID.
media_file_typestring
Art der Mediendatei, zum Beispiel Audio, Video oder Bild.
public_titlestring
Titel, der öffentlich angezeigt wird.
public_subtitlestring
Untertitel, der öffentlich angezeigt wird.
public_linkstring
Öffentlicher Link zur Datei.
public_authorstring
Öffentlich angezeigter Autor.
public_summarystring
Kurze Zusammenfassung, die öffentlich angezeigt wird.
public_descriptionstring
Beschreibung, die öffentlich angezeigt wird.
public_explicitboolean
Der Inhalt ist als explizit gekennzeichnet.
public_thumbnailstring
URL der Vorschau.
public_keywordsstring
Schlüsselwörter der Datei.
public_file_namestring
Name der Datei.
public_file_mimestring
MIME-Typ der Datei.
public_file_sizeinteger
Größe der Datei in Bytes.
public_durationinteger
Dauer von Audio oder Video in Sekunden.
public_dimension_xinteger
Breite des Bildes oder Videos in Pixel.
public_dimension_yinteger
Höhe des Bildes oder Videos in Pixeln.
public_datestring (date-time)
Veröffentlichungsdatum der Datei.
public_orderinteger
Reihenfolge der Datei innerhalb ihrer Gruppe.
public_episode_typestring
Episodentyp für Podcasts, zum Beispiel full oder trailer.
public_seasonstring
Staffel für Podcasts.
guidstring
Global eindeutige ID der Datei, in Feeds verwendet.
display_start_hourinteger
Stunde, ab der die Datei angezeigt wird.
display_end_hourinteger
Stunde, bis zu der die Datei angezeigt wird.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/media/mediagroup/42/entries \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/media/mediagroup/42/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/mediagroup/42/entries"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/media/mediagroup/42/entries', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/mediagroup/42/entries"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/mediagroup/42/entries")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/mediagroup/42/entries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/media_group_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MediaGroupController.getEntries('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "public_title": "Beispiel",
    "public_description": "Text",
    "public_file_name": "Beispiel",
    "media_file_type": "string",
    "public_subtitle": "string",
    "public_link": "string",
    "public_author": "string",
    "public_summary": "string",
    "public_explicit": true
  }
]