User

Benutzer / User

Diese Methode liefert ein einzelnes User-Objekt mit der angegebenen ID

GET/api/users/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Diese Methode liefert ein einzelnes User-Objekt mit der angegebenen IDUser

Felder anzeigen (11)

idinteger
Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.
namestring
Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.
usernamestring
Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.
emailstring
E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.
user_access_groupUserAccessGroup3
Benutzergruppe des Benutzers. Legt die Rechte des Benutzers für alle Scopes fest.
positioningeneralstring
Freitext zur Position oder Rolle des Benutzers.
crm_personCRMPerson10
CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- 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
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
profile_picture_urlstring
URL des Profilbilds des Benutzers.
archivedboolean
Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.
require2faboolean
Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.
search_stringstring
Text, unter dem die Entität gesucht werden kann.

Anfrage

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

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "username": "lena.hartmann@example.org",
  "email": "lena.hartmann@example.org",
  "profile_picture_url": "https://vynst.de",
  "positioningeneral": "string",
  "crm_person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "profile_picture_url": "https://vynst.de",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "archived": true,
  "require2fa": true,
  "search_string": "string"
}

Diese Methode aktualisiert ein User-Objekt

PUT/api/users/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

userUser2
Felder anzeigen (4)
- namestring
  Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.
- usernamestring
  Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.
- emailstring
  E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.
- user_access_groupUserAccessGroup3
  Benutzergruppe des Benutzers. Legt die Rechte des Benutzers für alle Scopes fest.

Antworten

200Diese Methode aktualisiert ein User-ObjektUser14

Felder anzeigen (10)

idinteger
Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.
namestring
Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.
usernamestring
Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.
emailstring
E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.
positioningeneralstring
Freitext zur Position oder Rolle des Benutzers.
crm_personCRMPerson10
CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- 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
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
profile_picture_urlstring
URL des Profilbilds des Benutzers.
archivedboolean
Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.
require2faboolean
Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.
search_stringstring
Text, unter dem die Entität gesucht werden kann.

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/users/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "user": {
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    user: {
      name: 'Beispiel',
      username: 'lena.hartmann@example.org',
      email: 'lena.hartmann@example.org'
    }
  })
};

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

payload = { "user": {
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org"
  } }
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/users/42', [
  'body' => '{"user":{"name":"Beispiel","username":"lena.hartmann@example.org","email":"lena.hartmann@example.org"}}',
  '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/users/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"user\":{\"name\":\"Beispiel\",\"username\":\"lena.hartmann@example.org\",\"email\":\"lena.hartmann@example.org\"}}")
  {
    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, "{\"user\":{\"name\":\"Beispiel\",\"username\":\"lena.hartmann@example.org\",\"email\":\"lena.hartmann@example.org\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/users/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/users/42"

	payload := strings.NewReader("{\"user\":{\"name\":\"Beispiel\",\"username\":\"lena.hartmann@example.org\",\"email\":\"lena.hartmann@example.org\"}}")

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

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

final result = await UserController.put(User.fromJson({
  "name": "Beispiel",
  "username": "lena.hartmann@example.org",
  "email": "lena.hartmann@example.org"
}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "username": "lena.hartmann@example.org",
  "email": "lena.hartmann@example.org",
  "profile_picture_url": "https://vynst.de",
  "positioningeneral": "string",
  "crm_person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "profile_picture_url": "https://vynst.de",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "archived": true,
  "require2fa": true,
  "search_string": "string"
}

Diese Methode liefert alle User-Objekte

GET/api/users

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

200Diese Methode liefert alle User-Objektearray<User14>

Felder anzeigen (10)

idinteger
Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.
namestring
Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.
usernamestring
Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.
emailstring
E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.
positioningeneralstring
Freitext zur Position oder Rolle des Benutzers.
crm_personCRMPerson10
CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- 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
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
profile_picture_urlstring
URL des Profilbilds des Benutzers.
archivedboolean
Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.
require2faboolean
Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.
search_stringstring
Text, unter dem die Entität gesucht werden kann.

Anfrage

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

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

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

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

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

Antwort 200 application/json

[
  {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  }
]

Diese Methode liefert das eigene User-Objekt

GET/api/user/profile

Antworten

200Diese Methode liefert das eigene User-ObjektUser14

Felder anzeigen (10)

idinteger
Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.
namestring
Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.
usernamestring
Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.
emailstring
E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.
positioningeneralstring
Freitext zur Position oder Rolle des Benutzers.
crm_personCRMPerson10
CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- 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
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
profile_picture_urlstring
URL des Profilbilds des Benutzers.
archivedboolean
Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.
require2faboolean
Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.
search_stringstring
Text, unter dem die Entität gesucht werden kann.

Anfrage

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

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

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

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

	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/user/profile'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "username": "lena.hartmann@example.org",
  "email": "lena.hartmann@example.org",
  "profile_picture_url": "https://vynst.de",
  "positioningeneral": "string",
  "crm_person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "profile_picture_url": "https://vynst.de",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "archived": true,
  "require2fa": true,
  "search_string": "string"
}