Unified Categories

CRM / Vereinheitlichte Kategorien

CRM9 EndpunkteCRM / Unified Categories

Liefert eine Liste der einheitlichen Kategorien.

GET/api/crm/category/unified

Query-Parameter

`id`string	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`name`string	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`parent`string	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`categoryType`string	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`slugIdentifier`string	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`viewOrder`integer	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`isUiFilter`string	Diese Eigenschaft markiert eine Entität als Filter für das Frontend \| Benötigtes Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`deleted`boolean	Diese Eigenschaft markiert eine Entität als gelöscht / archiviert \| Benötigtes Zugriffsrecht: SCOPE \| Standardwert: false
`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 einheitlichen Kategorien.array<UnifiedCategory>

Felder anzeigen (32)

idinteger
Primärschlüssel der einheitlichen Kategorie. Interne ID.
category_typestring
Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.
childrenarray<UnifiedCategory>
Untergeordnete Kategorien.
parentUnifiedCategory
Ü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

Anfrage

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

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

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

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/crm/category/unified', [
  '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/crm/category/unified"),
  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/crm/category/unified")
  .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/crm/category/unified"

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

Antwort 200 application/json

[
  {
    "id": 42,
    "name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "image_url": "https://vynst.de"
  }
]

Einheitliche Kategorie neu anlegen

POST/api/crm/category/unified

Query-Parameter

create_access_tagboolean 1: außerdem einen Zugriffs-Tag mit dem Namen der Kategorie anlegen und verknüpfen (benötigt das Schreibrecht für Einstellungen)

Request-Body application/json

dataUnifiedCategory11
Felder anzeigen (21)
- 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
- 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

Antworten

200Einheitliche Kategorie neu anlegenUnifiedCategory

Felder anzeigen (32)

idinteger
Primärschlüssel der einheitlichen Kategorie. Interne ID.
category_typestring
Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.
childrenarray<UnifiedCategory>
Untergeordnete Kategorien.
parentUnifiedCategory
Ü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

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/crm/category/unified \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      address_street: 'Jakobistr. 39',
      address_city: 'Hannover',
      address_zip: '30163',
      address_country: 'DE',
      address_full_country: 'DE',
      main_phone: '+49 511 123456'
    }
  })
};

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

payload = { "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  } }
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/crm/category/unified', [
  'body' => '{"data":{"address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163","address_country":"DE","address_full_country":"DE","main_phone":"+49 511 123456"}}',
  '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/crm/category/unified"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")
  {
    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, "{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/crm/category/unified")
  .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/crm/category/unified"

	payload := strings.NewReader("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")

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

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

final result = await CrmUnifiedCategoryController.post(UnifiedCategory.fromJson({
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456"
}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "image_url": "https://vynst.de"
}

Liefert eine Liste der öffentlichen einheitlichen Kategorien.

GET/api/crm/public/category/unified

Query-Parameter

`id`string	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`name`string	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`parent`string	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`categoryType`string	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`slugIdentifier`string	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`viewOrder`integer	Erfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`isUiFilter`string	Diese Eigenschaft markiert eine Entität als Filter für das Frontend \| Benötigtes Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
`deleted`boolean	Diese Eigenschaft markiert eine Entität als gelöscht / archiviert \| Benötigtes Zugriffsrecht: SCOPE \| Standardwert: false
`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 öffentlichen einheitlichen Kategorien.array<UnifiedCategory3>

Felder anzeigen (3)

idinteger
Primärschlüssel der einheitlichen Kategorie. Interne ID.
category_typestring
Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.
namestring
Name der Einheit.

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/crm/public/category/unified', 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/crm/public/category/unified"

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/crm/public/category/unified', [
  '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/crm/public/category/unified"),
  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/crm/public/category/unified")
  .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/crm/public/category/unified"

	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/crm_unified_category_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 CrmUnifiedCategoryController.getAllPublic();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "name": "Beispiel",
    "category_type": "string"
  }
]

Gibt eine einzelne öffentliche einheitliche Kategorie mit der angegebenen ID zurück.

GET/api/crm/public/category/unified/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Gibt eine einzelne öffentliche einheitliche Kategorie mit der angegebenen ID zurück.UnifiedCategory

Felder anzeigen (32)

idinteger
Primärschlüssel der einheitlichen Kategorie. Interne ID.
category_typestring
Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.
childrenarray<UnifiedCategory>
Untergeordnete Kategorien.
parentUnifiedCategory
Ü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

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/public/category/unified/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/crm/public/category/unified/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/crm/public/category/unified/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/crm/public/category/unified/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/crm/public/category/unified/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/crm/public/category/unified/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/crm/public/category/unified/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 package:http (kein Controller im Package iw_erp_api)

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

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

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "image_url": "https://vynst.de"
}

Gibt eine einzelne einheitliche Kategorie mit der angegebenen ID zurück.

GET/api/crm/category/unified/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Gibt eine einzelne einheitliche Kategorie mit der angegebenen ID zurück.UnifiedCategory

Felder anzeigen (32)

idinteger
Primärschlüssel der einheitlichen Kategorie. Interne ID.
category_typestring
Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.
childrenarray<UnifiedCategory>
Untergeordnete Kategorien.
parentUnifiedCategory
Ü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

Anfrage

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

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "image_url": "https://vynst.de"
}

Vereinheitlichte Kategorie mit der angegebenen ID einzeln aktualisieren

PUT/api/crm/category/unified/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

dataUnifiedCategory11
Felder anzeigen (21)
- 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
- 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

Antworten

200Vereinheitlichte Kategorie mit der angegebenen ID einzeln aktualisierenUnifiedCategory

Felder anzeigen (32)

idinteger
Primärschlüssel der einheitlichen Kategorie. Interne ID.
category_typestring
Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.
childrenarray<UnifiedCategory>
Untergeordnete Kategorien.
parentUnifiedCategory
Ü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

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/crm/category/unified/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      address_street: 'Jakobistr. 39',
      address_city: 'Hannover',
      address_zip: '30163',
      address_country: 'DE',
      address_full_country: 'DE',
      main_phone: '+49 511 123456'
    }
  })
};

fetch('https://eure-instanz.iw-erp.de/api/crm/category/unified/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/crm/category/unified/42"

payload = { "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  } }
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/crm/category/unified/42', [
  'body' => '{"data":{"address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163","address_country":"DE","address_full_country":"DE","main_phone":"+49 511 123456"}}',
  '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/crm/category/unified/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")
  {
    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, "{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/crm/category/unified/42")
  .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/crm/category/unified/42"

	payload := strings.NewReader("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")

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

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

final result = await CrmUnifiedCategoryController.put(UnifiedCategory.fromJson({
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456"
}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "image_url": "https://vynst.de"
}

Vereinheitlichte Kategorie mit der angegebenen ID einzeln aktualisieren

PATCH/api/crm/category/unified/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

dataUnifiedCategory11
Felder anzeigen (21)
- 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
- 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

Antworten

200Vereinheitlichte Kategorie mit der angegebenen ID einzeln aktualisierenUnifiedCategory

Felder anzeigen (32)

idinteger
Primärschlüssel der einheitlichen Kategorie. Interne ID.
category_typestring
Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.
childrenarray<UnifiedCategory>
Untergeordnete Kategorien.
parentUnifiedCategory
Ü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

Anfrage

curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/crm/category/unified/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      address_street: 'Jakobistr. 39',
      address_city: 'Hannover',
      address_zip: '30163',
      address_country: 'DE',
      address_full_country: 'DE',
      main_phone: '+49 511 123456'
    }
  })
};

fetch('https://eure-instanz.iw-erp.de/api/crm/category/unified/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/crm/category/unified/42"

payload = { "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  } }
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/crm/category/unified/42', [
  'body' => '{"data":{"address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163","address_country":"DE","address_full_country":"DE","main_phone":"+49 511 123456"}}',
  '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/crm/category/unified/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")
  {
    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, "{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/crm/category/unified/42")
  .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/crm/category/unified/42"

	payload := strings.NewReader("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")

	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/crm/category/unified/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "main_phone": "+49 511 123456"
    }
  }),
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "image_url": "https://vynst.de"
}

Gibt eine einzelne Erweiterung der einheitlichen Kategorie mit der angegebenen ID der einheitlichen Kategorie zurück.

GET/api/crm/unified_category_extended/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Gibt eine einzelne Erweiterung der einheitlichen Kategorie mit der angegebenen ID der einheitlichen Kategorie zurück.UnifiedCategoryExtension

Felder anzeigen (4)

idinteger
Primärschlüssel der Kategorieerweiterung. Interne ID.
unified_categoryUnifiedCategory
Kategorie, zu der die Erweiterung gehört.
Felder anzeigen (32)
- idinteger
  Primärschlüssel der einheitlichen Kategorie. Interne ID.
- category_typestring
  Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.
- childrenarray<UnifiedCategory>
  Untergeordnete Kategorien.
- parentUnifiedCategory
  Ü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
trainer_person_list_accessboolean
Trainer dürfen die Personenliste der Kategorie einsehen.
trainer_can_post_socialboolean
Trainer dürfen im Social-Feed der Kategorie Beiträge veröffentlichen.

Anfrage

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

Antwort 200 application/json

{
  "id": 42,
  "unified_category": {
    "id": 42,
    "name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "image_url": "https://vynst.de"
  },
  "trainer_person_list_access": true,
  "trainer_can_post_social": true
}

Erweiterung der vereinheitlichten Kategorie mit der angegebenen ID einzeln aktualisieren

PUT/api/crm/unified_category_extended/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

dataUnifiedCategoryExtension2

Antworten

200Erweiterung der vereinheitlichten Kategorie mit der angegebenen ID einzeln aktualisierenUnifiedCategoryExtension

Felder anzeigen (4)

idinteger
Primärschlüssel der Kategorieerweiterung. Interne ID.
unified_categoryUnifiedCategory
Kategorie, zu der die Erweiterung gehört.
Felder anzeigen (32)
- idinteger
  Primärschlüssel der einheitlichen Kategorie. Interne ID.
- category_typestring
  Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.
- childrenarray<UnifiedCategory>
  Untergeordnete Kategorien.
- parentUnifiedCategory
  Ü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
trainer_person_list_accessboolean
Trainer dürfen die Personenliste der Kategorie einsehen.
trainer_can_post_socialboolean
Trainer dürfen im Social-Feed der Kategorie Beiträge veröffentlichen.

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/crm/unified_category_extended/42 \
  --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/crm/unified_category_extended/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/crm/unified_category_extended/42"

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

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

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

final result = await CrmUnifiedCategoryExtensionController.put('42', UnifiedCategoryExtension.fromJson({}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "unified_category": {
    "id": 42,
    "name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "image_url": "https://vynst.de"
  },
  "trainer_person_list_access": true,
  "trainer_can_post_social": true
}