Freigeben über


Survalyzer Swiss (Vorschau)

Der Survalyzer Connector bietet vereinfachten Zugriff auf alle API-Funktionen des Schweizer Rechenzentrums.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Survalyzer Developer Center
URL https://developer.survalyzer.com/
Connectormetadaten
Herausgeber Survalyzer AG
Webseite https://survalyzer.com
Datenschutzrichtlinie https://survalyzer.com/privacy-policy
Kategorien Marketing; Produktivität

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
Client-ID – Ihre Survalyzer ClientId Schnur Geben Sie die Client-ID ein. Richtig
Geheimer Clientschlüssel - Ihr Survalyzer ClientSecret securestring Geben Sie den geheimen Clientschlüssel ein. Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Aktualisieren von Opt-Outs

Diese Aktion bietet die Möglichkeit, Einträge in die Opt-Out Liste für einen Arbeitsbereich zu schreiben.

Arbeitsbereiche lesen

Diese Aktion bietet die Möglichkeit, alle verfügbaren Arbeitsbereiche zu lesen.

Artefakt erstellen

Diese Aktion bietet die Möglichkeit, ein neues Artefakt zu erstellen.

Artefakt löschen

Diese Aktion bietet die Möglichkeit, Artefakte zu löschen.

Bereich löschen

Diese Aktion bietet die Möglichkeit, das Panel zu löschen.

E-Mail senden

Diese Aktion bietet die Möglichkeit, E-Mails zu senden.

Erstellen von WebHook

Diese Aktion bietet die Möglichkeit, den Web-Hook zu erstellen.

Gutschriftsguthaben lesen

Diese Aktion gibt den Umfrageguthaben für den authentifizierten Benutzer zurück.

Händler lesen

Diese Aktion bietet die Möglichkeit, die Verteilerliste zu lesen.

Incentivecode einlösen

Diese Aktion bietet die Möglichkeit, Umfrageguthaben für Incentives/Gutscheine auszugeben.

Interview lesen

Diese Aktion bietet die Möglichkeit, die Interviewdaten zu lesen.

Interview löschen

Diese Aktion bietet die Möglichkeit, das Interview zu löschen.

Interview zurücksetzen

Diese Aktion bietet die Möglichkeit, die Mitgliederantwort des Panels zurückzusetzen.

Interviews kompakt lesen

Diese Aktion bietet die Möglichkeit, die Interviewliste kompakt zu lesen.

Interviews lesen

Diese Aktion bietet die Möglichkeit, die Interviewliste zu lesen.

Lese-Sampling-Projekt

Diese Aktion bietet die Möglichkeit, das Samplingprojekt zu lesen.

Leseanreize

Diese Aktion gibt die verfügbaren Incentives/Gutscheine für den authentifizierten Benutzer zurück.

Lesebereich

Diese Aktion bietet die Möglichkeit, die Paneldefinition zu lesen.

Lesen Opt-Outs

Diese Aktion bietet die Möglichkeit, alle Opt-Outs für einen Arbeitsbereich zu lesen.

Lesen von Artefakten

Diese Aktion bietet die Möglichkeit, die Artefaktliste zu lesen.

Lesen von Incentivetransaktionen

Die Aktion gibt einen Überblick über alle Einnahmen und Ausgaben im Zusammenhang mit Umfrageguthaben zurück.

Lesen von WebHooks

Diese Aktion bietet die Möglichkeit, die Web-Hook-Liste zu lesen.

Links zur Umfrage lesen

Diese Aktion bietet die Möglichkeit, die Umfragelinks zu lesen.

Mitglieder aktualisieren

Diese Aktion bietet die Möglichkeit, die Mitgliederliste zu aktualisieren.

Mitglieder einladen

Diese Aktion bietet die Möglichkeit, das Mitglied einzuladen.

Mitglieder einladen

Diese Aktion bietet die Möglichkeit, Mitglieder zu erstellen und einzuladen.

Mitglieder erinnern

Diese Aktion bietet die Möglichkeit, das Mitglied daran zu erinnern.

Mitglieder erstellen

Diese Aktion bietet die Möglichkeit, die Mitgliederliste zu erstellen.

Mitglieder lesen

Diese Aktion bietet die Möglichkeit, Mitglieder zu lesen.

Mitglieder löschen

Diese Aktion bietet die Möglichkeit, Mitglieder zu löschen.

Nachrichtenvorlagen lesen

Diese Aktion bietet die Möglichkeit, alle konfigurierten Nachrichtenvorlagen für E-Mail und SMS zu empfangen.

Panel aktualisieren

Diese Aktion bietet die Möglichkeit, das Panel zu aktualisieren.

Panel oder Beispiel erstellen

Diese Aktion bietet die Möglichkeit, ein neues Panel zu erstellen.

PDF-Interview herunterladen

Diese Aktion bietet die Möglichkeit, die Antworten herunterzuladen.

Samplingprojekt löschen

Diese Aktion bietet die Möglichkeit, das Samplingprojekt zu löschen.

Umfrage aktualisieren

Diese Aktion bietet die Möglichkeit, die Umfrage zu aktualisieren.

Umfrage erstellen

Diese Aktion bietet die Möglichkeit, eine Umfrage zu erstellen.

Umfrage lesen

Diese Aktion bietet die Möglichkeit, die Umfrage zu lesen.

Umfrage löschen

Diese Aktion bietet die Möglichkeit, die Umfrage zu löschen.

Umfragen lesen

Diese Aktion bietet die Möglichkeit, alle verfügbaren Umfragen eines bestimmten Arbeitsbereichs zu lesen.

Unzustellbarkeiten lesen

Diese Aktion bietet die Möglichkeit, die Unzustellbarkeitsliste zu lesen.

Verteiler löschen

Diese Aktion bietet die Möglichkeit, Verteiler zu löschen.

Web-Hook aktualisieren

Diese Aktion bietet die Möglichkeit, den Web-Hook zu aktualisieren.

WebHook löschen

Diese Aktion bietet die Möglichkeit, den Web-Hook zu löschen.

Workflowübergang ausführen

Diese Aktion bietet die Möglichkeit, Workflowübergangsspezifisch für den Workflow auszuführen.

Workflowübergänge lesen

Diese Aktion bietet die Möglichkeit, alle workflowspezifischen Übergänge für den Workflow zu lesen.

Aktualisieren von Opt-Outs

Diese Aktion bietet die Möglichkeit, Einträge in die Opt-Out Liste für einen Arbeitsbereich zu schreiben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
workspaceId
workspaceId integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

panelId
panelId integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

distributorId
distributorId integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

E-Mail
email True string

Ruft die E-Mail ab oder legt sie fest.

optOutOperation
optOutOperation True string

OptOutOperation

Handy
cellPhone True integer

Ruft das Mobiltelefon ab oder legt es fest.

optOutOperation
optOutOperation True string

OptOutOperation

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die WriteOptOutList-API dar.

Arbeitsbereiche lesen

Diese Aktion bietet die Möglichkeit, alle verfügbaren Arbeitsbereiche zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Anforderungsparameter für die ReadWorkspaceList-API dar.

Artefakt erstellen

Diese Aktion bietet die Möglichkeit, ein neues Artefakt zu erstellen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
workspaceId
workspaceId integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

Pfad
path string

Ruft den Pfad ab oder legt den Pfad fest.

Gibt zurück

Diese Klasse stellt die Antwort der CreateArtifact-API dar.

Artefakt löschen

Diese Aktion bietet die Möglichkeit, Artefakte zu löschen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Pfad
path string

Ruft den Pfad ab oder legt den Pfad fest.

filename
filename string

Dient zum Abrufen oder Festlegen des Dateinamens.

workspaceId
workspaceId integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die DeleteArtifact-API dar.

Bereich löschen

Diese Aktion bietet die Möglichkeit, das Panel zu löschen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
panelId
panelId True integer

Dient zum Abrufen oder Festlegen des Beispielbezeichners.

keepInterviews
keepInterviews boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Interviews beibehalten].

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die DeleteSample-API dar.

E-Mail senden

Diese Aktion bietet die Möglichkeit, E-Mails zu senden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
messageTemplateId
messageTemplateId integer

Dient zum Abrufen oder Festlegen des Nachrichtenvorlagenbezeichners.

name
name string

Ruft den Namen ab oder legt den Namen fest.

type
type string

Dient zum Abrufen oder Festlegen des Typs.

languageCode
languageCode True string

Dient zum Abrufen oder Festlegen des Sprachcodes.

Text
text string

Ruft den Text ab oder legt den Text fest.

language
language True string

Ruft die Sprache ab oder legt sie fest.

subject
subject string

Dient zum Abrufen oder Festlegen des Betreffs.

body
body string

Ruft den Text ab oder legt den Text fest.

from
from True string

Dient zum Abrufen oder Festlegen von.

fromName
fromName string

Ruft den Namen ab oder legt sie fest.

zu
to True string

Ruft ab oder legt diesen fest.

toName
toName string

Wandelt in Namen um.

replyTo
replyTo string

Ruft die Antwort ab oder legt sie fest.

replyToName
replyToName string

Ruft den Namen der Antwort ab oder legt diesen fest.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ExecuteSendMail-API dar.

Erstellen von WebHook

Diese Aktion bietet die Möglichkeit, den Web-Hook zu erstellen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
eventType
eventType string

Eventtyp

entityIdentifier
entityIdentifier string

Dient zum Abrufen oder Festlegen des Entitätsbezeichners.

securityToken
securityToken string

Ruft das Sicherheitstoken ab oder legt es fest.

webHookUrl
webHookUrl string

Ruft die Web hook-URL ab oder legt sie fest.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die CreateWebHook-API dar.

Gutschriftsguthaben lesen

Diese Aktion gibt den Umfrageguthaben für den authentifizierten Benutzer zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
object

Diese Klasse stellt die Anforderungsparameter für die ReadCreditBalance-API dar.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadCreditBalance-API dar.

Händler lesen

Diese Aktion bietet die Möglichkeit, die Verteilerliste zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
surveyId
surveyId integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

panelId
panelId integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadDistributorList-API dar.

Incentivecode einlösen

Diese Aktion bietet die Möglichkeit, Umfrageguthaben für Incentives/Gutscheine auszugeben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
incentiveId
incentiveId True integer

Dient zum Abrufen oder Festlegen des Anreizbezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die RedeemIncentiveCode-API dar.

Interview lesen

Diese Aktion bietet die Möglichkeit, die Interviewdaten zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Mieter
tenant True string

Ruft den Mandanten ab oder legt den Mandanten fest.

interviewId
interviewId True uuid

Dient zum Abrufen oder Festlegen des Interviewbezeichners.

surveyId
surveyId True integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

loadSurveyDefinition
loadSurveyDefinition boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Load Survey definition].

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadInterviewData-API dar.

Interview löschen

Diese Aktion bietet die Möglichkeit, das Interview zu löschen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
interviewId
interviewId uuid

Dient zum Abrufen oder Festlegen des Interviewbezeichners.

surveyId
surveyId integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die DeleteInterview-API dar.

Interview zurücksetzen

Diese Aktion bietet die Möglichkeit, die Mitgliederantwort des Panels zurückzusetzen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
surveyId
surveyId integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

interviewId
interviewId uuid

Dient zum Abrufen oder Festlegen des Interviewbezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ResetInterview-API dar.

Interviews kompakt lesen

Diese Aktion bietet die Möglichkeit, die Interviewliste kompakt zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Mieter
tenant string

Ruft den Mandanten ab oder legt den Mandanten fest.

surveyId
surveyId integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

fieldsToDownload
fieldsToDownload array of string

Ruft die angeforderten Spalten ab oder legt sie fest.

loadCodePlan
loadCodePlan boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Ladecodeplan].

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadInterviewListCompact-API dar.

Interviews lesen

Diese Aktion bietet die Möglichkeit, die Interviewliste zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Mieter
tenant string

Ruft den Mandanten ab oder legt den Mandanten fest.

surveyId
surveyId integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

fieldsToDownload
fieldsToDownload array of string

Ruft die angeforderten Spalten ab oder legt sie fest.

loadCodePlan
loadCodePlan boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Ladecodeplan].

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadInterviewList-API dar.

Lese-Sampling-Projekt

Diese Aktion bietet die Möglichkeit, das Samplingprojekt zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadSamplingProject-API dar.

Leseanreize

Diese Aktion gibt die verfügbaren Incentives/Gutscheine für den authentifizierten Benutzer zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Anforderungsparameter für die ReadIncentiveList-API dar.

Lesebereich

Diese Aktion bietet die Möglichkeit, die Paneldefinition zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Mieter
tenant string

Ruft den Mandanten ab oder legt den Mandanten fest.

panelId
panelId True integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadPanelDefinition-API dar.

Lesen Opt-Outs

Diese Aktion bietet die Möglichkeit, alle Opt-Outs für einen Arbeitsbereich zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
panelId
panelId integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

workspaceId
workspaceId integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadOptOutList-API dar.

Lesen von Artefakten

Diese Aktion bietet die Möglichkeit, die Artefaktliste zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Pfad
path string

Ruft den Pfad ab oder legt den Pfad fest.

workspaceId
workspaceId integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

Gibt zurück

Diese Klasse stellt die Anforderungsparameter für die ReadArtifactList-API dar.

Lesen von Incentivetransaktionen

Die Aktion gibt einen Überblick über alle Einnahmen und Ausgaben im Zusammenhang mit Umfrageguthaben zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadIncentiveTransactionList-API dar.

Lesen von WebHooks

Diese Aktion bietet die Möglichkeit, die Web-Hook-Liste zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
eventType
eventType string

Eventtyp

entityIdentifier
entityIdentifier string

Dient zum Abrufen oder Festlegen des Entitätsbezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadWebHookList-API dar.

Diese Aktion bietet die Möglichkeit, die Umfragelinks zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
surveyId
surveyId integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

Gibt zurück

Diese Klasse stellt die Antwort der ReadSurveyLinks-API dar.

Mitglieder aktualisieren

Diese Aktion bietet die Möglichkeit, die Mitgliederliste zu aktualisieren.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Mieter
tenant string

Ruft den Mandanten ab oder legt den Mandanten fest.

panelId
panelId True integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

fields
fields True object

Ruft die Felder ab oder legt sie fest.

ErstelltAm
createdAt date-time

Dient zum Abrufen oder Festlegen der erstellten Datei.

createdBy
createdBy string

Ruft ab oder legt die erstellte von.

updatedAt
updatedAt date-time

Ruft die aktualisierung ab oder legt diese fest.

aktualisiertvon
updatedBy string

Dient zum Abrufen oder Festlegen des aktualisierten Werts.

id
id string

Die ID des Interviews

Staat
state string

Dient zum Abrufen oder Festlegen des Zustands.

surveyId
surveyId integer

Die ID der Umfrage

surveyVersionId
surveyVersionId integer

Die ID der Umfrageversion

surveyName
surveyName string

Der Name der Umfrage

surveyState
surveyState string

Dient zum Abrufen oder Festlegen des Status der Umfrage.

answersLink
answersLink string

Der Link zur Seite "Antworten drucken"

interviewLink
interviewLink string

Ruft den Interviewlink ab oder legt den Link fest.

startDate
startDate string

Ruft ab oder legt das Startdatum fest.

Enddatum
endDate string

Ruft das Enddatum ab oder legt es fest.

samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

distributorId
distributorId integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die UpdateMembers-API dar.

Mitglieder einladen

Diese Aktion bietet die Möglichkeit, das Mitglied einzuladen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
surveyId
surveyId True integer

Die ID der Umfrage

panelId
panelId True integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

memberIds
memberIds array of integer

Dient zum Abrufen oder Festlegen der Panelmitglieder-IDs.

messageTemplateId
messageTemplateId True integer

Dient zum Abrufen oder Festlegen des Nachrichtenvorlagenbezeichners.

name
name string

Ruft den Namen ab oder legt den Namen fest.

type
type string

Dient zum Abrufen oder Festlegen des Typs.

languageCode
languageCode True string

Dient zum Abrufen oder Festlegen des Sprachcodes.

Text
text string

Ruft den Text ab oder legt den Text fest.

scheduleDateTime
scheduleDateTime date-time

Ruft die Zeitplanzeit ab oder legt sie fest.

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

Kanal
channel string

Verteilungskanal

asyncProcess
asyncProcess boolean

Dient zum Abrufen oder Festlegen des asynchronen Prozesses.

interviewExpiryDate
interviewExpiryDate string

Ruft das Ablaufdatum des Interviews ab oder legt es fest.

from
from string

Dient zum Abrufen oder Festlegen von.

fromName
fromName string

Ruft den Namen ab oder legt sie fest.

replyTo
replyTo string

Ruft die Antwort ab oder legt sie fest.

replyToName
replyToName string

Ruft den Namen der Antwort ab oder legt diesen fest.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die InviteMembers-API dar.

Mitglieder einladen

Diese Aktion bietet die Möglichkeit, Mitglieder zu erstellen und einzuladen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

surveyId
surveyId True integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

panelId
panelId True integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

Kanal
channel True string

Verteilungskanal

messageTemplateId
messageTemplateId True integer

Dient zum Abrufen oder Festlegen des Nachrichtenvorlagenbezeichners.

name
name string

Ruft den Namen ab oder legt den Namen fest.

type
type string

Dient zum Abrufen oder Festlegen des Typs.

languageCode
languageCode True string

Dient zum Abrufen oder Festlegen des Sprachcodes.

Text
text string

Ruft den Text ab oder legt den Text fest.

id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

fields
fields True object

Ruft die Felder ab oder legt sie fest.

ErstelltAm
createdAt date-time

Dient zum Abrufen oder Festlegen der erstellten Datei.

createdBy
createdBy string

Ruft ab oder legt die erstellte von.

updatedAt
updatedAt date-time

Ruft die aktualisierung ab oder legt diese fest.

aktualisiertvon
updatedBy string

Dient zum Abrufen oder Festlegen des aktualisierten Werts.

id
id string

Die ID des Interviews

Staat
state string

Dient zum Abrufen oder Festlegen des Zustands.

surveyId
surveyId integer

Die ID der Umfrage

surveyVersionId
surveyVersionId integer

Die ID der Umfrageversion

surveyName
surveyName string

Der Name der Umfrage

surveyState
surveyState string

Dient zum Abrufen oder Festlegen des Status der Umfrage.

answersLink
answersLink string

Der Link zur Seite "Antworten drucken"

interviewLink
interviewLink string

Ruft den Interviewlink ab oder legt den Link fest.

startDate
startDate string

Ruft ab oder legt das Startdatum fest.

Enddatum
endDate string

Ruft das Enddatum ab oder legt es fest.

samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

distributorId
distributorId integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

scheduleDateTime
scheduleDateTime string

Dient zum Abrufen oder Festlegen der Terminplanungstermine.

asyncProcess
asyncProcess boolean

Dient zum Abrufen oder Festlegen des asynchronen Prozesses.

interviewExpiryDate
interviewExpiryDate string

Ruft das Ablaufdatum des Interviews ab oder legt es fest.

from
from string

Dient zum Abrufen oder Festlegen von.

fromName
fromName string

Ruft den Namen ab oder legt sie fest.

replyTo
replyTo string

Ruft die Antwort ab oder legt sie fest.

replyToName
replyToName string

Ruft den Namen der Antwort ab oder legt diesen fest.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die CreateAndInviteMembers-API dar.

Mitglieder erinnern

Diese Aktion bietet die Möglichkeit, das Mitglied daran zu erinnern.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
distributorId
distributorId True integer

Die ID der Umfrage

messageTemplateId
messageTemplateId True integer

Dient zum Abrufen oder Festlegen des Nachrichtenvorlagenbezeichners.

name
name string

Ruft den Namen ab oder legt den Namen fest.

type
type string

Dient zum Abrufen oder Festlegen des Typs.

languageCode
languageCode True string

Dient zum Abrufen oder Festlegen des Sprachcodes.

Text
text string

Ruft den Text ab oder legt den Text fest.

scheduleDateTime
scheduleDateTime date-time

Ruft die Zeitplanzeit ab oder legt sie fest.

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

Kanal
channel string

Verteilungskanal

from
from string

Dient zum Abrufen oder Festlegen von.

fromName
fromName string

Ruft den Namen ab oder legt sie fest.

replyTo
replyTo string

Ruft die Antwort ab oder legt sie fest.

replyToName
replyToName string

Ruft den Namen der Antwort ab oder legt diesen fest.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die RemindMembers-API dar.

Mitglieder erstellen

Diese Aktion bietet die Möglichkeit, die Mitgliederliste zu erstellen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Mieter
tenant string

Ruft den Mandanten ab oder legt den Mandanten fest.

panelId
panelId True integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

fields
fields True object

Ruft die Felder ab oder legt sie fest.

ErstelltAm
createdAt date-time

Dient zum Abrufen oder Festlegen der erstellten Datei.

createdBy
createdBy string

Ruft ab oder legt die erstellte von.

updatedAt
updatedAt date-time

Ruft die aktualisierung ab oder legt diese fest.

aktualisiertvon
updatedBy string

Dient zum Abrufen oder Festlegen des aktualisierten Werts.

id
id string

Die ID des Interviews

Staat
state string

Dient zum Abrufen oder Festlegen des Zustands.

surveyId
surveyId integer

Die ID der Umfrage

surveyVersionId
surveyVersionId integer

Die ID der Umfrageversion

surveyName
surveyName string

Der Name der Umfrage

surveyState
surveyState string

Dient zum Abrufen oder Festlegen des Status der Umfrage.

answersLink
answersLink string

Der Link zur Seite "Antworten drucken"

interviewLink
interviewLink string

Ruft den Interviewlink ab oder legt den Link fest.

startDate
startDate string

Ruft ab oder legt das Startdatum fest.

Enddatum
endDate string

Ruft das Enddatum ab oder legt es fest.

samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

distributorId
distributorId integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die CreateMembers-API dar.

Mitglieder lesen

Diese Aktion bietet die Möglichkeit, Mitglieder zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Mieter
tenant string

Ruft den Mandanten ab oder legt den Mandanten fest.

panelId
panelId True integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

InterviewsRequired
interviewsRequired True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Sitzungsinformationen erforderlich sind.

fieldsToDownload
fieldsToDownload array of string

Ruft die herunterzuladenden Felder ab oder legt sie fest.

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadMemberList-API dar.

Mitglieder löschen

Diese Aktion bietet die Möglichkeit, Mitglieder zu löschen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
panelId
panelId True integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

panelMembersIds
panelMembersIds True array of integer

Dient zum Abrufen oder Festlegen des Panelmitgliedsbezeichners.

keepInterviews
keepInterviews boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Interviews beibehalten].

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die DeleteMember-API dar.

Nachrichtenvorlagen lesen

Diese Aktion bietet die Möglichkeit, alle konfigurierten Nachrichtenvorlagen für E-Mail und SMS zu empfangen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
workspaceId
workspaceId integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

language
language True string

Ruft die Sprache ab oder legt sie fest.

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadMessageTemplateList-API dar.

Panel aktualisieren

Diese Aktion bietet die Möglichkeit, das Panel zu aktualisieren.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Mieter
tenant string

Ruft den Mandanten ab oder legt den Mandanten fest.

panelId
panelId True integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

id
id integer

Die ID des Felds. Dies ist ein obligatorisches Feld bei der Umbenennung.

name
name string

Der Name des Felds. In diesem Feld ist ein Eintrag erforderlich.

type
type string

PanelMemberFieldType

value
value

Der Wert des -Felds. Der Werttyp muss mit der Type-Eigenschaft übereinstimmen.

removedFields
removedFields array of integer

Ruft die entfernten Felder ab oder legt sie fest.

id
id integer

Die ID des Felds. Dies ist ein obligatorisches Feld bei der Umbenennung.

name
name string

Der Name des Felds. In diesem Feld ist ein Eintrag erforderlich.

type
type string

PanelMemberFieldType

value
value

Der Wert des -Felds. Der Werttyp muss mit der Type-Eigenschaft übereinstimmen.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die WritePanel-API dar.

Panel oder Beispiel erstellen

Diese Aktion bietet die Möglichkeit, ein neues Panel zu erstellen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
workspaceId
workspaceId True integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

name
name True string

Ruft den Panelnamen ab oder legt den Namen fest.

panelType
panelType True string

PanelModelType

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die CreatePanel-API dar.

PDF-Interview herunterladen

Diese Aktion bietet die Möglichkeit, die Antworten herunterzuladen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Tenant
tenant True string

Der Mandant.

SurveyId
surveyId True integer

Der Umfragebezeichner.

InterviewId
interviewId True uuid

Der Interviewbezeichner.

Teil abgeschlossen anzeigen
showPartialCompleted boolean

wenn auf <"c>true</c> " festgelegt [Teil abgeschlossen anzeigen].

Gebietsschema
locale string

Das Gebietsschema.

Thmezone
timeZone string

Die Zeitzone.

isCancellationRequested
isCancellationRequested boolean
canBeCanceled
canBeCanceled boolean
isInvalid
isInvalid boolean
isClosed
isClosed boolean

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die DownloadAnswers-API dar.

Samplingprojekt löschen

Diese Aktion bietet die Möglichkeit, das Samplingprojekt zu löschen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

keepInterviews
keepInterviews boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Interviews beibehalten].

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die DeleteSamplingProject-API dar.

Umfrage aktualisieren

Diese Aktion bietet die Möglichkeit, die Umfrage zu aktualisieren.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
surveyId
surveyId True integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

surveyName
surveyName string

Ruft den Namen der Umfrage ab oder legt den Namen fest.

allowMultipleParticipation
allowMultipleParticipation True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [mehrere Teilnahme zulassen].

allowNavigateBack
allowNavigateBack True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Navigation zurück zulassen].

allowSaveProgress
allowSaveProgress boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Speicherfortschritt zulassen].

randomizeSections
randomizeSections True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [randomize sections].

enableAutoScroll
enableAutoScroll boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [automatisches Scrollen aktivieren]

enableCodeAccess
enableCodeAccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Codezugriff aktivieren].

accessType
accessType string

Zugriffstyp

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

associatedPanels
associatedPanels array of integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

codeAccessMode
codeAccessMode True string

AuthenticationType

enablePanelSync
enablePanelSync boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Panelsynchronisierung aktivieren].

panelSyncBehaviour
panelSyncBehaviour string

PanelSyncBehaviour

identifier
identifier string

Dient zum Abrufen oder Festlegen des Bezeichners.

panelField
panelField string

Ruft das Panelfeld ab oder legt es fest.

defaultLanguage
defaultLanguage True string

Ruft die Standardsprache ab oder legt sie fest.

Enddatum
endDate date-time

Ruft das Enddatum ab oder legt es fest.

Sprachen
languages True array of string

Ruft die Sprachen ab oder legt sie fest.

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

name
name True string

Ruft den Namen ab oder legt den Namen fest.

randomizePages
randomizePages True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [randomize pages].

excludeFromRandomization
excludeFromRandomization True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [aus randomisierung ausgeschlossen].

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

elementType
elementType True string

ElementType

Code
code string

Ruft den Code ab oder legt den Code fest.

codeManuallyChanged
codeManuallyChanged boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Code manuell geändert].

languageCode
languageCode True string

Dient zum Abrufen oder Festlegen des Sprachcodes.

Text
text string

Ruft den Text ab oder legt den Text fest.

hasHintText
hasHintText boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Hinweistext enthält.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz nicht verfügbar ist.

forceResponse
forceResponse boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Erzwingungsantwort].

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

Code
code True string

Ruft den Code ab oder legt den Code fest.

codeManuallyChanged
codeManuallyChanged boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Code manuell geändert].

allowTextEntry
allowTextEntry True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Texteingabe zulassen].

forceInput
forceInput True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Eingabe erzwingen].

AutoVervollständigen
autocomplete True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob dieser Survalyzer.Contracts.Public.Elements.Choice autoVervollständigen ist.

ausschließlich
exclusive True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Survalyzer.Contracts.Public.Elements.Choice exklusiv ist.

excludeFromRandomization
excludeFromRandomization boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [aus randomisierung ausgeschlossen].

validationType
validationType True string

ContentValidierung

earliestDate
earliestDate string

Dient zum Abrufen oder Festlegen des frühesten Datums.

latestDate
latestDate string

Ruft das neueste Datum ab oder legt es fest.

minValue
minValue double

Dient zum Abrufen oder Festlegen des Minimalwerts.

maxValue
maxValue double

Dient zum Abrufen oder Festlegen des Maximalwerts.

Dezimalstellen
decimalPlaces integer

Dient zum Abrufen oder Festlegen der Dezimalstellen.

disableThousandSeparator
disableThousandSeparator boolean

Ruft das Tausendertrennzeichen ab, oder legt dieses fest.

conditionAction
conditionAction True string

FilterAction

autocompleteListVariable
autocompleteListVariable string

Ruft die AutoVervollständigen-Listenvariable ab oder legt sie fest.

randomizeChoices
randomizeChoices boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [randomize choices].

columnType
columnType string

Spaltentyp

minValue
minValue integer

Dient zum Abrufen oder Festlegen des Minimalwerts.

maxValue
maxValue integer

Dient zum Abrufen oder Festlegen des Maximalwerts.

showCenterLabel
showCenterLabel boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [mittlere Beschriftung anzeigen].

showValue
showValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Wert anzeigen].

maxDecimals
maxDecimals integer

Ruft die maximalen Ziffern nach komma ab oder legt diese fest.

textFieldSize
textFieldSize string

TextFieldSize

AutoVervollständigen
autocomplete boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob dieses Survalyzer.Contracts.Public.Elements.SurveyElement autovervollständigen ist.

hasPlaceholder
hasPlaceholder boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Platzhalter hat.

isPassword
isPassword boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz ein Kennwort ist.

minMaxValidation
minMaxValidation boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [minimale maximale Gültigkeitsprüfung]

minimumCheckedChoices
minimumCheckedChoices integer

Ruft die minimal geprüften Auswahlmöglichkeiten ab, oder legt diese fest.

maximumCheckedChoices
maximumCheckedChoices integer

Ruft die maximalen aktivierten Auswahlmöglichkeiten ab oder legt sie fest.

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

hasNotAvailableChoice
hasNotAvailableChoice True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz nicht verfügbar ist.

randomizeColumns
randomizeColumns True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Randomize columns].

choiceType
choiceType True string

ChoiceType

randomizeRows
randomizeRows boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Zufällige Zeilen].

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

Code
code True string

Ruft den Code ab oder legt den Code fest.

codeManuallyChanged
codeManuallyChanged boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Code manuell geändert].

excludeFromRandomization
excludeFromRandomization True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [aus randomisierung ausgeschlossen].

numberOfRanks
numberOfRanks integer

Ruft die Anzahl der Rangfolgen ab oder legt sie fest.

hasStartText
hasStartText boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Starttext hat.

enableMeasurement
enableMeasurement boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Maß aktivieren].

showButtons
showButtons boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Schaltflächen anzeigen].

likeKey
likeKey string

Dient zum Abrufen oder Festlegen des ähnlichen Schlüssels.

nicht gefälltKey
dislikeKey string

Dient zum Abrufen oder Festlegen der Abgleichstaste.

interviewState
interviewState string

Dient zum Abrufen oder Festlegen des Status der Antwort.

actionType
actionType True string

QuotaAction

from
from string

Ruft den Absender ab oder legt den Absender fest.

zu
to string

Dient zum Abrufen oder Festlegen des Empfängers.

valueAssignmentType
valueAssignmentType string

ValueAssignmentType

variableName
variableName string

Dient zum Abrufen oder Festlegen des Namens der Variablen.

executionBehavior
executionBehavior string

ExecutionBehavior

apiCallMethod
apiCallMethod string

ApiCallMethod

headers
headers string

Ruft die Kopfzeilen ab oder legt sie fest.

externalUri
externalUri string

Dient zum Abrufen oder Festlegen des externen URI.

scriptType
scriptType string

ScriptType

Inhalt
content string

Ruft den Inhalt ab oder legt den Inhalt fest.

hasRatingLabels
hasRatingLabels boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Bewertungsbezeichnungen enthält.

evaluateAsJson
evaluateAsJson boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [als json ausgewertet].

autocompleteListVariable
autocompleteListVariable string

Ruft die AutoVervollständigen-Listenvariable ab oder legt sie fest.

arrangementMode
arrangementMode string

ArrangementMode

enableAnimation
enableAnimation boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Animation aktivieren].

useSmiley
useSmiley boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Smiley verwenden].

hasPrompt
hasPrompt boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz eine Eingabeaufforderung hat.

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

variableName
variableName True string

Dient zum Abrufen oder Festlegen des Namens der Variablen.

defaultTextOverrides
defaultTextOverrides object

Dient zum Abrufen oder Festlegen der Standardtextüberschreibungen.

surveyDesignLayout
surveyDesignLayout integer

Ruft das Entwurfslayout der Umfrage ab oder legt es fest.

matrixSubQuestionSize
matrixSubQuestionSize string

MatrixSubQuestionSize

name
name string

Ruft den Namen ab oder legt den Namen fest.

type
type string

Dient zum Abrufen oder Festlegen des Typs.

languageCode
languageCode True string

Dient zum Abrufen oder Festlegen des Sprachcodes.

Text
text string

Ruft den Text ab oder legt den Text fest.

anonymizingMode
anonymizingMode True string

AnonymizingMode

logIp
logIp True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [log ip].

logUserAgent
logUserAgent True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Log User Agent].

logReferer
logReferer True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Log Referer].

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die UpdateSurvey-API dar.

Umfrage erstellen

Diese Aktion bietet die Möglichkeit, eine Umfrage zu erstellen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
workspaceId
workspaceId True integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

name
name True string

Ruft den Namen ab oder legt den Namen fest.

allowMultipleParticipation
allowMultipleParticipation True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [mehrere Teilnahme zulassen].

allowNavigateBack
allowNavigateBack True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Navigation zurück zulassen].

allowSaveProgress
allowSaveProgress boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Speicherfortschritt zulassen].

randomizeSections
randomizeSections True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [randomize sections].

enableAutoScroll
enableAutoScroll boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [automatisches Scrollen aktivieren]

enableCodeAccess
enableCodeAccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Codezugriff aktivieren].

accessType
accessType string

Zugriffstyp

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

associatedPanels
associatedPanels array of integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

codeAccessMode
codeAccessMode True string

AuthenticationType

enablePanelSync
enablePanelSync boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Panelsynchronisierung aktivieren].

panelSyncBehaviour
panelSyncBehaviour string

PanelSyncBehaviour

identifier
identifier string

Dient zum Abrufen oder Festlegen des Bezeichners.

panelField
panelField string

Ruft das Panelfeld ab oder legt es fest.

defaultLanguage
defaultLanguage True string

Ruft die Standardsprache ab oder legt sie fest.

Enddatum
endDate date-time

Ruft das Enddatum ab oder legt es fest.

Sprachen
languages True array of string

Ruft die Sprachen ab oder legt sie fest.

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

name
name True string

Ruft den Namen ab oder legt den Namen fest.

randomizePages
randomizePages True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [randomize pages].

excludeFromRandomization
excludeFromRandomization True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [aus randomisierung ausgeschlossen].

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

elementType
elementType True string

ElementType

Code
code string

Ruft den Code ab oder legt den Code fest.

codeManuallyChanged
codeManuallyChanged boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Code manuell geändert].

languageCode
languageCode True string

Dient zum Abrufen oder Festlegen des Sprachcodes.

Text
text string

Ruft den Text ab oder legt den Text fest.

hasHintText
hasHintText boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Hinweistext enthält.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz nicht verfügbar ist.

forceResponse
forceResponse boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Erzwingungsantwort].

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

Code
code True string

Ruft den Code ab oder legt den Code fest.

codeManuallyChanged
codeManuallyChanged boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Code manuell geändert].

allowTextEntry
allowTextEntry True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Texteingabe zulassen].

forceInput
forceInput True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Eingabe erzwingen].

AutoVervollständigen
autocomplete True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob dieser Survalyzer.Contracts.Public.Elements.Choice autoVervollständigen ist.

ausschließlich
exclusive True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Survalyzer.Contracts.Public.Elements.Choice exklusiv ist.

excludeFromRandomization
excludeFromRandomization boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [aus randomisierung ausgeschlossen].

validationType
validationType True string

ContentValidierung

earliestDate
earliestDate string

Dient zum Abrufen oder Festlegen des frühesten Datums.

latestDate
latestDate string

Ruft das neueste Datum ab oder legt es fest.

minValue
minValue double

Dient zum Abrufen oder Festlegen des Minimalwerts.

maxValue
maxValue double

Dient zum Abrufen oder Festlegen des Maximalwerts.

Dezimalstellen
decimalPlaces integer

Dient zum Abrufen oder Festlegen der Dezimalstellen.

disableThousandSeparator
disableThousandSeparator boolean

Ruft das Tausendertrennzeichen ab, oder legt dieses fest.

conditionAction
conditionAction True string

FilterAction

autocompleteListVariable
autocompleteListVariable string

Ruft die AutoVervollständigen-Listenvariable ab oder legt sie fest.

randomizeChoices
randomizeChoices boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [randomize choices].

columnType
columnType string

Spaltentyp

minValue
minValue integer

Dient zum Abrufen oder Festlegen des Minimalwerts.

maxValue
maxValue integer

Dient zum Abrufen oder Festlegen des Maximalwerts.

showCenterLabel
showCenterLabel boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [mittlere Beschriftung anzeigen].

showValue
showValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Wert anzeigen].

maxDecimals
maxDecimals integer

Ruft die maximalen Ziffern nach komma ab oder legt diese fest.

textFieldSize
textFieldSize string

TextFieldSize

AutoVervollständigen
autocomplete boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob dieses Survalyzer.Contracts.Public.Elements.SurveyElement autovervollständigen ist.

hasPlaceholder
hasPlaceholder boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Platzhalter hat.

isPassword
isPassword boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz ein Kennwort ist.

minMaxValidation
minMaxValidation boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [minimale maximale Gültigkeitsprüfung]

minimumCheckedChoices
minimumCheckedChoices integer

Ruft die minimal geprüften Auswahlmöglichkeiten ab, oder legt diese fest.

maximumCheckedChoices
maximumCheckedChoices integer

Ruft die maximalen aktivierten Auswahlmöglichkeiten ab oder legt sie fest.

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

hasNotAvailableChoice
hasNotAvailableChoice True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz nicht verfügbar ist.

randomizeColumns
randomizeColumns True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Randomize columns].

choiceType
choiceType True string

ChoiceType

randomizeRows
randomizeRows boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Zufällige Zeilen].

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

Code
code True string

Ruft den Code ab oder legt den Code fest.

codeManuallyChanged
codeManuallyChanged boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Code manuell geändert].

excludeFromRandomization
excludeFromRandomization True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [aus randomisierung ausgeschlossen].

numberOfRanks
numberOfRanks integer

Ruft die Anzahl der Rangfolgen ab oder legt sie fest.

hasStartText
hasStartText boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Starttext hat.

enableMeasurement
enableMeasurement boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Maß aktivieren].

showButtons
showButtons boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Schaltflächen anzeigen].

likeKey
likeKey string

Dient zum Abrufen oder Festlegen des ähnlichen Schlüssels.

nicht gefälltKey
dislikeKey string

Dient zum Abrufen oder Festlegen der Abgleichstaste.

interviewState
interviewState string

Dient zum Abrufen oder Festlegen des Status der Antwort.

actionType
actionType True string

QuotaAction

from
from string

Ruft den Absender ab oder legt den Absender fest.

zu
to string

Dient zum Abrufen oder Festlegen des Empfängers.

valueAssignmentType
valueAssignmentType string

ValueAssignmentType

variableName
variableName string

Dient zum Abrufen oder Festlegen des Namens der Variablen.

executionBehavior
executionBehavior string

ExecutionBehavior

apiCallMethod
apiCallMethod string

ApiCallMethod

headers
headers string

Ruft die Kopfzeilen ab oder legt sie fest.

externalUri
externalUri string

Dient zum Abrufen oder Festlegen des externen URI.

scriptType
scriptType string

ScriptType

Inhalt
content string

Ruft den Inhalt ab oder legt den Inhalt fest.

hasRatingLabels
hasRatingLabels boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Bewertungsbezeichnungen enthält.

evaluateAsJson
evaluateAsJson boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [als json ausgewertet].

autocompleteListVariable
autocompleteListVariable string

Ruft die AutoVervollständigen-Listenvariable ab oder legt sie fest.

arrangementMode
arrangementMode string

ArrangementMode

enableAnimation
enableAnimation boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Animation aktivieren].

useSmiley
useSmiley boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Smiley verwenden].

hasPrompt
hasPrompt boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz eine Eingabeaufforderung hat.

id
id True integer

Dient zum Abrufen oder Festlegen des Bezeichners.

variableName
variableName True string

Dient zum Abrufen oder Festlegen des Namens der Variablen.

defaultTextOverrides
defaultTextOverrides object

Dient zum Abrufen oder Festlegen der Standardtextüberschreibungen.

surveyDesignLayout
surveyDesignLayout integer

Ruft das Entwurfslayout der Umfrage ab oder legt es fest.

matrixSubQuestionSize
matrixSubQuestionSize string

MatrixSubQuestionSize

name
name string

Ruft den Namen ab oder legt den Namen fest.

type
type string

Dient zum Abrufen oder Festlegen des Typs.

languageCode
languageCode True string

Dient zum Abrufen oder Festlegen des Sprachcodes.

Text
text string

Ruft den Text ab oder legt den Text fest.

anonymizingMode
anonymizingMode True string

AnonymizingMode

logIp
logIp True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [log ip].

logUserAgent
logUserAgent True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Log User Agent].

logReferer
logReferer True boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Log Referer].

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die CreateSurvey-API dar.

Umfrage lesen

Diese Aktion bietet die Möglichkeit, die Umfrage zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Mieter
tenant string

Ruft den Mandanten ab oder legt den Mandanten fest.

surveyId
surveyId True integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadSurveyDefinition-API dar.

Umfrage löschen

Diese Aktion bietet die Möglichkeit, die Umfrage zu löschen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
surveyId
surveyId True integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die DeleteSurvey-API dar.

Umfragen lesen

Diese Aktion bietet die Möglichkeit, alle verfügbaren Umfragen eines bestimmten Arbeitsbereichs zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
workspaceId
workspaceId True integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Antwortparameter für die ReadSurveyList-API dar.

Unzustellbarkeiten lesen

Diese Aktion bietet die Möglichkeit, die Unzustellbarkeitsliste zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
surveyId
surveyId True integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

panelId
panelId integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

Verteiler
distributors array of integer

Ruft die Händler ab oder legt sie fest.

invitationType
invitationType string

InvitationType

Konjunktion
conjunction True string

Konjunktion

Bedingungstyp
conditionType True string

ConditionType

identifier
identifier True string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

pageSize
pageSize True integer

Ruft die Größe der Seite ab oder legt diese fest.

Seite
page True integer

Ruft die Seite ab oder legt sie fest.

orderField
orderField string

Ruft das Order-Feld ab oder legt es fest.

orderDirection
orderDirection string

OrderDirection

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadBounceList-API dar.

Verteiler löschen

Diese Aktion bietet die Möglichkeit, Verteiler zu löschen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
distributorId
distributorId True integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

keepInterviews
keepInterviews boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Interviews beibehalten].

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die DeleteDistributor-API dar.

Web-Hook aktualisieren

Diese Aktion bietet die Möglichkeit, den Web-Hook zu aktualisieren.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
webHookId
webHookId uuid

Ruft den Web-Hook-Bezeichner ab oder legt sie fest.

eventType
eventType string

Eventtyp

entityIdentifier
entityIdentifier string

Dient zum Abrufen oder Festlegen des Entitätsbezeichners.

securityToken
securityToken string

Ruft das Sicherheitstoken ab oder legt es fest.

webHookUrl
webHookUrl string

Ruft die Web hook-URL ab oder legt sie fest.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die CreateWebHook-API dar.

WebHook löschen

Diese Aktion bietet die Möglichkeit, den Web-Hook zu löschen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
webHookId
webHookId uuid

Ruft den Web-Hook-Bezeichner ab oder legt sie fest.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die DeleteWebHook-API dar.

Workflowübergang ausführen

Diese Aktion bietet die Möglichkeit, Workflowübergangsspezifisch für den Workflow auszuführen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Arbeitsablauf
workflow True string

Workflowtyp

surveyId
surveyId integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

distributorId
distributorId integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

reminderId
reminderId integer

Dient zum Abrufen oder Festlegen des Erinnerungsbezeichners.

targetState
targetState True string

Dient zum Abrufen oder Festlegen des Status des Ziels.

dynamicParameters
dynamicParameters object

Ruft die dynamischen Parameter ab oder legt sie fest.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ExecuteWorkflowTransition-API dar.

Workflowübergänge lesen

Diese Aktion bietet die Möglichkeit, alle workflowspezifischen Übergänge für den Workflow zu lesen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Arbeitsablauf
workflow True string

Workflowtyp

currentState
currentState True string

Dient zum Abrufen oder Festlegen des Status des aktuellen.

Gibt zurück

Diese Klasse stellt die Rückgabeparameter für die ReadWorkflowTransitions-API dar.

Definitionen

Zugriffstyp

Zugriffstyp

Zugriffstyp

ActionElement

Diese Klasse stellt ein Ende der Umfrageaktion für "abgeschlossen/screenout/quota full" dar.This class represents an end of survey action for complete/screenout/quota full.

Name Pfad Typ Beschreibung
actionType
actionType ActionType

QuotaAction

endOfSurveyText
endOfSurveyText array of TranslationElement

Ruft das Ende des Umfragetexts ab oder legt es fest.

forwardUrl
forwardUrl array of TranslationElement

Ruft die Weiterleitungs-URL ab oder legt sie fest.

Aktionstyp

QuotaAction

QuotaAction

AnonymizingConfiguration

Diese Klasse enthält die Anonymisierungseinstellungen, die auf eine Arbeitsbereichsgruppe, einen Arbeitsbereich oder eine einzelne Umfrage angewendet werden können.

Name Pfad Typ Beschreibung
anonymizingMode
anonymizingMode AnonymizingMode

AnonymizingMode

logIp
logIp boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [log ip].

logUserAgent
logUserAgent boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Log User Agent].

logReferer
logReferer boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Log Referer].

AnonymizingMode

AnonymizingMode

AnonymizingMode

ApiCallMethod

ApiCallMethod

ApiCallMethod

ArrangementMode

ArrangementMode

ArrangementMode

BounceElement

Diese Klasse stellt ein Ende der Umfrageaktion für "abgeschlossen/screenout/quota full" dar.This class represents an end of survey action for complete/screenout/quota full.

Name Pfad Typ Beschreibung
distributorId
distributorId integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

interviewId
interviewId uuid

Dient zum Abrufen oder Festlegen des Interviewbezeichners.

panelId
panelId integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

panelMemberId
panelMemberId integer

Dient zum Abrufen oder Festlegen des Panelmitgliedsbezeichners.

bounceType
bounceType BounceType

BounceType

Zeitstempel
timestamp date-time

Ruft den Zeitstempel ab oder legt den Zeitstempel fest.

Staat
state string

Dient zum Abrufen oder Festlegen des Zustands.

Grund
reason string

Ruft den Grund ab oder legt diesen fest.

E-Mail
email string

Ruft die E-Mail ab oder legt sie fest.

phone
phone integer

Ruft das Telefon ab oder legt es fest.

invitationType
invitationType InvitationType

InvitationType

BounceType

BounceType

BounceType

Auswahl

Diese Klasse stellt eine einzelne Auswahl dar, die in jedem Auswahlfragetyp verwendet werden kann.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

Code
code string

Ruft den Code ab oder legt den Code fest.

codeManuallyChanged
codeManuallyChanged boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Code manuell geändert].

Text
text array of TranslationElement

Ruft die Textübersetzungen ab oder legt sie fest.

allowTextEntry
allowTextEntry boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Texteingabe zulassen].

forceInput
forceInput boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Eingabe erzwingen].

AutoVervollständigen
autocomplete boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob dieser Survalyzer.Contracts.Public.Elements.Choice autoVervollständigen ist.

autovervollständigenText
autocompleteText array of TranslationElement

Ruft die AutoVervollständigen-Textübersetzungen ab oder legt sie fest.

ausschließlich
exclusive boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Survalyzer.Contracts.Public.Elements.Choice exklusiv ist.

excludeFromRandomization
excludeFromRandomization boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [aus randomisierung ausgeschlossen].

contentValidation
contentValidation ContentValidation

Diese Klasse stellt eine Inhaltsüberprüfung innerhalb einer Umfrage dar.

condition
condition ConditionDefinition

Diese Klasse stellt die Definition von Bedingungselementen dar.

autocompleteListVariable
autocompleteListVariable string

Ruft die AutoVervollständigen-Listenvariable ab oder legt sie fest.

ChoiceType

ChoiceType

ChoiceType

CodeAccessMode

AuthenticationType

AuthenticationType

ColItem

Diese Klasse stellt eine Zelle einer Umfrageantwort dar.

Name Pfad Typ Beschreibung
id
id string

Dient zum Abrufen oder Festlegen des Bezeichners.

value
value

Dient zum Abrufen oder Festlegen des Werts.

ColumnGroup

Diese Klasse stellt eine Spaltengruppe innerhalb komplexer Fragetypen wie Matrixfragen dar.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

Text
text array of TranslationElement

Ruft die Textübersetzungen ab oder legt sie fest.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz nicht verfügbar ist.

notAvailableChoiceText
notAvailableChoiceText array of TranslationElement

Ruft die nicht verfügbaren Auswahltextübersetzungen ab oder legt sie fest.

randomizeColumns
randomizeColumns boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Randomize columns].

prompt
prompt array of TranslationElement

Ruft die Eingabeaufforderung ab oder legt sie fest.

choiceType
choiceType ChoiceType

ChoiceType

choices
choices array of Choice

Ruft die Auswahl ab oder legt sie fest.

condition
condition ConditionDefinition

Diese Klasse stellt die Definition von Bedingungselementen dar.

Spaltentyp

Spaltentyp

Spaltentyp

Zustand

Diese Klasse ist die Basis für alle Bedingungselemente.

Name Pfad Typ Beschreibung
Konjunktion
conjunction Conjunction

Konjunktion

Bedingungstyp
conditionType ConditionType

ConditionType

identifier
identifier string

Dient zum Abrufen oder Festlegen des Bezeichners.

conditionOperator
conditionOperator ConditionOperator

ConditionOperator

value
value string

Dient zum Abrufen oder Festlegen des Werts.

variableType
variableType VariableType

VariableType

jsonValue
jsonValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [json-Wert].

jsonPath
jsonPath string

Dient zum Abrufen oder Festlegen des JSON-Pfads.

ConditionAction

FilterAction

FilterAction

ConditionDefinition

Diese Klasse stellt die Definition von Bedingungselementen dar.

Name Pfad Typ Beschreibung
conditionAction
conditionAction ConditionAction

FilterAction

Elemente
elements array of Condition

Ruft die Elemente ab oder legt sie fest.

ConditionOperator

ConditionOperator

ConditionOperator

ConditionType

ConditionType

ConditionType

Konjunktion

Konjunktion

Konjunktion

ContentValidierung

Diese Klasse stellt eine Inhaltsüberprüfung innerhalb einer Umfrage dar.

Name Pfad Typ Beschreibung
validationType
validationType ContentValidationType

ContentValidierung

earliestDate
earliestDate string

Dient zum Abrufen oder Festlegen des frühesten Datums.

latestDate
latestDate string

Ruft das neueste Datum ab oder legt es fest.

minValue
minValue double

Dient zum Abrufen oder Festlegen des Minimalwerts.

maxValue
maxValue double

Dient zum Abrufen oder Festlegen des Maximalwerts.

Dezimalstellen
decimalPlaces integer

Dient zum Abrufen oder Festlegen der Dezimalstellen.

disableThousandSeparator
disableThousandSeparator boolean

Ruft das Tausendertrennzeichen ab, oder legt dieses fest.

ContentValidationType

ContentValidierung

ContentValidierung

CreateAndInviteMembersResponse

Diese Klasse stellt die Rückgabeparameter für die CreateAndInviteMembers-API dar.

Name Pfad Typ Beschreibung
samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

distributorId
distributorId integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

validationIssues
validationIssues array of WritePanelMemberIssue

Ruft die Probleme ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

CreateArtifactResponse

Diese Klasse stellt die Antwort der CreateArtifact-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

CreateMembersResponse

Diese Klasse stellt die Rückgabeparameter für die CreateMembers-API dar.

Name Pfad Typ Beschreibung
membersIds
membersIds array of integer

Ruft die Member-IDs ab oder legt sie fest.

validationIssues
validationIssues array of WritePanelMemberIssue

Ruft die Probleme ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

CreatePanelResponse

Diese Klasse stellt die Rückgabeparameter für die CreatePanel-API dar.

Name Pfad Typ Beschreibung
id
id integer

Rufen Sie die ID des erstellten Bereichs ab.

name
name string

Rufen Sie den Namen des erstellten Bereichs ab.

isExtendedPanel
isExtendedPanel boolean

Rufen Sie den Typ des erstellten Bereichs ab.

Erstellungsdatum
createdDate string

Rufen Sie das Erstellungsdatum des erstellten Panels ab.

isLock
isLock boolean

Rufen Sie den Wert ab, der angibt, ob der Bereich gesperrt ist.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

CreateSurveyResponse

Diese Klasse stellt die Rückgabeparameter für die CreateSurvey-API dar.

Name Pfad Typ Beschreibung
surveyId
surveyId integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

CreateWebHookResponse

Diese Klasse stellt die Rückgabeparameter für die CreateWebHook-API dar.

Name Pfad Typ Beschreibung
webHookId
webHookId uuid

Ruft den Web-Hook-Bezeichner ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

CustomVariable

Diese Klasse stellt eine einzelne benutzerdefinierte Variable dar.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

variableName
variableName string

Dient zum Abrufen oder Festlegen des Namens der Variablen.

variableType
variableType VariableType

VariableType

DataAccessControl

Diese Klasse enthält die Konfiguration, wie auf die Entität zugegriffen werden kann.

Name Pfad Typ Beschreibung
accessType
accessType AccessType

Zugriffstyp

conditions
conditions array of Condition

Ruft die Bedingungen ab oder legt sie fest.

DeleteArtifactResponse

Diese Klasse stellt die Rückgabeparameter für die DeleteArtifact-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

DeleteDistributorResponse

Diese Klasse stellt die Rückgabeparameter für die DeleteDistributor-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

DeleteInterviewResponse

Diese Klasse stellt die Rückgabeparameter für die DeleteInterview-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

DeleteMembersResponse

Diese Klasse stellt die Rückgabeparameter für die DeleteMember-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

DeletePanelResponse

Diese Klasse stellt die Rückgabeparameter für die DeleteSample-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

DeleteSamplingProjectResponse

Diese Klasse stellt die Rückgabeparameter für die DeleteSamplingProject-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

DeleteSurveyResponse

Diese Klasse stellt die Rückgabeparameter für die DeleteSurvey-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

DeleteWebHookResponse

Diese Klasse stellt die Rückgabeparameter für die DeleteWebHook-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

DesignConfiguration

Diese Klasse stellt die Formatierungsmöglichkeiten für ein Konto dar.

Name Pfad Typ Beschreibung
surveyDesignLayout
surveyDesignLayout integer

Ruft das Entwurfslayout der Umfrage ab oder legt es fest.

matrixSubQuestionSize
matrixSubQuestionSize MatrixSubQuestionSize

MatrixSubQuestionSize

textBlocks
textBlocks array of TextBlock

Dient zum Abrufen oder Festlegen des Inhalts der Vorlage.

DistributionChannel

Verteilungskanal

Verteilungskanal

DistributorElement

Diese Klasse stellt ein Verteilerelement dar.

Name Pfad Typ Beschreibung
distributorId
distributorId integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

distributionChannel
distributionChannel DistributionChannel

Verteilungskanal

surveyId
surveyId integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

surveyVersion
surveyVersion integer

Ruft die Umfrageversion ab oder legt sie fest.

panelId
panelId integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

scheduledDistribution
scheduledDistribution date-time

Ruft die geplante Verteilung ab oder legt sie fest.

executedDistribution
executedDistribution date-time

Ruft die ausgeführte Verteilung ab oder legt sie fest.

distributionState
distributionState string

Dient zum Abrufen oder Festlegen des Status der Verteilung.

conditions
conditions array of ConditionDefinition

Ruft die Bedingungen ab oder legt sie fest.

DownloadAnswersResponse

Diese Klasse stellt die Rückgabeparameter für die DownloadAnswers-API dar.

Name Pfad Typ Beschreibung
downloadUrl
downloadUrl string

Ruft die Download-URL ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ElementType

ElementType

ElementType

Eventtyp

Eventtyp

Eventtyp

ExecuteSendMailResponse

Diese Klasse stellt die Rückgabeparameter für die ExecuteSendMail-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ExecuteWorkflowTransitionResponse

Diese Klasse stellt die Rückgabeparameter für die ExecuteWorkflowTransition-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ExecutionBehavior

ExecutionBehavior

ExecutionBehavior

Gespräch

Diese Klasse stellt Interviewdaten dar.

Name Pfad Typ Beschreibung
id
id string

Die ID des Interviews

Staat
state string

Dient zum Abrufen oder Festlegen des Zustands.

surveyId
surveyId integer

Die ID der Umfrage

surveyVersionId
surveyVersionId integer

Die ID der Umfrageversion

surveyName
surveyName string

Der Name der Umfrage

surveyState
surveyState string

Dient zum Abrufen oder Festlegen des Status der Umfrage.

answersLink
answersLink string

Der Link zur Seite "Antworten drucken"

interviewLink
interviewLink string

Ruft den Interviewlink ab oder legt den Link fest.

startDate
startDate string

Ruft ab oder legt das Startdatum fest.

Enddatum
endDate string

Ruft das Enddatum ab oder legt es fest.

samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

distributorId
distributorId integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

InvitationType

InvitationType

InvitationType

InviteMembersResponse

Diese Klasse stellt die Rückgabeparameter für die InviteMembers-API dar.

Name Pfad Typ Beschreibung
samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

distributorId
distributorId integer

Dient zum Abrufen oder Festlegen des Verteilerbezeichners.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

MatrixSubQuestionSize

MatrixSubQuestionSize

MatrixSubQuestionSize

Mitglied

Diese Klasse stellt ein einzelnes Panelmitglied mit einer dynamischen Struktur dar, die auf dem Panel basiert.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

fields
fields object

Ruft die Felder ab oder legt sie fest.

ErstelltAm
createdAt date-time

Dient zum Abrufen oder Festlegen der erstellten Datei.

createdBy
createdBy string

Ruft ab oder legt die erstellte von.

updatedAt
updatedAt date-time

Ruft die aktualisierung ab oder legt diese fest.

aktualisiertvon
updatedBy string

Dient zum Abrufen oder Festlegen des aktualisierten Werts.

Interviews
interviews array of Interview

Ruft die Interviews ab oder legt sie fest.

MessageTemplateItem

Diese Klasse stellt ein Nachrichtenvorlagenelement dar.

Name Pfad Typ Beschreibung
id
id integer

Die ID der E-Mail-Nachricht

name
name string

Der Name der E-Mail-Nachricht

Inhalt
content string

Der Inhalt der E-Mail-Nachricht

subject
subject string

Der Betreff der E-Mail-Nachricht

defaultLocale
defaultLocale string

Das Standardgebietsschema der E-Mail-Nachricht

Locales
locales array of string

Die Liste der Gebietsschemas für diese E-Mail-Nachricht

MinMaxChoice

Diese Klasse stellt ein Min. Max Choice-Element innerhalb einer Umfrage dar.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

Code
code string

Ruft den Code ab oder legt den Code fest.

codeManuallyChanged
codeManuallyChanged boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Code manuell geändert].

leftText
leftText array of TranslationElement

Ruft die linken Textübersetzungen ab oder legt sie fest.

rightText
rightText array of TranslationElement

Ruft die richtigen Textübersetzungen ab oder legt sie fest.

excludeFromRandomization
excludeFromRandomization boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [aus randomisierung ausgeschlossen].

condition
condition ConditionDefinition

Diese Klasse stellt die Definition von Bedingungselementen dar.

OptOutItem

Diese Klasse stellt ein Opt-Out Element dar.

Name Pfad Typ Beschreibung
E-Mail
email string

Ruft die E-Mail ab oder legt sie fest.

phone
phone integer

Ruft das Telefon ab oder legt es fest.

optOutAt
optOutAt string

Ruft die Abmeldung ab, oder legt sie fest.

optOutBy
optOutBy string

Ruft ab oder legt die Abmeldung fest.

PanelDefinition

Diese Klasse enthält die vollständige Definition aller Felder, die in einem vom Kunden definierten Bereich enthalten sind.

Name Pfad Typ Beschreibung
Gruppen
groups array of VariableGroupElement

Ruft die Gruppen ab oder legt sie fest.

dataAccessControl
dataAccessControl DataAccessControl

Diese Klasse enthält die Konfiguration, wie auf die Entität zugegriffen werden kann.

PanelFieldItem

Diese Klasse stellt ein Panelfeld innerhalb eines Panels dar.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

name
name string

Ruft den Namen ab oder legt den Namen fest.

Anzeigename
displayName string

Dient zum Abrufen oder Festlegen des Anzeigenamens.

isSystem
isSystem boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz System ist.

obligatorisch
mandatory boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Survalyzer.Contracts.Public.Elements.PanelFieldItem obligatorisch ist.

anonymisieren
anonymize boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Survalyzer.Contracts.Public.Elements.PanelFieldItem anonymisiert ist.

validationExpression
validationExpression string

Dient zum Abrufen oder Festlegen des Gültigkeitsprüfungsausdrucks.

validationErrorMessageId
validationErrorMessageId string

Dient zum Abrufen oder Festlegen des Überprüfungsmeldungsbezeichners.

panelFieldType
panelFieldType VariableType

VariableType

metadata
metadata object

Ruft die Metadaten ab oder legt sie fest.

PanelIncentive

Diese Klasse stellt einen einzelnen Anreiz dar.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

name
name string

Ruft den Namen ab oder legt den Namen fest.

priceInCredits
priceInCredits integer

Ruft den Preis in Gutschriften ab oder legt den Preis fest.

Beschreibung
description string

Ruft die Beschreibung ab oder legt sie fest.

availableVouchersCount
availableVouchersCount integer

Ruft die Anzahl der verfügbaren Gutscheine ab oder legt sie fest.

PanelSyncBehaviour

PanelSyncBehaviour

PanelSyncBehaviour

PanelSyncElement

Diese Klasse stellt ein einzelnes Synchronisierungselement zwischen einer Umfrage und einem Panel dar.

Name Pfad Typ Beschreibung
identifier
identifier string

Dient zum Abrufen oder Festlegen des Bezeichners.

panelField
panelField string

Ruft das Panelfeld ab oder legt es fest.

ReadArtifactListRequest

Diese Klasse stellt die Anforderungsparameter für die ReadArtifactList-API dar.

Name Pfad Typ Beschreibung
Pfad
path string

Ruft den Pfad ab oder legt den Pfad fest.

workspaceId
workspaceId integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

ReadBounceListResponseV3

Diese Klasse stellt die Rückgabeparameter für die ReadBounceList-API dar.

Name Pfad Typ Beschreibung
Springt
bounces array of BounceElement

Ruft die Liste der Unzustellbarkeiten ab oder legt sie fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadCreditBalanceResponse

Diese Klasse stellt die Rückgabeparameter für die ReadCreditBalance-API dar.

Name Pfad Typ Beschreibung
Gleichgewicht
balance integer

Ruft den Saldo ab oder legt es fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadDistributorListResponse

Diese Klasse stellt die Rückgabeparameter für die ReadDistributorList-API dar.

Name Pfad Typ Beschreibung
Verteiler
distributors array of DistributorElement

Ruft die Händler ab oder legt sie fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadIncentiveListResponse

Diese Klasse stellt die Anforderungsparameter für die ReadIncentiveList-API dar.

Name Pfad Typ Beschreibung
panelIncentives
panelIncentives array of PanelIncentive

Ruft die Panelanreize ab oder legt sie fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadIncentiveTransactionListResponse

Diese Klasse stellt die Rückgabeparameter für die ReadIncentiveTransactionList-API dar.

Name Pfad Typ Beschreibung
incentiveTransactions
incentiveTransactions array of SurveyCreditLog

Ruft die Anreiztransaktionen ab oder legt sie fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadInterviewDataResponse

Diese Klasse stellt die Rückgabeparameter für die ReadInterviewData-API dar.

Name Pfad Typ Beschreibung
Antwortdaten
responseData object

Ruft die Antwortdaten ab oder legt sie fest.

surveyDefinition
surveyDefinition SurveyDefinition

Diese Klasse stellt die Definition einer Umfrage dar, die alle Metadaten und Einstellungen enthält.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadInterviewListCompactResponseV3

Diese Klasse stellt die Rückgabeparameter für die ReadInterviewListCompact-API dar.

Name Pfad Typ Beschreibung
surveyName
surveyName string

Ruft den Namen der Umfrage ab oder legt den Namen fest.

surveyDefaultLanguage
surveyDefaultLanguage string

Ruft die Standardsprache der Umfrage ab oder legt sie fest.

surveyLanguages
surveyLanguages array of string

Ruft die Umfragesprachen ab oder legt sie fest.

Interviews
interviews array of object

Ruft die Interviews ab oder legt sie fest.

items
interviews object
codePlan
codePlan array of SurveyMetadataItem

Ruft den Codeplan ab oder legt den Codeplan fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadInterviewListResponseV3

Diese Klasse stellt die Rückgabeparameter für die ReadInterviewList-API dar.

Name Pfad Typ Beschreibung
surveyName
surveyName string

Ruft den Namen der Umfrage ab oder legt den Namen fest.

surveyDefaultLanguage
surveyDefaultLanguage string

Ruft die Standardsprache der Umfrage ab oder legt sie fest.

surveyLanguages
surveyLanguages array of string

Ruft die Umfragesprachen ab oder legt sie fest.

codePlan
codePlan array of SurveyMetadataItem

Ruft den Codeplan ab oder legt den Codeplan fest.

Interviews
interviews array of Row

Ruft die Interviews ab oder legt sie fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadMemberListResponse

Diese Klasse stellt die Rückgabeparameter für die ReadMemberList-API dar.

Name Pfad Typ Beschreibung
members
members array of Member

Ruft die Panelmitglieder ab oder legt sie fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadMessageTemplateListResponse

Diese Klasse stellt die Rückgabeparameter für die ReadMessageTemplateList-API dar.

Name Pfad Typ Beschreibung
messageTemplates
messageTemplates array of MessageTemplateItem

Ruft die Nachrichtenvorlagen ab oder legt sie fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadOptOutListResponseV3

Diese Klasse stellt die Rückgabeparameter für die ReadOptOutList-API dar.

Name Pfad Typ Beschreibung
optOutItems
optOutItems array of OptOutItem

Ruft die Abmeldungselemente ab oder legt sie fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadPanelDefinitionResponse

Diese Klasse stellt die Rückgabeparameter für die ReadPanelDefinition-API dar.

Name Pfad Typ Beschreibung
Bereich
panel PanelDefinition

Diese Klasse enthält die vollständige Definition aller Felder, die in einem vom Kunden definierten Bereich enthalten sind.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadSamplingProjectResponse

Diese Klasse stellt die Rückgabeparameter für die ReadSamplingProject-API dar.

Name Pfad Typ Beschreibung
samplingProject
samplingProject SamplingProjectElement

Diese Klasse stellt ein Samplingprojekt dar.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadSurveyLinksResponse

Diese Klasse stellt die Antwort der ReadSurveyLinks-API dar.

Name Pfad Typ Beschreibung
anonymousList
anonymousList array of SurveyLink

Ruft die anonyme Liste ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadSurveyListResponse

Diese Klasse stellt die Antwortparameter für die ReadSurveyList-API dar.

Name Pfad Typ Beschreibung
befragungen
surveys array of SurveyListItem

Ruft die Umfragen ab oder legt sie fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadSurveyResponse

Diese Klasse stellt die Rückgabeparameter für die ReadSurveyDefinition-API dar.

Name Pfad Typ Beschreibung
surveyName
surveyName string

Ruft den Namen der Umfrage ab oder legt den Namen fest.

surveyVersion
surveyVersion integer

Ruft die Umfrageversion ab oder legt sie fest.

surveyState
surveyState string

Dient zum Abrufen oder Festlegen des Status der Umfrage.

ErstelltAm
createdAt string

Dient zum Abrufen oder Festlegen der erstellten Datei.

createdBy
createdBy string

Ruft ab oder legt die erstellte von.

Vermessung
survey SurveyDefinition

Diese Klasse stellt die Definition einer Umfrage dar, die alle Metadaten und Einstellungen enthält.

surveyConfiguration
surveyConfiguration SurveyConfiguration

Diese Klasse stellt die Umfragekonfiguration mit allen Einstellungen dar, die ein Benutzer konfigurieren kann.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadWebHookListResponse

Diese Klasse stellt die Rückgabeparameter für die ReadWebHookList-API dar.

Name Pfad Typ Beschreibung
webHooks
webHooks array of WebHookElement

Ruft die Web-Hooks ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadWorkflowTransitionsResponse

Diese Klasse stellt die Rückgabeparameter für die ReadWorkflowTransitions-API dar.

Name Pfad Typ Beschreibung
Übergänge
transitions array of WorkflowTransition

Ruft die Übergänge ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ReadWorkspaceListResponse

Diese Klasse stellt die Anforderungsparameter für die ReadWorkspaceList-API dar.

Name Pfad Typ Beschreibung
Arbeitsbereiche
workspaces array of WorkspaceDto

Ruft die Arbeitsbereiche ab oder legt sie fest.

totalCount
totalCount integer

Ruft die Gesamtanzahl ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

RedeemIncentiveCodeResponse

Diese Klasse stellt die Rückgabeparameter für die RedeemIncentiveCode-API dar.

Name Pfad Typ Beschreibung
voucherCode
voucherCode string

Ruft den Gutscheincode ab oder legt den Gutscheincode fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

RemindMembersResponse

Diese Klasse stellt die Rückgabeparameter für die RemindMembers-API dar.

Name Pfad Typ Beschreibung
reminderId
reminderId integer

Dient zum Abrufen oder Festlegen des Erinnerungsbezeichners.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ResetInterviewResponse

Diese Klasse stellt die Rückgabeparameter für die ResetInterview-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

Zeile

Diese Klasse stellt ein Zeilenelement dar.

Name Pfad Typ Beschreibung
columns
columns array of ColItem

Ruft die Spalten ab oder legt sie fest.

RowItem

Diese Klasse stellt eine Umfrageantwort dar.

Name Pfad Typ Beschreibung
id
id string

Dient zum Abrufen oder Festlegen des Bezeichners.

value
value string

Dient zum Abrufen oder Festlegen des Werts.

SamplingProjectElement

Diese Klasse stellt ein Samplingprojekt dar.

Name Pfad Typ Beschreibung
samplingProjectId
samplingProjectId integer

Dient zum Abrufen oder Festlegen des Samplingprojektbezeichners.

name
name string

Ruft den Namen ab oder legt den Namen fest.

workspaceId
workspaceId integer

Dient zum Abrufen oder Festlegen des Arbeitsbereichsbezeichners.

surveyId
surveyId integer

Dient zum Abrufen oder Festlegen des Umfragebezeichners.

surveyVersion
surveyVersion integer

Ruft die Umfrageversion ab oder legt sie fest.

panelId
panelId integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

samplingProviderId
samplingProviderId integer

Dient zum Abrufen oder Festlegen des Samplinganbieterbezeichners.

projectState
projectState string

Ruft den Status des Projekts ab oder legt den Status fest.

scheduledDistribution
scheduledDistribution string

Ruft die geplante Verteilung ab oder legt sie fest.

executedDistribution
executedDistribution string

Ruft die ausgeführte Verteilung ab oder legt sie fest.

conditions
conditions array of ConditionDefinition

Ruft die Bedingungen ab oder legt sie fest.

ScriptType

ScriptType

ScriptType

`Section`

Diese Klasse stellt einen Abschnitt innerhalb einer Umfrage dar.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

name
name string

Ruft den Namen ab oder legt den Namen fest.

randomizePages
randomizePages boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [randomize pages].

excludeFromRandomization
excludeFromRandomization boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [aus randomisierung ausgeschlossen].

Elemente
elements array of SurveyElement

Ruft die Elemente ab oder legt sie fest.

condition
condition ConditionDefinition

Diese Klasse stellt die Definition von Bedingungselementen dar.

SurveyConfiguration

Diese Klasse stellt die Umfragekonfiguration mit allen Einstellungen dar, die ein Benutzer konfigurieren kann.

Name Pfad Typ Beschreibung
designConfiguration
designConfiguration DesignConfiguration

Diese Klasse stellt die Formatierungsmöglichkeiten für ein Konto dar.

anonymizingConfiguration
anonymizingConfiguration AnonymizingConfiguration

Diese Klasse enthält die Anonymisierungseinstellungen, die auf eine Arbeitsbereichsgruppe, einen Arbeitsbereich oder eine einzelne Umfrage angewendet werden können.

SurveyCreditLog

Diese Klasse stellt eine einzelne Kredittransaktion dar.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

oldValue
oldValue string

Dient zum Abrufen oder Festlegen des alten Werts.

newValue
newValue string

Dient zum Abrufen oder Festlegen des neuen Werts.

Beschreibung
description string

Ruft die Beschreibung ab oder legt sie fest.

modifiedDate
modifiedDate string

Ruft das Änderungsdatum ab oder legt es fest.

modifiedBy
modifiedBy string

Dient zum Abrufen oder Festlegen des geänderten Werts.

responseId
responseId uuid

Dient zum Abrufen oder Festlegen des Antwortbezeichners.

interviewLink
interviewLink string

Ruft den Interviewlink ab oder legt den Link fest.

SurveyDefinition

Diese Klasse stellt die Definition einer Umfrage dar, die alle Metadaten und Einstellungen enthält.

Name Pfad Typ Beschreibung
allowMultipleParticipation
allowMultipleParticipation boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [mehrere Teilnahme zulassen].

allowNavigateBack
allowNavigateBack boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Navigation zurück zulassen].

allowSaveProgress
allowSaveProgress boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Speicherfortschritt zulassen].

randomizeSections
randomizeSections boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [randomize sections].

enableAutoScroll
enableAutoScroll boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [automatisches Scrollen aktivieren]

enableCodeAccess
enableCodeAccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Codezugriff aktivieren].

dataAccessControl
dataAccessControl DataAccessControl

Diese Klasse enthält die Konfiguration, wie auf die Entität zugegriffen werden kann.

associatedPanels
associatedPanels array of integer

Dient zum Abrufen oder Festlegen des Panelbezeichners.

codeAccessMode
codeAccessMode CodeAccessMode

AuthenticationType

enablePanelSync
enablePanelSync boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Panelsynchronisierung aktivieren].

panelSyncBehaviour
panelSyncBehaviour PanelSyncBehaviour

PanelSyncBehaviour

panelSyncs
panelSyncs array of PanelSyncElement

Ruft die Panelsynchronisierungen ab oder legt sie fest.

defaultLanguage
defaultLanguage string

Ruft die Standardsprache ab oder legt sie fest.

Enddatum
endDate date-time

Ruft das Enddatum ab oder legt es fest.

Sprachen
languages array of string

Ruft die Sprachen ab oder legt sie fest.

Abschnitte
sections array of Section

Ruft die Abschnitte ab oder legt sie fest.

customVariables
customVariables array of CustomVariable

Ruft die benutzerdefinierten Variablen ab oder legt sie fest.

surveyEndText
surveyEndText array of TranslationElement

Ruft den Endtext der Umfrage ab oder legt sie fest.

defaultTextOverrides
defaultTextOverrides object

Dient zum Abrufen oder Festlegen der Standardtextüberschreibungen.

SurveyElement

Diese Klasse stellt eine Umfrageelementdefinition mit allen Metadaten und Einstellungen dar.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

elementType
elementType ElementType

ElementType

Code
code string

Ruft den Code ab oder legt den Code fest.

codeManuallyChanged
codeManuallyChanged boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Code manuell geändert].

Text
text array of TranslationElement

Ruft die Textübersetzungen ab oder legt sie fest.

hintText
hintText array of TranslationElement

Ruft die Hint-Textübersetzungen ab oder legt sie fest.

hasHintText
hasHintText boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Hinweistext enthält.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz nicht verfügbar ist.

notAvailableChoiceText
notAvailableChoiceText array of TranslationElement

Ruft die nicht verfügbaren Auswahltextübersetzungen ab oder legt sie fest.

forceResponse
forceResponse boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Erzwingungsantwort].

choices
choices array of Choice

Ruft die Auswahl ab oder legt sie fest.

randomizeChoices
randomizeChoices boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [randomize choices].

columnType
columnType ColumnType

Spaltentyp

prompt
prompt array of TranslationElement

Ruft die Eingabeaufforderung ab oder legt sie fest.

minValue
minValue integer

Dient zum Abrufen oder Festlegen des Minimalwerts.

maxValue
maxValue integer

Dient zum Abrufen oder Festlegen des Maximalwerts.

showCenterLabel
showCenterLabel boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [mittlere Beschriftung anzeigen].

leftLabel
leftLabel array of TranslationElement

Ruft die linke Beschriftung ab oder legt sie fest.

centerLabel
centerLabel array of TranslationElement

Ruft die mittlere Beschriftung ab oder legt sie fest.

rightLabel
rightLabel array of TranslationElement

Ruft die richtige Beschriftung ab oder legt sie fest.

showValue
showValue boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Wert anzeigen].

maxDecimals
maxDecimals integer

Ruft die maximalen Ziffern nach komma ab oder legt diese fest.

textFieldSize
textFieldSize TextFieldSize

TextFieldSize

AutoVervollständigen
autocomplete boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob dieses Survalyzer.Contracts.Public.Elements.SurveyElement autovervollständigen ist.

autovervollständigenText
autocompleteText array of TranslationElement

Ruft die AutoVervollständigen-Textübersetzungen ab oder legt sie fest.

contentValidation
contentValidation ContentValidation

Diese Klasse stellt eine Inhaltsüberprüfung innerhalb einer Umfrage dar.

hasPlaceholder
hasPlaceholder boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Platzhalter hat.

Platzhalter
placeholder array of TranslationElement

Dient zum Abrufen oder Festlegen des Platzhalters.

isPassword
isPassword boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz ein Kennwort ist.

minMaxValidation
minMaxValidation boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [minimale maximale Gültigkeitsprüfung]

minimumCheckedChoices
minimumCheckedChoices integer

Ruft die minimal geprüften Auswahlmöglichkeiten ab, oder legt diese fest.

maximumCheckedChoices
maximumCheckedChoices integer

Ruft die maximalen aktivierten Auswahlmöglichkeiten ab oder legt sie fest.

columnGroups
columnGroups array of ColumnGroup

Ruft die Spaltengruppen ab oder legt sie fest.

randomizeRows
randomizeRows boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Zufällige Zeilen].

Zeilen
rows array of MinMaxChoice

Ruft die Zeilen ab oder legt sie fest.

numberOfRanks
numberOfRanks integer

Ruft die Anzahl der Rangfolgen ab oder legt sie fest.

likeText
likeText array of TranslationElement

Ruft die ähnlichen Textübersetzungen ab oder legt diese fest.

nichtlikeText
dislikeText array of TranslationElement

Ruft die Abneigung von Textübersetzungen ab oder legt sie fest.

hasStartText
hasStartText boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Starttext hat.

startText
startText array of TranslationElement

Ruft den Anfangstext ab oder legt den Text fest.

enableMeasurement
enableMeasurement boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Maß aktivieren].

showButtons
showButtons boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Schaltflächen anzeigen].

likeKey
likeKey string

Dient zum Abrufen oder Festlegen des ähnlichen Schlüssels.

nicht gefälltKey
dislikeKey string

Dient zum Abrufen oder Festlegen der Abgleichstaste.

interviewState
interviewState string

Dient zum Abrufen oder Festlegen des Status der Antwort.

Handlung
action ActionElement

Diese Klasse stellt ein Ende der Umfrageaktion für "abgeschlossen/screenout/quota full" dar.This class represents an end of survey action for complete/screenout/quota full.

from
from string

Ruft den Absender ab oder legt den Absender fest.

zu
to string

Dient zum Abrufen oder Festlegen des Empfängers.

subject
subject array of TranslationElement

Ruft die Betreffübersetzungen ab oder legt sie fest.

message
message array of TranslationElement

Ruft die Nachrichtenübersetzungen ab oder legt sie fest.

valueAssignmentType
valueAssignmentType ValueAssignmentType

ValueAssignmentType

variableName
variableName string

Dient zum Abrufen oder Festlegen des Namens der Variablen.

functionTerm
functionTerm array of TranslationElement

Dient zum Abrufen oder Festlegen des Funktionsausdrucks.

executionBehavior
executionBehavior ExecutionBehavior

ExecutionBehavior

apiCallMethod
apiCallMethod ApiCallMethod

ApiCallMethod

URL
url array of TranslationElement

Ruft die URL ab oder legt sie fest.

headers
headers string

Ruft die Kopfzeilen ab oder legt sie fest.

body
body array of TranslationElement

Ruft den Text ab oder legt den Text fest.

externalUri
externalUri string

Dient zum Abrufen oder Festlegen des externen URI.

scriptType
scriptType ScriptType

ScriptType

Inhalt
content string

Ruft den Inhalt ab oder legt den Inhalt fest.

hasRatingLabels
hasRatingLabels boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz Bewertungsbezeichnungen enthält.

leftRatingLabel
leftRatingLabel array of TranslationElement

Ruft die linke Bewertungsbezeichnung ab oder legt sie fest.

rightRatingLabel
rightRatingLabel array of TranslationElement

Ruft die richtige Bewertungsbezeichnung ab oder legt sie fest.

condition
condition ConditionDefinition

Diese Klasse stellt die Definition von Bedingungselementen dar.

evaluateAsJson
evaluateAsJson boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [als json ausgewertet].

autocompleteListVariable
autocompleteListVariable string

Ruft die AutoVervollständigen-Listenvariable ab oder legt sie fest.

arrangementMode
arrangementMode ArrangementMode

ArrangementMode

enableAnimation
enableAnimation boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Animation aktivieren].

useSmiley
useSmiley boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob [Smiley verwenden].

hasPrompt
hasPrompt boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz eine Eingabeaufforderung hat.

Die SurveyLink-Entität

Name Pfad Typ Beschreibung
URL
url string

Ruft die URL ab oder legt sie fest.

isCustom
isCustom boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz benutzerdefiniert ist.

language
language string

Ruft die Sprache ab oder legt sie fest.

SurveyListItem

Diese Klasse stellt ein einzelnes Umfrageelement dar.

Name Pfad Typ Beschreibung
id
id integer

Die ID der Umfrage

name
name string

Der Name der Umfrage

modifiedDate
modifiedDate string

Das Änderungsdatum der Umfrage

Enddatum
endDate string

Das Datum, an dem die Umfrage endet

isEndDateEnabled
isEndDateEnabled boolean

Wenn das Enddatum für diese Umfrage aktiviert ist

status
status SurveyStatus

SurveyStatus

archiveDate
archiveDate string

Das Datum, an dem die Umfrage archiviert wurde

statusOn
statusOn boolean

Ist die Umfrage aktiviert oder deaktiviert

answers
answers integer

Ruft die Antworten ab oder legt sie fest.

SurveyMetadataItem

Diese Klasse stellt ein einzelnes Metadatenelement dar.

Name Pfad Typ Beschreibung
Code
code string

Ruft den Code ab oder legt den Code fest.

Datentyp
dataType string

Dient zum Abrufen oder Festlegen des Datentyps.

questionCode
questionCode string

Ruft den Fragecode ab oder legt den Fragecode fest.

type
type string

Dient zum Abrufen oder Festlegen des Typs.

Frage
question string

Ruft die Frage ab oder legt sie fest.

rudern
row string

Ruft die Zeile ab oder legt sie fest.

choice
choice string

Ruft die Auswahl ab oder legt sie fest.

values
values array of RowItem

Ruft die Werte ab oder legt sie fest.

sectionName
sectionName string

Dient zum Abrufen oder Festlegen des Abschnittsnamens.

SurveyStatus

SurveyStatus

SurveyStatus

TextBlock

TextBlock

Name Pfad Typ Beschreibung
name
name string

Ruft den Namen ab oder legt den Namen fest.

type
type string

Dient zum Abrufen oder Festlegen des Typs.

Text
text array of TranslationElement

Ruft den Text ab oder legt den Text fest.

TextFieldSize

TextFieldSize

TextFieldSize

TranslationElement

Diese Klasse stellt eine Textübersetzung innerhalb einer Umfrage dar.

Name Pfad Typ Beschreibung
languageCode
languageCode string

Dient zum Abrufen oder Festlegen des Sprachcodes.

Text
text string

Ruft den Text ab oder legt den Text fest.

UpdateMembersResponse

Diese Klasse stellt die Rückgabeparameter für die UpdateMembers-API dar.

Name Pfad Typ Beschreibung
validationIssues
validationIssues array of WritePanelMemberIssue

Ruft die Probleme ab oder legt sie fest.

isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

UpdateSurveyResponse

Diese Klasse stellt die Rückgabeparameter für die UpdateSurvey-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

UpdateWebHookResponse

Diese Klasse stellt die Rückgabeparameter für die CreateWebHook-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

ValueAssignmentType

ValueAssignmentType

ValueAssignmentType

VariableGroupElement

Diese Klasse stellt eine Gruppe von Feldern in einem Panel dar.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

name
name string

Ruft den Namen ab oder legt den Namen fest.

Anzeigename
displayName string

Dient zum Abrufen oder Festlegen des Anzeigenamens.

fields
fields array of PanelFieldItem

Ruft die Felder ab oder legt sie fest.

VariableType

VariableType

VariableType

WebHookElement

Diese Klasse stellt einen einzelnen WebHook dar.

Name Pfad Typ Beschreibung
id
id uuid

Dient zum Abrufen oder Festlegen des Bezeichners.

eventType
eventType EventType

Eventtyp

entityIdentifier
entityIdentifier string

Dient zum Abrufen oder Festlegen des Entitätsbezeichners.

ErstelltAm
createdAt date-time

Dient zum Abrufen oder Festlegen der erstellten Datei.

createdBy
createdBy string

Ruft ab oder legt die erstellte von.

updatedAt
updatedAt date-time

Ruft die aktualisierung ab oder legt diese fest.

aktualisiertvon
updatedBy string

Dient zum Abrufen oder Festlegen des aktualisierten Werts.

WorkflowTransition

Diese Klasse stellt einen Übergang von einem Zustand zu einem anderen dar.

Name Pfad Typ Beschreibung
name
name string

Ruft den Namen ab oder legt den Namen fest.

Handlung
action string

Dient zum Abrufen oder Festlegen des Namens der Aktion.

newState
newState string

Erstellt einen neuen Zustand.

condition
condition string

Ruft die Bedingung ab oder legt sie fest.

WorkspaceDto

Diese Klasse stellt eine Arbeitsbereichsentität dar.

Name Pfad Typ Beschreibung
id
id integer

Dient zum Abrufen oder Festlegen des Bezeichners.

name
name string

Ruft den Namen ab oder legt den Namen fest.

numberOfSurveys
numberOfSurveys integer

Ruft die Anzahl der Umfragen ab oder legt sie fest.

WriteOptOutListResponse

Diese Klasse stellt die Rückgabeparameter für die WriteOptOutList-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

WritePanelMemberIssue

Stellen Sie ein Problem dar, das angezeigt werden kann

Name Pfad Typ Beschreibung
Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

WritePanelResponse

Diese Klasse stellt die Rückgabeparameter für die WritePanel-API dar.

Name Pfad Typ Beschreibung
isSuccess
isSuccess boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Instanz erfolgreich ist.

errorMessage
errorMessage string

Ruft die Fehlermeldung ab oder legt sie fest.

Fehlercode
errorCode string

Ruft den Fehlercode ab oder legt ihn fest.