Partager via


Survalyzer EU (préversion)

Le connecteur Survalyzer offre un accès simplifié à toutes les fonctionnalités d’API du centre de données de l’UE.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Centre de développement Survalyzer
URL https://developer.survalyzer.com/
Métadonnées du connecteur
Éditeur Survalyzer AG
Website https://survalyzer.com
Politique de confidentialité https://survalyzer.com/privacy-policy
Catégories Marketing; Productivité

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :

Par défaut Paramètres de création de connexion. Toutes les régions Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application Power est partagée avec un autre utilisateur, un autre utilisateur sera invité à créer explicitement une nouvelle connexion.

Nom Type Descriptif Obligatoire
ID client - Votre ClientId Survalyzer ficelle Entrez l’ID client. Vrai
Clé secrète client - Votre ClientSecret Survalyzer securestring Entrez la clé secrète client. Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Créer des membres

Cette action offre la possibilité de créer la liste des membres.

Créer un artefact

Cette action offre la possibilité de créer un artefact.

Créer un panneau ou un exemple

Cette action offre la possibilité de créer un panneau.

Créer un webHook

Cette action offre la possibilité de créer le web hook.

Créer une enquête

Cette action offre la possibilité de créer une enquête.

Envoyer un courrier électronique

Cette action offre la possibilité d’envoyer du courrier électronique.

Exécuter la transition de flux de travail

Cette action offre la possibilité d’exécuter la transition de flux de travail spécifique au flux de travail.

Inviter des membres

Cette action offre la possibilité d’inviter le membre.

Inviter des membres

Cette action offre la possibilité de créer et d’inviter des membres.

Lire interview Compact

Cette action offre la possibilité de lire la liste d’entrevues compact.

Lire le projet d’échantillonnage

Cette action offre la possibilité de lire le projet d’échantillonnage.

Lire le solde du crédit

Cette action retourne le solde du crédit d’enquête pour l’utilisateur authentifié.

Lire les artefacts

Cette action offre la possibilité de lire la liste des artefacts.

Lire les distributeurs

Cette action offre la possibilité de lire la liste des serveurs de distribution.

Lire les enquêtes

Cette action offre la possibilité de lire toutes les enquêtes disponibles d’un espace de travail donné.

Lire les entrevues

Cette action offre la possibilité de lire la liste des entrevues.

Lire les espaces de travail

Cette action offre la possibilité de lire tous les espaces de travail disponibles.

Lire les incentives

Cette action retourne les primes incitatives/bons disponibles pour l’utilisateur authentifié.

Lire les liens d’enquête

Cette action offre la possibilité de lire les liens d’enquête.

Lire les membres

Cette action offre la possibilité de lire des membres.

Lire les modèles de messages

Cette action offre la possibilité de recevoir tous les modèles de message configurés pour e-mail et SMS.

Lire les rebonds

Cette action offre la possibilité de lire la liste de rebonds.

Lire les transactions incitatives

L’action retourne une vue d’ensemble de tous les revenus et dépenses liés aux crédits d’enquête.

Lire les transitions de flux de travail

Cette action offre la possibilité de lire toutes les transitions de flux de travail spécifiques au flux de travail.

Lire les WebHooks

Cette action offre la possibilité de lire la liste de crochets web.

Lire l’enquête

Cette action offre la possibilité de lire l’enquête.

Lire l’entrevue

Cette action offre la possibilité de lire les données d’entrevue.

Lire Opt-Outs

Cette action offre la possibilité de lire toutes les Opt-Outs d’un espace de travail.

Mettre à jour les membres

Cette action offre la possibilité de mettre à jour la liste des membres.

Mettre à jour l’enquête

Cette action offre la possibilité de mettre à jour l’enquête.

Mettre à jour Opt-Outs

Cette action offre la possibilité d’écrire des entrées dans la liste Opt-Out pour un espace de travail.

Mettre à jour web Hook

Cette action offre la possibilité de mettre à jour le web hook.

Panneau de lecture

Cette action offre la possibilité de lire la définition du panneau.

Panneau de mise à jour

Cette action offre la possibilité de mettre à jour le panneau.

Panneau Supprimer

Cette action offre la possibilité de supprimer le panneau.

Rappeler aux membres

Cette action offre la possibilité de rappeler au membre.

Réinitialiser l’entrevue

Cette action offre la possibilité de réinitialiser la réponse des membres du panneau.

Supprimer des membres

Cette action offre la possibilité de supprimer des membres.

Supprimer le projet d’échantillonnage

Cette action offre la possibilité de supprimer le projet d’échantillonnage.

Supprimer le serveur de distribution

Cette action offre la possibilité de supprimer le serveur de distribution.

Supprimer le WebHook

Cette action offre la possibilité de supprimer le web hook.

Supprimer l’enquête

Cette action offre la possibilité de supprimer l’enquête.

Supprimer l’entrevue

Cette action offre la possibilité de supprimer l’entrevue.

Supprimer un artefact

Cette action offre la possibilité de supprimer l’artefact.

Télécharger le PDF d’entrevue

Cette action offre la possibilité de télécharger les réponses.

Échanger le code d’incentive

Cette action offre la possibilité de dépenser des crédits d’enquête pour les primes incitatives/bons.

Créer des membres

Cette action offre la possibilité de créer la liste des membres.

Paramètres

Nom Clé Obligatoire Type Description
tenant
tenant string

Obtient ou définit le locataire.

panelId
panelId True integer

Obtient ou définit l’identificateur du panneau.

pièce d'identité
id integer

Obtient ou définit l’identificateur.

fields
fields True object

Obtient ou définit les champs.

createdAt
createdAt date-time

Obtient ou définit le fichier créé à l’adresse.

createdBy
createdBy string

Obtient ou définit le jeu créé par.

updatedAt
updatedAt date-time

Obtient ou définit la mise à jour à l’adresse.

mis à jourPar
updatedBy string

Obtient ou définit la mise à jour par.

pièce d'identité
id string

ID de l’entrevue

état
state string

Obtient ou définit l’état.

surveyId
surveyId integer

ID de l’enquête

surveyVersionId
surveyVersionId integer

ID de la version de l’enquête

surveyName
surveyName string

Nom de l’enquête

surveyState
surveyState string

Obtient ou définit l’état de l’enquête.

answersLink
answersLink string

Lien vers la page d’impression des réponses

interviewLink
interviewLink string

Obtient ou définit le lien d’entrevue.

date de début
startDate string

Obtient ou définit la date de début.

date de fin
endDate string

Obtient ou définit la date de fin.

samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

distributorId
distributorId integer

Obtient ou définit l’identificateur du serveur de distribution.

Retours

Cette classe représente les paramètres de retour de l’API CreateMembers.

Créer un artefact

Cette action offre la possibilité de créer un artefact.

Paramètres

Nom Clé Obligatoire Type Description
workspaceId
workspaceId integer

Obtient ou définit l’identificateur de l’espace de travail.

path
path string

Obtient ou définit le chemin d’accès.

Retours

Cette classe représente la réponse de l’API CreateArtifact.

Créer un panneau ou un exemple

Cette action offre la possibilité de créer un panneau.

Paramètres

Nom Clé Obligatoire Type Description
workspaceId
workspaceId True integer

Obtient ou définit l’identificateur de l’espace de travail.

nom
name True string

Obtient ou définit le nom du panneau.

panelType
panelType True string

PanelModelType

Retours

Cette classe représente les paramètres de retour de l’API CreatePanel.

Créer un webHook

Cette action offre la possibilité de créer le web hook.

Paramètres

Nom Clé Obligatoire Type Description
eventType
eventType string

EventType

entityIdentifier
entityIdentifier string

Obtient ou définit l’identificateur d’entité.

securityToken
securityToken string

Obtient ou définit le jeton de sécurité.

webHookUrl
webHookUrl string

Obtient ou définit l’URL du hook web.

Retours

Cette classe représente les paramètres de retour de l’API CreateWebHook.

Créer une enquête

Cette action offre la possibilité de créer une enquête.

Paramètres

Nom Clé Obligatoire Type Description
workspaceId
workspaceId True integer

Obtient ou définit l’identificateur de l’espace de travail.

nom
name True string

Obtient ou définit le nom.

allowMultipleParticipation
allowMultipleParticipation True boolean

Obtient ou définit une valeur indiquant si [autoriser plusieurs participations].

allowNavigateBack
allowNavigateBack True boolean

Obtient ou définit une valeur indiquant si [autoriser la navigation vers l’arrière].

allowSaveProgress
allowSaveProgress boolean

Obtient ou définit une valeur indiquant si [autoriser la progression de l’enregistrement].

randomSections
randomizeSections True boolean

Obtient ou définit une valeur indiquant si [sections aléatoires].

enableAutoScroll
enableAutoScroll boolean

Obtient ou définit une valeur indiquant si [activer le défilement automatique].

enableCodeAccess
enableCodeAccess boolean

Obtient ou définit une valeur indiquant si [activer l’accès au code].

accessType
accessType string

Type d'accès

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

associatedPanels
associatedPanels array of integer

Obtient ou définit l’identificateur du panneau.

codeAccessMode
codeAccessMode True string

Élément AuthenticationType

enablePanelSync
enablePanelSync boolean

Obtient ou définit une valeur indiquant si [activer la synchronisation du panneau].

panelSyncBehaviour
panelSyncBehaviour string

PanelSyncBehaviour

identifier
identifier string

Obtient ou définit l’identificateur.

panelField
panelField string

Obtient ou définit le champ du panneau.

defaultLanguage
defaultLanguage True string

Obtient ou définit la langue par défaut.

date de fin
endDate date-time

Obtient ou définit la date de fin.

langues
languages True array of string

Obtient ou définit les langues.

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

nom
name True string

Obtient ou définit le nom.

randomPages
randomizePages True boolean

Obtient ou définit une valeur indiquant si [pages aléatoires].

excludeFromRandomization
excludeFromRandomization True boolean

Obtient ou définit une valeur indiquant si [exclure de la randomisation].

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

elementType
elementType True string

ElementType

code
code string

Obtient ou définit le code.

codeManuallyChanged
codeManuallyChanged boolean

Obtient ou définit une valeur indiquant si [code modifié manuellement].

languageCode
languageCode True string

Obtient ou définit le code de langue.

texte
text string

Obtient ou définit le texte.

hasHintText
hasHintText boolean

Obtient ou définit une valeur indiquant si cette instance a du texte d’indicateur.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Obtient ou définit une valeur indiquant si cette instance n’a pas le choix disponible.

forceResponse
forceResponse boolean

Obtient ou définit une valeur indiquant si [force response].

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

code
code True string

Obtient ou définit le code.

codeManuallyChanged
codeManuallyChanged boolean

Obtient ou définit une valeur indiquant si [code modifié manuellement].

allowTextEntry
allowTextEntry True boolean

Obtient ou définit une valeur indiquant si [autoriser l’entrée de texte].

forceInput
forceInput True boolean

Obtient ou définit une valeur indiquant si [force input].

saisie semi-automatique
autocomplete True boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.Choice est autocomplétion.

exclusif
exclusive True boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.Choice est exclusif.

excludeFromRandomization
excludeFromRandomization boolean

Obtient ou définit une valeur indiquant si [exclure de la randomisation].

validationType
validationType True string

ContentValidation

earliestDate
earliestDate string

Obtient ou définit la date la plus ancienne.

latestDate
latestDate string

Obtient ou définit la date la plus récente.

minValue
minValue double

Obtient ou définit la valeur minimale.

maxValue
maxValue double

Obtient ou définit la valeur maximale.

Décimales
decimalPlaces integer

Obtient ou définit les décimales.

disableThousandSeparator
disableThousandSeparator boolean

Obtient ou définit le séparateur de milliers de désactivation.

conditionAction
conditionAction True string

FilterAction

autocompleteListVariable
autocompleteListVariable string

Obtient ou définit la variable de liste de saisie semi-automatique.

randomChoices
randomizeChoices boolean

Obtient ou définit une valeur indiquant si [choix aléatoires].

columnType
columnType string

ColumnType

minValue
minValue integer

Obtient ou définit la valeur minimale.

maxValue
maxValue integer

Obtient ou définit la valeur maximale.

showCenterLabel
showCenterLabel boolean

Obtient ou définit une valeur indiquant si [show center label].

showValue
showValue boolean

Obtient ou définit une valeur indiquant si [show value].

maxDecimals
maxDecimals integer

Obtient ou définit les chiffres maximum après la virgule.

textFieldSize
textFieldSize string

TextFieldSize

saisie semi-automatique
autocomplete boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.SurveyElement est autocomplétion.

hasPlaceholder
hasPlaceholder boolean

Obtient ou définit une valeur indiquant si cette instance a un espace réservé.

isPassword
isPassword boolean

Obtient ou définit une valeur indiquant si cette instance est un mot de passe.

minMaxValidation
minMaxValidation boolean

Obtient ou définit une valeur indiquant si [validation maximale minimale].

minimumCheckedChoices
minimumCheckedChoices integer

Obtient ou définit les choix vérifiés minimum.

maximumCheckedChoices
maximumCheckedChoices integer

Obtient ou définit les choix activés maximum.

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

hasNotAvailableChoice
hasNotAvailableChoice True boolean

Obtient ou définit une valeur indiquant si cette instance n’a pas le choix disponible.

randomColumns
randomizeColumns True boolean

Obtient ou définit une valeur indiquant si [colonnes aléatoires].

choiceType
choiceType True string

ChoiceType

randomRows
randomizeRows boolean

Obtient ou définit une valeur indiquant si [lignes aléatoires].

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

code
code True string

Obtient ou définit le code.

codeManuallyChanged
codeManuallyChanged boolean

Obtient ou définit une valeur indiquant si [code modifié manuellement].

excludeFromRandomization
excludeFromRandomization True boolean

Obtient ou définit une valeur indiquant si [exclure de la randomisation].

numberOfRanks
numberOfRanks integer

Obtient ou définit le nombre de rangs.

hasStartText
hasStartText boolean

Obtient ou définit une valeur indiquant si cette instance a du texte de début.

enableMeasurement
enableMeasurement boolean

Obtient ou définit une valeur indiquant si [activer la mesure].

showButtons
showButtons boolean

Obtient ou définit une valeur indiquant si [afficher les boutons].

likeKey
likeKey string

Obtient ou définit la clé semblable.

dislikeKey
dislikeKey string

Obtient ou définit la clé dislike.

interviewState
interviewState string

Obtient ou définit l’état de la réponse.

actionType
actionType True string

QuotaAction

de
from string

Obtient ou définit l’expéditeur.

à
to string

Obtient ou définit le récepteur.

valueAssignmentType
valueAssignmentType string

ValueAssignmentType

variableName
variableName string

Obtient ou définit le nom de la variable.

executionBehavior
executionBehavior string

ExecutionBehavior

apiCallMethod
apiCallMethod string

ApiCallMethod

headers
headers string

Obtient ou définit les en-têtes.

externalUri
externalUri string

Obtient ou définit l’URI externe.

scriptType
scriptType string

ScriptType

contenu
content string

Obtient ou définit le contenu.

hasRatingLabels
hasRatingLabels boolean

Obtient ou définit une valeur indiquant si cette instance a des étiquettes d’évaluation.

evaluateAsJson
evaluateAsJson boolean

Obtient ou définit une valeur indiquant si [évaluer en tant que json].

autocompleteListVariable
autocompleteListVariable string

Obtient ou définit la variable de liste de saisie semi-automatique.

arrangementMode
arrangementMode string

ArrangementMode

enableAnimation
enableAnimation boolean

Obtient ou définit une valeur indiquant si [activer l’animation].

useSmiley
useSmiley boolean

Obtient ou définit une valeur indiquant si [utiliser smiley].

hasPrompt
hasPrompt boolean

Obtient ou définit une valeur indiquant si cette instance a une invite.

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

variableName
variableName True string

Obtient ou définit le nom de la variable.

defaultTextOverrides
defaultTextOverrides object

Obtient ou définit les remplacements de texte par défaut.

surveyDesignLayout
surveyDesignLayout integer

Obtient ou définit la disposition de conception de l’enquête.

matrixSubQuestionSize
matrixSubQuestionSize string

MatrixSubQuestionSize

nom
name string

Obtient ou définit le nom.

type
type string

Obtient ou définit le type.

languageCode
languageCode True string

Obtient ou définit le code de langue.

texte
text string

Obtient ou définit le texte.

anonymisingMode
anonymizingMode True string

AnonymisationMode

logIp
logIp True boolean

Obtient ou définit une valeur indiquant si [log ip].

logUserAgent
logUserAgent True boolean

Obtient ou définit une valeur indiquant si [agent utilisateur du journal].

logReferer
logReferer True boolean

Obtient ou définit une valeur indiquant si [log referer].

Retours

Cette classe représente les paramètres de retour de l’API CreateSurvey.

Envoyer un courrier électronique

Cette action offre la possibilité d’envoyer du courrier électronique.

Paramètres

Nom Clé Obligatoire Type Description
messageTemplateId
messageTemplateId integer

Obtient ou définit l’identificateur du modèle de message.

nom
name string

Obtient ou définit le nom.

type
type string

Obtient ou définit le type.

languageCode
languageCode True string

Obtient ou définit le code de langue.

texte
text string

Obtient ou définit le texte.

language
language True string

Obtient ou définit la langue.

Objet
subject string

Obtient ou définit l’objet.

body
body string

Obtient ou définit le corps.

de
from True string

Obtient ou définit à partir de.

fromName
fromName string

Obtient ou définit le nom.

à
to True string

Obtient ou définit la valeur à.

toName
toName string

Convertit en nom.

replyTo
replyTo string

Obtient ou définit la réponse à.

replyToName
replyToName string

Obtient ou définit le nom de la réponse à.

Retours

Cette classe représente les paramètres de retour de l’API ExecuteSendMail.

Exécuter la transition de flux de travail

Cette action offre la possibilité d’exécuter la transition de flux de travail spécifique au flux de travail.

Paramètres

Nom Clé Obligatoire Type Description
flux de travail
workflow True string

Type de flux de travail

surveyId
surveyId integer

Obtient ou définit l’identificateur d’enquête.

samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

distributorId
distributorId integer

Obtient ou définit l’identificateur du serveur de distribution.

reminderId
reminderId integer

Obtient ou définit l’identificateur de rappel.

targetState
targetState True string

Obtient ou définit l’état de la cible.

dynamicParameters
dynamicParameters object

Obtient ou définit les paramètres dynamiques.

Retours

Cette classe représente les paramètres de retour de l’API ExecuteWorkflowTransition.

Inviter des membres

Cette action offre la possibilité d’inviter le membre.

Paramètres

Nom Clé Obligatoire Type Description
surveyId
surveyId True integer

ID de l’enquête

panelId
panelId True integer

Obtient ou définit l’identificateur du panneau.

samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

memberIds
memberIds array of integer

Obtient ou définit les ID des membres du panneau.

messageTemplateId
messageTemplateId True integer

Obtient ou définit l’identificateur du modèle de message.

nom
name string

Obtient ou définit le nom.

type
type string

Obtient ou définit le type.

languageCode
languageCode True string

Obtient ou définit le code de langue.

texte
text string

Obtient ou définit le texte.

scheduleDateTime
scheduleDateTime date-time

Obtient ou définit l’heure de planification.

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

chaîne
channel string

Canal de distribution

asyncProcess
asyncProcess boolean

Obtient ou définit le processus asynchrone.

interviewExpiryDate
interviewExpiryDate string

Obtient ou définit la date d’expiration de l’entrevue.

de
from string

Obtient ou définit à partir de.

fromName
fromName string

Obtient ou définit le nom.

replyTo
replyTo string

Obtient ou définit la réponse à.

replyToName
replyToName string

Obtient ou définit le nom de la réponse à.

Retours

Cette classe représente les paramètres de retour de l’API InviteMembers.

Inviter des membres

Cette action offre la possibilité de créer et d’inviter des membres.

Paramètres

Nom Clé Obligatoire Type Description
samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

surveyId
surveyId True integer

Obtient ou définit l’identificateur d’enquête.

panelId
panelId True integer

Obtient ou définit l’identificateur du panneau.

chaîne
channel True string

Canal de distribution

messageTemplateId
messageTemplateId True integer

Obtient ou définit l’identificateur du modèle de message.

nom
name string

Obtient ou définit le nom.

type
type string

Obtient ou définit le type.

languageCode
languageCode True string

Obtient ou définit le code de langue.

texte
text string

Obtient ou définit le texte.

pièce d'identité
id integer

Obtient ou définit l’identificateur.

fields
fields True object

Obtient ou définit les champs.

createdAt
createdAt date-time

Obtient ou définit le fichier créé à l’adresse.

createdBy
createdBy string

Obtient ou définit le jeu créé par.

updatedAt
updatedAt date-time

Obtient ou définit la mise à jour à l’adresse.

mis à jourPar
updatedBy string

Obtient ou définit la mise à jour par.

pièce d'identité
id string

ID de l’entrevue

état
state string

Obtient ou définit l’état.

surveyId
surveyId integer

ID de l’enquête

surveyVersionId
surveyVersionId integer

ID de la version de l’enquête

surveyName
surveyName string

Nom de l’enquête

surveyState
surveyState string

Obtient ou définit l’état de l’enquête.

answersLink
answersLink string

Lien vers la page d’impression des réponses

interviewLink
interviewLink string

Obtient ou définit le lien d’entrevue.

date de début
startDate string

Obtient ou définit la date de début.

date de fin
endDate string

Obtient ou définit la date de fin.

samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

distributorId
distributorId integer

Obtient ou définit l’identificateur du serveur de distribution.

scheduleDateTime
scheduleDateTime string

Obtient ou définit l’heure de la date de planification.

asyncProcess
asyncProcess boolean

Obtient ou définit le processus asynchrone.

interviewExpiryDate
interviewExpiryDate string

Obtient ou définit la date d’expiration de l’entrevue.

de
from string

Obtient ou définit à partir de.

fromName
fromName string

Obtient ou définit le nom.

replyTo
replyTo string

Obtient ou définit la réponse à.

replyToName
replyToName string

Obtient ou définit le nom de la réponse à.

Retours

Cette classe représente les paramètres de retour de l’API CreateAndInviteMembers.

Lire interview Compact

Cette action offre la possibilité de lire la liste d’entrevues compact.

Paramètres

Nom Clé Obligatoire Type Description
tenant
tenant string

Obtient ou définit le locataire.

surveyId
surveyId integer

Obtient ou définit l’identificateur d’enquête.

fieldsToDownload
fieldsToDownload array of string

Obtient ou définit les colonnes demandées.

loadCodePlan
loadCodePlan boolean

Obtient ou définit une valeur indiquant si [plan de code de chargement].

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de retour de l’API ReadInterviewListCompact.

Lire le projet d’échantillonnage

Cette action offre la possibilité de lire le projet d’échantillonnage.

Paramètres

Nom Clé Obligatoire Type Description
samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

Retours

Cette classe représente les paramètres de retour de l’API ReadSamplingProject.

Lire le solde du crédit

Cette action retourne le solde du crédit d’enquête pour l’utilisateur authentifié.

Paramètres

Nom Clé Obligatoire Type Description
object

Cette classe représente les paramètres de requête de l’API ReadCreditBalance.

Retours

Cette classe représente les paramètres de retour de l’API ReadCreditBalance.

Lire les artefacts

Cette action offre la possibilité de lire la liste des artefacts.

Paramètres

Nom Clé Obligatoire Type Description
path
path string

Obtient ou définit le chemin d’accès.

workspaceId
workspaceId integer

Obtient ou définit l’identificateur de l’espace de travail.

Retours

Cette classe représente les paramètres de requête de l’API ReadArtifactList.

Lire les distributeurs

Cette action offre la possibilité de lire la liste des serveurs de distribution.

Paramètres

Nom Clé Obligatoire Type Description
surveyId
surveyId integer

Obtient ou définit l’identificateur d’enquête.

panelId
panelId integer

Obtient ou définit l’identificateur du panneau.

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de retour de l’API ReadDistributorList.

Lire les enquêtes

Cette action offre la possibilité de lire toutes les enquêtes disponibles d’un espace de travail donné.

Paramètres

Nom Clé Obligatoire Type Description
workspaceId
workspaceId True integer

Obtient ou définit l’identificateur de l’espace de travail.

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de réponse de l’API ReadSurveyList.

Lire les entrevues

Cette action offre la possibilité de lire la liste des entrevues.

Paramètres

Nom Clé Obligatoire Type Description
tenant
tenant string

Obtient ou définit le locataire.

surveyId
surveyId integer

Obtient ou définit l’identificateur d’enquête.

fieldsToDownload
fieldsToDownload array of string

Obtient ou définit les colonnes demandées.

loadCodePlan
loadCodePlan boolean

Obtient ou définit une valeur indiquant si [plan de code de chargement].

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de retour de l’API ReadInterviewList.

Lire les espaces de travail

Cette action offre la possibilité de lire tous les espaces de travail disponibles.

Paramètres

Nom Clé Obligatoire Type Description
conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de requête de l’API ReadWorkspaceList.

Lire les incentives

Cette action retourne les primes incitatives/bons disponibles pour l’utilisateur authentifié.

Paramètres

Nom Clé Obligatoire Type Description
conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de requête de l’API ReadIncentiveList.

Lire les liens d’enquête

Cette action offre la possibilité de lire les liens d’enquête.

Paramètres

Nom Clé Obligatoire Type Description
surveyId
surveyId integer

Obtient ou définit l’identificateur d’enquête.

Retours

Cette classe représente la réponse de l’API ReadSurveyLinks.

Lire les membres

Cette action offre la possibilité de lire des membres.

Paramètres

Nom Clé Obligatoire Type Description
tenant
tenant string

Obtient ou définit le locataire.

panelId
panelId True integer

Obtient ou définit l’identificateur du panneau.

interviewsRequired
interviewsRequired True boolean

Obtient ou définit une valeur indiquant si les informations de session sont requises.

fieldsToDownload
fieldsToDownload array of string

Obtient ou définit les champs à télécharger.

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de retour de l’API ReadMemberList.

Lire les modèles de messages

Cette action offre la possibilité de recevoir tous les modèles de message configurés pour e-mail et SMS.

Paramètres

Nom Clé Obligatoire Type Description
workspaceId
workspaceId integer

Obtient ou définit l’identificateur de l’espace de travail.

language
language True string

Obtient ou définit la langue.

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de retour de l’API ReadMessageTemplateList.

Lire les rebonds

Cette action offre la possibilité de lire la liste de rebonds.

Paramètres

Nom Clé Obligatoire Type Description
surveyId
surveyId True integer

Obtient ou définit l’identificateur d’enquête.

panelId
panelId integer

Obtient ou définit l’identificateur du panneau.

Distributeurs
distributors array of integer

Obtient ou définit les distributeurs.

invitationType
invitationType string

InvitationType

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de retour de l’API ReadBounceList.

Lire les transactions incitatives

L’action retourne une vue d’ensemble de tous les revenus et dépenses liés aux crédits d’enquête.

Paramètres

Nom Clé Obligatoire Type Description
conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de retour de l’API ReadIncentiveTransactionList.

Lire les transitions de flux de travail

Cette action offre la possibilité de lire toutes les transitions de flux de travail spécifiques au flux de travail.

Paramètres

Nom Clé Obligatoire Type Description
flux de travail
workflow True string

Type de flux de travail

currentState
currentState True string

Obtient ou définit l’état du courant.

Retours

Cette classe représente les paramètres de retour de l’API ReadWorkflowTransitions.

Lire les WebHooks

Cette action offre la possibilité de lire la liste de crochets web.

Paramètres

Nom Clé Obligatoire Type Description
eventType
eventType string

EventType

entityIdentifier
entityIdentifier string

Obtient ou définit l’identificateur d’entité.

Retours

Cette classe représente les paramètres de retour de l’API ReadWebHookList.

Lire l’enquête

Cette action offre la possibilité de lire l’enquête.

Paramètres

Nom Clé Obligatoire Type Description
tenant
tenant string

Obtient ou définit le locataire.

surveyId
surveyId True integer

Obtient ou définit l’identificateur d’enquête.

Retours

Cette classe représente les paramètres de retour de l’API ReadSurveyDefinition.

Lire l’entrevue

Cette action offre la possibilité de lire les données d’entrevue.

Paramètres

Nom Clé Obligatoire Type Description
tenant
tenant True string

Obtient ou définit le locataire.

interviewId
interviewId True uuid

Obtient ou définit l’identificateur d’entrevue.

surveyId
surveyId True integer

Obtient ou définit l’identificateur d’enquête.

loadSurveyDefinition
loadSurveyDefinition boolean

Obtient ou définit une valeur indiquant si [définition de l’enquête de charge].

Retours

Cette classe représente les paramètres de retour de l’API ReadInterviewData.

Lire Opt-Outs

Cette action offre la possibilité de lire toutes les Opt-Outs d’un espace de travail.

Paramètres

Nom Clé Obligatoire Type Description
panelId
panelId integer

Obtient ou définit l’identificateur du panneau.

workspaceId
workspaceId integer

Obtient ou définit l’identificateur de l’espace de travail.

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

pageSize
pageSize True integer

Obtient ou définit la taille de la page.

page
page True integer

Obtient ou définit la page.

orderField
orderField string

Obtient ou définit le champ de commande.

orderDirection
orderDirection string

OrderDirection

Retours

Cette classe représente les paramètres de retour de l’API ReadOptOutList.

Mettre à jour les membres

Cette action offre la possibilité de mettre à jour la liste des membres.

Paramètres

Nom Clé Obligatoire Type Description
tenant
tenant string

Obtient ou définit le locataire.

panelId
panelId True integer

Obtient ou définit l’identificateur du panneau.

pièce d'identité
id integer

Obtient ou définit l’identificateur.

fields
fields True object

Obtient ou définit les champs.

createdAt
createdAt date-time

Obtient ou définit le fichier créé à l’adresse.

createdBy
createdBy string

Obtient ou définit le jeu créé par.

updatedAt
updatedAt date-time

Obtient ou définit la mise à jour à l’adresse.

mis à jourPar
updatedBy string

Obtient ou définit la mise à jour par.

pièce d'identité
id string

ID de l’entrevue

état
state string

Obtient ou définit l’état.

surveyId
surveyId integer

ID de l’enquête

surveyVersionId
surveyVersionId integer

ID de la version de l’enquête

surveyName
surveyName string

Nom de l’enquête

surveyState
surveyState string

Obtient ou définit l’état de l’enquête.

answersLink
answersLink string

Lien vers la page d’impression des réponses

interviewLink
interviewLink string

Obtient ou définit le lien d’entrevue.

date de début
startDate string

Obtient ou définit la date de début.

date de fin
endDate string

Obtient ou définit la date de fin.

samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

distributorId
distributorId integer

Obtient ou définit l’identificateur du serveur de distribution.

Retours

Cette classe représente les paramètres de retour de l’API UpdateMembers.

Mettre à jour l’enquête

Cette action offre la possibilité de mettre à jour l’enquête.

Paramètres

Nom Clé Obligatoire Type Description
surveyId
surveyId True integer

Obtient ou définit l’identificateur d’enquête.

surveyName
surveyName string

Obtient ou définit le nom de l’enquête.

allowMultipleParticipation
allowMultipleParticipation True boolean

Obtient ou définit une valeur indiquant si [autoriser plusieurs participations].

allowNavigateBack
allowNavigateBack True boolean

Obtient ou définit une valeur indiquant si [autoriser la navigation vers l’arrière].

allowSaveProgress
allowSaveProgress boolean

Obtient ou définit une valeur indiquant si [autoriser la progression de l’enregistrement].

randomSections
randomizeSections True boolean

Obtient ou définit une valeur indiquant si [sections aléatoires].

enableAutoScroll
enableAutoScroll boolean

Obtient ou définit une valeur indiquant si [activer le défilement automatique].

enableCodeAccess
enableCodeAccess boolean

Obtient ou définit une valeur indiquant si [activer l’accès au code].

accessType
accessType string

Type d'accès

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

associatedPanels
associatedPanels array of integer

Obtient ou définit l’identificateur du panneau.

codeAccessMode
codeAccessMode True string

Élément AuthenticationType

enablePanelSync
enablePanelSync boolean

Obtient ou définit une valeur indiquant si [activer la synchronisation du panneau].

panelSyncBehaviour
panelSyncBehaviour string

PanelSyncBehaviour

identifier
identifier string

Obtient ou définit l’identificateur.

panelField
panelField string

Obtient ou définit le champ du panneau.

defaultLanguage
defaultLanguage True string

Obtient ou définit la langue par défaut.

date de fin
endDate date-time

Obtient ou définit la date de fin.

langues
languages True array of string

Obtient ou définit les langues.

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

nom
name True string

Obtient ou définit le nom.

randomPages
randomizePages True boolean

Obtient ou définit une valeur indiquant si [pages aléatoires].

excludeFromRandomization
excludeFromRandomization True boolean

Obtient ou définit une valeur indiquant si [exclure de la randomisation].

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

elementType
elementType True string

ElementType

code
code string

Obtient ou définit le code.

codeManuallyChanged
codeManuallyChanged boolean

Obtient ou définit une valeur indiquant si [code modifié manuellement].

languageCode
languageCode True string

Obtient ou définit le code de langue.

texte
text string

Obtient ou définit le texte.

hasHintText
hasHintText boolean

Obtient ou définit une valeur indiquant si cette instance a du texte d’indicateur.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Obtient ou définit une valeur indiquant si cette instance n’a pas le choix disponible.

forceResponse
forceResponse boolean

Obtient ou définit une valeur indiquant si [force response].

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

code
code True string

Obtient ou définit le code.

codeManuallyChanged
codeManuallyChanged boolean

Obtient ou définit une valeur indiquant si [code modifié manuellement].

allowTextEntry
allowTextEntry True boolean

Obtient ou définit une valeur indiquant si [autoriser l’entrée de texte].

forceInput
forceInput True boolean

Obtient ou définit une valeur indiquant si [force input].

saisie semi-automatique
autocomplete True boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.Choice est autocomplétion.

exclusif
exclusive True boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.Choice est exclusif.

excludeFromRandomization
excludeFromRandomization boolean

Obtient ou définit une valeur indiquant si [exclure de la randomisation].

validationType
validationType True string

ContentValidation

earliestDate
earliestDate string

Obtient ou définit la date la plus ancienne.

latestDate
latestDate string

Obtient ou définit la date la plus récente.

minValue
minValue double

Obtient ou définit la valeur minimale.

maxValue
maxValue double

Obtient ou définit la valeur maximale.

Décimales
decimalPlaces integer

Obtient ou définit les décimales.

disableThousandSeparator
disableThousandSeparator boolean

Obtient ou définit le séparateur de milliers de désactivation.

conditionAction
conditionAction True string

FilterAction

autocompleteListVariable
autocompleteListVariable string

Obtient ou définit la variable de liste de saisie semi-automatique.

randomChoices
randomizeChoices boolean

Obtient ou définit une valeur indiquant si [choix aléatoires].

columnType
columnType string

ColumnType

minValue
minValue integer

Obtient ou définit la valeur minimale.

maxValue
maxValue integer

Obtient ou définit la valeur maximale.

showCenterLabel
showCenterLabel boolean

Obtient ou définit une valeur indiquant si [show center label].

showValue
showValue boolean

Obtient ou définit une valeur indiquant si [show value].

maxDecimals
maxDecimals integer

Obtient ou définit les chiffres maximum après la virgule.

textFieldSize
textFieldSize string

TextFieldSize

saisie semi-automatique
autocomplete boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.SurveyElement est autocomplétion.

hasPlaceholder
hasPlaceholder boolean

Obtient ou définit une valeur indiquant si cette instance a un espace réservé.

isPassword
isPassword boolean

Obtient ou définit une valeur indiquant si cette instance est un mot de passe.

minMaxValidation
minMaxValidation boolean

Obtient ou définit une valeur indiquant si [validation maximale minimale].

minimumCheckedChoices
minimumCheckedChoices integer

Obtient ou définit les choix vérifiés minimum.

maximumCheckedChoices
maximumCheckedChoices integer

Obtient ou définit les choix activés maximum.

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

hasNotAvailableChoice
hasNotAvailableChoice True boolean

Obtient ou définit une valeur indiquant si cette instance n’a pas le choix disponible.

randomColumns
randomizeColumns True boolean

Obtient ou définit une valeur indiquant si [colonnes aléatoires].

choiceType
choiceType True string

ChoiceType

randomRows
randomizeRows boolean

Obtient ou définit une valeur indiquant si [lignes aléatoires].

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

code
code True string

Obtient ou définit le code.

codeManuallyChanged
codeManuallyChanged boolean

Obtient ou définit une valeur indiquant si [code modifié manuellement].

excludeFromRandomization
excludeFromRandomization True boolean

Obtient ou définit une valeur indiquant si [exclure de la randomisation].

numberOfRanks
numberOfRanks integer

Obtient ou définit le nombre de rangs.

hasStartText
hasStartText boolean

Obtient ou définit une valeur indiquant si cette instance a du texte de début.

enableMeasurement
enableMeasurement boolean

Obtient ou définit une valeur indiquant si [activer la mesure].

showButtons
showButtons boolean

Obtient ou définit une valeur indiquant si [afficher les boutons].

likeKey
likeKey string

Obtient ou définit la clé semblable.

dislikeKey
dislikeKey string

Obtient ou définit la clé dislike.

interviewState
interviewState string

Obtient ou définit l’état de la réponse.

actionType
actionType True string

QuotaAction

de
from string

Obtient ou définit l’expéditeur.

à
to string

Obtient ou définit le récepteur.

valueAssignmentType
valueAssignmentType string

ValueAssignmentType

variableName
variableName string

Obtient ou définit le nom de la variable.

executionBehavior
executionBehavior string

ExecutionBehavior

apiCallMethod
apiCallMethod string

ApiCallMethod

headers
headers string

Obtient ou définit les en-têtes.

externalUri
externalUri string

Obtient ou définit l’URI externe.

scriptType
scriptType string

ScriptType

contenu
content string

Obtient ou définit le contenu.

hasRatingLabels
hasRatingLabels boolean

Obtient ou définit une valeur indiquant si cette instance a des étiquettes d’évaluation.

evaluateAsJson
evaluateAsJson boolean

Obtient ou définit une valeur indiquant si [évaluer en tant que json].

autocompleteListVariable
autocompleteListVariable string

Obtient ou définit la variable de liste de saisie semi-automatique.

arrangementMode
arrangementMode string

ArrangementMode

enableAnimation
enableAnimation boolean

Obtient ou définit une valeur indiquant si [activer l’animation].

useSmiley
useSmiley boolean

Obtient ou définit une valeur indiquant si [utiliser smiley].

hasPrompt
hasPrompt boolean

Obtient ou définit une valeur indiquant si cette instance a une invite.

pièce d'identité
id True integer

Obtient ou définit l’identificateur.

variableName
variableName True string

Obtient ou définit le nom de la variable.

defaultTextOverrides
defaultTextOverrides object

Obtient ou définit les remplacements de texte par défaut.

surveyDesignLayout
surveyDesignLayout integer

Obtient ou définit la disposition de conception de l’enquête.

matrixSubQuestionSize
matrixSubQuestionSize string

MatrixSubQuestionSize

nom
name string

Obtient ou définit le nom.

type
type string

Obtient ou définit le type.

languageCode
languageCode True string

Obtient ou définit le code de langue.

texte
text string

Obtient ou définit le texte.

anonymisingMode
anonymizingMode True string

AnonymisationMode

logIp
logIp True boolean

Obtient ou définit une valeur indiquant si [log ip].

logUserAgent
logUserAgent True boolean

Obtient ou définit une valeur indiquant si [agent utilisateur du journal].

logReferer
logReferer True boolean

Obtient ou définit une valeur indiquant si [log referer].

Retours

Cette classe représente les paramètres de retour de l’API UpdateSurvey.

Mettre à jour Opt-Outs

Cette action offre la possibilité d’écrire des entrées dans la liste Opt-Out pour un espace de travail.

Paramètres

Nom Clé Obligatoire Type Description
workspaceId
workspaceId integer

Obtient ou définit l’identificateur de l’espace de travail.

panelId
panelId integer

Obtient ou définit l’identificateur du panneau.

distributorId
distributorId integer

Obtient ou définit l’identificateur du serveur de distribution.

Messagerie électronique
email True string

Obtient ou définit l’e-mail.

optOutOperation
optOutOperation True string

OptOutOperation

natel
cellPhone True integer

Obtient ou définit le téléphone cellulaire.

optOutOperation
optOutOperation True string

OptOutOperation

Retours

Cette classe représente les paramètres de retour de l’API WriteOptOutList.

Mettre à jour web Hook

Cette action offre la possibilité de mettre à jour le web hook.

Paramètres

Nom Clé Obligatoire Type Description
webHookId
webHookId uuid

Obtient ou définit l’identificateur de hook web.

eventType
eventType string

EventType

entityIdentifier
entityIdentifier string

Obtient ou définit l’identificateur d’entité.

securityToken
securityToken string

Obtient ou définit le jeton de sécurité.

webHookUrl
webHookUrl string

Obtient ou définit l’URL du hook web.

Retours

Cette classe représente les paramètres de retour de l’API CreateWebHook.

Panneau de lecture

Cette action offre la possibilité de lire la définition du panneau.

Paramètres

Nom Clé Obligatoire Type Description
tenant
tenant string

Obtient ou définit le locataire.

panelId
panelId True integer

Obtient ou définit l’identificateur du panneau.

Retours

Cette classe représente les paramètres de retour de l’API ReadPanelDefinition.

Panneau de mise à jour

Cette action offre la possibilité de mettre à jour le panneau.

Paramètres

Nom Clé Obligatoire Type Description
tenant
tenant string

Obtient ou définit le locataire.

panelId
panelId True integer

Obtient ou définit l’identificateur du panneau.

pièce d'identité
id integer

ID du champ. Il s’agit d’un champ obligatoire en cas de changement de nom.

nom
name string

Nom du champ. Ce champ est obligatoire.

type
type string

PanelMemberFieldType

value
value

La valeur du champ . Le type valeur doit correspondre à la propriété Type.

removedFields
removedFields array of integer

Obtient ou définit les champs supprimés.

pièce d'identité
id integer

ID du champ. Il s’agit d’un champ obligatoire en cas de changement de nom.

nom
name string

Nom du champ. Ce champ est obligatoire.

type
type string

PanelMemberFieldType

value
value

La valeur du champ . Le type valeur doit correspondre à la propriété Type.

Retours

Cette classe représente les paramètres de retour de l’API WritePanel.

Panneau Supprimer

Cette action offre la possibilité de supprimer le panneau.

Paramètres

Nom Clé Obligatoire Type Description
panelId
panelId True integer

Obtient ou définit l’exemple d’identificateur.

keepInterviews
keepInterviews boolean

Obtient ou définit une valeur indiquant si [conservez les entrevues].

Retours

Cette classe représente les paramètres de retour de l’API DeleteSample.

Rappeler aux membres

Cette action offre la possibilité de rappeler au membre.

Paramètres

Nom Clé Obligatoire Type Description
distributorId
distributorId True integer

ID de l’enquête

messageTemplateId
messageTemplateId True integer

Obtient ou définit l’identificateur du modèle de message.

nom
name string

Obtient ou définit le nom.

type
type string

Obtient ou définit le type.

languageCode
languageCode True string

Obtient ou définit le code de langue.

texte
text string

Obtient ou définit le texte.

scheduleDateTime
scheduleDateTime date-time

Obtient ou définit l’heure de planification.

conjonction
conjunction True string

Conjonction

conditionType
conditionType True string

ConditionType

identifier
identifier True string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator True string

ConditionOperator

value
value True string

Obtient ou définit la valeur.

variableType
variableType string

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

chaîne
channel string

Canal de distribution

de
from string

Obtient ou définit à partir de.

fromName
fromName string

Obtient ou définit le nom.

replyTo
replyTo string

Obtient ou définit la réponse à.

replyToName
replyToName string

Obtient ou définit le nom de la réponse à.

Retours

Cette classe représente les paramètres de retour de l’API RemindMembers.

Réinitialiser l’entrevue

Cette action offre la possibilité de réinitialiser la réponse des membres du panneau.

Paramètres

Nom Clé Obligatoire Type Description
surveyId
surveyId integer

Obtient ou définit l’identificateur d’enquête.

interviewId
interviewId uuid

Obtient ou définit l’identificateur d’entrevue.

Retours

Cette classe représente les paramètres de retour de l’API ResetInterview.

Supprimer des membres

Cette action offre la possibilité de supprimer des membres.

Paramètres

Nom Clé Obligatoire Type Description
panelId
panelId True integer

Obtient ou définit l’identificateur du panneau.

panelMembersIds
panelMembersIds True array of integer

Obtient ou définit l’identificateur de membre du panneau.

keepInterviews
keepInterviews boolean

Obtient ou définit une valeur indiquant si [conservez les entrevues].

Retours

Cette classe représente les paramètres de retour de l’API DeleteMember.

Supprimer le projet d’échantillonnage

Cette action offre la possibilité de supprimer le projet d’échantillonnage.

Paramètres

Nom Clé Obligatoire Type Description
samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

keepInterviews
keepInterviews boolean

Obtient ou définit une valeur indiquant si [conservez les entrevues].

Retours

Cette classe représente les paramètres de retour de l’API DeleteSamplingProject.

Supprimer le serveur de distribution

Cette action offre la possibilité de supprimer le serveur de distribution.

Paramètres

Nom Clé Obligatoire Type Description
distributorId
distributorId True integer

Obtient ou définit l’identificateur du serveur de distribution.

keepInterviews
keepInterviews boolean

Obtient ou définit une valeur indiquant si [conservez les entrevues].

Retours

Cette classe représente les paramètres de retour de l’API DeleteDistributor.

Supprimer le WebHook

Cette action offre la possibilité de supprimer le web hook.

Paramètres

Nom Clé Obligatoire Type Description
webHookId
webHookId uuid

Obtient ou définit l’identificateur de hook web.

Retours

Cette classe représente les paramètres de retour de l’API DeleteWebHook.

Supprimer l’enquête

Cette action offre la possibilité de supprimer l’enquête.

Paramètres

Nom Clé Obligatoire Type Description
surveyId
surveyId True integer

Obtient ou définit l’identificateur d’enquête.

Retours

Cette classe représente les paramètres de retour de l’API DeleteSurvey.

Supprimer l’entrevue

Cette action offre la possibilité de supprimer l’entrevue.

Paramètres

Nom Clé Obligatoire Type Description
interviewId
interviewId uuid

Obtient ou définit l’identificateur d’entrevue.

surveyId
surveyId integer

Obtient ou définit l’identificateur d’enquête.

Retours

Cette classe représente les paramètres de retour de l’API DeleteInterview.

Supprimer un artefact

Cette action offre la possibilité de supprimer l’artefact.

Paramètres

Nom Clé Obligatoire Type Description
path
path string

Obtient ou définit le chemin d’accès.

filename
filename string

Obtient ou définit le nom de fichier.

workspaceId
workspaceId integer

Obtient ou définit l’identificateur de l’espace de travail.

Retours

Cette classe représente les paramètres de retour de l’API DeleteArtifact.

Télécharger le PDF d’entrevue

Cette action offre la possibilité de télécharger les réponses.

Paramètres

Nom Clé Obligatoire Type Description
Locataire
tenant True string

Locataire.

SurveyId
surveyId True integer

Identificateur d’enquête.

InterviewId
interviewId True uuid

Identificateur d’entrevue.

Afficher l’achèvement partiel
showPartialCompleted boolean

si la valeur <est c>true</c> [afficher la fin partielle].

Paramètres régionaux
locale string

Paramètres régionaux.

Zone d’arithmétique
timeZone string

Fuseau horaire.

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

Retours

Cette classe représente les paramètres de retour de l’API DownloadAnswers.

Échanger le code d’incentive

Cette action offre la possibilité de dépenser des crédits d’enquête pour les primes incitatives/bons.

Paramètres

Nom Clé Obligatoire Type Description
incentiveId
incentiveId True integer

Obtient ou définit l’identificateur d’incentive.

Retours

Cette classe représente les paramètres de retour de l’API RedeemIncentiveCode.

Définitions

Type d'accès

Type d'accès

Type d'accès

ActionElement

Cette classe représente une action de fin d’enquête pour l’exécution/l’écran/le quota complet.

Nom Chemin d’accès Type Description
actionType
actionType ActionType

QuotaAction

endOfSurveyText
endOfSurveyText array of TranslationElement

Obtient ou définit la fin du texte d’enquête.

forwardUrl
forwardUrl array of TranslationElement

Obtient ou définit l’URL de transfert.

Type d'action

QuotaAction

QuotaAction

AnonymisingConfiguration

Cette classe contient les paramètres d’anonymisation qui peuvent être appliqués à un groupe d’espaces de travail, à un espace de travail ou à une enquête individuelle.

Nom Chemin d’accès Type Description
anonymisingMode
anonymizingMode AnonymizingMode

AnonymisationMode

logIp
logIp boolean

Obtient ou définit une valeur indiquant si [log ip].

logUserAgent
logUserAgent boolean

Obtient ou définit une valeur indiquant si [agent utilisateur du journal].

logReferer
logReferer boolean

Obtient ou définit une valeur indiquant si [log referer].

AnonymisationMode

AnonymisationMode

AnonymisationMode

ApiCallMethod

ApiCallMethod

ApiCallMethod

ArrangementMode

ArrangementMode

ArrangementMode

BounceElement

Cette classe représente une action de fin d’enquête pour l’exécution/l’écran/le quota complet.

Nom Chemin d’accès Type Description
distributorId
distributorId integer

Obtient ou définit l’identificateur du serveur de distribution.

interviewId
interviewId uuid

Obtient ou définit l’identificateur d’entrevue.

panelId
panelId integer

Obtient ou définit l’identificateur du panneau.

panelMemberId
panelMemberId integer

Obtient ou définit l’identificateur de membre du panneau.

bounceType
bounceType BounceType

BounceType

horodatage
timestamp date-time

Obtient ou définit l’horodatage.

état
state string

Obtient ou définit l’état.

reason
reason string

Obtient ou définit la raison.

Messagerie électronique
email string

Obtient ou définit l’e-mail.

phone
phone integer

Obtient ou définit le téléphone.

invitationType
invitationType InvitationType

InvitationType

BounceType

BounceType

BounceType

Option

Cette classe représente un choix unique qui peut être utilisé dans chaque type de question de choix.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

code
code string

Obtient ou définit le code.

codeManuallyChanged
codeManuallyChanged boolean

Obtient ou définit une valeur indiquant si [code modifié manuellement].

texte
text array of TranslationElement

Obtient ou définit les traductions de texte.

allowTextEntry
allowTextEntry boolean

Obtient ou définit une valeur indiquant si [autoriser l’entrée de texte].

forceInput
forceInput boolean

Obtient ou définit une valeur indiquant si [force input].

saisie semi-automatique
autocomplete boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.Choice est autocomplétion.

autocompleteText
autocompleteText array of TranslationElement

Obtient ou définit les traductions de texte de saisie semi-automatique.

exclusif
exclusive boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.Choice est exclusif.

excludeFromRandomization
excludeFromRandomization boolean

Obtient ou définit une valeur indiquant si [exclure de la randomisation].

contentValidation
contentValidation ContentValidation

Cette classe représente une validation de contenu à l’intérieur d’une enquête.

condition
condition ConditionDefinition

Cette classe représente la définition des éléments de conditions.

autocompleteListVariable
autocompleteListVariable string

Obtient ou définit la variable de liste de saisie semi-automatique.

ChoiceType

ChoiceType

ChoiceType

CodeAccessMode

Élément AuthenticationType

Élément AuthenticationType

ColItem

Cette classe représente une cellule d’une réponse d’enquête.

Nom Chemin d’accès Type Description
pièce d'identité
id string

Obtient ou définit l’identificateur.

value
value

Obtient ou définit la valeur.

ColumnGroup

Cette classe représente un groupe de colonnes à l’intérieur de types de questions complexes, tels que des questions de matrice.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

texte
text array of TranslationElement

Obtient ou définit les traductions de texte.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Obtient ou définit une valeur indiquant si cette instance n’a pas le choix disponible.

notAvailableChoiceText
notAvailableChoiceText array of TranslationElement

Obtient ou définit les traductions de texte de choix non disponibles.

randomColumns
randomizeColumns boolean

Obtient ou définit une valeur indiquant si [colonnes aléatoires].

prompt
prompt array of TranslationElement

Obtient ou définit l’invite.

choiceType
choiceType ChoiceType

ChoiceType

choices
choices array of Choice

Obtient ou définit les choix.

condition
condition ConditionDefinition

Cette classe représente la définition des éléments de conditions.

ColumnType

ColumnType

ColumnType

Condition

Cette classe est la base de tous les éléments de condition.

Nom Chemin d’accès Type Description
conjonction
conjunction Conjunction

Conjonction

conditionType
conditionType ConditionType

ConditionType

identifier
identifier string

Obtient ou définit l’identificateur.

conditionOperator
conditionOperator ConditionOperator

ConditionOperator

value
value string

Obtient ou définit la valeur.

variableType
variableType VariableType

VariableType

jsonValue
jsonValue boolean

Obtient ou définit une valeur indiquant si [valeur json].

jsonPath
jsonPath string

Obtient ou définit le chemin json.

ConditionAction

FilterAction

FilterAction

ConditionDefinition

Cette classe représente la définition des éléments de conditions.

Nom Chemin d’accès Type Description
conditionAction
conditionAction ConditionAction

FilterAction

Éléments
elements array of Condition

Obtient ou définit les éléments.

ConditionOperator

ConditionOperator

ConditionOperator

ConditionType

ConditionType

ConditionType

Conjonction

Conjonction

Conjonction

ContentValidation

Cette classe représente une validation de contenu à l’intérieur d’une enquête.

Nom Chemin d’accès Type Description
validationType
validationType ContentValidationType

ContentValidation

earliestDate
earliestDate string

Obtient ou définit la date la plus ancienne.

latestDate
latestDate string

Obtient ou définit la date la plus récente.

minValue
minValue double

Obtient ou définit la valeur minimale.

maxValue
maxValue double

Obtient ou définit la valeur maximale.

Décimales
decimalPlaces integer

Obtient ou définit les décimales.

disableThousandSeparator
disableThousandSeparator boolean

Obtient ou définit le séparateur de milliers de désactivation.

ContentValidationType

ContentValidation

ContentValidation

CreateAndInviteMembersResponse

Cette classe représente les paramètres de retour de l’API CreateAndInviteMembers.

Nom Chemin d’accès Type Description
samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

distributorId
distributorId integer

Obtient ou définit l’identificateur du serveur de distribution.

validationIssues
validationIssues array of WritePanelMemberIssue

Obtient ou définit les problèmes.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

CreateArtifactResponse

Cette classe représente la réponse de l’API CreateArtifact.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

CreateMembersResponse

Cette classe représente les paramètres de retour de l’API CreateMembers.

Nom Chemin d’accès Type Description
membersIds
membersIds array of integer

Obtient ou définit les ID de membres.

validationIssues
validationIssues array of WritePanelMemberIssue

Obtient ou définit les problèmes.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

CreatePanelResponse

Cette classe représente les paramètres de retour de l’API CreatePanel.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtenez l’ID du panneau créé.

nom
name string

Obtenez le nom du panneau créé.

isExtendedPanel
isExtendedPanel boolean

Obtenez le type de panneau créé.

date de création
createdDate string

Obtenez la date de création du panneau créé.

isLock
isLock boolean

Obtient la valeur qui indique si le panneau est verrouillé.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

CreateSurveyResponse

Cette classe représente les paramètres de retour de l’API CreateSurvey.

Nom Chemin d’accès Type Description
surveyId
surveyId integer

Obtient ou définit l’identificateur d’enquête.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

CreateWebHookResponse

Cette classe représente les paramètres de retour de l’API CreateWebHook.

Nom Chemin d’accès Type Description
webHookId
webHookId uuid

Obtient ou définit l’identificateur de hook web.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

CustomVariable

Cette classe représente une variable personnalisée unique.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

variableName
variableName string

Obtient ou définit le nom de la variable.

variableType
variableType VariableType

VariableType

DataAccessControl

Cette classe contient la configuration de la façon dont l’entité est accessible

Nom Chemin d’accès Type Description
accessType
accessType AccessType

Type d'accès

conditions
conditions array of Condition

Obtient ou définit les conditions.

DeleteArtifactResponse

Cette classe représente les paramètres de retour de l’API DeleteArtifact.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

DeleteDistributorResponse

Cette classe représente les paramètres de retour de l’API DeleteDistributor.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

DeleteInterviewResponse

Cette classe représente les paramètres de retour de l’API DeleteInterview.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

DeleteMembersResponse

Cette classe représente les paramètres de retour de l’API DeleteMember.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

DeletePanelResponse

Cette classe représente les paramètres de retour de l’API DeleteSample.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

DeleteSamplingProjectResponse

Cette classe représente les paramètres de retour de l’API DeleteSamplingProject.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

DeleteSurveyResponse

Cette classe représente les paramètres de retour de l’API DeleteSurvey.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

DeleteWebHookResponse

Cette classe représente les paramètres de retour de l’API DeleteWebHook.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

DesignConfiguration

Cette classe représente les possibilités de style d’un compte.

Nom Chemin d’accès Type Description
surveyDesignLayout
surveyDesignLayout integer

Obtient ou définit la disposition de conception de l’enquête.

matrixSubQuestionSize
matrixSubQuestionSize MatrixSubQuestionSize

MatrixSubQuestionSize

textBlocks
textBlocks array of TextBlock

Obtient ou définit le contenu du modèle.

DistributionChannel

Canal de distribution

Canal de distribution

DistributorElement

Cette classe représente un élément de distribution.

Nom Chemin d’accès Type Description
distributorId
distributorId integer

Obtient ou définit l’identificateur du serveur de distribution.

distributionChannel
distributionChannel DistributionChannel

Canal de distribution

surveyId
surveyId integer

Obtient ou définit l’identificateur d’enquête.

samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

surveyVersion
surveyVersion integer

Obtient ou définit la version de l’enquête.

panelId
panelId integer

Obtient ou définit l’identificateur du panneau.

scheduledDistribution
scheduledDistribution date-time

Obtient ou définit la distribution planifiée.

executedDistribution
executedDistribution date-time

Obtient ou définit la distribution exécutée.

distributionState
distributionState string

Obtient ou définit l’état de la distribution.

conditions
conditions array of ConditionDefinition

Obtient ou définit les conditions.

DownloadAnswersResponse

Cette classe représente les paramètres de retour de l’API DownloadAnswers.

Nom Chemin d’accès Type Description
téléchargerUrl
downloadUrl string

Obtient ou définit l’URL de téléchargement.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ElementType

ElementType

ElementType

EventType

EventType

EventType

ExecuteSendMailResponse

Cette classe représente les paramètres de retour de l’API ExecuteSendMail.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ExecuteWorkflowTransitionResponse

Cette classe représente les paramètres de retour de l’API ExecuteWorkflowTransition.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ExecutionBehavior

ExecutionBehavior

ExecutionBehavior

Interview

Cette classe représente les données d’enregistrement d’entrevue

Nom Chemin d’accès Type Description
pièce d'identité
id string

ID de l’entrevue

état
state string

Obtient ou définit l’état.

surveyId
surveyId integer

ID de l’enquête

surveyVersionId
surveyVersionId integer

ID de la version de l’enquête

surveyName
surveyName string

Nom de l’enquête

surveyState
surveyState string

Obtient ou définit l’état de l’enquête.

answersLink
answersLink string

Lien vers la page d’impression des réponses

interviewLink
interviewLink string

Obtient ou définit le lien d’entrevue.

date de début
startDate string

Obtient ou définit la date de début.

date de fin
endDate string

Obtient ou définit la date de fin.

samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

distributorId
distributorId integer

Obtient ou définit l’identificateur du serveur de distribution.

InvitationType

InvitationType

InvitationType

InviteMembersResponse

Cette classe représente les paramètres de retour de l’API InviteMembers.

Nom Chemin d’accès Type Description
samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

distributorId
distributorId integer

Obtient ou définit l’identificateur du serveur de distribution.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

MatrixSubQuestionSize

MatrixSubQuestionSize

MatrixSubQuestionSize

Membre

Cette classe représente un membre de panneau unique avec une structure dynamique basée sur le panneau.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

fields
fields object

Obtient ou définit les champs.

createdAt
createdAt date-time

Obtient ou définit le fichier créé à l’adresse.

createdBy
createdBy string

Obtient ou définit le jeu créé par.

updatedAt
updatedAt date-time

Obtient ou définit la mise à jour à l’adresse.

mis à jourPar
updatedBy string

Obtient ou définit la mise à jour par.

Entrevues
interviews array of Interview

Obtient ou définit les entrevues.

MessageTemplateItem

Cette classe représente un élément de modèle de message.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

ID du message électronique

nom
name string

Nom du message électronique

contenu
content string

Contenu du message électronique

Objet
subject string

Objet du message électronique

defaultLocale
defaultLocale string

Paramètres régionaux par défaut du message électronique

paramètres régionaux
locales array of string

Liste des paramètres régionaux pour ce message électronique

MinMaxChoice

Cette classe représente un élément de choix minimal à l’intérieur d’une enquête.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

code
code string

Obtient ou définit le code.

codeManuallyChanged
codeManuallyChanged boolean

Obtient ou définit une valeur indiquant si [code modifié manuellement].

leftText
leftText array of TranslationElement

Obtient ou définit les traductions de texte de gauche.

rightText
rightText array of TranslationElement

Obtient ou définit les traductions de texte appropriées.

excludeFromRandomization
excludeFromRandomization boolean

Obtient ou définit une valeur indiquant si [exclure de la randomisation].

condition
condition ConditionDefinition

Cette classe représente la définition des éléments de conditions.

OptOutItem

Cette classe représente un élément Opt-Out.

Nom Chemin d’accès Type Description
Messagerie électronique
email string

Obtient ou définit l’e-mail.

phone
phone integer

Obtient ou définit le téléphone.

optOutAt
optOutAt string

Obtient ou définit la désactivation à l’adresse.

optOutBy
optOutBy string

Obtient ou définit la désactivation par.

PanelDefinition

Cette classe contient la définition complète de tous les champs contenus dans un panneau défini par le client.

Nom Chemin d’accès Type Description
groups
groups array of VariableGroupElement

Obtient ou définit les groupes.

dataAccessControl
dataAccessControl DataAccessControl

Cette classe contient la configuration de la façon dont l’entité est accessible

PanelFieldItem

Cette classe représente un champ de panneau à l’intérieur d’un panneau.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

nom
name string

Obtient ou définit le nom.

nom d’affichage
displayName string

Obtient ou définit le nom complet.

isSystem
isSystem boolean

Obtient ou définit une valeur indiquant si cette instance est système.

obligatoire
mandatory boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.PanelFieldItem est obligatoire.

anonymisation
anonymize boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.PanelFieldItem est anonymisé.

validationExpression
validationExpression string

Obtient ou définit l’expression de validation.

validationErrorMessageId
validationErrorMessageId string

Obtient ou définit l’identificateur du message de validation.

panelFieldType
panelFieldType VariableType

VariableType

metadata
metadata object

Obtient ou définit les métadonnées.

PanelIncentive

Cette classe représente un seul incentive.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

nom
name string

Obtient ou définit le nom.

priceInCredits
priceInCredits integer

Obtient ou définit le prix en crédits.

descriptif
description string

Obtient ou définit la description.

availableVouchersCount
availableVouchersCount integer

Obtient ou définit le nombre de bons disponibles.

PanelSyncBehaviour

PanelSyncBehaviour

PanelSyncBehaviour

PanelSyncElement

Cette classe représente un élément de synchronisation unique entre une enquête et un panneau.

Nom Chemin d’accès Type Description
identifier
identifier string

Obtient ou définit l’identificateur.

panelField
panelField string

Obtient ou définit le champ du panneau.

ReadArtifactListRequest

Cette classe représente les paramètres de requête de l’API ReadArtifactList.

Nom Chemin d’accès Type Description
path
path string

Obtient ou définit le chemin d’accès.

workspaceId
workspaceId integer

Obtient ou définit l’identificateur de l’espace de travail.

ReadBounceListResponseV3

Cette classe représente les paramètres de retour de l’API ReadBounceList.

Nom Chemin d’accès Type Description
Rebondit
bounces array of BounceElement

Obtient ou définit la liste des rebonds.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadCreditBalanceResponse

Cette classe représente les paramètres de retour de l’API ReadCreditBalance.

Nom Chemin d’accès Type Description
balance
balance integer

Obtient ou définit l’équilibre.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadDistributorListResponse

Cette classe représente les paramètres de retour de l’API ReadDistributorList.

Nom Chemin d’accès Type Description
Distributeurs
distributors array of DistributorElement

Obtient ou définit les distributeurs.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadIncentiveListResponse

Cette classe représente les paramètres de requête de l’API ReadIncentiveList.

Nom Chemin d’accès Type Description
panelIncentives
panelIncentives array of PanelIncentive

Obtient ou définit les primes incitatives du panneau.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadIncentiveTransactionListResponse

Cette classe représente les paramètres de retour de l’API ReadIncentiveTransactionList.

Nom Chemin d’accès Type Description
incentiveTransactions
incentiveTransactions array of SurveyCreditLog

Obtient ou définit les transactions incitatives.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadInterviewDataResponse

Cette classe représente les paramètres de retour de l’API ReadInterviewData.

Nom Chemin d’accès Type Description
donnéesDeRéponse
responseData object

Obtient ou définit les données de réponse.

surveyDefinition
surveyDefinition SurveyDefinition

Cette classe représente la définition d’une enquête contenant toutes les métadonnées et tous les paramètres.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadInterviewListCompactResponseV3

Cette classe représente les paramètres de retour de l’API ReadInterviewListCompact.

Nom Chemin d’accès Type Description
surveyName
surveyName string

Obtient ou définit le nom de l’enquête.

surveyDefaultLanguage
surveyDefaultLanguage string

Obtient ou définit la langue par défaut de l’enquête.

surveyLanguages
surveyLanguages array of string

Obtient ou définit les langues d’enquête.

Entrevues
interviews array of object

Obtient ou définit les entrevues.

items
interviews object
codePlan
codePlan array of SurveyMetadataItem

Obtient ou définit le plan de code.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadInterviewListResponseV3

Cette classe représente les paramètres de retour de l’API ReadInterviewList.

Nom Chemin d’accès Type Description
surveyName
surveyName string

Obtient ou définit le nom de l’enquête.

surveyDefaultLanguage
surveyDefaultLanguage string

Obtient ou définit la langue par défaut de l’enquête.

surveyLanguages
surveyLanguages array of string

Obtient ou définit les langues d’enquête.

codePlan
codePlan array of SurveyMetadataItem

Obtient ou définit le plan de code.

Entrevues
interviews array of Row

Obtient ou définit les entrevues.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadMemberListResponse

Cette classe représente les paramètres de retour de l’API ReadMemberList.

Nom Chemin d’accès Type Description
membres
members array of Member

Obtient ou définit les membres du panneau.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadMessageTemplateListResponse

Cette classe représente les paramètres de retour de l’API ReadMessageTemplateList.

Nom Chemin d’accès Type Description
messageTemplates
messageTemplates array of MessageTemplateItem

Obtient ou définit les modèles de message.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadOptOutListResponseV3

Cette classe représente les paramètres de retour de l’API ReadOptOutList.

Nom Chemin d’accès Type Description
optOutItems
optOutItems array of OptOutItem

Obtient ou définit les éléments de désactivation.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadPanelDefinitionResponse

Cette classe représente les paramètres de retour de l’API ReadPanelDefinition.

Nom Chemin d’accès Type Description
panneau
panel PanelDefinition

Cette classe contient la définition complète de tous les champs contenus dans un panneau défini par le client.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadSamplingProjectResponse

Cette classe représente les paramètres de retour de l’API ReadSamplingProject.

Nom Chemin d’accès Type Description
samplingProject
samplingProject SamplingProjectElement

Cette classe représente un projet d’échantillonnage.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadSurveyLinksResponse

Cette classe représente la réponse de l’API ReadSurveyLinks.

Nom Chemin d’accès Type Description
anonymousList
anonymousList array of SurveyLink

Obtient ou définit la liste anonyme.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadSurveyListResponse

Cette classe représente les paramètres de réponse de l’API ReadSurveyList.

Nom Chemin d’accès Type Description
Enquêtes
surveys array of SurveyListItem

Obtient ou définit les enquêtes.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadSurveyResponse

Cette classe représente les paramètres de retour de l’API ReadSurveyDefinition.

Nom Chemin d’accès Type Description
surveyName
surveyName string

Obtient ou définit le nom de l’enquête.

surveyVersion
surveyVersion integer

Obtient ou définit la version de l’enquête.

surveyState
surveyState string

Obtient ou définit l’état de l’enquête.

createdAt
createdAt string

Obtient ou définit le fichier créé à l’adresse.

createdBy
createdBy string

Obtient ou définit le jeu créé par.

enquête
survey SurveyDefinition

Cette classe représente la définition d’une enquête contenant toutes les métadonnées et tous les paramètres.

surveyConfiguration
surveyConfiguration SurveyConfiguration

Cette classe représente la configuration de l’enquête avec tous les paramètres qu’un utilisateur peut configurer.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadWebHookListResponse

Cette classe représente les paramètres de retour de l’API ReadWebHookList.

Nom Chemin d’accès Type Description
webHooks
webHooks array of WebHookElement

Obtient ou définit les hooks web.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadWorkflowTransitionsResponse

Cette classe représente les paramètres de retour de l’API ReadWorkflowTransitions.

Nom Chemin d’accès Type Description
Transitions
transitions array of WorkflowTransition

Obtient ou définit les transitions.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ReadWorkspaceListResponse

Cette classe représente les paramètres de requête de l’API ReadWorkspaceList.

Nom Chemin d’accès Type Description
workspaces
workspaces array of WorkspaceDto

Obtient ou définit les espaces de travail.

totalCount
totalCount integer

Obtient ou définit le nombre total.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

RedeemIncentiveCodeResponse

Cette classe représente les paramètres de retour de l’API RedeemIncentiveCode.

Nom Chemin d’accès Type Description
voucherCode
voucherCode string

Obtient ou définit le code de bon.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

RemindMembersResponse

Cette classe représente les paramètres de retour de l’API RemindMembers.

Nom Chemin d’accès Type Description
reminderId
reminderId integer

Obtient ou définit l’identificateur de rappel.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ResetInterviewResponse

Cette classe représente les paramètres de retour de l’API ResetInterview.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

Ligne

Cette classe représente un élément Row.

Nom Chemin d’accès Type Description
columns
columns array of ColItem

Obtient ou définit les colonnes.

RowItem

Cette classe représente une réponse d’enquête.

Nom Chemin d’accès Type Description
pièce d'identité
id string

Obtient ou définit l’identificateur.

value
value string

Obtient ou définit la valeur.

SamplingProjectElement

Cette classe représente un projet d’échantillonnage.

Nom Chemin d’accès Type Description
samplingProjectId
samplingProjectId integer

Obtient ou définit l’identificateur du projet d’échantillonnage.

nom
name string

Obtient ou définit le nom.

workspaceId
workspaceId integer

Obtient ou définit l’identificateur de l’espace de travail.

surveyId
surveyId integer

Obtient ou définit l’identificateur d’enquête.

surveyVersion
surveyVersion integer

Obtient ou définit la version de l’enquête.

panelId
panelId integer

Obtient ou définit l’identificateur du panneau.

samplingProviderId
samplingProviderId integer

Obtient ou définit l’identificateur du fournisseur d’échantillonnage.

projectState
projectState string

Obtient ou définit l’état du projet.

scheduledDistribution
scheduledDistribution string

Obtient ou définit la distribution planifiée.

executedDistribution
executedDistribution string

Obtient ou définit la distribution exécutée.

conditions
conditions array of ConditionDefinition

Obtient ou définit les conditions.

ScriptType

ScriptType

ScriptType

Section

Cette classe représente une section à l’intérieur d’une enquête.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

nom
name string

Obtient ou définit le nom.

randomPages
randomizePages boolean

Obtient ou définit une valeur indiquant si [pages aléatoires].

excludeFromRandomization
excludeFromRandomization boolean

Obtient ou définit une valeur indiquant si [exclure de la randomisation].

Éléments
elements array of SurveyElement

Obtient ou définit les éléments.

condition
condition ConditionDefinition

Cette classe représente la définition des éléments de conditions.

SurveyConfiguration

Cette classe représente la configuration de l’enquête avec tous les paramètres qu’un utilisateur peut configurer.

Nom Chemin d’accès Type Description
designConfiguration
designConfiguration DesignConfiguration

Cette classe représente les possibilités de style d’un compte.

anonymisingConfiguration
anonymizingConfiguration AnonymizingConfiguration

Cette classe contient les paramètres d’anonymisation qui peuvent être appliqués à un groupe d’espaces de travail, à un espace de travail ou à une enquête individuelle.

SurveyCreditLog

Cette classe représente une transaction de crédit unique.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

oldValue
oldValue string

Obtient ou définit l’ancienne valeur.

newValue
newValue string

Obtient ou définit la nouvelle valeur.

descriptif
description string

Obtient ou définit la description.

modifiedDate
modifiedDate string

Obtient ou définit la date de modification.

modifiedBy
modifiedBy string

Obtient ou définit la modification par.

responseId
responseId uuid

Obtient ou définit l’identificateur de réponse.

interviewLink
interviewLink string

Obtient ou définit le lien d’entrevue.

SurveyDefinition

Cette classe représente la définition d’une enquête contenant toutes les métadonnées et tous les paramètres.

Nom Chemin d’accès Type Description
allowMultipleParticipation
allowMultipleParticipation boolean

Obtient ou définit une valeur indiquant si [autoriser plusieurs participations].

allowNavigateBack
allowNavigateBack boolean

Obtient ou définit une valeur indiquant si [autoriser la navigation vers l’arrière].

allowSaveProgress
allowSaveProgress boolean

Obtient ou définit une valeur indiquant si [autoriser la progression de l’enregistrement].

randomSections
randomizeSections boolean

Obtient ou définit une valeur indiquant si [sections aléatoires].

enableAutoScroll
enableAutoScroll boolean

Obtient ou définit une valeur indiquant si [activer le défilement automatique].

enableCodeAccess
enableCodeAccess boolean

Obtient ou définit une valeur indiquant si [activer l’accès au code].

dataAccessControl
dataAccessControl DataAccessControl

Cette classe contient la configuration de la façon dont l’entité est accessible

associatedPanels
associatedPanels array of integer

Obtient ou définit l’identificateur du panneau.

codeAccessMode
codeAccessMode CodeAccessMode

Élément AuthenticationType

enablePanelSync
enablePanelSync boolean

Obtient ou définit une valeur indiquant si [activer la synchronisation du panneau].

panelSyncBehaviour
panelSyncBehaviour PanelSyncBehaviour

PanelSyncBehaviour

panelSyncs
panelSyncs array of PanelSyncElement

Obtient ou définit la synchronisation du panneau.

defaultLanguage
defaultLanguage string

Obtient ou définit la langue par défaut.

date de fin
endDate date-time

Obtient ou définit la date de fin.

langues
languages array of string

Obtient ou définit les langues.

Sections
sections array of Section

Obtient ou définit les sections.

customVariables
customVariables array of CustomVariable

Obtient ou définit les variables personnalisées.

surveyEndText
surveyEndText array of TranslationElement

Obtient ou définit le texte de fin de l’enquête.

defaultTextOverrides
defaultTextOverrides object

Obtient ou définit les remplacements de texte par défaut.

SurveyElement

Cette classe représente une définition d’élément d’enquête avec toutes les métadonnées et paramètres.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

elementType
elementType ElementType

ElementType

code
code string

Obtient ou définit le code.

codeManuallyChanged
codeManuallyChanged boolean

Obtient ou définit une valeur indiquant si [code modifié manuellement].

texte
text array of TranslationElement

Obtient ou définit les traductions de texte.

hintText
hintText array of TranslationElement

Obtient ou définit les traductions de texte d’indicateur.

hasHintText
hasHintText boolean

Obtient ou définit une valeur indiquant si cette instance a du texte d’indicateur.

hasNotAvailableChoice
hasNotAvailableChoice boolean

Obtient ou définit une valeur indiquant si cette instance n’a pas le choix disponible.

notAvailableChoiceText
notAvailableChoiceText array of TranslationElement

Obtient ou définit les traductions de texte de choix non disponibles.

forceResponse
forceResponse boolean

Obtient ou définit une valeur indiquant si [force response].

choices
choices array of Choice

Obtient ou définit les choix.

randomChoices
randomizeChoices boolean

Obtient ou définit une valeur indiquant si [choix aléatoires].

columnType
columnType ColumnType

ColumnType

prompt
prompt array of TranslationElement

Obtient ou définit l’invite.

minValue
minValue integer

Obtient ou définit la valeur minimale.

maxValue
maxValue integer

Obtient ou définit la valeur maximale.

showCenterLabel
showCenterLabel boolean

Obtient ou définit une valeur indiquant si [show center label].

leftLabel
leftLabel array of TranslationElement

Obtient ou définit l’étiquette gauche.

centerLabel
centerLabel array of TranslationElement

Obtient ou définit l’étiquette centrale.

rightLabel
rightLabel array of TranslationElement

Obtient ou définit l’étiquette appropriée.

showValue
showValue boolean

Obtient ou définit une valeur indiquant si [show value].

maxDecimals
maxDecimals integer

Obtient ou définit les chiffres maximum après la virgule.

textFieldSize
textFieldSize TextFieldSize

TextFieldSize

saisie semi-automatique
autocomplete boolean

Obtient ou définit une valeur indiquant si ce Survalyzer.Contracts.Public.Elements.SurveyElement est autocomplétion.

autocompleteText
autocompleteText array of TranslationElement

Obtient ou définit les traductions de texte de saisie semi-automatique.

contentValidation
contentValidation ContentValidation

Cette classe représente une validation de contenu à l’intérieur d’une enquête.

hasPlaceholder
hasPlaceholder boolean

Obtient ou définit une valeur indiquant si cette instance a un espace réservé.

Espace réservé
placeholder array of TranslationElement

Obtient ou définit l’espace réservé.

isPassword
isPassword boolean

Obtient ou définit une valeur indiquant si cette instance est un mot de passe.

minMaxValidation
minMaxValidation boolean

Obtient ou définit une valeur indiquant si [validation maximale minimale].

minimumCheckedChoices
minimumCheckedChoices integer

Obtient ou définit les choix vérifiés minimum.

maximumCheckedChoices
maximumCheckedChoices integer

Obtient ou définit les choix activés maximum.

columnGroups
columnGroups array of ColumnGroup

Obtient ou définit les groupes de colonnes.

randomRows
randomizeRows boolean

Obtient ou définit une valeur indiquant si [lignes aléatoires].

Lignes
rows array of MinMaxChoice

Obtient ou définit les lignes.

numberOfRanks
numberOfRanks integer

Obtient ou définit le nombre de rangs.

likeText
likeText array of TranslationElement

Obtient ou définit les traductions de texte similaires.

dislikeText
dislikeText array of TranslationElement

Obtient ou définit les traductions de texte non similaires.

hasStartText
hasStartText boolean

Obtient ou définit une valeur indiquant si cette instance a du texte de début.

startText
startText array of TranslationElement

Obtient ou définit le texte de début.

enableMeasurement
enableMeasurement boolean

Obtient ou définit une valeur indiquant si [activer la mesure].

showButtons
showButtons boolean

Obtient ou définit une valeur indiquant si [afficher les boutons].

likeKey
likeKey string

Obtient ou définit la clé semblable.

dislikeKey
dislikeKey string

Obtient ou définit la clé dislike.

interviewState
interviewState string

Obtient ou définit l’état de la réponse.

action
action ActionElement

Cette classe représente une action de fin d’enquête pour l’exécution/l’écran/le quota complet.

de
from string

Obtient ou définit l’expéditeur.

à
to string

Obtient ou définit le récepteur.

Objet
subject array of TranslationElement

Obtient ou définit les traductions d’objet.

Message
message array of TranslationElement

Obtient ou définit les traductions de messages.

valueAssignmentType
valueAssignmentType ValueAssignmentType

ValueAssignmentType

variableName
variableName string

Obtient ou définit le nom de la variable.

functionTerm
functionTerm array of TranslationElement

Obtient ou définit le terme de fonction.

executionBehavior
executionBehavior ExecutionBehavior

ExecutionBehavior

apiCallMethod
apiCallMethod ApiCallMethod

ApiCallMethod

URL
url array of TranslationElement

Obtient ou définit l’URL.

headers
headers string

Obtient ou définit les en-têtes.

body
body array of TranslationElement

Obtient ou définit le corps.

externalUri
externalUri string

Obtient ou définit l’URI externe.

scriptType
scriptType ScriptType

ScriptType

contenu
content string

Obtient ou définit le contenu.

hasRatingLabels
hasRatingLabels boolean

Obtient ou définit une valeur indiquant si cette instance a des étiquettes d’évaluation.

leftRatingLabel
leftRatingLabel array of TranslationElement

Obtient ou définit l’étiquette d’évaluation de gauche.

rightRatingLabel
rightRatingLabel array of TranslationElement

Obtient ou définit l’étiquette d’évaluation appropriée.

condition
condition ConditionDefinition

Cette classe représente la définition des éléments de conditions.

evaluateAsJson
evaluateAsJson boolean

Obtient ou définit une valeur indiquant si [évaluer en tant que json].

autocompleteListVariable
autocompleteListVariable string

Obtient ou définit la variable de liste de saisie semi-automatique.

arrangementMode
arrangementMode ArrangementMode

ArrangementMode

enableAnimation
enableAnimation boolean

Obtient ou définit une valeur indiquant si [activer l’animation].

useSmiley
useSmiley boolean

Obtient ou définit une valeur indiquant si [utiliser smiley].

hasPrompt
hasPrompt boolean

Obtient ou définit une valeur indiquant si cette instance a une invite.

Entité SurveyLink

Nom Chemin d’accès Type Description
URL
url string

Obtient ou définit l’URL.

isCustom
isCustom boolean

Obtient ou définit une valeur indiquant si cette instance est personnalisée.

language
language string

Obtient ou définit la langue.

SurveyListItem

Cette classe représente un seul élément d’enquête.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

ID de l’enquête

nom
name string

Nom de l’enquête

modifiedDate
modifiedDate string

Date de modification de l’enquête

date de fin
endDate string

Date à laquelle l’enquête se termine

isEndDateEnabled
isEndDateEnabled boolean

Si la date de fin est activée pour cette enquête

status
status SurveyStatus

SurveyStatus

archiveDate
archiveDate string

Date à laquelle l’enquête a été archivée

statusOn
statusOn boolean

L’enquête est activée ou désactivée

answers
answers integer

Obtient ou définit les réponses.

SurveyMetadataItem

Cette classe représente un élément de métadonnées unique.

Nom Chemin d’accès Type Description
code
code string

Obtient ou définit le code.

type de données
dataType string

Obtient ou définit le type de données.

questionCode
questionCode string

Obtient ou définit le code de question.

type
type string

Obtient ou définit le type.

question
question string

Obtient ou définit la question.

ramer
row string

Obtient ou définit la ligne.

choice
choice string

Obtient ou définit le choix.

values
values array of RowItem

Obtient ou définit les valeurs.

sectionName
sectionName string

Obtient ou définit le nom de la section.

SurveyStatus

SurveyStatus

SurveyStatus

Bloc de texte

Bloc de texte

Nom Chemin d’accès Type Description
nom
name string

Obtient ou définit le nom.

type
type string

Obtient ou définit le type.

texte
text array of TranslationElement

Obtient ou définit le texte.

TextFieldSize

TextFieldSize

TextFieldSize

TranslationElement

Cette classe représente une traduction de texte à l’intérieur d’une enquête.

Nom Chemin d’accès Type Description
languageCode
languageCode string

Obtient ou définit le code de langue.

texte
text string

Obtient ou définit le texte.

UpdateMembersResponse

Cette classe représente les paramètres de retour de l’API UpdateMembers.

Nom Chemin d’accès Type Description
validationIssues
validationIssues array of WritePanelMemberIssue

Obtient ou définit les problèmes.

estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

UpdateSurveyResponse

Cette classe représente les paramètres de retour de l’API UpdateSurvey.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

UpdateWebHookResponse

Cette classe représente les paramètres de retour de l’API CreateWebHook.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

ValueAssignmentType

ValueAssignmentType

ValueAssignmentType

VariableGroupElement

Cette classe représente un groupe de champs dans un panneau.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

nom
name string

Obtient ou définit le nom.

nom d’affichage
displayName string

Obtient ou définit le nom complet.

fields
fields array of PanelFieldItem

Obtient ou définit les champs.

VariableType

VariableType

VariableType

WebHookElement

Cette classe représente un webHook unique

Nom Chemin d’accès Type Description
pièce d'identité
id uuid

Obtient ou définit l’identificateur.

eventType
eventType EventType

EventType

entityIdentifier
entityIdentifier string

Obtient ou définit l’identificateur d’entité.

createdAt
createdAt date-time

Obtient ou définit le fichier créé à l’adresse.

createdBy
createdBy string

Obtient ou définit le jeu créé par.

updatedAt
updatedAt date-time

Obtient ou définit la mise à jour à l’adresse.

mis à jourPar
updatedBy string

Obtient ou définit la mise à jour par.

WorkflowTransition

Cette classe représente une transition d’un état à un autre.

Nom Chemin d’accès Type Description
nom
name string

Obtient ou définit le nom.

action
action string

Obtient ou définit le nom de l’action.

newState
newState string

Crée un état.

condition
condition string

Obtient ou définit la condition.

WorkspaceDto

Cette classe représente une entité d’espace de travail.

Nom Chemin d’accès Type Description
pièce d'identité
id integer

Obtient ou définit l’identificateur.

nom
name string

Obtient ou définit le nom.

numberOfSurveys
numberOfSurveys integer

Obtient ou définit le nombre d’enquêtes.

WriteOptOutListResponse

Cette classe représente les paramètres de retour de l’API WriteOptOutList.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

WritePanelMemberIssue

Représenter un problème qui peut être affiché

Nom Chemin d’accès Type Description
code d'erreur
errorCode string

Obtient ou définit le code d’erreur.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

WritePanelResponse

Cette classe représente les paramètres de retour de l’API WritePanel.

Nom Chemin d’accès Type Description
estSucces
isSuccess boolean

Obtient ou définit une valeur indiquant si cette instance réussit.

errorMessage
errorMessage string

Obtient ou définit le message d’erreur.

code d'erreur
errorCode string

Obtient ou définit le code d’erreur.