MediaQuestionnaire

Medien / MediaQuestionnaire

Medien7 EndpunkteMedia / MediaQuestionnaire

Diese Methode liefert alle MediaQuestionnaire

GET/api/media/questionnaire

Query-Parameter

`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der MediaQuestionnaire-Objekte.array<MediaQuestionnaire>

Felder anzeigen (34)

idinteger
Primärschlüssel des Fragebogens. Interne ID.
questionnaire_typestring
Art des Fragebogens, zum Beispiel Anmeldung oder Umfrage.
tokenstring
Öffentlicher Token des Fragebogens. Anstelle der ID verwendet.
public_copyrightstring
Urheberrechtstext, der mit dem Fragebogen angezeigt wird.
public_language_codestring
Sprache des Fragebogens, zum Beispiel de.
complexity_levelinteger
Komplexitätsstufe des Fragebogens.
public_authorstring
Öffentlich angezeigter Autor.
show_free_textboolean
Ein Freitextfeld anzeigen.
show_attachmentboolean
Ein Upload-Feld für Anhänge anzeigen.
require_attachmentboolean
Ein Anhang muss hochgeladen werden.
with_paginationboolean
Den Fragebogen seitenweise anzeigen.
one_entry_per_personboolean
Wenn true, ist nur ein Eintrag pro Person erlaubt - nur für angemeldete Benutzer und Tabellenergebnisse
require_addressboolean
Die Adresse muss eingegeben werden.
require_contactboolean
Kontaktdaten müssen eingegeben werden.
require_ageboolean
Das Alter muss eingegeben werden.
require_grade_levelboolean
Die Schulklassenstufe muss eingegeben werden.
start_timestring (date-time)
Beginn der Verfügbarkeit des Fragebogens.
end_timestring (date-time)
Ende der Verfügbarkeit des Fragebogens.
age_groupstring
Altersgruppe, für die der Fragebogen gedacht ist.
min_ageinteger
Mindestalter in Jahren.
max_ageinteger
Maximales Alter in Jahren.
min_grade_levelinteger
Mindestschulstufe.
max_grade_levelinteger
Maximale Klassenstufe.
age_toleranceinteger
Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.
group_allowedboolean
Ob der Fragebogen auf eine Gruppe beschränkt ist.
allow_self_registerboolean
Ob sich Personen selbst für die Beantwortung des Fragebogens registrieren können.
allow_self_download_result_templateboolean
Ob Antwortende ihr eigenes Ergebnis herunterladen können.
clarification_enabledboolean
Zweite Schleife nach dem KI-Vergleich: Antworten, die die KI nicht als erfüllt bewertet, werden zu Klärungspunkten (MediaQuestionnaireClarification), die mit dem Kunden besprochen und entschieden werden, bevor die Ergebnisvorlage angelegt wird. Ohne sie folgt die Ergebnisvorlage direkt dem KI-Vergleich.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
image_urlstring
URL des Bildes des Datensatzes.
namestring
Name der Einheit.
slug_identifierstring
Slug, der in URLs der Entität verwendet wird.

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/questionnaire', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/questionnaire"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/questionnaire"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/questionnaire")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/questionnaire"

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

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

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

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

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/media_questionnaire_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 MediaQuestionnaireController.getAll();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "show_free_text": true,
    "image_url": "https://vynst.de",
    "name": "Beispiel",
    "questionnaire_type": "string",
    "token": "string",
    "public_copyright": "string",
    "public_language_code": "string",
    "complexity_level": 1,
    "public_author": "string"
  }
]

MediaQuestionnaire neu anlegen

POST/api/media/questionnaire

Antworten

200MediaQuestionnaire neu anlegenMediaQuestionnaire2

Felder anzeigen (43)

idinteger
Primärschlüssel des Fragebogens. Interne ID.
questionnaire_typestring
Art des Fragebogens, zum Beispiel Anmeldung oder Umfrage.
tokenstring
Öffentlicher Token des Fragebogens. Anstelle der ID verwendet.
public_copyrightstring
Urheberrechtstext, der mit dem Fragebogen angezeigt wird.
public_language_codestring
Sprache des Fragebogens, zum Beispiel de.
complexity_levelinteger
Komplexitätsstufe des Fragebogens.
public_authorstring
Öffentlich angezeigter Autor.
show_free_textboolean
Ein Freitextfeld anzeigen.
show_attachmentboolean
Ein Upload-Feld für Anhänge anzeigen.
require_attachmentboolean
Ein Anhang muss hochgeladen werden.
with_paginationboolean
Den Fragebogen seitenweise anzeigen.
one_entry_per_personboolean
Wenn true, ist nur ein Eintrag pro Person erlaubt - nur für angemeldete Benutzer und Tabellenergebnisse
require_addressboolean
Die Adresse muss eingegeben werden.
require_contactboolean
Kontaktdaten müssen eingegeben werden.
require_ageboolean
Das Alter muss eingegeben werden.
require_grade_levelboolean
Die Schulklassenstufe muss eingegeben werden.
start_timestring (date-time)
Beginn der Verfügbarkeit des Fragebogens.
end_timestring (date-time)
Ende der Verfügbarkeit des Fragebogens.
pagesarray<MediaQuestionnairePage>
Seiten des Fragebogens.
Felder anzeigen (12)
- idinteger
  Primärschlüssel der Fragebogenseite. Interne ID.
- page_numberinteger
  Nummer der Seite innerhalb des Fragebogens.
- page_progress_statusstring
  Fortschrittsstatus, der für die Seite angezeigt wird.
- answer_requiredboolean
  Wenn true, ist mindestens eine Antwort erforderlich
- previous_answer_requiredboolean
  Wenn true, wird die Seite nur angezeigt, wenn die vorherige Frage beantwortet wurde
- previous_answer_referencestring
  Verweis auf den vorherigen Antwortinhalt
- content_hintstring
  Hinweistext, der auf der Seite angezeigt wird.
- submenu_titlestring
  Titel des Untermenüeintrags für die Seite.
- 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.
- image_urlstring
  URL des Bildes des Datensatzes.
entriesarray<MediaQuestionnaireContent>
Fragen und Inhalte des Fragebogens.
Felder anzeigen (17)
- idinteger
  Primärschlüssel des Fragebogen-Inhalts. Interne ID.
- contentstring
  Frage oder Text des Inhalts.
- content_keystring
  Stabiler Schlüssel der Frage: ändert sich nach dem Setzen nie (Text, Typ und Position dürfen sich ändern), eindeutig innerhalb des Fragebogens und übernommen nach MediaQuestionnaireContentAnswer::$contentKey. Wird von MediaQuestionnaireContentKeyListener befüllt.
- content_hintstring
  Hinweis zur Antwort.
- content_filterstring
  Filter des Inhalts, zum Beispiel welche Antworten erlaubt sind.
- public_titlestring
  Titel des Inhalts, der öffentlich angezeigt wird.
- answerstring
  Gegebene Antwort
- answer_liststring
  Antwortliste für Dropdowns oder Optionsfelder. Durch Zeilenumbruch getrennt. Innere Werte werden durch | getrennt, um Wert und Bezeichnung zu trennen
- answer_requiredboolean
  Wenn true, ist die Antwort erforderlich
- previous_answer_requiredboolean
  Wenn true, wird die Frage nur angezeigt, wenn die vorherige Frage beantwortet wurde
- previous_answer_referencestring
  Verweis auf den vorherigen Antwortinhalt
- answer_in_titleboolean
  Wenn true, wird die Antwort dem Titel hinzugefügt
- answer_in_tableboolean
  Wenn true, wird die Antwort der Ergebnistabelle hinzugefügt (falls verfügbar)
- page_numberinteger
  Seite des Fragebogens, auf der sich der Inhalt befindet.
- content_typestring
  Art des Inhalts, zum Beispiel Text, Auswahl oder Upload.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
notification_emailstring
Empfänger der Management-Benachrichtigungs-E-Mail, die bei jeder neuen Antwort gesendet wird. Mehrere Adressen können kommagetrennt angegeben werden (z. B. "a@x.de, b@y.de").
notification_textstring
Kurztext der Benachrichtigung, die nach der Antwort versendet wird.
notification_long_textstring
Langtext der Benachrichtigung, die nach der Beantwortung gesendet wird.
age_groupstring
Altersgruppe, für die der Fragebogen gedacht ist.
min_ageinteger
Mindestalter in Jahren.
max_ageinteger
Maximales Alter in Jahren.
min_grade_levelinteger
Mindestschulstufe.
max_grade_levelinteger
Maximale Klassenstufe.
age_toleranceinteger
Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.
eventsarray<BaseEvent24>
Events, zu denen der Fragebogen gehört.
Felder anzeigen (81)
- ticketSeatingPlanIdinteger
  ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primärschlüssel der Veranstaltung. Interne ID.
- tokenstring
  Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
- moments_modestring
  Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
- moments_designstring
  Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
- public_keywordsstring
  Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
- public_subtitlestring
  Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
- event_typestring
  Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
- age_groupstring
  Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
- min_ageinteger
  Mindestalter der Teilnehmenden in Jahren.
- max_ageinteger
  Maximales Alter der Teilnehmer in Jahren.
- min_age_monthsinteger
  Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
- max_age_monthsinteger
  Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
- min_grade_levelinteger
  Mindestschulstufe der Teilnehmenden.
- max_grade_levelinteger
  Maximale Klassenstufe der Teilnehmer.
- age_toleranceinteger
  Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
- event_people_limitinteger
  maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
- event_people_min_limitinteger
  minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
- hide_event_people_limitboolean
  eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
- event_people_recovered_vaccinated_limitinteger
  Maximale Anzahl genesener oder geimpfter Teilnehmer.
- event_people_not_recovered_vaccinated_limitinteger
  Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
- has_wait_listboolean
  Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
- wait_list_confirmation_requiredboolean
  Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
- trial_enabledboolean
  Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
- can_sign_up_for_main_eventboolean
  Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
- only_sign_up_for_main_eventboolean
  Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
- sign_up_limit_days_beforeinteger
  Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
- sign_up_limit_stop_days_beforeinteger
  Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
- sign_up_delete_hours_beforeinteger
  Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
- start_timestring (date-time)
  Beginn der Veranstaltung.
- end_timestring (date-time)
  Ende der Veranstaltung.
- require_addressboolean
  Teilnehmende müssen bei der Anmeldung eine Adresse angeben.
- require_contactboolean
  Teilnehmende müssen bei der Anmeldung Kontaktdaten angeben.
- require_billingboolean
  Teilnehmende müssen bei der Anmeldung Rechnungsdaten angeben.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Teilnehmende müssen bei der Anmeldung ihr Alter angeben.
- require_grade_levelboolean
  Teilnehmende müssen bei der Anmeldung ihre Schulstufe angeben.
- require_free_note_field_idsstring
  IDs der Freitext-Notizfelder, die Teilnehmer ausfüllen müssen.
- generate_new_bookingsboolean
  Buchungen werden für den Veranstaltungsplan automatisch erzeugt.
- generate_new_bookings_v2boolean
  Buchungen werden mit der zweiten Version des Plan-Generators erzeugt.
- generate_ignore_sys_calendarboolean
  Erzeugte Buchungen ignorieren die Feiertage des Systemkalenders.
- copy_main_sign_ups_to_bookingboolean
  Anmeldungen der Hauptveranstaltung werden in die erzeugten Buchungen kopiert.
- generate_hour_startstring (date-time)
  Startzeit des Tages für erzeugte Buchungen.
- generate_hour_endstring (date-time)
  Endzeit des Tages für generierte Buchungen.
- generate_day_of_weekinteger
  Wochentag für erzeugte Buchungen.
- bitmask_days_of_weekinteger
  Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet
- bitmask_hours_startinteger
  Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt
- summarized_date_timesstring
  Zeichenkette mit den Wochentagen und Stunden, zu denen eine Veranstaltung beginnt
- media_questionnaireMediaQuestionnaire2
  Fragebogen der Veranstaltung im Medienmodul.
- customer_detail_ctastring
  In der Kunden-App auf der Veranstaltungsdetailseite angezeigter Call-to-Action-Text.
- customer_badgestring
  Badge-Text, der in der Kunden-App bei der Veranstaltung angezeigt wird.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live-Zeitnahme-Ergebnisse sind öffentlich.
- timing_gps_trackingboolean
  GPS-Tracking der Teilnehmer ist für die Zeitmessung aktiviert.
- timing_self_check_inboolean
  Teilnehmende können sich für die Zeitmessung selbst einchecken.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) für die Veranstaltung; die Einträge sind EventScoreboardActivity, aus denen der Spielstand berechnet wird.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die möglichen Einträge.
- scoreboard_home_namestring
  Name des Heimteams auf der Anzeigetafel.
- scoreboard_away_namestring
  Name des Gastteams auf der Anzeigetafel.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- 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.
- … 20 weitere Felder
ai_chat_promptstring
Der Systemprompt für den KI-Bot. Der Prompt wird um den MediaQuestionnaireContent in entries ergänzt, damit die KI den Kontext kennt, zu welchen Fragen am Ende des Chats Antworten gewünscht sind. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_chat_optimizer_promptstring
Der Systemprompt für den KI-Bot. Der Prompt wird verwendet, um den Chat-Prompt mit dem vorhandenen Kontext zu optimieren. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_chat_auto_close_secret_wordstring
Ein Wort als letzter Teil einer KI-Chatantwort, das den Chat beendet und den Abschluss des Fragebogens auslöst. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_chat_completed_promptstring
Der Systemprompt für den KI-Bot, der alle Chatnachrichten und den MediaQuestionnaireContent in entries verarbeitet, um auf jede der Fragen eine Antwort zu erzeugen. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_answer_summary_promptstring
Der Systemprompt für den KI-Bot, der die Antwort auf jede Frage verarbeitet und eine Zusammenfassung bzw. einen Wiki-Artikel der Antworten erzeugt. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
required_previous_questionnaireMediaQuestionnaire2
Fragebogen, der zuerst beantwortet werden muss.
group_allowedboolean
Ob der Fragebogen auf eine Gruppe beschränkt ist.
allow_self_registerboolean
Ob sich Personen selbst für die Beantwortung des Fragebogens registrieren können.
result_templateFlexibleLatexTemplate
Vorlage zur Darstellung des Ergebnisses des Fragebogens.
Felder anzeigen (35)
- predefinedboolean
  Wahr für Vorlagen, die mit dem servercontrolpanel ausgeliefert werden (PredefinedFlexibleTemplateMap). Ihre IDs werden im Code referenziert, daher bietet die Oberfläche an, sie zu duplizieren ("Vorlage anpassen"), statt sie zu bearbeiten.
- data_typestring
  Datentyp (Referenzklassenschlüssel), mit dem die Vorlage gerendert und geprüft wird. Für vordefinierte Vorlagen (Tag IW_PFLT) ist dies der Datentyp des Codes, der sie verwendet.
- data_type_labelstring
  Menschlich lesbare Bezeichnung des zugewiesenen Datentyps, null bei Tags, die keinem bekannten Datentyp entsprechen.
- template_modestring
  Serialisierter Modus, damit Clients nicht wissen müssen, dass null Standard bedeutet.
- last_check_statusstring
  Zusammenfassung der letzten Vorlagenprüfung für Listenansichten; das vollständige Ergebnis ist nur in der Admin-Detailansicht verfügbar.
- idstring
  Primärschlüssel der Vorlage. Interne ID. Wird als String-Kennung verwendet.
- namestring
  Name der Vorlage.
- tagstring
  Tag, mit dem Vorlagen gruppiert werden.
- mass_messageboolean
  Ob die Vorlage für Massennachrichten verwendet wird.
- default_store_as_pdfboolean
  Ob das erzeugte Dokument standardmäßig als PDF gespeichert wird.
- security_scopestring
  Scope, der steuert, wer die Vorlage verwenden kann.
- security_user_access_typeinteger
  Für die Verwendung der Vorlage erforderlicher Zugriffstyp.
- param1string
  In der Vorlage verwendeter Wert von Parameter 1.
- param2string
  In der Vorlage verwendeter Wert von Parameter 2.
- param3string
  In der Vorlage verwendeter Wert von Parameter 3.
- param4string
  In der Vorlage verwendeter Wert von Parameter 4.
- param5string
  In der Vorlage verwendeter Wert von Parameter 5.
- param6string
  In der Vorlage verwendeter Wert von Parameter 6.
- param7string
  In der Vorlage verwendeter Wert von Parameter 7.
- param8string
  In der Vorlage verwendeter Wert von Parameter 8.
- param9string
  In der Vorlage verwendeter Wert von Parameter 9.
- param10string
  In der Vorlage verwendeter Wert von Parameter 10.
- default_value_param1string
  Standardwert von Parameter 1.
- default_value_param2string
  Standardwert von Parameter 2.
- default_value_param3string
  Standardwert von Parameter 3.
- default_value_param4string
  Standardwert von Parameter 4.
- default_value_param5string
  Standardwert von Parameter 5.
- default_value_param6string
  Standardwert von Parameter 6.
- default_value_param7string
  Standardwert von Parameter 7.
- default_value_param8string
  Standardwert von Parameter 8.
- default_value_param9string
  Standardwert von Parameter 9.
- default_value_param10string
  Standardwert von Parameter 10.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
auto_send_result_templateboolean
Ob das Ergebnis nach der Beantwortung automatisch gesendet wird.
allow_self_download_result_templateboolean
Ob Antwortende ihr eigenes Ergebnis herunterladen können.
answer_productPredefinedBillingItem14
Produkt für die Abrechnung individueller Fragebogenantworten
Felder anzeigen (15)
- idinteger
  Primärschlüssel der zugeordneten Abrechnungsposition. Interne ID.
- namestringPflicht
  Name der Abrechnungsposition.
- descriptionstringPflicht
  Beschreibung des Abrechnungspostens, die dem Kunden angezeigt wird.
- internal_descriptionstring
  Interne Beschreibung der Abrechnungsposition, wird dem Kunden nicht angezeigt.
- fixed_hoursnumber (float)
  Feste Anzahl abgerechneter Stunden.
- fixed_pricenumber (float)
  Fester abgerechneter Preis.
- fixed_price_base_unitnumber (float)
  Basiseinheit für den Festpreis.
- price_fixed_hoursnumber (float)
  Preis für die Pauschalstunden.
- price_additional_hoursnumber (float)
  Preis für jede weitere Stunde.
- name_additional_hoursstring
  Name des Zusatzstunden-Postens.
- description_additional_hoursstring
  Beschreibung des Zusatzstundenpostens.
- time_billed_on_ticket_closeboolean
  Ob die Zeit beim Schließen des Tickets abgerechnet wird.
- billing_typeBillingItemType
  Typ der Abrechnungsposition.
- buying_pricenumber (float)
  Einkaufspreis der Position.
- … 73 weitere Felder
… 15 weitere Felder

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/questionnaire', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/questionnaire"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/questionnaire"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/questionnaire")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/questionnaire"

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

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

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

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

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/media_questionnaire_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_questionnaire.dart';

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

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

Antwort 200 application/json

{
  "id": 42,
  "show_free_text": true,
  "notification_email": "lena.hartmann@example.org",
  "notification_text": "Text",
  "notification_long_text": "Text",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "questionnaire_type": "string",
  "token": "string",
  "public_copyright": "string"
}

Diese Methode liefert ein einzelnes MediaQuestionnaire mit der angegebenen ID oder dem Token

GET/api/media/questionnaire/{identifier}

Pfad-Parameter

identifierPflichtstring

Query-Parameter

draftTokenstring Token (angemeldet: ID oder Token) einer eigenen Entwurfsantwort für diesen Fragebogen - gewährt Leserecht auch ohne Zugriffs-Tags

Antworten

200Liefert ein einzelnes MediaQuestionnaire-Objekt.MediaQuestionnaire

Felder anzeigen (34)

idinteger
Primärschlüssel des Fragebogens. Interne ID.
questionnaire_typestring
Art des Fragebogens, zum Beispiel Anmeldung oder Umfrage.
tokenstring
Öffentlicher Token des Fragebogens. Anstelle der ID verwendet.
public_copyrightstring
Urheberrechtstext, der mit dem Fragebogen angezeigt wird.
public_language_codestring
Sprache des Fragebogens, zum Beispiel de.
complexity_levelinteger
Komplexitätsstufe des Fragebogens.
public_authorstring
Öffentlich angezeigter Autor.
show_free_textboolean
Ein Freitextfeld anzeigen.
show_attachmentboolean
Ein Upload-Feld für Anhänge anzeigen.
require_attachmentboolean
Ein Anhang muss hochgeladen werden.
with_paginationboolean
Den Fragebogen seitenweise anzeigen.
one_entry_per_personboolean
Wenn true, ist nur ein Eintrag pro Person erlaubt - nur für angemeldete Benutzer und Tabellenergebnisse
require_addressboolean
Die Adresse muss eingegeben werden.
require_contactboolean
Kontaktdaten müssen eingegeben werden.
require_ageboolean
Das Alter muss eingegeben werden.
require_grade_levelboolean
Die Schulklassenstufe muss eingegeben werden.
start_timestring (date-time)
Beginn der Verfügbarkeit des Fragebogens.
end_timestring (date-time)
Ende der Verfügbarkeit des Fragebogens.
age_groupstring
Altersgruppe, für die der Fragebogen gedacht ist.
min_ageinteger
Mindestalter in Jahren.
max_ageinteger
Maximales Alter in Jahren.
min_grade_levelinteger
Mindestschulstufe.
max_grade_levelinteger
Maximale Klassenstufe.
age_toleranceinteger
Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.
group_allowedboolean
Ob der Fragebogen auf eine Gruppe beschränkt ist.
allow_self_registerboolean
Ob sich Personen selbst für die Beantwortung des Fragebogens registrieren können.
allow_self_download_result_templateboolean
Ob Antwortende ihr eigenes Ergebnis herunterladen können.
clarification_enabledboolean
Zweite Schleife nach dem KI-Vergleich: Antworten, die die KI nicht als erfüllt bewertet, werden zu Klärungspunkten (MediaQuestionnaireClarification), die mit dem Kunden besprochen und entschieden werden, bevor die Ergebnisvorlage angelegt wird. Ohne sie folgt die Ergebnisvorlage direkt dem KI-Vergleich.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
image_urlstring
URL des Bildes des Datensatzes.
namestring
Name der Einheit.
slug_identifierstring
Slug, der in URLs der Entität verwendet wird.

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/questionnaire/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/questionnaire/42"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/questionnaire/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/questionnaire/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/questionnaire/42"

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

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

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

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

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

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

Antwort 200 application/json

{
  "id": 42,
  "show_free_text": true,
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "questionnaire_type": "string",
  "token": "string",
  "public_copyright": "string",
  "public_language_code": "string",
  "complexity_level": 1,
  "public_author": "string"
}

MediaQuestionnaire aktualisieren

PUT/api/media/questionnaire/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200MediaQuestionnaire aktualisierenMediaQuestionnaire2

Felder anzeigen (43)

idinteger
Primärschlüssel des Fragebogens. Interne ID.
questionnaire_typestring
Art des Fragebogens, zum Beispiel Anmeldung oder Umfrage.
tokenstring
Öffentlicher Token des Fragebogens. Anstelle der ID verwendet.
public_copyrightstring
Urheberrechtstext, der mit dem Fragebogen angezeigt wird.
public_language_codestring
Sprache des Fragebogens, zum Beispiel de.
complexity_levelinteger
Komplexitätsstufe des Fragebogens.
public_authorstring
Öffentlich angezeigter Autor.
show_free_textboolean
Ein Freitextfeld anzeigen.
show_attachmentboolean
Ein Upload-Feld für Anhänge anzeigen.
require_attachmentboolean
Ein Anhang muss hochgeladen werden.
with_paginationboolean
Den Fragebogen seitenweise anzeigen.
one_entry_per_personboolean
Wenn true, ist nur ein Eintrag pro Person erlaubt - nur für angemeldete Benutzer und Tabellenergebnisse
require_addressboolean
Die Adresse muss eingegeben werden.
require_contactboolean
Kontaktdaten müssen eingegeben werden.
require_ageboolean
Das Alter muss eingegeben werden.
require_grade_levelboolean
Die Schulklassenstufe muss eingegeben werden.
start_timestring (date-time)
Beginn der Verfügbarkeit des Fragebogens.
end_timestring (date-time)
Ende der Verfügbarkeit des Fragebogens.
pagesarray<MediaQuestionnairePage>
Seiten des Fragebogens.
Felder anzeigen (12)
- idinteger
  Primärschlüssel der Fragebogenseite. Interne ID.
- page_numberinteger
  Nummer der Seite innerhalb des Fragebogens.
- page_progress_statusstring
  Fortschrittsstatus, der für die Seite angezeigt wird.
- answer_requiredboolean
  Wenn true, ist mindestens eine Antwort erforderlich
- previous_answer_requiredboolean
  Wenn true, wird die Seite nur angezeigt, wenn die vorherige Frage beantwortet wurde
- previous_answer_referencestring
  Verweis auf den vorherigen Antwortinhalt
- content_hintstring
  Hinweistext, der auf der Seite angezeigt wird.
- submenu_titlestring
  Titel des Untermenüeintrags für die Seite.
- 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.
- image_urlstring
  URL des Bildes des Datensatzes.
entriesarray<MediaQuestionnaireContent>
Fragen und Inhalte des Fragebogens.
Felder anzeigen (17)
- idinteger
  Primärschlüssel des Fragebogen-Inhalts. Interne ID.
- contentstring
  Frage oder Text des Inhalts.
- content_keystring
  Stabiler Schlüssel der Frage: ändert sich nach dem Setzen nie (Text, Typ und Position dürfen sich ändern), eindeutig innerhalb des Fragebogens und übernommen nach MediaQuestionnaireContentAnswer::$contentKey. Wird von MediaQuestionnaireContentKeyListener befüllt.
- content_hintstring
  Hinweis zur Antwort.
- content_filterstring
  Filter des Inhalts, zum Beispiel welche Antworten erlaubt sind.
- public_titlestring
  Titel des Inhalts, der öffentlich angezeigt wird.
- answerstring
  Gegebene Antwort
- answer_liststring
  Antwortliste für Dropdowns oder Optionsfelder. Durch Zeilenumbruch getrennt. Innere Werte werden durch | getrennt, um Wert und Bezeichnung zu trennen
- answer_requiredboolean
  Wenn true, ist die Antwort erforderlich
- previous_answer_requiredboolean
  Wenn true, wird die Frage nur angezeigt, wenn die vorherige Frage beantwortet wurde
- previous_answer_referencestring
  Verweis auf den vorherigen Antwortinhalt
- answer_in_titleboolean
  Wenn true, wird die Antwort dem Titel hinzugefügt
- answer_in_tableboolean
  Wenn true, wird die Antwort der Ergebnistabelle hinzugefügt (falls verfügbar)
- page_numberinteger
  Seite des Fragebogens, auf der sich der Inhalt befindet.
- content_typestring
  Art des Inhalts, zum Beispiel Text, Auswahl oder Upload.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
notification_emailstring
Empfänger der Management-Benachrichtigungs-E-Mail, die bei jeder neuen Antwort gesendet wird. Mehrere Adressen können kommagetrennt angegeben werden (z. B. "a@x.de, b@y.de").
notification_textstring
Kurztext der Benachrichtigung, die nach der Antwort versendet wird.
notification_long_textstring
Langtext der Benachrichtigung, die nach der Beantwortung gesendet wird.
age_groupstring
Altersgruppe, für die der Fragebogen gedacht ist.
min_ageinteger
Mindestalter in Jahren.
max_ageinteger
Maximales Alter in Jahren.
min_grade_levelinteger
Mindestschulstufe.
max_grade_levelinteger
Maximale Klassenstufe.
age_toleranceinteger
Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.
eventsarray<BaseEvent24>
Events, zu denen der Fragebogen gehört.
Felder anzeigen (81)
- ticketSeatingPlanIdinteger
  ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primärschlüssel der Veranstaltung. Interne ID.
- tokenstring
  Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
- moments_modestring
  Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
- moments_designstring
  Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
- public_keywordsstring
  Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
- public_subtitlestring
  Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
- event_typestring
  Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
- age_groupstring
  Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
- min_ageinteger
  Mindestalter der Teilnehmenden in Jahren.
- max_ageinteger
  Maximales Alter der Teilnehmer in Jahren.
- min_age_monthsinteger
  Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
- max_age_monthsinteger
  Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
- min_grade_levelinteger
  Mindestschulstufe der Teilnehmenden.
- max_grade_levelinteger
  Maximale Klassenstufe der Teilnehmer.
- age_toleranceinteger
  Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
- event_people_limitinteger
  maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
- event_people_min_limitinteger
  minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
- hide_event_people_limitboolean
  eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
- event_people_recovered_vaccinated_limitinteger
  Maximale Anzahl genesener oder geimpfter Teilnehmer.
- event_people_not_recovered_vaccinated_limitinteger
  Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
- has_wait_listboolean
  Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
- wait_list_confirmation_requiredboolean
  Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
- trial_enabledboolean
  Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
- can_sign_up_for_main_eventboolean
  Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
- only_sign_up_for_main_eventboolean
  Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
- sign_up_limit_days_beforeinteger
  Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
- sign_up_limit_stop_days_beforeinteger
  Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
- sign_up_delete_hours_beforeinteger
  Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
- start_timestring (date-time)
  Beginn der Veranstaltung.
- end_timestring (date-time)
  Ende der Veranstaltung.
- require_addressboolean
  Teilnehmende müssen bei der Anmeldung eine Adresse angeben.
- require_contactboolean
  Teilnehmende müssen bei der Anmeldung Kontaktdaten angeben.
- require_billingboolean
  Teilnehmende müssen bei der Anmeldung Rechnungsdaten angeben.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Teilnehmende müssen bei der Anmeldung ihr Alter angeben.
- require_grade_levelboolean
  Teilnehmende müssen bei der Anmeldung ihre Schulstufe angeben.
- require_free_note_field_idsstring
  IDs der Freitext-Notizfelder, die Teilnehmer ausfüllen müssen.
- generate_new_bookingsboolean
  Buchungen werden für den Veranstaltungsplan automatisch erzeugt.
- generate_new_bookings_v2boolean
  Buchungen werden mit der zweiten Version des Plan-Generators erzeugt.
- generate_ignore_sys_calendarboolean
  Erzeugte Buchungen ignorieren die Feiertage des Systemkalenders.
- copy_main_sign_ups_to_bookingboolean
  Anmeldungen der Hauptveranstaltung werden in die erzeugten Buchungen kopiert.
- generate_hour_startstring (date-time)
  Startzeit des Tages für erzeugte Buchungen.
- generate_hour_endstring (date-time)
  Endzeit des Tages für generierte Buchungen.
- generate_day_of_weekinteger
  Wochentag für erzeugte Buchungen.
- bitmask_days_of_weekinteger
  Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet
- bitmask_hours_startinteger
  Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt
- summarized_date_timesstring
  Zeichenkette mit den Wochentagen und Stunden, zu denen eine Veranstaltung beginnt
- media_questionnaireMediaQuestionnaire2
  Fragebogen der Veranstaltung im Medienmodul.
- customer_detail_ctastring
  In der Kunden-App auf der Veranstaltungsdetailseite angezeigter Call-to-Action-Text.
- customer_badgestring
  Badge-Text, der in der Kunden-App bei der Veranstaltung angezeigt wird.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live-Zeitnahme-Ergebnisse sind öffentlich.
- timing_gps_trackingboolean
  GPS-Tracking der Teilnehmer ist für die Zeitmessung aktiviert.
- timing_self_check_inboolean
  Teilnehmende können sich für die Zeitmessung selbst einchecken.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) für die Veranstaltung; die Einträge sind EventScoreboardActivity, aus denen der Spielstand berechnet wird.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die möglichen Einträge.
- scoreboard_home_namestring
  Name des Heimteams auf der Anzeigetafel.
- scoreboard_away_namestring
  Name des Gastteams auf der Anzeigetafel.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- 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.
- … 20 weitere Felder
ai_chat_promptstring
Der Systemprompt für den KI-Bot. Der Prompt wird um den MediaQuestionnaireContent in entries ergänzt, damit die KI den Kontext kennt, zu welchen Fragen am Ende des Chats Antworten gewünscht sind. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_chat_optimizer_promptstring
Der Systemprompt für den KI-Bot. Der Prompt wird verwendet, um den Chat-Prompt mit dem vorhandenen Kontext zu optimieren. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_chat_auto_close_secret_wordstring
Ein Wort als letzter Teil einer KI-Chatantwort, das den Chat beendet und den Abschluss des Fragebogens auslöst. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_chat_completed_promptstring
Der Systemprompt für den KI-Bot, der alle Chatnachrichten und den MediaQuestionnaireContent in entries verarbeitet, um auf jede der Fragen eine Antwort zu erzeugen. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_answer_summary_promptstring
Der Systemprompt für den KI-Bot, der die Antwort auf jede Frage verarbeitet und eine Zusammenfassung bzw. einen Wiki-Artikel der Antworten erzeugt. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
required_previous_questionnaireMediaQuestionnaire2
Fragebogen, der zuerst beantwortet werden muss.
group_allowedboolean
Ob der Fragebogen auf eine Gruppe beschränkt ist.
allow_self_registerboolean
Ob sich Personen selbst für die Beantwortung des Fragebogens registrieren können.
result_templateFlexibleLatexTemplate
Vorlage zur Darstellung des Ergebnisses des Fragebogens.
Felder anzeigen (35)
- predefinedboolean
  Wahr für Vorlagen, die mit dem servercontrolpanel ausgeliefert werden (PredefinedFlexibleTemplateMap). Ihre IDs werden im Code referenziert, daher bietet die Oberfläche an, sie zu duplizieren ("Vorlage anpassen"), statt sie zu bearbeiten.
- data_typestring
  Datentyp (Referenzklassenschlüssel), mit dem die Vorlage gerendert und geprüft wird. Für vordefinierte Vorlagen (Tag IW_PFLT) ist dies der Datentyp des Codes, der sie verwendet.
- data_type_labelstring
  Menschlich lesbare Bezeichnung des zugewiesenen Datentyps, null bei Tags, die keinem bekannten Datentyp entsprechen.
- template_modestring
  Serialisierter Modus, damit Clients nicht wissen müssen, dass null Standard bedeutet.
- last_check_statusstring
  Zusammenfassung der letzten Vorlagenprüfung für Listenansichten; das vollständige Ergebnis ist nur in der Admin-Detailansicht verfügbar.
- idstring
  Primärschlüssel der Vorlage. Interne ID. Wird als String-Kennung verwendet.
- namestring
  Name der Vorlage.
- tagstring
  Tag, mit dem Vorlagen gruppiert werden.
- mass_messageboolean
  Ob die Vorlage für Massennachrichten verwendet wird.
- default_store_as_pdfboolean
  Ob das erzeugte Dokument standardmäßig als PDF gespeichert wird.
- security_scopestring
  Scope, der steuert, wer die Vorlage verwenden kann.
- security_user_access_typeinteger
  Für die Verwendung der Vorlage erforderlicher Zugriffstyp.
- param1string
  In der Vorlage verwendeter Wert von Parameter 1.
- param2string
  In der Vorlage verwendeter Wert von Parameter 2.
- param3string
  In der Vorlage verwendeter Wert von Parameter 3.
- param4string
  In der Vorlage verwendeter Wert von Parameter 4.
- param5string
  In der Vorlage verwendeter Wert von Parameter 5.
- param6string
  In der Vorlage verwendeter Wert von Parameter 6.
- param7string
  In der Vorlage verwendeter Wert von Parameter 7.
- param8string
  In der Vorlage verwendeter Wert von Parameter 8.
- param9string
  In der Vorlage verwendeter Wert von Parameter 9.
- param10string
  In der Vorlage verwendeter Wert von Parameter 10.
- default_value_param1string
  Standardwert von Parameter 1.
- default_value_param2string
  Standardwert von Parameter 2.
- default_value_param3string
  Standardwert von Parameter 3.
- default_value_param4string
  Standardwert von Parameter 4.
- default_value_param5string
  Standardwert von Parameter 5.
- default_value_param6string
  Standardwert von Parameter 6.
- default_value_param7string
  Standardwert von Parameter 7.
- default_value_param8string
  Standardwert von Parameter 8.
- default_value_param9string
  Standardwert von Parameter 9.
- default_value_param10string
  Standardwert von Parameter 10.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
auto_send_result_templateboolean
Ob das Ergebnis nach der Beantwortung automatisch gesendet wird.
allow_self_download_result_templateboolean
Ob Antwortende ihr eigenes Ergebnis herunterladen können.
answer_productPredefinedBillingItem14
Produkt für die Abrechnung individueller Fragebogenantworten
Felder anzeigen (15)
- idinteger
  Primärschlüssel der zugeordneten Abrechnungsposition. Interne ID.
- namestringPflicht
  Name der Abrechnungsposition.
- descriptionstringPflicht
  Beschreibung des Abrechnungspostens, die dem Kunden angezeigt wird.
- internal_descriptionstring
  Interne Beschreibung der Abrechnungsposition, wird dem Kunden nicht angezeigt.
- fixed_hoursnumber (float)
  Feste Anzahl abgerechneter Stunden.
- fixed_pricenumber (float)
  Fester abgerechneter Preis.
- fixed_price_base_unitnumber (float)
  Basiseinheit für den Festpreis.
- price_fixed_hoursnumber (float)
  Preis für die Pauschalstunden.
- price_additional_hoursnumber (float)
  Preis für jede weitere Stunde.
- name_additional_hoursstring
  Name des Zusatzstunden-Postens.
- description_additional_hoursstring
  Beschreibung des Zusatzstundenpostens.
- time_billed_on_ticket_closeboolean
  Ob die Zeit beim Schließen des Tickets abgerechnet wird.
- billing_typeBillingItemType
  Typ der Abrechnungsposition.
- buying_pricenumber (float)
  Einkaufspreis der Position.
- … 73 weitere Felder
… 15 weitere Felder

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/questionnaire/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/questionnaire/42"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/questionnaire/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/questionnaire/42")
  .put(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/questionnaire/42"

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

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

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

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

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/media_questionnaire_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/media_questionnaire.dart';

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

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

Antwort 200 application/json

{
  "id": 42,
  "show_free_text": true,
  "notification_email": "lena.hartmann@example.org",
  "notification_text": "Text",
  "notification_long_text": "Text",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "questionnaire_type": "string",
  "token": "string",
  "public_copyright": "string"
}

MediaQuestionnaire aktualisieren

PATCH/api/media/questionnaire/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200MediaQuestionnaire aktualisierenMediaQuestionnaire2

Felder anzeigen (43)

idinteger
Primärschlüssel des Fragebogens. Interne ID.
questionnaire_typestring
Art des Fragebogens, zum Beispiel Anmeldung oder Umfrage.
tokenstring
Öffentlicher Token des Fragebogens. Anstelle der ID verwendet.
public_copyrightstring
Urheberrechtstext, der mit dem Fragebogen angezeigt wird.
public_language_codestring
Sprache des Fragebogens, zum Beispiel de.
complexity_levelinteger
Komplexitätsstufe des Fragebogens.
public_authorstring
Öffentlich angezeigter Autor.
show_free_textboolean
Ein Freitextfeld anzeigen.
show_attachmentboolean
Ein Upload-Feld für Anhänge anzeigen.
require_attachmentboolean
Ein Anhang muss hochgeladen werden.
with_paginationboolean
Den Fragebogen seitenweise anzeigen.
one_entry_per_personboolean
Wenn true, ist nur ein Eintrag pro Person erlaubt - nur für angemeldete Benutzer und Tabellenergebnisse
require_addressboolean
Die Adresse muss eingegeben werden.
require_contactboolean
Kontaktdaten müssen eingegeben werden.
require_ageboolean
Das Alter muss eingegeben werden.
require_grade_levelboolean
Die Schulklassenstufe muss eingegeben werden.
start_timestring (date-time)
Beginn der Verfügbarkeit des Fragebogens.
end_timestring (date-time)
Ende der Verfügbarkeit des Fragebogens.
pagesarray<MediaQuestionnairePage>
Seiten des Fragebogens.
Felder anzeigen (12)
- idinteger
  Primärschlüssel der Fragebogenseite. Interne ID.
- page_numberinteger
  Nummer der Seite innerhalb des Fragebogens.
- page_progress_statusstring
  Fortschrittsstatus, der für die Seite angezeigt wird.
- answer_requiredboolean
  Wenn true, ist mindestens eine Antwort erforderlich
- previous_answer_requiredboolean
  Wenn true, wird die Seite nur angezeigt, wenn die vorherige Frage beantwortet wurde
- previous_answer_referencestring
  Verweis auf den vorherigen Antwortinhalt
- content_hintstring
  Hinweistext, der auf der Seite angezeigt wird.
- submenu_titlestring
  Titel des Untermenüeintrags für die Seite.
- 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.
- image_urlstring
  URL des Bildes des Datensatzes.
entriesarray<MediaQuestionnaireContent>
Fragen und Inhalte des Fragebogens.
Felder anzeigen (17)
- idinteger
  Primärschlüssel des Fragebogen-Inhalts. Interne ID.
- contentstring
  Frage oder Text des Inhalts.
- content_keystring
  Stabiler Schlüssel der Frage: ändert sich nach dem Setzen nie (Text, Typ und Position dürfen sich ändern), eindeutig innerhalb des Fragebogens und übernommen nach MediaQuestionnaireContentAnswer::$contentKey. Wird von MediaQuestionnaireContentKeyListener befüllt.
- content_hintstring
  Hinweis zur Antwort.
- content_filterstring
  Filter des Inhalts, zum Beispiel welche Antworten erlaubt sind.
- public_titlestring
  Titel des Inhalts, der öffentlich angezeigt wird.
- answerstring
  Gegebene Antwort
- answer_liststring
  Antwortliste für Dropdowns oder Optionsfelder. Durch Zeilenumbruch getrennt. Innere Werte werden durch | getrennt, um Wert und Bezeichnung zu trennen
- answer_requiredboolean
  Wenn true, ist die Antwort erforderlich
- previous_answer_requiredboolean
  Wenn true, wird die Frage nur angezeigt, wenn die vorherige Frage beantwortet wurde
- previous_answer_referencestring
  Verweis auf den vorherigen Antwortinhalt
- answer_in_titleboolean
  Wenn true, wird die Antwort dem Titel hinzugefügt
- answer_in_tableboolean
  Wenn true, wird die Antwort der Ergebnistabelle hinzugefügt (falls verfügbar)
- page_numberinteger
  Seite des Fragebogens, auf der sich der Inhalt befindet.
- content_typestring
  Art des Inhalts, zum Beispiel Text, Auswahl oder Upload.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
notification_emailstring
Empfänger der Management-Benachrichtigungs-E-Mail, die bei jeder neuen Antwort gesendet wird. Mehrere Adressen können kommagetrennt angegeben werden (z. B. "a@x.de, b@y.de").
notification_textstring
Kurztext der Benachrichtigung, die nach der Antwort versendet wird.
notification_long_textstring
Langtext der Benachrichtigung, die nach der Beantwortung gesendet wird.
age_groupstring
Altersgruppe, für die der Fragebogen gedacht ist.
min_ageinteger
Mindestalter in Jahren.
max_ageinteger
Maximales Alter in Jahren.
min_grade_levelinteger
Mindestschulstufe.
max_grade_levelinteger
Maximale Klassenstufe.
age_toleranceinteger
Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.
eventsarray<BaseEvent24>
Events, zu denen der Fragebogen gehört.
Felder anzeigen (81)
- ticketSeatingPlanIdinteger
  ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
- bib_numbers_enabledboolean
- timing_enabledboolean
- idinteger
  Primärschlüssel der Veranstaltung. Interne ID.
- tokenstring
  Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
- moments_modestring
  Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
- moments_designstring
  Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
- public_keywordsstring
  Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
- public_subtitlestring
  Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
- event_typestring
  Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
- age_groupstring
  Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
- min_ageinteger
  Mindestalter der Teilnehmenden in Jahren.
- max_ageinteger
  Maximales Alter der Teilnehmer in Jahren.
- min_age_monthsinteger
  Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
- max_age_monthsinteger
  Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
- min_grade_levelinteger
  Mindestschulstufe der Teilnehmenden.
- max_grade_levelinteger
  Maximale Klassenstufe der Teilnehmer.
- age_toleranceinteger
  Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
- event_people_limitinteger
  maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
- event_people_min_limitinteger
  minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
- hide_event_people_limitboolean
  eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
- event_people_recovered_vaccinated_limitinteger
  Maximale Anzahl genesener oder geimpfter Teilnehmer.
- event_people_not_recovered_vaccinated_limitinteger
  Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
- has_wait_listboolean
  Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
- wait_list_confirmation_requiredboolean
  Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
- trial_enabledboolean
  Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
- can_sign_up_for_main_eventboolean
  Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
- only_sign_up_for_main_eventboolean
  Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
- sign_up_limit_days_beforeinteger
  Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
- sign_up_limit_stop_days_beforeinteger
  Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
- sign_up_delete_hours_beforeinteger
  Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
- start_timestring (date-time)
  Beginn der Veranstaltung.
- end_timestring (date-time)
  Ende der Veranstaltung.
- require_addressboolean
  Teilnehmende müssen bei der Anmeldung eine Adresse angeben.
- require_contactboolean
  Teilnehmende müssen bei der Anmeldung Kontaktdaten angeben.
- require_billingboolean
  Teilnehmende müssen bei der Anmeldung Rechnungsdaten angeben.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Teilnehmende müssen bei der Anmeldung ihr Alter angeben.
- require_grade_levelboolean
  Teilnehmende müssen bei der Anmeldung ihre Schulstufe angeben.
- require_free_note_field_idsstring
  IDs der Freitext-Notizfelder, die Teilnehmer ausfüllen müssen.
- generate_new_bookingsboolean
  Buchungen werden für den Veranstaltungsplan automatisch erzeugt.
- generate_new_bookings_v2boolean
  Buchungen werden mit der zweiten Version des Plan-Generators erzeugt.
- generate_ignore_sys_calendarboolean
  Erzeugte Buchungen ignorieren die Feiertage des Systemkalenders.
- copy_main_sign_ups_to_bookingboolean
  Anmeldungen der Hauptveranstaltung werden in die erzeugten Buchungen kopiert.
- generate_hour_startstring (date-time)
  Startzeit des Tages für erzeugte Buchungen.
- generate_hour_endstring (date-time)
  Endzeit des Tages für generierte Buchungen.
- generate_day_of_weekinteger
  Wochentag für erzeugte Buchungen.
- bitmask_days_of_weekinteger
  Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet
- bitmask_hours_startinteger
  Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt
- summarized_date_timesstring
  Zeichenkette mit den Wochentagen und Stunden, zu denen eine Veranstaltung beginnt
- media_questionnaireMediaQuestionnaire2
  Fragebogen der Veranstaltung im Medienmodul.
- customer_detail_ctastring
  In der Kunden-App auf der Veranstaltungsdetailseite angezeigter Call-to-Action-Text.
- customer_badgestring
  Badge-Text, der in der Kunden-App bei der Veranstaltung angezeigt wird.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live-Zeitnahme-Ergebnisse sind öffentlich.
- timing_gps_trackingboolean
  GPS-Tracking der Teilnehmer ist für die Zeitmessung aktiviert.
- timing_self_check_inboolean
  Teilnehmende können sich für die Zeitmessung selbst einchecken.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) für die Veranstaltung; die Einträge sind EventScoreboardActivity, aus denen der Spielstand berechnet wird.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die möglichen Einträge.
- scoreboard_home_namestring
  Name des Heimteams auf der Anzeigetafel.
- scoreboard_away_namestring
  Name des Gastteams auf der Anzeigetafel.
- ticket_sales_enabledboolean
  Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
- ticket_max_per_orderinteger
  Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
- ticket_personalizedboolean
  Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
- ticket_seatingboolean
  Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- 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.
- … 20 weitere Felder
ai_chat_promptstring
Der Systemprompt für den KI-Bot. Der Prompt wird um den MediaQuestionnaireContent in entries ergänzt, damit die KI den Kontext kennt, zu welchen Fragen am Ende des Chats Antworten gewünscht sind. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_chat_optimizer_promptstring
Der Systemprompt für den KI-Bot. Der Prompt wird verwendet, um den Chat-Prompt mit dem vorhandenen Kontext zu optimieren. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_chat_auto_close_secret_wordstring
Ein Wort als letzter Teil einer KI-Chatantwort, das den Chat beendet und den Abschluss des Fragebogens auslöst. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_chat_completed_promptstring
Der Systemprompt für den KI-Bot, der alle Chatnachrichten und den MediaQuestionnaireContent in entries verarbeitet, um auf jede der Fragen eine Antwort zu erzeugen. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
ai_answer_summary_promptstring
Der Systemprompt für den KI-Bot, der die Antwort auf jede Frage verarbeitet und eine Zusammenfassung bzw. einen Wiki-Artikel der Antworten erzeugt. Kann mit dem Fragebogentyp Q_TYPE_RESULT_LIST_AI_CHAT verwendet werden.
required_previous_questionnaireMediaQuestionnaire2
Fragebogen, der zuerst beantwortet werden muss.
group_allowedboolean
Ob der Fragebogen auf eine Gruppe beschränkt ist.
allow_self_registerboolean
Ob sich Personen selbst für die Beantwortung des Fragebogens registrieren können.
result_templateFlexibleLatexTemplate
Vorlage zur Darstellung des Ergebnisses des Fragebogens.
Felder anzeigen (35)
- predefinedboolean
  Wahr für Vorlagen, die mit dem servercontrolpanel ausgeliefert werden (PredefinedFlexibleTemplateMap). Ihre IDs werden im Code referenziert, daher bietet die Oberfläche an, sie zu duplizieren ("Vorlage anpassen"), statt sie zu bearbeiten.
- data_typestring
  Datentyp (Referenzklassenschlüssel), mit dem die Vorlage gerendert und geprüft wird. Für vordefinierte Vorlagen (Tag IW_PFLT) ist dies der Datentyp des Codes, der sie verwendet.
- data_type_labelstring
  Menschlich lesbare Bezeichnung des zugewiesenen Datentyps, null bei Tags, die keinem bekannten Datentyp entsprechen.
- template_modestring
  Serialisierter Modus, damit Clients nicht wissen müssen, dass null Standard bedeutet.
- last_check_statusstring
  Zusammenfassung der letzten Vorlagenprüfung für Listenansichten; das vollständige Ergebnis ist nur in der Admin-Detailansicht verfügbar.
- idstring
  Primärschlüssel der Vorlage. Interne ID. Wird als String-Kennung verwendet.
- namestring
  Name der Vorlage.
- tagstring
  Tag, mit dem Vorlagen gruppiert werden.
- mass_messageboolean
  Ob die Vorlage für Massennachrichten verwendet wird.
- default_store_as_pdfboolean
  Ob das erzeugte Dokument standardmäßig als PDF gespeichert wird.
- security_scopestring
  Scope, der steuert, wer die Vorlage verwenden kann.
- security_user_access_typeinteger
  Für die Verwendung der Vorlage erforderlicher Zugriffstyp.
- param1string
  In der Vorlage verwendeter Wert von Parameter 1.
- param2string
  In der Vorlage verwendeter Wert von Parameter 2.
- param3string
  In der Vorlage verwendeter Wert von Parameter 3.
- param4string
  In der Vorlage verwendeter Wert von Parameter 4.
- param5string
  In der Vorlage verwendeter Wert von Parameter 5.
- param6string
  In der Vorlage verwendeter Wert von Parameter 6.
- param7string
  In der Vorlage verwendeter Wert von Parameter 7.
- param8string
  In der Vorlage verwendeter Wert von Parameter 8.
- param9string
  In der Vorlage verwendeter Wert von Parameter 9.
- param10string
  In der Vorlage verwendeter Wert von Parameter 10.
- default_value_param1string
  Standardwert von Parameter 1.
- default_value_param2string
  Standardwert von Parameter 2.
- default_value_param3string
  Standardwert von Parameter 3.
- default_value_param4string
  Standardwert von Parameter 4.
- default_value_param5string
  Standardwert von Parameter 5.
- default_value_param6string
  Standardwert von Parameter 6.
- default_value_param7string
  Standardwert von Parameter 7.
- default_value_param8string
  Standardwert von Parameter 8.
- default_value_param9string
  Standardwert von Parameter 9.
- default_value_param10string
  Standardwert von Parameter 10.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
auto_send_result_templateboolean
Ob das Ergebnis nach der Beantwortung automatisch gesendet wird.
allow_self_download_result_templateboolean
Ob Antwortende ihr eigenes Ergebnis herunterladen können.
answer_productPredefinedBillingItem14
Produkt für die Abrechnung individueller Fragebogenantworten
Felder anzeigen (15)
- idinteger
  Primärschlüssel der zugeordneten Abrechnungsposition. Interne ID.
- namestringPflicht
  Name der Abrechnungsposition.
- descriptionstringPflicht
  Beschreibung des Abrechnungspostens, die dem Kunden angezeigt wird.
- internal_descriptionstring
  Interne Beschreibung der Abrechnungsposition, wird dem Kunden nicht angezeigt.
- fixed_hoursnumber (float)
  Feste Anzahl abgerechneter Stunden.
- fixed_pricenumber (float)
  Fester abgerechneter Preis.
- fixed_price_base_unitnumber (float)
  Basiseinheit für den Festpreis.
- price_fixed_hoursnumber (float)
  Preis für die Pauschalstunden.
- price_additional_hoursnumber (float)
  Preis für jede weitere Stunde.
- name_additional_hoursstring
  Name des Zusatzstunden-Postens.
- description_additional_hoursstring
  Beschreibung des Zusatzstundenpostens.
- time_billed_on_ticket_closeboolean
  Ob die Zeit beim Schließen des Tickets abgerechnet wird.
- billing_typeBillingItemType
  Typ der Abrechnungsposition.
- buying_pricenumber (float)
  Einkaufspreis der Position.
- … 73 weitere Felder
… 15 weitere Felder

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/questionnaire/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/questionnaire/42"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/questionnaire/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/questionnaire/42")
  .patch(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/questionnaire/42"

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

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

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

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

	fmt.Println(string(body))

}

Dart mit package:http (kein Controller im Package iw_erp_api)

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

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

Antwort 200 application/json

{
  "id": 42,
  "show_free_text": true,
  "notification_email": "lena.hartmann@example.org",
  "notification_text": "Text",
  "notification_long_text": "Text",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "questionnaire_type": "string",
  "token": "string",
  "public_copyright": "string"
}

Löscht einen einzelnen MediaQuestionnaire

DELETE/api/media/questionnaire/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Löscht einen einzelnen MediaQuestionnaireMediaQuestionnaire

Felder anzeigen (34)

idinteger
Primärschlüssel des Fragebogens. Interne ID.
questionnaire_typestring
Art des Fragebogens, zum Beispiel Anmeldung oder Umfrage.
tokenstring
Öffentlicher Token des Fragebogens. Anstelle der ID verwendet.
public_copyrightstring
Urheberrechtstext, der mit dem Fragebogen angezeigt wird.
public_language_codestring
Sprache des Fragebogens, zum Beispiel de.
complexity_levelinteger
Komplexitätsstufe des Fragebogens.
public_authorstring
Öffentlich angezeigter Autor.
show_free_textboolean
Ein Freitextfeld anzeigen.
show_attachmentboolean
Ein Upload-Feld für Anhänge anzeigen.
require_attachmentboolean
Ein Anhang muss hochgeladen werden.
with_paginationboolean
Den Fragebogen seitenweise anzeigen.
one_entry_per_personboolean
Wenn true, ist nur ein Eintrag pro Person erlaubt - nur für angemeldete Benutzer und Tabellenergebnisse
require_addressboolean
Die Adresse muss eingegeben werden.
require_contactboolean
Kontaktdaten müssen eingegeben werden.
require_ageboolean
Das Alter muss eingegeben werden.
require_grade_levelboolean
Die Schulklassenstufe muss eingegeben werden.
start_timestring (date-time)
Beginn der Verfügbarkeit des Fragebogens.
end_timestring (date-time)
Ende der Verfügbarkeit des Fragebogens.
age_groupstring
Altersgruppe, für die der Fragebogen gedacht ist.
min_ageinteger
Mindestalter in Jahren.
max_ageinteger
Maximales Alter in Jahren.
min_grade_levelinteger
Mindestschulstufe.
max_grade_levelinteger
Maximale Klassenstufe.
age_toleranceinteger
Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.
group_allowedboolean
Ob der Fragebogen auf eine Gruppe beschränkt ist.
allow_self_registerboolean
Ob sich Personen selbst für die Beantwortung des Fragebogens registrieren können.
allow_self_download_result_templateboolean
Ob Antwortende ihr eigenes Ergebnis herunterladen können.
clarification_enabledboolean
Zweite Schleife nach dem KI-Vergleich: Antworten, die die KI nicht als erfüllt bewertet, werden zu Klärungspunkten (MediaQuestionnaireClarification), die mit dem Kunden besprochen und entschieden werden, bevor die Ergebnisvorlage angelegt wird. Ohne sie folgt die Ergebnisvorlage direkt dem KI-Vergleich.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
image_urlstring
URL des Bildes des Datensatzes.
namestring
Name der Einheit.
slug_identifierstring
Slug, der in URLs der Entität verwendet wird.

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/questionnaire/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/questionnaire/42"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/questionnaire/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/questionnaire/42")
  .delete(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/questionnaire/42"

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

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

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

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

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

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

Antwort 200 application/json

{
  "id": 42,
  "show_free_text": true,
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "questionnaire_type": "string",
  "token": "string",
  "public_copyright": "string",
  "public_language_code": "string",
  "complexity_level": 1,
  "public_author": "string"
}

Statistik für einen MediaQuestionnaire mit optionaler Filterung abrufen.

GET/api/media/questionnaire/{identifier}/statistics

Werden Filter angewendet, enthält die Antwort auch einen Vergleich mit den ungefilterten Ergebnissen.

Unterstützte Filterparameter:

minAge: Mindestalter
maxAge: Höchstalter
gender: Geschlechtsfilter (M, W, D, U)
gradeLevel: Klassenstufe
schoolClass: Schulklasse
naceSection: NACE-Abschnittscode (A-U)
naceCode: NACE-Code (z. B. 01.11, 62.01)
mediaQuestionnaireAnswerGroup: Filter auf Antworten aus einer bestimmten Gruppe

Pfad-Parameter

identifierPflichtstring

Antworten

default

Anfrage

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

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

fetch('https://eure-instanz.iw-erp.de/api/media/questionnaire/42/statistics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/media/questionnaire/42/statistics"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/media/questionnaire/42/statistics"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/media/questionnaire/42/statistics")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/media/questionnaire/42/statistics"

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