MediaCardButton

Medien / MediaCardButton

Medien6 EndpunkteMedia / MediaCardButton

Diese Methode liefert alle MediaCardButton

GET/api/media/card_button

Query-Parameter

`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 MediaCardButton-Objekte.array<MediaCardButton>

Felder anzeigen (22)

idinteger
Primärschlüssel der Kartenschaltfläche. Interne ID.
card_typestring
Art der Karte, zum Beispiel eine Kachel auf dem Startbildschirm.
card_conditionsstring
Bedingungen, unter denen die Karte angezeigt wird, als Text.
tokenstring
Öffentlicher Token der Karte. Anstelle der ID verwendet.
language_codestring
Sprache der Karte, zum Beispiel de oder en.
icon_asset_namestring
Name des Symbols der Karte.
icon_packagestring
Symbolpaket, zu dem das Symbol gehört.
icon_colorstring
Farbe des Symbols.
text_colorstring
Farbe des Textes.
background_colorstring
Hintergrundfarbe der Karte.
link_actionstring
Aktion beim Antippen der Karte, zum Beispiel eine Seite öffnen.
link_urlstring
URL, auf die die Karte verlinkt.
image_opacitynumber (float)
Deckkraft des Hintergrundbildes, von 0 bis 1.
ui_presetstring
Layoutvorlage der Karte.
start_datestring (date-time)
Beginn des Anzeigezeitraums.
end_datestring (date-time)
Ende des Anzeigezeitraums.
dismissableboolean
Der Benutzer kann die Karte ausblenden.
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
image_urlstring
URL des Bildes des Datensatzes.
namestring
Name der Einheit.

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/media/card_button \
  --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/card_button', 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/card_button"

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/card_button', [
  '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/card_button"),
  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/card_button")
  .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/card_button"

	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_card_button_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 MediaCardButtonController.getAll();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "icon_asset_name": "Beispiel",
    "icon_color": "#3f5efb",
    "text_color": "#3f5efb",
    "background_color": "#3f5efb",
    "link_url": "https://vynst.de",
    "image_url": "https://vynst.de",
    "name": "Beispiel",
    "card_type": "string",
    "card_conditions": "string"
  }
]

MediaCardButton neu anlegen

POST/api/media/card_button

Antworten

200MediaCardButton neu anlegenMediaCardButton2

Felder anzeigen (25)

idinteger
Primärschlüssel der Kartenschaltfläche. Interne ID.
card_typestring
Art der Karte, zum Beispiel eine Kachel auf dem Startbildschirm.
card_conditionsstring
Bedingungen, unter denen die Karte angezeigt wird, als Text.
tokenstring
Öffentlicher Token der Karte. Anstelle der ID verwendet.
language_codestring
Sprache der Karte, zum Beispiel de oder en.
icon_asset_namestring
Name des Symbols der Karte.
icon_packagestring
Symbolpaket, zu dem das Symbol gehört.
icon_colorstring
Farbe des Symbols.
text_colorstring
Farbe des Textes.
background_colorstring
Hintergrundfarbe der Karte.
link_actionstring
Aktion beim Antippen der Karte, zum Beispiel eine Seite öffnen.
link_urlstring
URL, auf die die Karte verlinkt.
image_opacitynumber (float)
Deckkraft des Hintergrundbildes, von 0 bis 1.
ui_presetstring
Layoutvorlage der Karte.
start_datestring (date-time)
Beginn des Anzeigezeitraums.
end_datestring (date-time)
Ende des Anzeigezeitraums.
dismissableboolean
Der Benutzer kann die Karte ausblenden.
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<AccessRightStorage10>
Zugriffsrechteliste, die die Sichtbarkeit steuert.
Felder anzeigen (12)
- idinteger
  Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.
- userUser53
  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
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
image_urlstring
URL des Bildes des Datensatzes.
ucatsarray<UnifiedCategory28>
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<UnifiedCategory28>
  Untergeordnete Kategorien.
- parentUnifiedCategory28
  Ü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
namestring
Name der Einheit.

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/card_button', 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/card_button"

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

response = requests.post(url, 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/card_button', [
  'headers' => [
    '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/card_button"),
  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/card_button")
  .post(null)
  .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/card_button"

	req, _ := http.NewRequest("POST", 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_card_button_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_card_button.dart';

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

final result = await MediaCardButtonController.post(MediaCardButton.fromJson({}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "icon_asset_name": "Beispiel",
  "icon_color": "#3f5efb",
  "text_color": "#3f5efb",
  "background_color": "#3f5efb",
  "link_url": "https://vynst.de",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "card_type": "string",
  "card_conditions": "string"
}

Diese Methode liefert eine einzelne MediaCardButton mit der angegebenen ID oder dem Token

GET/api/media/card_button/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes MediaCardButton-Objekt.MediaCardButton

Felder anzeigen (22)

idinteger
Primärschlüssel der Kartenschaltfläche. Interne ID.
card_typestring
Art der Karte, zum Beispiel eine Kachel auf dem Startbildschirm.
card_conditionsstring
Bedingungen, unter denen die Karte angezeigt wird, als Text.
tokenstring
Öffentlicher Token der Karte. Anstelle der ID verwendet.
language_codestring
Sprache der Karte, zum Beispiel de oder en.
icon_asset_namestring
Name des Symbols der Karte.
icon_packagestring
Symbolpaket, zu dem das Symbol gehört.
icon_colorstring
Farbe des Symbols.
text_colorstring
Farbe des Textes.
background_colorstring
Hintergrundfarbe der Karte.
link_actionstring
Aktion beim Antippen der Karte, zum Beispiel eine Seite öffnen.
link_urlstring
URL, auf die die Karte verlinkt.
image_opacitynumber (float)
Deckkraft des Hintergrundbildes, von 0 bis 1.
ui_presetstring
Layoutvorlage der Karte.
start_datestring (date-time)
Beginn des Anzeigezeitraums.
end_datestring (date-time)
Ende des Anzeigezeitraums.
dismissableboolean
Der Benutzer kann die Karte ausblenden.
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
image_urlstring
URL des Bildes des Datensatzes.
namestring
Name der Einheit.

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/media/card_button/42 \
  --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/card_button/42', 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/card_button/42"

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/card_button/42', [
  '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/card_button/42"),
  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/card_button/42")
  .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/card_button/42"

	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_card_button_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 MediaCardButtonController.get('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "icon_asset_name": "Beispiel",
  "icon_color": "#3f5efb",
  "text_color": "#3f5efb",
  "background_color": "#3f5efb",
  "link_url": "https://vynst.de",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "card_type": "string",
  "card_conditions": "string"
}

MediaCardButton aktualisieren

PUT/api/media/card_button/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200MediaCardButton aktualisierenMediaCardButton2

Felder anzeigen (25)

idinteger
Primärschlüssel der Kartenschaltfläche. Interne ID.
card_typestring
Art der Karte, zum Beispiel eine Kachel auf dem Startbildschirm.
card_conditionsstring
Bedingungen, unter denen die Karte angezeigt wird, als Text.
tokenstring
Öffentlicher Token der Karte. Anstelle der ID verwendet.
language_codestring
Sprache der Karte, zum Beispiel de oder en.
icon_asset_namestring
Name des Symbols der Karte.
icon_packagestring
Symbolpaket, zu dem das Symbol gehört.
icon_colorstring
Farbe des Symbols.
text_colorstring
Farbe des Textes.
background_colorstring
Hintergrundfarbe der Karte.
link_actionstring
Aktion beim Antippen der Karte, zum Beispiel eine Seite öffnen.
link_urlstring
URL, auf die die Karte verlinkt.
image_opacitynumber (float)
Deckkraft des Hintergrundbildes, von 0 bis 1.
ui_presetstring
Layoutvorlage der Karte.
start_datestring (date-time)
Beginn des Anzeigezeitraums.
end_datestring (date-time)
Ende des Anzeigezeitraums.
dismissableboolean
Der Benutzer kann die Karte ausblenden.
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<AccessRightStorage10>
Zugriffsrechteliste, die die Sichtbarkeit steuert.
Felder anzeigen (12)
- idinteger
  Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.
- userUser53
  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
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
image_urlstring
URL des Bildes des Datensatzes.
ucatsarray<UnifiedCategory28>
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<UnifiedCategory28>
  Untergeordnete Kategorien.
- parentUnifiedCategory28
  Ü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
namestring
Name der Einheit.

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/card_button/42', 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/card_button/42"

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

response = requests.put(url, 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/card_button/42', [
  'headers' => [
    '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/card_button/42"),
  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/card_button/42")
  .put(null)
  .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/card_button/42"

	req, _ := http.NewRequest("PUT", 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_card_button_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_card_button.dart';

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

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

Antwort 200 application/json

{
  "id": 42,
  "icon_asset_name": "Beispiel",
  "icon_color": "#3f5efb",
  "text_color": "#3f5efb",
  "background_color": "#3f5efb",
  "link_url": "https://vynst.de",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "card_type": "string",
  "card_conditions": "string"
}

MediaCardButton aktualisieren

PATCH/api/media/card_button/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200MediaCardButton aktualisierenMediaCardButton2

Felder anzeigen (25)

idinteger
Primärschlüssel der Kartenschaltfläche. Interne ID.
card_typestring
Art der Karte, zum Beispiel eine Kachel auf dem Startbildschirm.
card_conditionsstring
Bedingungen, unter denen die Karte angezeigt wird, als Text.
tokenstring
Öffentlicher Token der Karte. Anstelle der ID verwendet.
language_codestring
Sprache der Karte, zum Beispiel de oder en.
icon_asset_namestring
Name des Symbols der Karte.
icon_packagestring
Symbolpaket, zu dem das Symbol gehört.
icon_colorstring
Farbe des Symbols.
text_colorstring
Farbe des Textes.
background_colorstring
Hintergrundfarbe der Karte.
link_actionstring
Aktion beim Antippen der Karte, zum Beispiel eine Seite öffnen.
link_urlstring
URL, auf die die Karte verlinkt.
image_opacitynumber (float)
Deckkraft des Hintergrundbildes, von 0 bis 1.
ui_presetstring
Layoutvorlage der Karte.
start_datestring (date-time)
Beginn des Anzeigezeitraums.
end_datestring (date-time)
Ende des Anzeigezeitraums.
dismissableboolean
Der Benutzer kann die Karte ausblenden.
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<AccessRightStorage10>
Zugriffsrechteliste, die die Sichtbarkeit steuert.
Felder anzeigen (12)
- idinteger
  Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.
- userUser53
  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
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
image_urlstring
URL des Bildes des Datensatzes.
ucatsarray<UnifiedCategory28>
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<UnifiedCategory28>
  Untergeordnete Kategorien.
- parentUnifiedCategory28
  Ü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
namestring
Name der Einheit.

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/card_button/42', 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/card_button/42"

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

response = requests.patch(url, 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/card_button/42', [
  'headers' => [
    '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/card_button/42"),
  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/card_button/42")
  .patch(null)
  .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/card_button/42"

	req, _ := http.NewRequest("PATCH", 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 package:http (kein Controller im Package iw_erp_api)

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

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

Antwort 200 application/json

{
  "id": 42,
  "icon_asset_name": "Beispiel",
  "icon_color": "#3f5efb",
  "text_color": "#3f5efb",
  "background_color": "#3f5efb",
  "link_url": "https://vynst.de",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "card_type": "string",
  "card_conditions": "string"
}

Löscht einen einzelnen MediaCardButton

DELETE/api/media/card_button/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Löscht einen einzelnen MediaCardButtonMediaCardButton

Felder anzeigen (22)

idinteger
Primärschlüssel der Kartenschaltfläche. Interne ID.
card_typestring
Art der Karte, zum Beispiel eine Kachel auf dem Startbildschirm.
card_conditionsstring
Bedingungen, unter denen die Karte angezeigt wird, als Text.
tokenstring
Öffentlicher Token der Karte. Anstelle der ID verwendet.
language_codestring
Sprache der Karte, zum Beispiel de oder en.
icon_asset_namestring
Name des Symbols der Karte.
icon_packagestring
Symbolpaket, zu dem das Symbol gehört.
icon_colorstring
Farbe des Symbols.
text_colorstring
Farbe des Textes.
background_colorstring
Hintergrundfarbe der Karte.
link_actionstring
Aktion beim Antippen der Karte, zum Beispiel eine Seite öffnen.
link_urlstring
URL, auf die die Karte verlinkt.
image_opacitynumber (float)
Deckkraft des Hintergrundbildes, von 0 bis 1.
ui_presetstring
Layoutvorlage der Karte.
start_datestring (date-time)
Beginn des Anzeigezeitraums.
end_datestring (date-time)
Ende des Anzeigezeitraums.
dismissableboolean
Der Benutzer kann die Karte ausblenden.
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
image_urlstring
URL des Bildes des Datensatzes.
namestring
Name der Einheit.

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/card_button/42', 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/card_button/42"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/card_button/42"),
  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/card_button/42")
  .delete(null)
  .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/card_button/42"

	req, _ := http.NewRequest("DELETE", 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_card_button_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 MediaCardButtonController.delete('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "icon_asset_name": "Beispiel",
  "icon_color": "#3f5efb",
  "text_color": "#3f5efb",
  "background_color": "#3f5efb",
  "link_url": "https://vynst.de",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "card_type": "string",
  "card_conditions": "string"
}