NewsArticleType

Medien / NewsArticleType

Medien5 EndpunkteMedia / NewsArticleType

Diese Methode liefert alle MediaNewsArticleDataType-Objekte

GET/api/media/news_article_type

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 MediaNewsArticleDataType-Objekte.array<MediaNewsArticleDataType>

Felder anzeigen (10)

idstring
Kennung des Datentyps für News-Artikel. Zum Beispiel Nachricht oder Pressemitteilung.
namestring
Name des Nachrichtenartikel-Typs.
show_adminboolean
Den Typ in der Admin-App anzeigen.
show_customerboolean
Den Typ in der Kunden-App anzeigen.
menu_namestring
Name des Menüeintrags für den Typ.
show_admin_menuboolean
Den Typ im Admin-Menü anzeigen.
show_customer_menuboolean
Den Typ im Menü der Kunden-App anzeigen.
show_customer_descriptionboolean
steuert, ob die Kunden-Nachrichtenliste die Beschreibung unter der Überschrift anzeigt
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
orderinteger
Position des Datensatzes in der Reihenfolge.

Anfrage

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

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

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

Antwort 200 application/json

[
  {
    "id": "42",
    "name": "Beispiel",
    "menu_name": "Beispiel",
    "show_customer_description": true,
    "show_admin": true,
    "show_customer": true,
    "show_admin_menu": true,
    "show_customer_menu": true,
    "deleted": true,
    "order": 1
  }
]

MediaNewsArticleDataType neu anlegen

POST/api/media/news_article_type

Antworten

200MediaNewsArticleDataType neu anlegenMediaNewsArticleDataType

Felder anzeigen (10)

idstring
Kennung des Datentyps für News-Artikel. Zum Beispiel Nachricht oder Pressemitteilung.
namestring
Name des Nachrichtenartikel-Typs.
show_adminboolean
Den Typ in der Admin-App anzeigen.
show_customerboolean
Den Typ in der Kunden-App anzeigen.
menu_namestring
Name des Menüeintrags für den Typ.
show_admin_menuboolean
Den Typ im Admin-Menü anzeigen.
show_customer_menuboolean
Den Typ im Menü der Kunden-App anzeigen.
show_customer_descriptionboolean
steuert, ob die Kunden-Nachrichtenliste die Beschreibung unter der Überschrift anzeigt
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
orderinteger
Position des Datensatzes in der Reihenfolge.

Anfrage

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

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

	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_news_article_type_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_news_article_type.dart';

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

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

Antwort 200 application/json

{
  "id": "42",
  "name": "Beispiel",
  "menu_name": "Beispiel",
  "show_customer_description": true,
  "show_admin": true,
  "show_customer": true,
  "show_admin_menu": true,
  "show_customer_menu": true,
  "deleted": true,
  "order": 1
}

Diese Methode liefert einen einzelnen MediaNewsArticleDataType mit der angegebenen ID

GET/api/media/news_article_type/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes MediaNewsArticleDataType-Objekt.MediaNewsArticleDataType

Felder anzeigen (10)

idstring
Kennung des Datentyps für News-Artikel. Zum Beispiel Nachricht oder Pressemitteilung.
namestring
Name des Nachrichtenartikel-Typs.
show_adminboolean
Den Typ in der Admin-App anzeigen.
show_customerboolean
Den Typ in der Kunden-App anzeigen.
menu_namestring
Name des Menüeintrags für den Typ.
show_admin_menuboolean
Den Typ im Admin-Menü anzeigen.
show_customer_menuboolean
Den Typ im Menü der Kunden-App anzeigen.
show_customer_descriptionboolean
steuert, ob die Kunden-Nachrichtenliste die Beschreibung unter der Überschrift anzeigt
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
orderinteger
Position des Datensatzes in der Reihenfolge.

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/media/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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_news_article_type_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 MediaNewsArticleTypeController.get('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": "42",
  "name": "Beispiel",
  "menu_name": "Beispiel",
  "show_customer_description": true,
  "show_admin": true,
  "show_customer": true,
  "show_admin_menu": true,
  "show_customer_menu": true,
  "deleted": true,
  "order": 1
}

MediaNewsArticleDataType aktualisieren

PUT/api/media/news_article_type/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200MediaNewsArticleDataType aktualisierenMediaNewsArticleDataType

Felder anzeigen (10)

idstring
Kennung des Datentyps für News-Artikel. Zum Beispiel Nachricht oder Pressemitteilung.
namestring
Name des Nachrichtenartikel-Typs.
show_adminboolean
Den Typ in der Admin-App anzeigen.
show_customerboolean
Den Typ in der Kunden-App anzeigen.
menu_namestring
Name des Menüeintrags für den Typ.
show_admin_menuboolean
Den Typ im Admin-Menü anzeigen.
show_customer_menuboolean
Den Typ im Menü der Kunden-App anzeigen.
show_customer_descriptionboolean
steuert, ob die Kunden-Nachrichtenliste die Beschreibung unter der Überschrift anzeigt
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
orderinteger
Position des Datensatzes in der Reihenfolge.

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/media/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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_news_article_type_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_news_article_type.dart';

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

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

Antwort 200 application/json

{
  "id": "42",
  "name": "Beispiel",
  "menu_name": "Beispiel",
  "show_customer_description": true,
  "show_admin": true,
  "show_customer": true,
  "show_admin_menu": true,
  "show_customer_menu": true,
  "deleted": true,
  "order": 1
}

MediaNewsArticleDataType aktualisieren

PATCH/api/media/news_article_type/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200MediaNewsArticleDataType aktualisierenMediaNewsArticleDataType

Felder anzeigen (10)

idstring
Kennung des Datentyps für News-Artikel. Zum Beispiel Nachricht oder Pressemitteilung.
namestring
Name des Nachrichtenartikel-Typs.
show_adminboolean
Den Typ in der Admin-App anzeigen.
show_customerboolean
Den Typ in der Kunden-App anzeigen.
menu_namestring
Name des Menüeintrags für den Typ.
show_admin_menuboolean
Den Typ im Admin-Menü anzeigen.
show_customer_menuboolean
Den Typ im Menü der Kunden-App anzeigen.
show_customer_descriptionboolean
steuert, ob die Kunden-Nachrichtenliste die Beschreibung unter der Überschrift anzeigt
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
orderinteger
Position des Datensatzes in der Reihenfolge.

Anfrage

curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/media/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/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/news_article_type/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Antwort 200 application/json

{
  "id": "42",
  "name": "Beispiel",
  "menu_name": "Beispiel",
  "show_customer_description": true,
  "show_admin": true,
  "show_customer": true,
  "show_admin_menu": true,
  "show_customer_menu": true,
  "deleted": true,
  "order": 1
}