TrainerChatroom

Chat und Benachrichtigungen9 EndpunkteChat / TrainerChatroom

Gibt den Chatroom einer Veranstaltung als deren Trainer zurück.

GET/api/cp/chat/trainer/event/{eventIdentifier}

Pfad-Parameter

eventIdentifierPflichtstring

Antworten

200Chatraum der VeranstaltungChatroom

Felder anzeigen (12)

unread_countinteger
is_unreadboolean
member_managedboolean
Event- und freie Gruppenraeume verwalten Mitglieder bzw. Raum-Admins mit (verlassen, aufnehmen); Support-, Assistenten- und Fragebogen-Raeume nur die Verwaltung. Die Apps blenden danach die Raum-Optionen ein.
is_support_roomboolean
Ist das der Haushalts-Chat mit dem Verein (Support-Chat)? Die Kunden-Apps sehen die Firma nicht und zeigen damit den Hinweis auf die Buerozeiten (chatroom_support_office_hours_enabled).
idinteger
Primärschlüssel des Chatraums. Interne ID.
notification_tokenstring
Token für Benachrichtigungen des Chatraums.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nach außen nur lesbar; gesetzt wird sie ausschließlich vom ChatroomTrustLevelHelper.
member_started_typestring
Von Mitgliedern gestartet (Paket D): „direct“ (1:1, chatroom_member_direct_enabled) oder „group“ (Gruppe eines Trainers, chatroom_trainer_groups_enabled); null für alle anderen Räume.
handover_atstring (date-time)
Seit wann sich die KI aus dem Raum zurückgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und gelöscht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.

Anfrage

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

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "member_managed": true,
  "is_support_room": true,
  "notification_token": "string",
  "trust_level": "string",
  "member_started_type": "string"
}

Chatraum einer Veranstaltung als deren Trainer anlegen (oder zurückgeben)

POST/api/cp/chat/trainer/event/{eventIdentifier}

Erfordert trainerCanCreateChatroom am Veranstaltungsdatentyp, und der angemeldete Benutzer muss die durchführende Person der Veranstaltung sein.

Pfad-Parameter

eventIdentifierPflichtstring

Antworten

200Chatraum der VeranstaltungChatroom

Felder anzeigen (12)

unread_countinteger
is_unreadboolean
member_managedboolean
Event- und freie Gruppenraeume verwalten Mitglieder bzw. Raum-Admins mit (verlassen, aufnehmen); Support-, Assistenten- und Fragebogen-Raeume nur die Verwaltung. Die Apps blenden danach die Raum-Optionen ein.
is_support_roomboolean
Ist das der Haushalts-Chat mit dem Verein (Support-Chat)? Die Kunden-Apps sehen die Firma nicht und zeigen damit den Hinweis auf die Buerozeiten (chatroom_support_office_hours_enabled).
idinteger
Primärschlüssel des Chatraums. Interne ID.
notification_tokenstring
Token für Benachrichtigungen des Chatraums.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nach außen nur lesbar; gesetzt wird sie ausschließlich vom ChatroomTrustLevelHelper.
member_started_typestring
Von Mitgliedern gestartet (Paket D): „direct“ (1:1, chatroom_member_direct_enabled) oder „group“ (Gruppe eines Trainers, chatroom_trainer_groups_enabled); null für alle anderen Räume.
handover_atstring (date-time)
Seit wann sich die KI aus dem Raum zurückgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und gelöscht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/trainer/event/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

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

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

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/cp/chat/trainer/event/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.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/cp/chat/trainer/event/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/cp/chat/trainer/event/42")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/cp/chat/trainer/event/42"

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

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

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

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

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/trainer_chatroom_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 TrainerChatroomController.post('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "member_managed": true,
  "is_support_room": true,
  "notification_token": "string",
  "trust_level": "string",
  "member_started_type": "string"
}

Schreibzugriff für einen Teilnehmer eines moderierten Chatrooms erteilen oder entziehen

PUT/api/cp/chat/trainer/participant/{identifier}

Nur Raumadministratoren (die Trainer der Veranstaltung) und Backend-Chat-Administratoren dürfen dies aufrufen. Raumadministratoren behalten selbst ihren Schreibzugriff - ein Trainer kann einen Co-Trainer nicht stummschalten.

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

dataChatroomParticipant
Felder anzeigen (11)
- idinteger
  Primärschlüssel des Teilnehmers. Interne ID.
- participant_typestring
  Art des Teilnehmers.
- first_namestring
  Vorname des Teilnehmers.
- last_namestring
  Nachname des Teilnehmers.
- nicknamestring
  Spitzname der Teilnehmenden.
- preferred_color_hexstring
  Bevorzugte Farbe des Teilnehmers als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- room_adminboolean
  Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann
- can_writeboolean
  Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann
- namestring
  Name der Einheit.
- image_urlstring
  URL des Bildes des Datensatzes.

Antworten

200Der aktualisierte TeilnehmerChatroomParticipant

Felder anzeigen (11)

idinteger
Primärschlüssel des Teilnehmers. Interne ID.
participant_typestring
Art des Teilnehmers.
first_namestring
Vorname des Teilnehmers.
last_namestring
Nachname des Teilnehmers.
nicknamestring
Spitzname der Teilnehmenden.
preferred_color_hexstring
Bevorzugte Farbe des Teilnehmers als Hexwert.
avatar_tokenstring
Token des Avatarbildes.
room_adminboolean
Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann
can_writeboolean
Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/trainer/participant/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      first_name: 'Lena',
      last_name: 'Hartmann',
      name: 'Beispiel',
      image_url: 'https://vynst.de',
      participant_type: 'string'
    }
  })
};

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

payload = { "data": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string"
  } }
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/cp/chat/trainer/participant/42', [
  'body' => '{"data":{"id":42,"first_name":"Lena","last_name":"Hartmann","name":"Beispiel","image_url":"https://vynst.de","participant_type":"string"}}',
  '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/cp/chat/trainer/participant/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}")
  {
    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\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/cp/chat/trainer/participant/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/cp/chat/trainer/participant/42"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}")

	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/trainer_chatroom_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 TrainerChatroomController.putWriteAccess('42', true);
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "participant_type": "string",
  "nickname": "string",
  "preferred_color_hex": "string",
  "avatar_token": "string",
  "room_admin": true
}

Schreibzugriff für einen Teilnehmer eines moderierten Chatrooms erteilen oder entziehen

PATCH/api/cp/chat/trainer/participant/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

dataChatroomParticipant
Felder anzeigen (11)
- idinteger
  Primärschlüssel des Teilnehmers. Interne ID.
- participant_typestring
  Art des Teilnehmers.
- first_namestring
  Vorname des Teilnehmers.
- last_namestring
  Nachname des Teilnehmers.
- nicknamestring
  Spitzname der Teilnehmenden.
- preferred_color_hexstring
  Bevorzugte Farbe des Teilnehmers als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- room_adminboolean
  Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann
- can_writeboolean
  Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann
- namestring
  Name der Einheit.
- image_urlstring
  URL des Bildes des Datensatzes.

Antworten

200Der aktualisierte TeilnehmerChatroomParticipant

Felder anzeigen (11)

idinteger
Primärschlüssel des Teilnehmers. Interne ID.
participant_typestring
Art des Teilnehmers.
first_namestring
Vorname des Teilnehmers.
last_namestring
Nachname des Teilnehmers.
nicknamestring
Spitzname der Teilnehmenden.
preferred_color_hexstring
Bevorzugte Farbe des Teilnehmers als Hexwert.
avatar_tokenstring
Token des Avatarbildes.
room_adminboolean
Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann
can_writeboolean
Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.

Anfrage

curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/trainer/participant/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      first_name: 'Lena',
      last_name: 'Hartmann',
      name: 'Beispiel',
      image_url: 'https://vynst.de',
      participant_type: 'string'
    }
  })
};

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

payload = { "data": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string"
  } }
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/cp/chat/trainer/participant/42', [
  'body' => '{"data":{"id":42,"first_name":"Lena","last_name":"Hartmann","name":"Beispiel","image_url":"https://vynst.de","participant_type":"string"}}',
  '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/cp/chat/trainer/participant/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}")
  {
    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\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/cp/chat/trainer/participant/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/cp/chat/trainer/participant/42"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}")

	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/cp/chat/trainer/participant/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "name": "Beispiel",
      "image_url": "https://vynst.de",
      "participant_type": "string"
    }
  }),
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "participant_type": "string",
  "nickname": "string",
  "preferred_color_hex": "string",
  "avatar_token": "string",
  "room_admin": true
}

Einen Teilnehmer aus einem moderierten Chatraum entfernen.

DELETE/api/cp/chat/trainer/participant/{identifier}

Co-Trainer (Raumadmins) können nicht entfernt werden. Die Veranstaltungssynchronisation fügt die Person nicht erneut hinzu. Erfordert chatroom_room_admin_manage_members_enabled.

Pfad-Parameter

identifierPflichtstring

Antworten

200Entfernt

Anfrage

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

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

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

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/cp/chat/trainer/participant/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/cp/chat/trainer/participant/42")
  .delete(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/cp/chat/trainer/participant/42"

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

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

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

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

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/trainer_chatroom_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 TrainerChatroomController.removeParticipant('42');
if (result.success) {
  print(result.data);
}

Personen, die ein Raum-Administrator dem Chatraum (erneut) hinzufügen kann

GET/api/cp/chat/trainer/chatroom/{identifier}/candidates

Ehemalige Teilnehmer und bei einem Event-Chat Personen, die für das Event angemeldet sind und nicht im Raum sind. Benötigt chatroom_room_admin_manage_members_enabled.

Pfad-Parameter

identifierPflichtstring

Antworten

200Liste der Kandidatenarray<object>

Felder anzeigen (4)

person_idinteger
first_namestring
last_namestring
reasonstring
former | signed_up

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/trainer/chatroom/42/candidates \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://eure-instanz.iw-erp.de/api/cp/chat/trainer/chatroom/42/candidates', 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/cp/chat/trainer/chatroom/42/candidates"

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/cp/chat/trainer/chatroom/42/candidates', [
  '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/cp/chat/trainer/chatroom/42/candidates"),
  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/cp/chat/trainer/chatroom/42/candidates")
  .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/cp/chat/trainer/chatroom/42/candidates"

	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/trainer_chatroom_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 TrainerChatroomController.getCandidates('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "person_id": 42,
    "reason": "string"
  }
]

Eine Person zu einem moderierten Chatraum hinzufügen

POST/api/cp/chat/trainer/chatroom/{identifier}/participant

Nur ehemalige Teilnehmende und Personen, die für die Veranstaltung angemeldet sind, im Chatraum (siehe candidates). Erfordert chatroom_room_admin_manage_members_enabled.

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

person_idinteger

Antworten

200Der hinzugefügte TeilnehmerChatroomParticipant

Felder anzeigen (11)

idinteger
Primärschlüssel des Teilnehmers. Interne ID.
participant_typestring
Art des Teilnehmers.
first_namestring
Vorname des Teilnehmers.
last_namestring
Nachname des Teilnehmers.
nicknamestring
Spitzname der Teilnehmenden.
preferred_color_hexstring
Bevorzugte Farbe des Teilnehmers als Hexwert.
avatar_tokenstring
Token des Avatarbildes.
room_adminboolean
Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann
can_writeboolean
Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/trainer/chatroom/42/participant \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{"person_id":12}'

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

fetch('https://eure-instanz.iw-erp.de/api/cp/chat/trainer/chatroom/42/participant', 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/cp/chat/trainer/chatroom/42/participant"

payload = { "person_id": 12 }
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/cp/chat/trainer/chatroom/42/participant', [
  'body' => '{"person_id":12}',
  '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/cp/chat/trainer/chatroom/42/participant"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"person_id\":12}")
  {
    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, "{\"person_id\":12}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/cp/chat/trainer/chatroom/42/participant")
  .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/cp/chat/trainer/chatroom/42/participant"

	payload := strings.NewReader("{\"person_id\":12}")

	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/trainer_chatroom_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 TrainerChatroomController.addParticipant('42', 42);
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "participant_type": "string",
  "nickname": "string",
  "preferred_color_hex": "string",
  "avatar_token": "string",
  "room_admin": true
}

Einen moderierten Chatraum umbenennen.

PUT/api/cp/chat/trainer/chatroom/{identifier}

Erfordert chatroom_room_admin_manage_members_enabled.

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

namestring

Antworten

200Der umbenannte ChatraumChatroom

Felder anzeigen (12)

unread_countinteger
is_unreadboolean
member_managedboolean
Event- und freie Gruppenraeume verwalten Mitglieder bzw. Raum-Admins mit (verlassen, aufnehmen); Support-, Assistenten- und Fragebogen-Raeume nur die Verwaltung. Die Apps blenden danach die Raum-Optionen ein.
is_support_roomboolean
Ist das der Haushalts-Chat mit dem Verein (Support-Chat)? Die Kunden-Apps sehen die Firma nicht und zeigen damit den Hinweis auf die Buerozeiten (chatroom_support_office_hours_enabled).
idinteger
Primärschlüssel des Chatraums. Interne ID.
notification_tokenstring
Token für Benachrichtigungen des Chatraums.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nach außen nur lesbar; gesetzt wird sie ausschließlich vom ChatroomTrustLevelHelper.
member_started_typestring
Von Mitgliedern gestartet (Paket D): „direct“ (1:1, chatroom_member_direct_enabled) oder „group“ (Gruppe eines Trainers, chatroom_trainer_groups_enabled); null für alle anderen Räume.
handover_atstring (date-time)
Seit wann sich die KI aus dem Raum zurückgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und gelöscht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/trainer/chatroom/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "name": "U12 Training"
}
'

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

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

payload = { "name": "U12 Training" }
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/cp/chat/trainer/chatroom/42', [
  'body' => '{"name":"U12 Training"}',
  '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/cp/chat/trainer/chatroom/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"name\":\"U12 Training\"}")
  {
    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, "{\"name\":\"U12 Training\"}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/cp/chat/trainer/chatroom/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/cp/chat/trainer/chatroom/42"

	payload := strings.NewReader("{\"name\":\"U12 Training\"}")

	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/trainer_chatroom_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 TrainerChatroomController.rename('42', '…');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "member_managed": true,
  "is_support_room": true,
  "notification_token": "string",
  "trust_level": "string",
  "member_started_type": "string"
}

Einen moderierten Chatraum umbenennen.

PATCH/api/cp/chat/trainer/chatroom/{identifier}

Erfordert chatroom_room_admin_manage_members_enabled.

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

namestring

Antworten

200Der umbenannte ChatraumChatroom

Felder anzeigen (12)

unread_countinteger
is_unreadboolean
member_managedboolean
Event- und freie Gruppenraeume verwalten Mitglieder bzw. Raum-Admins mit (verlassen, aufnehmen); Support-, Assistenten- und Fragebogen-Raeume nur die Verwaltung. Die Apps blenden danach die Raum-Optionen ein.
is_support_roomboolean
Ist das der Haushalts-Chat mit dem Verein (Support-Chat)? Die Kunden-Apps sehen die Firma nicht und zeigen damit den Hinweis auf die Buerozeiten (chatroom_support_office_hours_enabled).
idinteger
Primärschlüssel des Chatraums. Interne ID.
notification_tokenstring
Token für Benachrichtigungen des Chatraums.
trust_levelstring
Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nach außen nur lesbar; gesetzt wird sie ausschließlich vom ChatroomTrustLevelHelper.
member_started_typestring
Von Mitgliedern gestartet (Paket D): „direct“ (1:1, chatroom_member_direct_enabled) oder „group“ (Gruppe eines Trainers, chatroom_trainer_groups_enabled); null für alle anderen Räume.
handover_atstring (date-time)
Seit wann sich die KI aus dem Raum zurückgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und gelöscht nur vom ChatbotHandoverHelper.
handover_reasonstring
Siehe HANDOVER_REASON_*.
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.

Anfrage

curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/cp/chat/trainer/chatroom/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "name": "U12 Training"
}
'

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

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

payload = { "name": "U12 Training" }
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/cp/chat/trainer/chatroom/42', [
  'body' => '{"name":"U12 Training"}',
  '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/cp/chat/trainer/chatroom/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"name\":\"U12 Training\"}")
  {
    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, "{\"name\":\"U12 Training\"}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/cp/chat/trainer/chatroom/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/cp/chat/trainer/chatroom/42"

	payload := strings.NewReader("{\"name\":\"U12 Training\"}")

	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/cp/chat/trainer/chatroom/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "name": "U12 Training"
  }),
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "unread_count": 1,
  "is_unread": true,
  "member_managed": true,
  "is_support_room": true,
  "notification_token": "string",
  "trust_level": "string",
  "member_started_type": "string"
}