Survalyzer EU (versión preliminar)

El conector Survalyzer proporciona acceso simplificado a todas las funcionalidades de API del centro de datos de la UE.

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Centro para desarrolladores de Survalyzer
URL	https://developer.survalyzer.com/

Metadatos del conector
Publicador	Survalyzer AG
Website	https://survalyzer.com
Directiva de privacidad	https://survalyzer.com/privacy-policy
Categorías	Marketing; Productividad

Creación de una conexión

El conector admite los siguientes tipos de autenticación:


Predeterminado	Parámetros para crear una conexión.	Todas las regiones	No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre	Tipo	Description	Obligatorio
Id. de cliente: su ClientId de Survalyzer	cuerda / cadena	Escriba el identificador de cliente.	Cierto
Secreto de cliente: su clientSecret de Survalyzer	securestring	Escriba el secreto de cliente.	Cierto

Limitaciones

Nombre	Llamadas	Período de renovación
Llamadas API por conexión	100	60 segundos

Acciones

Actualización de Web Hook	Esta acción ofrece la posibilidad de actualizar el webhook.
Actualizar encuesta	Esta acción ofrece la posibilidad de actualizar la encuesta.
Actualizar miembros	Esta acción ofrece la posibilidad de actualizar la lista de miembros.
Actualizar Opt-Outs	Esta acción ofrece la posibilidad de escribir entradas en la lista de Opt-Out de un área de trabajo.
Canjear código de incentivo	Esta acción ofrece la posibilidad de gastar créditos de encuesta para incentivos/vales.
Creación de webHook	Esta acción ofrece la posibilidad de crear el webhook.
Crear artefacto	Esta acción ofrece la posibilidad de crear un nuevo artefacto.
Crear encuesta	Esta acción ofrece la posibilidad de crear una encuesta.
Crear miembros	Esta acción ofrece la posibilidad de crear la lista de miembros.
Crear panel o ejemplo	Esta acción ofrece la posibilidad de crear un nuevo panel.
Descargar PDF de entrevista	Esta acción ofrece la posibilidad de descargar las respuestas.
Ejecutar transición de flujo de trabajo	Esta acción ofrece la posibilidad de ejecutar la transición de flujo de trabajo específica para el flujo de trabajo.
Eliminar distribuidor	Esta acción ofrece la posibilidad de eliminar el distribuidor.
Eliminar encuesta	Esta acción ofrece la posibilidad de eliminar la encuesta.
Eliminar entrevista	Esta acción ofrece la posibilidad de eliminar la entrevista.
Eliminar miembros	Esta acción ofrece la posibilidad de eliminar miembros.
Eliminar panel	Esta acción ofrece la posibilidad de eliminar el panel.
Eliminar proyecto de muestreo	Esta acción ofrece la posibilidad de eliminar el proyecto de muestreo.
Eliminar un artefacto	Esta acción ofrece la posibilidad de eliminar artefactos.
Eliminar webHook	Esta acción ofrece la posibilidad de eliminar el webhook.
Enviar correo	Esta acción ofrece la posibilidad de enviar correo electrónico.
Invitar a miembros	Esta acción ofrece la posibilidad de invitar al miembro.
Invitar a miembros	Esta acción ofrece la posibilidad de crear e invitar a miembros.
Lectura de rebotes	Esta acción ofrece la posibilidad de leer la lista de rebotes.
Leer artefactos	Esta acción ofrece la posibilidad de leer la lista de artefactos.
Leer distribuidores	Esta acción ofrece la posibilidad de leer la lista de distribuidores.
Leer encuesta	Esta acción ofrece la posibilidad de leer la encuesta.
Leer encuestas	Esta acción ofrece la posibilidad de leer todas las encuestas disponibles de un área de trabajo determinada.
Leer entrevista	Esta acción ofrece la posibilidad de leer los datos de la entrevista.
Leer entrevistas	Esta acción ofrece la posibilidad de leer la lista de entrevistas.
Leer entrevistas compactas	Esta acción ofrece la posibilidad de leer la lista de entrevistas compacta.
Leer incentivos	Esta acción devuelve los incentivos o vales disponibles para el usuario autenticado.
Leer miembros	Esta acción ofrece la posibilidad de leer miembros.
Leer Opt-Outs	Esta acción ofrece la posibilidad de leer todos los Opt-Outs de un área de trabajo.
Leer plantillas de mensaje	Esta acción ofrece la posibilidad de recibir todas las plantillas de mensaje configuradas para correo electrónico y SMS.
Leer proyecto de muestreo	Esta acción ofrece la posibilidad de leer el proyecto de muestreo.
Leer saldo de crédito	Esta acción devuelve el saldo de crédito de la encuesta para el usuario autenticado.
Leer transacciones de incentivos	La acción devuelve información general sobre todas las ganancias y gastos relacionados con los créditos de la encuesta.
Leer transiciones de flujo de trabajo	Esta acción ofrece la posibilidad de leer todas las transiciones de flujo de trabajo específicas para el flujo de trabajo.
Leer vínculos de encuesta	Esta acción ofrece la posibilidad de leer los vínculos de la encuesta.
Leer webHooks	Esta acción ofrece la posibilidad de leer la lista de web hooks.
Leer áreas de trabajo	Esta acción ofrece la posibilidad de leer todas las áreas de trabajo disponibles.
Panel de actualización	Esta acción ofrece la posibilidad de actualizar el panel.
Panel de lectura	Esta acción ofrece la posibilidad de leer la definición del panel.
Recordar miembros	Esta acción ofrece la posibilidad de recordar al miembro.
Restablecer entrevista	Esta acción ofrece la posibilidad de restablecer la respuesta del miembro del panel.

Actualización de Web Hook

Id. de la operación:: UpdateWebHook

Esta acción ofrece la posibilidad de actualizar el webhook.

Parámetros

Nombre	Clave	Tipo	Description
webHookId	webHookId	uuid	Obtiene o establece el identificador de web hook.
eventType	eventType	string	Tipo de evento
entityIdentifier	entityIdentifier	string	Obtiene o establece el identificador de entidad.
securityToken	securityToken	string	Obtiene o establece el token de seguridad.
webHookUrl	webHookUrl	string	Obtiene o establece la dirección URL del enlace web.

Devoluciones

Esta clase representa los parámetros devueltos para la API CreateWebHook.

Body: UpdateWebHookResponse

Actualizar encuesta

Id. de la operación:: UpdateSurvey

Esta acción ofrece la posibilidad de actualizar la encuesta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
surveyId	surveyId	True	integer	Obtiene o establece el identificador de la encuesta.
surveyName	surveyName		string	Obtiene o establece el nombre de la encuesta.
allowMultipleParticipation	allowMultipleParticipation	True	boolean	Obtiene o establece un valor que indica si [permitir la participación múltiple].
allowNavigateBack	allowNavigateBack	True	boolean	Obtiene o establece un valor que indica si [permitir la navegación hacia atrás].
allowSaveProgress	allowSaveProgress		boolean	Obtiene o establece un valor que indica si [permitir el progreso de guardar].
randomSections	randomizeSections	True	boolean	Obtiene o establece un valor que indica si [secciones aleatorias].
enableAutoScroll	enableAutoScroll		boolean	Obtiene o establece un valor que indica si [habilitar el desplazamiento automático].
enableCodeAccess	enableCodeAccess		boolean	Obtiene o establece un valor que indica si [habilitar el acceso al código].
accessType	accessType		string	Tipo de acceso
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
associatedPanels	associatedPanels		array of integer	Obtiene o establece el identificador del panel.
codeAccessMode	codeAccessMode	True	string	AuthenticationType
enablePanelSync	enablePanelSync		boolean	Obtiene o establece un valor que indica si [habilitar la sincronización del panel].
panelSyncBehaviour	panelSyncBehaviour		string	PanelSyncBehaviour
identificador	identifier		string	Obtiene o establece el identificador.
panelField	panelField		string	Obtiene o establece el campo del panel.
defaultLanguage	defaultLanguage	True	string	Obtiene o establece el idioma predeterminado.
fecha de finalización	endDate		date-time	Obtiene o establece la fecha de finalización.
Idiomas	languages	True	array of string	Obtiene o establece los idiomas.
id	id	True	integer	Obtiene o establece el identificador.
nombre	name	True	string	Obtiene o establece el nombre.
randomPages	randomizePages	True	boolean	Obtiene o establece un valor que indica si [páginas aleatorias].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtiene o establece un valor que indica si [excluir de la selección aleatoria].
id	id	True	integer	Obtiene o establece el identificador.
elementType	elementType	True	string	ElementType
código	code		string	Obtiene o establece el código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtiene o establece un valor que indica si [código ha cambiado manualmente].
languageCode	languageCode	True	string	Obtiene o establece el código de idioma.
texto	text		string	Obtiene o establece el texto.
hasHintText	hasHintText		boolean	Obtiene o establece un valor que indica si esta instancia tiene texto de sugerencia.
hasNotAvailableChoice	hasNotAvailableChoice		boolean	Obtiene o establece un valor que indica si esta instancia no tiene opción disponible.
forceResponse	forceResponse		boolean	Obtiene o establece un valor que indica si [forzar respuesta].
id	id	True	integer	Obtiene o establece el identificador.
código	code	True	string	Obtiene o establece el código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtiene o establece un valor que indica si [código ha cambiado manualmente].
allowTextEntry	allowTextEntry	True	boolean	Obtiene o establece un valor que indica si [permitir entrada de texto].
forceInput	forceInput	True	boolean	Obtiene o establece un valor que indica si [forzar entrada].
autocompletar	autocomplete	True	boolean	Obtiene o establece un valor que indica si este Objeto Survalyzer.Contracts.Public.Elements.Choice es autocompletar.
exclusivo	exclusive	True	boolean	Obtiene o establece un valor que indica si este Survalyzer.Contracts.Public.Elements.Choice es exclusivo.
excludeFromRandomization	excludeFromRandomization		boolean	Obtiene o establece un valor que indica si [excluir de la selección aleatoria].
validationType	validationType	True	string	ContentValidation (Validación de contenido)
earliestDate	earliestDate		string	Obtiene o establece la fecha más antigua.
latestDate	latestDate		string	Obtiene o establece la fecha más reciente.
valor mínimo	minValue		double	Obtiene o establece el valor mínimo.
valorMáximo	maxValue		double	Obtiene o establece el valor máximo.
decimalPlaces	decimalPlaces		integer	Obtiene o establece las posiciones decimales.
disableThousandSeparator	disableThousandSeparator		boolean	Obtiene o establece el separador de miles de deshabilitación.
conditionAction	conditionAction	True	string	FilterAction
autocompleteListVariable	autocompleteListVariable		string	Obtiene o establece la variable de lista de autocompletar.
randomChoices	randomizeChoices		boolean	Obtiene o establece un valor que indica si [opciones aleatorias].
columnType	columnType		string	TipoDeColumna
valor mínimo	minValue		integer	Obtiene o establece el valor mínimo.
valorMáximo	maxValue		integer	Obtiene o establece el valor máximo.
showCenterLabel	showCenterLabel		boolean	Obtiene o establece un valor que indica si [mostrar etiqueta central].
showValue	showValue		boolean	Obtiene o establece un valor que indica si [mostrar valor].
maxDecimals	maxDecimals		integer	Obtiene o establece los dígitos máximos después de la coma.
textFieldSize	textFieldSize		string	TextFieldSize
autocompletar	autocomplete		boolean	Obtiene o establece un valor que indica si este Objeto Survalyzer.Contracts.Public.Elements.SurveyElement es autocompletar.
hasPlaceholder	hasPlaceholder		boolean	Obtiene o establece un valor que indica si esta instancia tiene un marcador de posición.
isPassword	isPassword		boolean	Obtiene o establece un valor que indica si esta instancia es contraseña.
minMaxValidation	minMaxValidation		boolean	Obtiene o establece un valor que indica si [validación máxima mínima].
minimumCheckedChoices	minimumCheckedChoices		integer	Obtiene o establece las opciones de comprobación mínimas.
maximumCheckedChoices	maximumCheckedChoices		integer	Obtiene o establece las opciones máximas activadas.
id	id	True	integer	Obtiene o establece el identificador.
hasNotAvailableChoice	hasNotAvailableChoice	True	boolean	Obtiene o establece un valor que indica si esta instancia no tiene opción disponible.
randomColumns	randomizeColumns	True	boolean	Obtiene o establece un valor que indica si [columnas aleatorias].
choiceType	choiceType	True	string	ChoiceType
randomRows	randomizeRows		boolean	Obtiene o establece un valor que indica si [filas aleatorias].
id	id	True	integer	Obtiene o establece el identificador.
código	code	True	string	Obtiene o establece el código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtiene o establece un valor que indica si [código ha cambiado manualmente].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtiene o establece un valor que indica si [excluir de la selección aleatoria].
numberOfRanks	numberOfRanks		integer	Obtiene o establece el número de clasificaciones.
hasStartText	hasStartText		boolean	Obtiene o establece un valor que indica si esta instancia tiene texto de inicio.
enableMeasurement	enableMeasurement		boolean	Obtiene o establece un valor que indica si [habilitar medida].
showButtons	showButtons		boolean	Obtiene o establece un valor que indica si [mostrar botones].
likeKey	likeKey		string	Obtiene o establece la clave similar.
dislikeKey	dislikeKey		string	Obtiene o establece la clave que no le gusta.
interviewState	interviewState		string	Obtiene o establece el estado de la respuesta.
actionType	actionType	True	string	QuotaAction
desde	from		string	Obtiene o establece el remitente.
to	to		string	Obtiene o establece el receptor.
valueAssignmentType	valueAssignmentType		string	ValueAssignmentType
variableName	variableName		string	Obtiene o establece el nombre de la variable.
executionBehavior	executionBehavior		string	ExecutionBehavior
apiCallMethod	apiCallMethod		string	ApiCallMethod
headers	headers		string	Obtiene o establece los encabezados.
externalUri	externalUri		string	Obtiene o establece el URI externo.
scriptType	scriptType		string	ScriptType
contenido	content		string	Obtiene o establece el contenido.
hasRatingLabels	hasRatingLabels		boolean	Obtiene o establece un valor que indica si esta instancia tiene etiquetas de clasificación.
evaluateAsJson	evaluateAsJson		boolean	Obtiene o establece un valor que indica si [evaluate as json].
autocompleteListVariable	autocompleteListVariable		string	Obtiene o establece la variable de lista de autocompletar.
arrangementMode	arrangementMode		string	ArrangementMode
enableAnimation	enableAnimation		boolean	Obtiene o establece un valor que indica si [habilitar animación].
useSmiley	useSmiley		boolean	Obtiene o establece un valor que indica si [usar sonriente].
hasPrompt	hasPrompt		boolean	Obtiene o establece un valor que indica si esta instancia tiene un símbolo del sistema.
id	id	True	integer	Obtiene o establece el identificador.
variableName	variableName	True	string	Obtiene o establece el nombre de la variable.
defaultTextOverrides	defaultTextOverrides		object	Obtiene o establece las invalidaciones de texto predeterminadas.
surveyDesignLayout	surveyDesignLayout		integer	Obtiene o establece el diseño de diseño de la encuesta.
matrixSubQuestionSize	matrixSubQuestionSize		string	MatrixSubQuestionSize
nombre	name		string	Obtiene o establece el nombre.
type	type		string	Obtiene o establece el tipo.
languageCode	languageCode	True	string	Obtiene o establece el código de idioma.
texto	text		string	Obtiene o establece el texto.
anonymizingMode	anonymizingMode	True	string	AnonymizingMode
logIp	logIp	True	boolean	Obtiene o establece un valor que indica si [log ip].
logUserAgent	logUserAgent	True	boolean	Obtiene o establece un valor que indica si [agente de usuario de registro].
logReferer	logReferer	True	boolean	Obtiene o establece un valor que indica si [referencia de registro].

Devoluciones

Esta clase representa los parámetros devueltos para updateSurvey API.

Body: UpdateSurveyResponse

Actualizar miembros

Id. de la operación:: UpdateMembers

Esta acción ofrece la posibilidad de actualizar la lista de miembros.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
tenant	tenant		string	Obtiene o establece el inquilino.
panelId	panelId	True	integer	Obtiene o establece el identificador del panel.
id	id		integer	Obtiene o establece el identificador.
fields	fields	True	object	Obtiene o establece los campos.
createdAt	createdAt		date-time	Obtiene o establece el objeto creado en .
createdBy	createdBy		string	Obtiene o establece el objeto creado por.
updatedAt	updatedAt		date-time	Obtiene o establece el objeto actualizado en .
actualizadoPor	updatedBy		string	Obtiene o establece el objeto actualizado por.
id	id		string	El identificador de la entrevista
estado	state		string	Obtiene o establece el estado.
surveyId	surveyId		integer	Identificador de la encuesta
surveyVersionId	surveyVersionId		integer	Identificador de la versión de la encuesta
surveyName	surveyName		string	Nombre de la encuesta
surveyState	surveyState		string	Obtiene o establece el estado de la encuesta.
answersLink	answersLink		string	Vínculo a la página de impresión de respuestas
interviewLink	interviewLink		string	Obtiene o establece el vínculo de entrevista.
startDate	startDate		string	Obtiene o establece la fecha de inicio.
fecha de finalización	endDate		string	Obtiene o establece la fecha de finalización.
samplingProjectId	samplingProjectId		integer	Obtiene o establece el identificador del proyecto de muestreo.
distributorId	distributorId		integer	Obtiene o establece el identificador del distribuidor.

Devoluciones

Esta clase representa los parámetros devueltos para updateMembers API.

Body: UpdateMembersResponse

Actualizar Opt-Outs

Id. de la operación:: WriteOptOutList

Esta acción ofrece la posibilidad de escribir entradas en la lista de Opt-Out de un área de trabajo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
workspaceId	workspaceId		integer	Obtiene o establece el identificador del área de trabajo.
panelId	panelId		integer	Obtiene o establece el identificador del panel.
distributorId	distributorId		integer	Obtiene o establece el identificador del distribuidor.
Correo electrónico	email	True	string	Obtiene o establece el correo electrónico.
optOutOperation	optOutOperation	True	string	OptOutOperation
celular	cellPhone	True	integer	Obtiene o establece el teléfono celular.
optOutOperation	optOutOperation	True	string	OptOutOperation

Devoluciones

Esta clase representa los parámetros devueltos para la API WriteOptOutList.

Body: WriteOptOutListResponse

Canjear código de incentivo

Id. de la operación:: RedeemIncentiveCode

Esta acción ofrece la posibilidad de gastar créditos de encuesta para incentivos/vales.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
incentiveId	incentiveId	True	integer	Obtiene o establece el identificador de incentivo.

Devoluciones

Esta clase representa los parámetros devueltos de la API RedeemIncentiveCode.

Body: RedeemIncentiveCodeResponse

Creación de webHook

Id. de la operación:: CreateWebHook

Esta acción ofrece la posibilidad de crear el webhook.

Parámetros

Nombre	Clave	Tipo	Description
eventType	eventType	string	Tipo de evento
entityIdentifier	entityIdentifier	string	Obtiene o establece el identificador de entidad.
securityToken	securityToken	string	Obtiene o establece el token de seguridad.
webHookUrl	webHookUrl	string	Obtiene o establece la dirección URL del enlace web.

Devoluciones

Esta clase representa los parámetros devueltos para la API CreateWebHook.

Body: CreateWebHookResponse

Crear artefacto

Id. de la operación:: CreateArtifact

Esta acción ofrece la posibilidad de crear un nuevo artefacto.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
workspaceId	workspaceId		integer	Obtiene o establece el identificador del área de trabajo.
camino	path		string	Obtiene o establece la ruta de acceso.

Devoluciones

Esta clase representa la respuesta de la API CreateArtifact.

Body: CreateArtifactResponse

Crear encuesta

Id. de la operación:: CreateSurvey

Esta acción ofrece la posibilidad de crear una encuesta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
workspaceId	workspaceId	True	integer	Obtiene o establece el identificador del área de trabajo.
nombre	name	True	string	Obtiene o establece el nombre.
allowMultipleParticipation	allowMultipleParticipation	True	boolean	Obtiene o establece un valor que indica si [permitir la participación múltiple].
allowNavigateBack	allowNavigateBack	True	boolean	Obtiene o establece un valor que indica si [permitir la navegación hacia atrás].
allowSaveProgress	allowSaveProgress		boolean	Obtiene o establece un valor que indica si [permitir el progreso de guardar].
randomSections	randomizeSections	True	boolean	Obtiene o establece un valor que indica si [secciones aleatorias].
enableAutoScroll	enableAutoScroll		boolean	Obtiene o establece un valor que indica si [habilitar el desplazamiento automático].
enableCodeAccess	enableCodeAccess		boolean	Obtiene o establece un valor que indica si [habilitar el acceso al código].
accessType	accessType		string	Tipo de acceso
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
associatedPanels	associatedPanels		array of integer	Obtiene o establece el identificador del panel.
codeAccessMode	codeAccessMode	True	string	AuthenticationType
enablePanelSync	enablePanelSync		boolean	Obtiene o establece un valor que indica si [habilitar la sincronización del panel].
panelSyncBehaviour	panelSyncBehaviour		string	PanelSyncBehaviour
identificador	identifier		string	Obtiene o establece el identificador.
panelField	panelField		string	Obtiene o establece el campo del panel.
defaultLanguage	defaultLanguage	True	string	Obtiene o establece el idioma predeterminado.
fecha de finalización	endDate		date-time	Obtiene o establece la fecha de finalización.
Idiomas	languages	True	array of string	Obtiene o establece los idiomas.
id	id	True	integer	Obtiene o establece el identificador.
nombre	name	True	string	Obtiene o establece el nombre.
randomPages	randomizePages	True	boolean	Obtiene o establece un valor que indica si [páginas aleatorias].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtiene o establece un valor que indica si [excluir de la selección aleatoria].
id	id	True	integer	Obtiene o establece el identificador.
elementType	elementType	True	string	ElementType
código	code		string	Obtiene o establece el código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtiene o establece un valor que indica si [código ha cambiado manualmente].
languageCode	languageCode	True	string	Obtiene o establece el código de idioma.
texto	text		string	Obtiene o establece el texto.
hasHintText	hasHintText		boolean	Obtiene o establece un valor que indica si esta instancia tiene texto de sugerencia.
hasNotAvailableChoice	hasNotAvailableChoice		boolean	Obtiene o establece un valor que indica si esta instancia no tiene opción disponible.
forceResponse	forceResponse		boolean	Obtiene o establece un valor que indica si [forzar respuesta].
id	id	True	integer	Obtiene o establece el identificador.
código	code	True	string	Obtiene o establece el código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtiene o establece un valor que indica si [código ha cambiado manualmente].
allowTextEntry	allowTextEntry	True	boolean	Obtiene o establece un valor que indica si [permitir entrada de texto].
forceInput	forceInput	True	boolean	Obtiene o establece un valor que indica si [forzar entrada].
autocompletar	autocomplete	True	boolean	Obtiene o establece un valor que indica si este Objeto Survalyzer.Contracts.Public.Elements.Choice es autocompletar.
exclusivo	exclusive	True	boolean	Obtiene o establece un valor que indica si este Survalyzer.Contracts.Public.Elements.Choice es exclusivo.
excludeFromRandomization	excludeFromRandomization		boolean	Obtiene o establece un valor que indica si [excluir de la selección aleatoria].
validationType	validationType	True	string	ContentValidation (Validación de contenido)
earliestDate	earliestDate		string	Obtiene o establece la fecha más antigua.
latestDate	latestDate		string	Obtiene o establece la fecha más reciente.
valor mínimo	minValue		double	Obtiene o establece el valor mínimo.
valorMáximo	maxValue		double	Obtiene o establece el valor máximo.
decimalPlaces	decimalPlaces		integer	Obtiene o establece las posiciones decimales.
disableThousandSeparator	disableThousandSeparator		boolean	Obtiene o establece el separador de miles de deshabilitación.
conditionAction	conditionAction	True	string	FilterAction
autocompleteListVariable	autocompleteListVariable		string	Obtiene o establece la variable de lista de autocompletar.
randomChoices	randomizeChoices		boolean	Obtiene o establece un valor que indica si [opciones aleatorias].
columnType	columnType		string	TipoDeColumna
valor mínimo	minValue		integer	Obtiene o establece el valor mínimo.
valorMáximo	maxValue		integer	Obtiene o establece el valor máximo.
showCenterLabel	showCenterLabel		boolean	Obtiene o establece un valor que indica si [mostrar etiqueta central].
showValue	showValue		boolean	Obtiene o establece un valor que indica si [mostrar valor].
maxDecimals	maxDecimals		integer	Obtiene o establece los dígitos máximos después de la coma.
textFieldSize	textFieldSize		string	TextFieldSize
autocompletar	autocomplete		boolean	Obtiene o establece un valor que indica si este Objeto Survalyzer.Contracts.Public.Elements.SurveyElement es autocompletar.
hasPlaceholder	hasPlaceholder		boolean	Obtiene o establece un valor que indica si esta instancia tiene un marcador de posición.
isPassword	isPassword		boolean	Obtiene o establece un valor que indica si esta instancia es contraseña.
minMaxValidation	minMaxValidation		boolean	Obtiene o establece un valor que indica si [validación máxima mínima].
minimumCheckedChoices	minimumCheckedChoices		integer	Obtiene o establece las opciones de comprobación mínimas.
maximumCheckedChoices	maximumCheckedChoices		integer	Obtiene o establece las opciones máximas activadas.
id	id	True	integer	Obtiene o establece el identificador.
hasNotAvailableChoice	hasNotAvailableChoice	True	boolean	Obtiene o establece un valor que indica si esta instancia no tiene opción disponible.
randomColumns	randomizeColumns	True	boolean	Obtiene o establece un valor que indica si [columnas aleatorias].
choiceType	choiceType	True	string	ChoiceType
randomRows	randomizeRows		boolean	Obtiene o establece un valor que indica si [filas aleatorias].
id	id	True	integer	Obtiene o establece el identificador.
código	code	True	string	Obtiene o establece el código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtiene o establece un valor que indica si [código ha cambiado manualmente].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtiene o establece un valor que indica si [excluir de la selección aleatoria].
numberOfRanks	numberOfRanks		integer	Obtiene o establece el número de clasificaciones.
hasStartText	hasStartText		boolean	Obtiene o establece un valor que indica si esta instancia tiene texto de inicio.
enableMeasurement	enableMeasurement		boolean	Obtiene o establece un valor que indica si [habilitar medida].
showButtons	showButtons		boolean	Obtiene o establece un valor que indica si [mostrar botones].
likeKey	likeKey		string	Obtiene o establece la clave similar.
dislikeKey	dislikeKey		string	Obtiene o establece la clave que no le gusta.
interviewState	interviewState		string	Obtiene o establece el estado de la respuesta.
actionType	actionType	True	string	QuotaAction
desde	from		string	Obtiene o establece el remitente.
to	to		string	Obtiene o establece el receptor.
valueAssignmentType	valueAssignmentType		string	ValueAssignmentType
variableName	variableName		string	Obtiene o establece el nombre de la variable.
executionBehavior	executionBehavior		string	ExecutionBehavior
apiCallMethod	apiCallMethod		string	ApiCallMethod
headers	headers		string	Obtiene o establece los encabezados.
externalUri	externalUri		string	Obtiene o establece el URI externo.
scriptType	scriptType		string	ScriptType
contenido	content		string	Obtiene o establece el contenido.
hasRatingLabels	hasRatingLabels		boolean	Obtiene o establece un valor que indica si esta instancia tiene etiquetas de clasificación.
evaluateAsJson	evaluateAsJson		boolean	Obtiene o establece un valor que indica si [evaluate as json].
autocompleteListVariable	autocompleteListVariable		string	Obtiene o establece la variable de lista de autocompletar.
arrangementMode	arrangementMode		string	ArrangementMode
enableAnimation	enableAnimation		boolean	Obtiene o establece un valor que indica si [habilitar animación].
useSmiley	useSmiley		boolean	Obtiene o establece un valor que indica si [usar sonriente].
hasPrompt	hasPrompt		boolean	Obtiene o establece un valor que indica si esta instancia tiene un símbolo del sistema.
id	id	True	integer	Obtiene o establece el identificador.
variableName	variableName	True	string	Obtiene o establece el nombre de la variable.
defaultTextOverrides	defaultTextOverrides		object	Obtiene o establece las invalidaciones de texto predeterminadas.
surveyDesignLayout	surveyDesignLayout		integer	Obtiene o establece el diseño de diseño de la encuesta.
matrixSubQuestionSize	matrixSubQuestionSize		string	MatrixSubQuestionSize
nombre	name		string	Obtiene o establece el nombre.
type	type		string	Obtiene o establece el tipo.
languageCode	languageCode	True	string	Obtiene o establece el código de idioma.
texto	text		string	Obtiene o establece el texto.
anonymizingMode	anonymizingMode	True	string	AnonymizingMode
logIp	logIp	True	boolean	Obtiene o establece un valor que indica si [log ip].
logUserAgent	logUserAgent	True	boolean	Obtiene o establece un valor que indica si [agente de usuario de registro].
logReferer	logReferer	True	boolean	Obtiene o establece un valor que indica si [referencia de registro].

Devoluciones

Esta clase representa los parámetros devueltos para createSurvey API.

Body: CreateSurveyResponse

Crear miembros

Id. de la operación:: CreateMembers

Esta acción ofrece la posibilidad de crear la lista de miembros.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
tenant	tenant		string	Obtiene o establece el inquilino.
panelId	panelId	True	integer	Obtiene o establece el identificador del panel.
id	id		integer	Obtiene o establece el identificador.
fields	fields	True	object	Obtiene o establece los campos.
createdAt	createdAt		date-time	Obtiene o establece el objeto creado en .
createdBy	createdBy		string	Obtiene o establece el objeto creado por.
updatedAt	updatedAt		date-time	Obtiene o establece el objeto actualizado en .
actualizadoPor	updatedBy		string	Obtiene o establece el objeto actualizado por.
id	id		string	El identificador de la entrevista
estado	state		string	Obtiene o establece el estado.
surveyId	surveyId		integer	Identificador de la encuesta
surveyVersionId	surveyVersionId		integer	Identificador de la versión de la encuesta
surveyName	surveyName		string	Nombre de la encuesta
surveyState	surveyState		string	Obtiene o establece el estado de la encuesta.
answersLink	answersLink		string	Vínculo a la página de impresión de respuestas
interviewLink	interviewLink		string	Obtiene o establece el vínculo de entrevista.
startDate	startDate		string	Obtiene o establece la fecha de inicio.
fecha de finalización	endDate		string	Obtiene o establece la fecha de finalización.
samplingProjectId	samplingProjectId		integer	Obtiene o establece el identificador del proyecto de muestreo.
distributorId	distributorId		integer	Obtiene o establece el identificador del distribuidor.

Devoluciones

Esta clase representa los parámetros devueltos para la API CreateMembers.

Body: CreateMembersResponse

Crear panel o ejemplo

Id. de la operación:: CreatePanel

Esta acción ofrece la posibilidad de crear un nuevo panel.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
workspaceId	workspaceId	True	integer	Obtiene o establece el identificador del área de trabajo.
nombre	name	True	string	Obtiene o establece el nombre del panel.
panelType	panelType	True	string	PanelModelType

Devoluciones

Esta clase representa los parámetros devueltos para la API CreatePanel.

Body: CreatePanelResponse

Descargar PDF de entrevista

Id. de la operación:: DownloadInterviewPdf

Esta acción ofrece la posibilidad de descargar las respuestas.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Inquilino	tenant	True	string	El inquilino.
SurveyId	surveyId	True	integer	Identificador de la encuesta.
InterviewId	interviewId	True	uuid	Identificador de la entrevista.
Mostrar completado parcial	showPartialCompleted		boolean	si se establece en <c>true</c> [mostrar completado parcial].
Configuración regional	locale		string	Configuración regional.
Thmezone	timeZone		string	Zona horaria.
isCancellationRequested	isCancellationRequested		boolean
canBeCanceled	canBeCanceled		boolean
isInvalid	isInvalid		boolean
isClosed	isClosed		boolean

Devoluciones

Esta clase representa los parámetros devueltos para la API DownloadAnswers.

Body: DownloadAnswersResponse

Ejecutar transición de flujo de trabajo

Id. de la operación:: ExecuteWorkflowTransition

Esta acción ofrece la posibilidad de ejecutar la transición de flujo de trabajo específica para el flujo de trabajo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
flujo de trabajo	workflow	True	string	Tipo de flujo de trabajo
surveyId	surveyId		integer	Obtiene o establece el identificador de la encuesta.
samplingProjectId	samplingProjectId		integer	Obtiene o establece el identificador del proyecto de muestreo.
distributorId	distributorId		integer	Obtiene o establece el identificador del distribuidor.
reminderId	reminderId		integer	Obtiene o establece el identificador de recordatorio.
targetState	targetState	True	string	Obtiene o establece el estado del destino.
dynamicParameters	dynamicParameters		object	Obtiene o establece los parámetros dinámicos.

Devoluciones

Esta clase representa los parámetros devueltos para executeWorkflowTransition API.

Body: ExecuteWorkflowTransitionResponse

Eliminar distribuidor

Id. de la operación:: DeleteDistributor

Esta acción ofrece la posibilidad de eliminar el distribuidor.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
distributorId	distributorId	True	integer	Obtiene o establece el identificador del distribuidor.
keepInterviews	keepInterviews		boolean	Obtiene o establece un valor que indica si [mantener entrevistas].

Devoluciones

Esta clase representa los parámetros devueltos de la API DeleteDistributor.

Body: DeleteDistributorResponse

Eliminar encuesta

Id. de la operación:: DeleteSurvey

Esta acción ofrece la posibilidad de eliminar la encuesta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
surveyId	surveyId	True	integer	Obtiene o establece el identificador de la encuesta.

Devoluciones

Esta clase representa los parámetros devueltos para deleteSurvey API.

Body: DeleteSurveyResponse

Eliminar entrevista

Id. de la operación:: DeleteInterview

Esta acción ofrece la posibilidad de eliminar la entrevista.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
interviewId	interviewId		uuid	Obtiene o establece el identificador de la entrevista.
surveyId	surveyId		integer	Obtiene o establece el identificador de la encuesta.

Devoluciones

Esta clase representa los parámetros devueltos para la API DeleteInterview.

Body: DeleteInterviewResponse

Eliminar miembros

Id. de la operación:: DeleteMembers

Esta acción ofrece la posibilidad de eliminar miembros.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
panelId	panelId	True	integer	Obtiene o establece el identificador del panel.
panelMembersIds	panelMembersIds	True	array of integer	Obtiene o establece el identificador de miembro del panel.
keepInterviews	keepInterviews		boolean	Obtiene o establece un valor que indica si [mantener entrevistas].

Devoluciones

Esta clase representa los parámetros devueltos para la API DeleteMember.

Body: DeleteMembersResponse

Eliminar panel

Id. de la operación:: DeletePanel

Esta acción ofrece la posibilidad de eliminar el panel.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
panelId	panelId	True	integer	Obtiene o establece el identificador de ejemplo.
keepInterviews	keepInterviews		boolean	Obtiene o establece un valor que indica si [mantener entrevistas].

Devoluciones

Esta clase representa los parámetros devueltos para la API DeleteSample.

Body: DeletePanelResponse

Eliminar proyecto de muestreo

Id. de la operación:: DeleteSamplingProject

Esta acción ofrece la posibilidad de eliminar el proyecto de muestreo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
samplingProjectId	samplingProjectId		integer	Obtiene o establece el identificador del proyecto de muestreo.
keepInterviews	keepInterviews		boolean	Obtiene o establece un valor que indica si [mantener entrevistas].

Devoluciones

Esta clase representa los parámetros devueltos para deleteSamplingProject API.

Body: DeleteSamplingProjectResponse

Eliminar un artefacto

Id. de la operación:: DeleteArtifact

Esta acción ofrece la posibilidad de eliminar artefactos.

Parámetros

Nombre	Clave	Tipo	Description
camino	path	string	Obtiene o establece la ruta de acceso.
filename	filename	string	Obtiene o establece el nombre de archivo.
workspaceId	workspaceId	integer	Obtiene o establece el identificador del área de trabajo.

Devoluciones

Esta clase representa los parámetros devueltos para la API DeleteArtifact.

Body: DeleteArtifactResponse

Eliminar webHook

Id. de la operación:: DeleteWebHook

Esta acción ofrece la posibilidad de eliminar el webhook.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
webHookId	webHookId		uuid	Obtiene o establece el identificador de web hook.

Devoluciones

Esta clase representa los parámetros devueltos de la API DeleteWebHook.

Body: DeleteWebHookResponse

Enviar correo

Id. de la operación:: ExecuteSendMail

Esta acción ofrece la posibilidad de enviar correo electrónico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
messageTemplateId	messageTemplateId		integer	Obtiene o establece el identificador de plantilla de mensaje.
nombre	name		string	Obtiene o establece el nombre.
type	type		string	Obtiene o establece el tipo.
languageCode	languageCode	True	string	Obtiene o establece el código de idioma.
texto	text		string	Obtiene o establece el texto.
lenguaje	language	True	string	Obtiene o establece el idioma.
Asunto	subject		string	Obtiene o establece el asunto.
body	body		string	Obtiene o establece el cuerpo.
desde	from	True	string	Obtiene o establece de .
fromName	fromName		string	Obtiene o establece a partir del nombre.
to	to	True	string	Obtiene o establece en .
toName	toName		string	Convierte en nombre.
replyTo	replyTo		string	Obtiene o establece la respuesta a.
replyToName	replyToName		string	Obtiene o establece el nombre de la respuesta a.

Devoluciones

Esta clase representa los parámetros devueltos para executeSendMail API.

Body: ExecuteSendMailResponse

Invitar a miembros

Id. de la operación:: InviteMembers

Esta acción ofrece la posibilidad de invitar al miembro.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
surveyId	surveyId	True	integer	Identificador de la encuesta
panelId	panelId	True	integer	Obtiene o establece el identificador del panel.
samplingProjectId	samplingProjectId		integer	Obtiene o establece el identificador del proyecto de muestreo.
memberIds	memberIds		array of integer	Obtiene o establece los identificadores de los miembros del panel.
messageTemplateId	messageTemplateId	True	integer	Obtiene o establece el identificador de plantilla de mensaje.
nombre	name		string	Obtiene o establece el nombre.
type	type		string	Obtiene o establece el tipo.
languageCode	languageCode	True	string	Obtiene o establece el código de idioma.
texto	text		string	Obtiene o establece el texto.
scheduleDateTime	scheduleDateTime		date-time	Obtiene o establece la hora de programación.
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
Canal	channel		string	Canal de distribución
asyncProcess	asyncProcess		boolean	Obtiene o establece el proceso asincrónico.
interviewExpiryDate	interviewExpiryDate		string	Obtiene o establece la fecha de expiración de la entrevista.
desde	from		string	Obtiene o establece de .
fromName	fromName		string	Obtiene o establece a partir del nombre.
replyTo	replyTo		string	Obtiene o establece la respuesta a.
replyToName	replyToName		string	Obtiene o establece el nombre de la respuesta a.

Devoluciones

Esta clase representa los parámetros devueltos para la API InviteMembers.

Body: InviteMembersResponse

Invitar a miembros

Id. de la operación:: CreateAndInviteMembers

Esta acción ofrece la posibilidad de crear e invitar a miembros.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
samplingProjectId	samplingProjectId		integer	Obtiene o establece el identificador del proyecto de muestreo.
surveyId	surveyId	True	integer	Obtiene o establece el identificador de la encuesta.
panelId	panelId	True	integer	Obtiene o establece el identificador del panel.
Canal	channel	True	string	Canal de distribución
messageTemplateId	messageTemplateId	True	integer	Obtiene o establece el identificador de plantilla de mensaje.
nombre	name		string	Obtiene o establece el nombre.
type	type		string	Obtiene o establece el tipo.
languageCode	languageCode	True	string	Obtiene o establece el código de idioma.
texto	text		string	Obtiene o establece el texto.
id	id		integer	Obtiene o establece el identificador.
fields	fields	True	object	Obtiene o establece los campos.
createdAt	createdAt		date-time	Obtiene o establece el objeto creado en .
createdBy	createdBy		string	Obtiene o establece el objeto creado por.
updatedAt	updatedAt		date-time	Obtiene o establece el objeto actualizado en .
actualizadoPor	updatedBy		string	Obtiene o establece el objeto actualizado por.
id	id		string	El identificador de la entrevista
estado	state		string	Obtiene o establece el estado.
surveyId	surveyId		integer	Identificador de la encuesta
surveyVersionId	surveyVersionId		integer	Identificador de la versión de la encuesta
surveyName	surveyName		string	Nombre de la encuesta
surveyState	surveyState		string	Obtiene o establece el estado de la encuesta.
answersLink	answersLink		string	Vínculo a la página de impresión de respuestas
interviewLink	interviewLink		string	Obtiene o establece el vínculo de entrevista.
startDate	startDate		string	Obtiene o establece la fecha de inicio.
fecha de finalización	endDate		string	Obtiene o establece la fecha de finalización.
samplingProjectId	samplingProjectId		integer	Obtiene o establece el identificador del proyecto de muestreo.
distributorId	distributorId		integer	Obtiene o establece el identificador del distribuidor.
scheduleDateTime	scheduleDateTime		string	Obtiene o establece la fecha y hora de programación.
asyncProcess	asyncProcess		boolean	Obtiene o establece el proceso asincrónico.
interviewExpiryDate	interviewExpiryDate		string	Obtiene o establece la fecha de expiración de la entrevista.
desde	from		string	Obtiene o establece de .
fromName	fromName		string	Obtiene o establece a partir del nombre.
replyTo	replyTo		string	Obtiene o establece la respuesta a.
replyToName	replyToName		string	Obtiene o establece el nombre de la respuesta a.

Devoluciones

Esta clase representa los parámetros devueltos para la API CreateAndInviteMembers.

Body: CreateAndInviteMembersResponse

Lectura de rebotes

Id. de la operación:: ReadBounceList

Esta acción ofrece la posibilidad de leer la lista de rebotes.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
surveyId	surveyId	True	integer	Obtiene o establece el identificador de la encuesta.
panelId	panelId		integer	Obtiene o establece el identificador del panel.
Distribuidores	distributors		array of integer	Obtiene o establece los distribuidores.
invitationType	invitationType		string	InvitationType
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros devueltos para la API ReadBounceList.

Body: ReadBounceListResponseV3

Leer artefactos

Id. de la operación:: ReadArtifactList

Esta acción ofrece la posibilidad de leer la lista de artefactos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
camino	path		string	Obtiene o establece la ruta de acceso.
workspaceId	workspaceId		integer	Obtiene o establece el identificador del área de trabajo.

Devoluciones

Esta clase representa los parámetros de solicitud de readArtifactList API.

Body: ReadArtifactListRequest

Leer distribuidores

Id. de la operación:: ReadDistributorList

Esta acción ofrece la posibilidad de leer la lista de distribuidores.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
surveyId	surveyId		integer	Obtiene o establece el identificador de la encuesta.
panelId	panelId		integer	Obtiene o establece el identificador del panel.
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros devueltos para la API ReadDistributorList.

Body: ReadDistributorListResponse

Leer encuesta

Id. de la operación:: ReadSurvey

Esta acción ofrece la posibilidad de leer la encuesta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
tenant	tenant		string	Obtiene o establece el inquilino.
surveyId	surveyId	True	integer	Obtiene o establece el identificador de la encuesta.

Devoluciones

Esta clase representa los parámetros devueltos de readSurveyDefinition API.

Body: ReadSurveyResponse

Leer encuestas

Id. de la operación:: ReadSurveyList

Esta acción ofrece la posibilidad de leer todas las encuestas disponibles de un área de trabajo determinada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
workspaceId	workspaceId	True	integer	Obtiene o establece el identificador del área de trabajo.
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros de respuesta de readSurveyList API.

Body: ReadSurveyListResponse

Leer entrevista

Id. de la operación:: ReadInterview

Esta acción ofrece la posibilidad de leer los datos de la entrevista.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
tenant	tenant	True	string	Obtiene o establece el inquilino.
interviewId	interviewId	True	uuid	Obtiene o establece el identificador de la entrevista.
surveyId	surveyId	True	integer	Obtiene o establece el identificador de la encuesta.
loadSurveyDefinition	loadSurveyDefinition		boolean	Obtiene o establece un valor que indica si [definición de encuesta de carga].

Devoluciones

Esta clase representa los parámetros devueltos para la API ReadInterviewData.

Body: ReadInterviewDataResponse

Leer entrevistas

Id. de la operación:: ReadInterviewList

Esta acción ofrece la posibilidad de leer la lista de entrevistas.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
tenant	tenant		string	Obtiene o establece el inquilino.
surveyId	surveyId		integer	Obtiene o establece el identificador de la encuesta.
fieldsToDownload	fieldsToDownload		array of string	Obtiene o establece las columnas solicitadas.
loadCodePlan	loadCodePlan		boolean	Obtiene o establece un valor que indica si [plan de carga de código].
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros devueltos para la API ReadInterviewList.

Body: ReadInterviewListResponseV3

Leer entrevistas compactas

Id. de la operación:: ReadInterviewListCompact

Esta acción ofrece la posibilidad de leer la lista de entrevistas compacta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
tenant	tenant		string	Obtiene o establece el inquilino.
surveyId	surveyId		integer	Obtiene o establece el identificador de la encuesta.
fieldsToDownload	fieldsToDownload		array of string	Obtiene o establece las columnas solicitadas.
loadCodePlan	loadCodePlan		boolean	Obtiene o establece un valor que indica si [plan de carga de código].
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros devueltos para readInterviewListCompact API.

Body: ReadInterviewListCompactResponseV3

Leer incentivos

Id. de la operación:: ReadIncentiveList

Esta acción devuelve los incentivos o vales disponibles para el usuario autenticado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros de solicitud de la API ReadIncentiveList.

Body: ReadIncentiveListResponse

Leer miembros

Id. de la operación:: ReadMemberList

Esta acción ofrece la posibilidad de leer miembros.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
tenant	tenant		string	Obtiene o establece el inquilino.
panelId	panelId	True	integer	Obtiene o establece el identificador del panel.
entrevistasRequired	interviewsRequired	True	boolean	Obtiene o establece un valor que indica si se requiere la información de sesión.
fieldsToDownload	fieldsToDownload		array of string	Obtiene o establece los campos que se van a descargar.
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros devueltos para la API ReadMemberList.

Body: ReadMemberListResponse

Leer Opt-Outs

Id. de la operación:: ReadOptOutList

Esta acción ofrece la posibilidad de leer todos los Opt-Outs de un área de trabajo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
panelId	panelId		integer	Obtiene o establece el identificador del panel.
workspaceId	workspaceId		integer	Obtiene o establece el identificador del área de trabajo.
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros devueltos de readOptOutList API.

Body: ReadOptOutListResponseV3

Leer plantillas de mensaje

Id. de la operación:: ReadMessageTemplateList

Esta acción ofrece la posibilidad de recibir todas las plantillas de mensaje configuradas para correo electrónico y SMS.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
workspaceId	workspaceId		integer	Obtiene o establece el identificador del área de trabajo.
lenguaje	language	True	string	Obtiene o establece el idioma.
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros devueltos para la API ReadMessageTemplateList.

Body: ReadMessageTemplateListResponse

Leer proyecto de muestreo

Id. de la operación:: ReadSamplingProject

Esta acción ofrece la posibilidad de leer el proyecto de muestreo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
samplingProjectId	samplingProjectId		integer	Obtiene o establece el identificador del proyecto de muestreo.

Devoluciones

Esta clase representa los parámetros devueltos para readSamplingProject API.

Body: ReadSamplingProjectResponse

Leer saldo de crédito

Id. de la operación:: ReadCreditBalance

Esta acción devuelve el saldo de crédito de la encuesta para el usuario autenticado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
			object	Esta clase representa los parámetros de solicitud de readCreditBalance API.

Devoluciones

Esta clase representa los parámetros devueltos para readCreditBalance API.

Body: ReadCreditBalanceResponse

Leer transacciones de incentivos

Id. de la operación:: ReadIncentiveTransactionList

La acción devuelve información general sobre todas las ganancias y gastos relacionados con los créditos de la encuesta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros devueltos para la API ReadIncentiveTransactionList.

Body: ReadIncentiveTransactionListResponse

Leer transiciones de flujo de trabajo

Id. de la operación:: ReadWorkflowTransitions

Esta acción ofrece la posibilidad de leer todas las transiciones de flujo de trabajo específicas para el flujo de trabajo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
flujo de trabajo	workflow	True	string	Tipo de flujo de trabajo
currentState	currentState	True	string	Obtiene o establece el estado del objeto actual.

Devoluciones

Esta clase representa los parámetros devueltos de la API ReadWorkflowTransitions.

Body: ReadWorkflowTransitionsResponse

Leer vínculos de encuesta

Id. de la operación:: ReadSurveyLinks

Esta acción ofrece la posibilidad de leer los vínculos de la encuesta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
surveyId	surveyId		integer	Obtiene o establece el identificador de la encuesta.

Devoluciones

Esta clase representa la respuesta de readSurveyLinks API.

Body: ReadSurveyLinksResponse

Leer webHooks

Id. de la operación:: ReadWebHookList

Esta acción ofrece la posibilidad de leer la lista de web hooks.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
eventType	eventType		string	Tipo de evento
entityIdentifier	entityIdentifier		string	Obtiene o establece el identificador de entidad.

Devoluciones

Esta clase representa los parámetros devueltos para la API ReadWebHookList.

Body: ReadWebHookListResponse

Leer áreas de trabajo

Id. de la operación:: ReadWorkspaceList

Esta acción ofrece la posibilidad de leer todas las áreas de trabajo disponibles.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
pageSize	pageSize	True	integer	Obtiene o establece el tamaño de la página.
page	page	True	integer	Obtiene o establece la página.
orderField	orderField		string	Obtiene o establece el campo de orden.
orderDirection	orderDirection		string	OrderDirection

Devoluciones

Esta clase representa los parámetros de solicitud de readWorkspaceList API.

Body: ReadWorkspaceListResponse

Panel de actualización

Id. de la operación:: UpdatePanel

Esta acción ofrece la posibilidad de actualizar el panel.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
tenant	tenant		string	Obtiene o establece el inquilino.
panelId	panelId	True	integer	Obtiene o establece el identificador del panel.
id	id		integer	Identificador del campo. Se trata de un campo obligatorio en caso de cambiar el nombre.
nombre	name		string	Nombre del campo. Este campo es obligatorio.
type	type		string	PanelMemberFieldType
value	value			El valor del campo . El tipo de valor debe coincidir con la propiedad Type.
removedFields	removedFields		array of integer	Obtiene o establece los campos eliminados.
id	id		integer	Identificador del campo. Se trata de un campo obligatorio en caso de cambiar el nombre.
nombre	name		string	Nombre del campo. Este campo es obligatorio.
type	type		string	PanelMemberFieldType
value	value			El valor del campo . El tipo de valor debe coincidir con la propiedad Type.

Devoluciones

Esta clase representa los parámetros devueltos para writePanel API.

Body: WritePanelResponse

Panel de lectura

Id. de la operación:: ReadPanel

Esta acción ofrece la posibilidad de leer la definición del panel.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
tenant	tenant		string	Obtiene o establece el inquilino.
panelId	panelId	True	integer	Obtiene o establece el identificador del panel.

Devoluciones

Esta clase representa los parámetros devueltos para readPanelDefinition API.

Body: ReadPanelDefinitionResponse

Recordar miembros

Id. de la operación:: RemindMembers

Esta acción ofrece la posibilidad de recordar al miembro.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
distributorId	distributorId	True	integer	Identificador de la encuesta
messageTemplateId	messageTemplateId	True	integer	Obtiene o establece el identificador de plantilla de mensaje.
nombre	name		string	Obtiene o establece el nombre.
type	type		string	Obtiene o establece el tipo.
languageCode	languageCode	True	string	Obtiene o establece el código de idioma.
texto	text		string	Obtiene o establece el texto.
scheduleDateTime	scheduleDateTime		date-time	Obtiene o establece la hora de programación.
conjunción	conjunction	True	string	Conjunción
conditionType	conditionType	True	string	ConditionType
identificador	identifier	True	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	True	string	ConditionOperator
value	value	True	string	Obtiene o establece el valor.
variableType	variableType		string	VariableType
jsonValue	jsonValue		boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath		string	Obtiene o establece la ruta de acceso json.
Canal	channel		string	Canal de distribución
desde	from		string	Obtiene o establece de .
fromName	fromName		string	Obtiene o establece a partir del nombre.
replyTo	replyTo		string	Obtiene o establece la respuesta a.
replyToName	replyToName		string	Obtiene o establece el nombre de la respuesta a.

Devoluciones

Esta clase representa los parámetros devueltos para la API RemindMembers.

Body: RemindMembersResponse

Restablecer entrevista

Id. de la operación:: ResetInterview

Esta acción ofrece la posibilidad de restablecer la respuesta del miembro del panel.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
surveyId	surveyId		integer	Obtiene o establece el identificador de la encuesta.
interviewId	interviewId		uuid	Obtiene o establece el identificador de la entrevista.

Devoluciones

Esta clase representa los parámetros devueltos para la API ResetInterview.

Body: ResetInterviewResponse

Definiciones

Tipo de acceso

: string

ActionElement

Esta clase representa un final de la acción de encuesta para completar, pantallar o cuota completa.

Nombre	Ruta de acceso	Tipo	Description
actionType	actionType	ActionType	QuotaAction
endOfSurveyText	endOfSurveyText	array of TranslationElement	Obtiene o establece el final del texto de la encuesta.
forwardUrl	forwardUrl	array of TranslationElement	Obtiene o establece la dirección URL de reenvío.

TipoDeAcción

QuotaAction

: string

AnonimizaciónConfiguración

Esta clase contiene la configuración de anonimización que se podría aplicar a un grupo de áreas de trabajo, un área de trabajo o una encuesta individual.

Nombre	Ruta de acceso	Tipo	Description
anonymizingMode	anonymizingMode	AnonymizingMode	AnonymizingMode
logIp	logIp	boolean	Obtiene o establece un valor que indica si [log ip].
logUserAgent	logUserAgent	boolean	Obtiene o establece un valor que indica si [agente de usuario de registro].
logReferer	logReferer	boolean	Obtiene o establece un valor que indica si [referencia de registro].

BounceElement

Esta clase representa un final de la acción de encuesta para completar, pantallar o cuota completa.

Nombre	Ruta de acceso	Tipo	Description
distributorId	distributorId	integer	Obtiene o establece el identificador del distribuidor.
interviewId	interviewId	uuid	Obtiene o establece el identificador de la entrevista.
panelId	panelId	integer	Obtiene o establece el identificador del panel.
panelMemberId	panelMemberId	integer	Obtiene o establece el identificador de miembro del panel.
bounceType	bounceType	BounceType	BounceType
marca de tiempo	timestamp	date-time	Obtiene o establece la marca de tiempo.
estado	state	string	Obtiene o establece el estado.
razón	reason	string	Obtiene o establece el motivo.
Correo electrónico	email	string	Obtiene o establece el correo electrónico.
phone	phone	integer	Obtiene o establece el teléfono.
invitationType	invitationType	InvitationType	InvitationType

BounceType

: string

Opción

Esta clase representa una única opción que se puede usar en cada tipo de pregunta de elección.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
código	code	string	Obtiene o establece el código.
codeManuallyChanged	codeManuallyChanged	boolean	Obtiene o establece un valor que indica si [código ha cambiado manualmente].
texto	text	array of TranslationElement	Obtiene o establece las traducciones de texto.
allowTextEntry	allowTextEntry	boolean	Obtiene o establece un valor que indica si [permitir entrada de texto].
forceInput	forceInput	boolean	Obtiene o establece un valor que indica si [forzar entrada].
autocompletar	autocomplete	boolean	Obtiene o establece un valor que indica si este Objeto Survalyzer.Contracts.Public.Elements.Choice es autocompletar.
autocompletarText	autocompleteText	array of TranslationElement	Obtiene o establece las traducciones de texto autocompletar.
exclusivo	exclusive	boolean	Obtiene o establece un valor que indica si este Survalyzer.Contracts.Public.Elements.Choice es exclusivo.
excludeFromRandomization	excludeFromRandomization	boolean	Obtiene o establece un valor que indica si [excluir de la selección aleatoria].
contentValidation	contentValidation	ContentValidation	Esta clase representa una validación de contenido dentro de una encuesta.
condition	condition	ConditionDefinition	Esta clase representa la definición de los elementos de condiciones.
autocompleteListVariable	autocompleteListVariable	string	Obtiene o establece la variable de lista de autocompletar.

ChoiceType

: string

CodeAccessMode

AuthenticationType

: string

ColItem

Esta clase representa una celda de una respuesta de encuesta.

Nombre	Ruta de acceso	Tipo	Description
id	id	string	Obtiene o establece el identificador.
value	value		Obtiene o establece el valor.

ColumnGroup

Esta clase representa un grupo de columnas dentro de tipos de preguntas complejos, como preguntas de matriz.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
texto	text	array of TranslationElement	Obtiene o establece las traducciones de texto.
hasNotAvailableChoice	hasNotAvailableChoice	boolean	Obtiene o establece un valor que indica si esta instancia no tiene opción disponible.
notAvailableChoiceText	notAvailableChoiceText	array of TranslationElement	Obtiene o establece las traducciones de texto que no están disponibles.
randomColumns	randomizeColumns	boolean	Obtiene o establece un valor que indica si [columnas aleatorias].
inmediato	prompt	array of TranslationElement	Obtiene o establece el símbolo del sistema.
choiceType	choiceType	ChoiceType	ChoiceType
opciones	choices	array of Choice	Obtiene o establece las opciones.
condition	condition	ConditionDefinition	Esta clase representa la definición de los elementos de condiciones.

TipoDeColumna

: string

Condición

Esta clase es la base de todos los elementos de condición.

Nombre	Ruta de acceso	Tipo	Description
conjunción	conjunction	Conjunction	Conjunción
conditionType	conditionType	ConditionType	ConditionType
identificador	identifier	string	Obtiene o establece el identificador.
conditionOperator	conditionOperator	ConditionOperator	ConditionOperator
value	value	string	Obtiene o establece el valor.
variableType	variableType	VariableType	VariableType
jsonValue	jsonValue	boolean	Obtiene o establece un valor que indica si [valor json].
jsonPath	jsonPath	string	Obtiene o establece la ruta de acceso json.

ConditionAction

FilterAction

: string

ConditionDefinition

Esta clase representa la definición de los elementos de condiciones.

Nombre	Ruta de acceso	Tipo	Description
conditionAction	conditionAction	ConditionAction	FilterAction
Elementos	elements	array of Condition	Obtiene o establece los elementos.

ConditionOperator

: string

ConditionType

: string

Conjunción

: string

ContentValidation (Validación de contenido)

Esta clase representa una validación de contenido dentro de una encuesta.

Nombre	Ruta de acceso	Tipo	Description
validationType	validationType	ContentValidationType	ContentValidation (Validación de contenido)
earliestDate	earliestDate	string	Obtiene o establece la fecha más antigua.
latestDate	latestDate	string	Obtiene o establece la fecha más reciente.
valor mínimo	minValue	double	Obtiene o establece el valor mínimo.
valorMáximo	maxValue	double	Obtiene o establece el valor máximo.
decimalPlaces	decimalPlaces	integer	Obtiene o establece las posiciones decimales.
disableThousandSeparator	disableThousandSeparator	boolean	Obtiene o establece el separador de miles de deshabilitación.

ContentValidationType

ContentValidation (Validación de contenido)

: string

CreateAndInviteMembersResponse

Esta clase representa los parámetros devueltos para la API CreateAndInviteMembers.

Nombre	Ruta de acceso	Tipo	Description
samplingProjectId	samplingProjectId	integer	Obtiene o establece el identificador del proyecto de muestreo.
distributorId	distributorId	integer	Obtiene o establece el identificador del distribuidor.
validationIssues	validationIssues	array of WritePanelMemberIssue	Obtiene o establece los problemas.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

CreateArtifactResponse

Esta clase representa la respuesta de la API CreateArtifact.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

CreateMembersResponse

Esta clase representa los parámetros devueltos para la API CreateMembers.

Nombre	Ruta de acceso	Tipo	Description
membersIds	membersIds	array of integer	Obtiene o establece los identificadores de miembros.
validationIssues	validationIssues	array of WritePanelMemberIssue	Obtiene o establece los problemas.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

CreatePanelResponse

Esta clase representa los parámetros devueltos para la API CreatePanel.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtenga el identificador del panel creado.
nombre	name	string	Obtenga el nombre del panel creado.
isExtendedPanel	isExtendedPanel	boolean	Obtiene el tipo de panel creado.
fecha de creación	createdDate	string	Obtenga la fecha de creación del panel creado.
isLock	isLock	boolean	Obtenga el valor que indica si el panel está bloqueado.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

CreateSurveyResponse

Esta clase representa los parámetros devueltos para createSurvey API.

Nombre	Ruta de acceso	Tipo	Description
surveyId	surveyId	integer	Obtiene o establece el identificador de la encuesta.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

CreateWebHookResponse

Esta clase representa los parámetros devueltos para la API CreateWebHook.

Nombre	Ruta de acceso	Tipo	Description
webHookId	webHookId	uuid	Obtiene o establece el identificador de web hook.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

CustomVariable

Esta clase representa una sola variable personalizada.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
variableName	variableName	string	Obtiene o establece el nombre de la variable.
variableType	variableType	VariableType	VariableType

DataAccessControl

Esta clase contiene la configuración de cómo se puede acceder a la entidad.

Nombre	Ruta de acceso	Tipo	Description
accessType	accessType	AccessType	Tipo de acceso
condiciones	conditions	array of Condition	Obtiene o establece las condiciones.

DeleteArtifactResponse

Esta clase representa los parámetros devueltos para la API DeleteArtifact.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

DeleteDistributorResponse

Esta clase representa los parámetros devueltos de la API DeleteDistributor.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

DeleteInterviewResponse

Esta clase representa los parámetros devueltos para la API DeleteInterview.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

DeleteMembersResponse

Esta clase representa los parámetros devueltos para la API DeleteMember.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

DeletePanelResponse

Esta clase representa los parámetros devueltos para la API DeleteSample.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

DeleteSamplingProjectResponse

Esta clase representa los parámetros devueltos para deleteSamplingProject API.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

DeleteSurveyResponse

Esta clase representa los parámetros devueltos para deleteSurvey API.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

DeleteWebHookResponse

Esta clase representa los parámetros devueltos de la API DeleteWebHook.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

DesignConfiguration

Esta clase representa las posibilidades de estilo de una cuenta.

Nombre	Ruta de acceso	Tipo	Description
surveyDesignLayout	surveyDesignLayout	integer	Obtiene o establece el diseño de diseño de la encuesta.
matrixSubQuestionSize	matrixSubQuestionSize	MatrixSubQuestionSize	MatrixSubQuestionSize
textBlocks	textBlocks	array of TextBlock	Obtiene o establece el contenido de la plantilla.

DistributionChannel

Canal de distribución

: string

DistributorElement

Esta clase representa un elemento distribuidor.

Nombre	Ruta de acceso	Tipo	Description
distributorId	distributorId	integer	Obtiene o establece el identificador del distribuidor.
distributionChannel	distributionChannel	DistributionChannel	Canal de distribución
surveyId	surveyId	integer	Obtiene o establece el identificador de la encuesta.
samplingProjectId	samplingProjectId	integer	Obtiene o establece el identificador del proyecto de muestreo.
surveyVersion	surveyVersion	integer	Obtiene o establece la versión de la encuesta.
panelId	panelId	integer	Obtiene o establece el identificador del panel.
scheduledDistribution	scheduledDistribution	date-time	Obtiene o establece la distribución programada.
executedDistribution	executedDistribution	date-time	Obtiene o establece la distribución ejecutada.
distributionState	distributionState	string	Obtiene o establece el estado de la distribución.
condiciones	conditions	array of ConditionDefinition	Obtiene o establece las condiciones.

DownloadAnswersResponse

Esta clase representa los parámetros devueltos para la API DownloadAnswers.

Nombre	Ruta de acceso	Tipo	Description
downloadUrl	downloadUrl	string	Obtiene o establece la dirección URL de descarga.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ElementType

: string

Tipo de evento

: string

ExecuteSendMailResponse

Esta clase representa los parámetros devueltos para executeSendMail API.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ExecuteWorkflowTransitionResponse

Esta clase representa los parámetros devueltos para executeWorkflowTransition API.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ExecutionBehavior

: string

Entrevista

Esta clase representa datos de registro de entrevistas

Nombre	Ruta de acceso	Tipo	Description
id	id	string	El identificador de la entrevista
estado	state	string	Obtiene o establece el estado.
surveyId	surveyId	integer	Identificador de la encuesta
surveyVersionId	surveyVersionId	integer	Identificador de la versión de la encuesta
surveyName	surveyName	string	Nombre de la encuesta
surveyState	surveyState	string	Obtiene o establece el estado de la encuesta.
answersLink	answersLink	string	Vínculo a la página de impresión de respuestas
interviewLink	interviewLink	string	Obtiene o establece el vínculo de entrevista.
startDate	startDate	string	Obtiene o establece la fecha de inicio.
fecha de finalización	endDate	string	Obtiene o establece la fecha de finalización.
samplingProjectId	samplingProjectId	integer	Obtiene o establece el identificador del proyecto de muestreo.
distributorId	distributorId	integer	Obtiene o establece el identificador del distribuidor.

InvitationType

: string

InviteMembersResponse

Esta clase representa los parámetros devueltos para la API InviteMembers.

Nombre	Ruta de acceso	Tipo	Description
samplingProjectId	samplingProjectId	integer	Obtiene o establece el identificador del proyecto de muestreo.
distributorId	distributorId	integer	Obtiene o establece el identificador del distribuidor.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

MatrixSubQuestionSize

: string

Miembro

Esta clase representa un único miembro del panel con una estructura dinámica basada en el Panel.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
fields	fields	object	Obtiene o establece los campos.
createdAt	createdAt	date-time	Obtiene o establece el objeto creado en .
createdBy	createdBy	string	Obtiene o establece el objeto creado por.
updatedAt	updatedAt	date-time	Obtiene o establece el objeto actualizado en .
actualizadoPor	updatedBy	string	Obtiene o establece el objeto actualizado por.
entrevistas	interviews	array of Interview	Obtiene o establece las entrevistas.

MessageTemplateItem

Esta clase representa un elemento de plantilla de mensaje.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador del mensaje de correo electrónico
nombre	name	string	Nombre del mensaje de correo electrónico
contenido	content	string	El contenido del mensaje de correo electrónico
Asunto	subject	string	Asunto del mensaje de correo electrónico
defaultLocale	defaultLocale	string	Configuración regional predeterminada del mensaje de correo electrónico
configuraciones regionales	locales	array of string	Lista de configuraciones regionales de este mensaje de correo electrónico

MinMaxChoice

Esta clase representa un elemento de selección máximo mínimo dentro de una encuesta.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
código	code	string	Obtiene o establece el código.
codeManuallyChanged	codeManuallyChanged	boolean	Obtiene o establece un valor que indica si [código ha cambiado manualmente].
leftText	leftText	array of TranslationElement	Obtiene o establece las traducciones de texto izquierdo.
rightText	rightText	array of TranslationElement	Obtiene o establece las traducciones de texto correctas.
excludeFromRandomization	excludeFromRandomization	boolean	Obtiene o establece un valor que indica si [excluir de la selección aleatoria].
condition	condition	ConditionDefinition	Esta clase representa la definición de los elementos de condiciones.

OptOutItem

Esta clase representa un elemento de Opt-Out.

Nombre	Ruta de acceso	Tipo	Description
Correo electrónico	email	string	Obtiene o establece el correo electrónico.
phone	phone	integer	Obtiene o establece el teléfono.
optOutAt	optOutAt	string	Obtiene o establece la exclusión en .
optOutBy	optOutBy	string	Obtiene o establece la opción de no participar.

PanelDefinition

Esta clase contiene la definición completa de todos los campos contenidos en un panel definido por el cliente.

Nombre	Ruta de acceso	Tipo	Description
groups	groups	array of VariableGroupElement	Obtiene o establece los grupos.
dataAccessControl	dataAccessControl	DataAccessControl	Esta clase contiene la configuración de cómo se puede acceder a la entidad.

PanelFieldItem

Esta clase representa un campo de panel dentro de un panel.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
nombre	name	string	Obtiene o establece el nombre.
Nombre para mostrar	displayName	string	Obtiene o establece el nombre para mostrar.
isSystem	isSystem	boolean	Obtiene o establece un valor que indica si esta instancia es del sistema.
obligatorio	mandatory	boolean	Obtiene o establece un valor que indica si este Objeto Survalyzer.Contracts.Public.Elements.PanelFieldItem es obligatorio.
anonimizar	anonymize	boolean	Obtiene o establece un valor que indica si survalyzer.Contracts.Public.Elements.PanelFieldItem es anónimo.
validationExpression	validationExpression	string	Obtiene o establece la expresión de validación.
validationErrorMessageId	validationErrorMessageId	string	Obtiene o establece el identificador del mensaje de validación.
panelFieldType	panelFieldType	VariableType	VariableType
metadata	metadata	object	Obtiene o establece los metadatos.

PanelIncentive

Esta clase representa un único incentivo.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
nombre	name	string	Obtiene o establece el nombre.
priceInCredits	priceInCredits	integer	Obtiene o establece el precio en créditos.
descripción	description	string	Obtiene o establece la descripción.
availableVouchersCount	availableVouchersCount	integer	Obtiene o establece el número de vales disponibles.

PanelSyncBehaviour

: string

PanelSyncElement

Esta clase representa un único elemento de sincronización entre una encuesta y un panel.

Nombre	Ruta de acceso	Tipo	Description
identificador	identifier	string	Obtiene o establece el identificador.
panelField	panelField	string	Obtiene o establece el campo del panel.

ReadArtifactListRequest

Esta clase representa los parámetros de solicitud de readArtifactList API.

Nombre	Ruta de acceso	Tipo	Description
camino	path	string	Obtiene o establece la ruta de acceso.
workspaceId	workspaceId	integer	Obtiene o establece el identificador del área de trabajo.

ReadBounceListResponseV3

Esta clase representa los parámetros devueltos para la API ReadBounceList.

Nombre	Ruta de acceso	Tipo	Description
Rebota	bounces	array of BounceElement	Obtiene o establece la lista de rebotes.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadCreditBalanceResponse

Esta clase representa los parámetros devueltos para readCreditBalance API.

Nombre	Ruta de acceso	Tipo	Description
equilibrar	balance	integer	Obtiene o establece el saldo.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadDistributorListResponse

Esta clase representa los parámetros devueltos para la API ReadDistributorList.

Nombre	Ruta de acceso	Tipo	Description
Distribuidores	distributors	array of DistributorElement	Obtiene o establece los distribuidores.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadIncentiveListResponse

Esta clase representa los parámetros de solicitud de la API ReadIncentiveList.

Nombre	Ruta de acceso	Tipo	Description
panelIncentives	panelIncentives	array of PanelIncentive	Obtiene o establece los incentivos del panel.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadIncentiveTransactionListResponse

Esta clase representa los parámetros devueltos para la API ReadIncentiveTransactionList.

Nombre	Ruta de acceso	Tipo	Description
incentiveTransactions	incentiveTransactions	array of SurveyCreditLog	Obtiene o establece las transacciones de incentivos.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadInterviewDataResponse

Esta clase representa los parámetros devueltos para la API ReadInterviewData.

Nombre	Ruta de acceso	Tipo	Description
datosDeRespuesta	responseData	object	Obtiene o establece los datos de respuesta.
surveyDefinition	surveyDefinition	SurveyDefinition	Esta clase representa la definición de una encuesta que contiene todos los metadatos y la configuración.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadInterviewListCompactResponseV3

Esta clase representa los parámetros devueltos para readInterviewListCompact API.

Nombre	Ruta de acceso	Tipo	Description
surveyName	surveyName	string	Obtiene o establece el nombre de la encuesta.
surveyDefaultLanguage	surveyDefaultLanguage	string	Obtiene o establece el idioma predeterminado de la encuesta.
surveyLanguages	surveyLanguages	array of string	Obtiene o establece los idiomas de la encuesta.
entrevistas	interviews	array of object	Obtiene o establece las entrevistas.
items	interviews	object
codePlan	codePlan	array of SurveyMetadataItem	Obtiene o establece el plan de código.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadInterviewListResponseV3

Esta clase representa los parámetros devueltos para la API ReadInterviewList.

Nombre	Ruta de acceso	Tipo	Description
surveyName	surveyName	string	Obtiene o establece el nombre de la encuesta.
surveyDefaultLanguage	surveyDefaultLanguage	string	Obtiene o establece el idioma predeterminado de la encuesta.
surveyLanguages	surveyLanguages	array of string	Obtiene o establece los idiomas de la encuesta.
codePlan	codePlan	array of SurveyMetadataItem	Obtiene o establece el plan de código.
entrevistas	interviews	array of Row	Obtiene o establece las entrevistas.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadMemberListResponse

Esta clase representa los parámetros devueltos para la API ReadMemberList.

Nombre	Ruta de acceso	Tipo	Description
Miembros	members	array of Member	Obtiene o establece los miembros del panel.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadMessageTemplateListResponse

Esta clase representa los parámetros devueltos para la API ReadMessageTemplateList.

Nombre	Ruta de acceso	Tipo	Description
messageTemplates	messageTemplates	array of MessageTemplateItem	Obtiene o establece las plantillas de mensaje.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadOptOutListResponseV3

Esta clase representa los parámetros devueltos de readOptOutList API.

Nombre	Ruta de acceso	Tipo	Description
optOutItems	optOutItems	array of OptOutItem	Obtiene o establece los elementos de exclusión.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadPanelDefinitionResponse

Esta clase representa los parámetros devueltos para readPanelDefinition API.

Nombre	Ruta de acceso	Tipo	Description
panel	panel	PanelDefinition	Esta clase contiene la definición completa de todos los campos contenidos en un panel definido por el cliente.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadSamplingProjectResponse

Esta clase representa los parámetros devueltos para readSamplingProject API.

Nombre	Ruta de acceso	Tipo	Description
samplingProject	samplingProject	SamplingProjectElement	Esta clase representa un proyecto de muestreo.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadSurveyLinksResponse

Esta clase representa la respuesta de readSurveyLinks API.

Nombre	Ruta de acceso	Tipo	Description
anonymousList	anonymousList	array of SurveyLink	Obtiene o establece la lista anónima.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadSurveyListResponse

Esta clase representa los parámetros de respuesta de readSurveyList API.

Nombre	Ruta de acceso	Tipo	Description
encuestas	surveys	array of SurveyListItem	Obtiene o establece las encuestas.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadSurveyResponse

Esta clase representa los parámetros devueltos de readSurveyDefinition API.

Nombre	Ruta de acceso	Tipo	Description
surveyName	surveyName	string	Obtiene o establece el nombre de la encuesta.
surveyVersion	surveyVersion	integer	Obtiene o establece la versión de la encuesta.
surveyState	surveyState	string	Obtiene o establece el estado de la encuesta.
createdAt	createdAt	string	Obtiene o establece el objeto creado en .
createdBy	createdBy	string	Obtiene o establece el objeto creado por.
encuesta	survey	SurveyDefinition	Esta clase representa la definición de una encuesta que contiene todos los metadatos y la configuración.
surveyConfiguration	surveyConfiguration	SurveyConfiguration	Esta clase representa la configuración de la encuesta con todos los valores que un usuario podría configurar.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadWebHookListResponse

Esta clase representa los parámetros devueltos para la API ReadWebHookList.

Nombre	Ruta de acceso	Tipo	Description
webHooks	webHooks	array of WebHookElement	Obtiene o establece los enlaces web.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadWorkflowTransitionsResponse

Esta clase representa los parámetros devueltos de la API ReadWorkflowTransitions.

Nombre	Ruta de acceso	Tipo	Description
Transiciones	transitions	array of WorkflowTransition	Obtiene o establece las transiciones.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ReadWorkspaceListResponse

Esta clase representa los parámetros de solicitud de readWorkspaceList API.

Nombre	Ruta de acceso	Tipo	Description
workspaces	workspaces	array of WorkspaceDto	Obtiene o establece las áreas de trabajo.
totalCount	totalCount	integer	Obtiene o establece el recuento total.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

RedeemIncentiveCodeResponse

Esta clase representa los parámetros devueltos de la API RedeemIncentiveCode.

Nombre	Ruta de acceso	Tipo	Description
voucherCode	voucherCode	string	Obtiene o establece el código del vale.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

RemindMembersResponse

Esta clase representa los parámetros devueltos para la API RemindMembers.

Nombre	Ruta de acceso	Tipo	Description
reminderId	reminderId	integer	Obtiene o establece el identificador de recordatorio.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ResetInterviewResponse

Esta clase representa los parámetros devueltos para la API ResetInterview.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

Row

Esta clase representa un elemento Row.

Nombre	Ruta de acceso	Tipo	Description
columns	columns	array of ColItem	Obtiene o establece las columnas.

RowItem

Esta clase representa una respuesta de encuesta.

Nombre	Ruta de acceso	Tipo	Description
id	id	string	Obtiene o establece el identificador.
value	value	string	Obtiene o establece el valor.

SamplingProjectElement

Esta clase representa un proyecto de muestreo.

Nombre	Ruta de acceso	Tipo	Description
samplingProjectId	samplingProjectId	integer	Obtiene o establece el identificador del proyecto de muestreo.
nombre	name	string	Obtiene o establece el nombre.
workspaceId	workspaceId	integer	Obtiene o establece el identificador del área de trabajo.
surveyId	surveyId	integer	Obtiene o establece el identificador de la encuesta.
surveyVersion	surveyVersion	integer	Obtiene o establece la versión de la encuesta.
panelId	panelId	integer	Obtiene o establece el identificador del panel.
samplingProviderId	samplingProviderId	integer	Obtiene o establece el identificador del proveedor de muestreo.
projectState	projectState	string	Obtiene o establece el estado del proyecto.
scheduledDistribution	scheduledDistribution	string	Obtiene o establece la distribución programada.
executedDistribution	executedDistribution	string	Obtiene o establece la distribución ejecutada.
condiciones	conditions	array of ConditionDefinition	Obtiene o establece las condiciones.

ScriptType

: string

Section

Esta clase representa una sección dentro de una encuesta.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
nombre	name	string	Obtiene o establece el nombre.
randomPages	randomizePages	boolean	Obtiene o establece un valor que indica si [páginas aleatorias].
excludeFromRandomization	excludeFromRandomization	boolean	Obtiene o establece un valor que indica si [excluir de la selección aleatoria].
Elementos	elements	array of SurveyElement	Obtiene o establece los elementos.
condition	condition	ConditionDefinition	Esta clase representa la definición de los elementos de condiciones.

SurveyConfiguration

Esta clase representa la configuración de la encuesta con todos los valores que un usuario podría configurar.

Nombre	Ruta de acceso	Tipo	Description
designConfiguration	designConfiguration	DesignConfiguration	Esta clase representa las posibilidades de estilo de una cuenta.
anonymizingConfiguration	anonymizingConfiguration	AnonymizingConfiguration	Esta clase contiene la configuración de anonimización que se podría aplicar a un grupo de áreas de trabajo, un área de trabajo o una encuesta individual.

SurveyCreditLog

Esta clase representa una sola transacción de crédito.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
oldValue	oldValue	string	Obtiene o establece el valor anterior.
newValue	newValue	string	Obtiene o establece el nuevo valor.
descripción	description	string	Obtiene o establece la descripción.
modifiedDate	modifiedDate	string	Obtiene o establece la fecha de modificación.
modifiedBy	modifiedBy	string	Obtiene o establece el modificado por.
responseId	responseId	uuid	Obtiene o establece el identificador de respuesta.
interviewLink	interviewLink	string	Obtiene o establece el vínculo de entrevista.

SurveyDefinition

Esta clase representa la definición de una encuesta que contiene todos los metadatos y la configuración.

Nombre	Ruta de acceso	Tipo	Description
allowMultipleParticipation	allowMultipleParticipation	boolean	Obtiene o establece un valor que indica si [permitir la participación múltiple].
allowNavigateBack	allowNavigateBack	boolean	Obtiene o establece un valor que indica si [permitir la navegación hacia atrás].
allowSaveProgress	allowSaveProgress	boolean	Obtiene o establece un valor que indica si [permitir el progreso de guardar].
randomSections	randomizeSections	boolean	Obtiene o establece un valor que indica si [secciones aleatorias].
enableAutoScroll	enableAutoScroll	boolean	Obtiene o establece un valor que indica si [habilitar el desplazamiento automático].
enableCodeAccess	enableCodeAccess	boolean	Obtiene o establece un valor que indica si [habilitar el acceso al código].
dataAccessControl	dataAccessControl	DataAccessControl	Esta clase contiene la configuración de cómo se puede acceder a la entidad.
associatedPanels	associatedPanels	array of integer	Obtiene o establece el identificador del panel.
codeAccessMode	codeAccessMode	CodeAccessMode	AuthenticationType
enablePanelSync	enablePanelSync	boolean	Obtiene o establece un valor que indica si [habilitar la sincronización del panel].
panelSyncBehaviour	panelSyncBehaviour	PanelSyncBehaviour	PanelSyncBehaviour
panelSyncs	panelSyncs	array of PanelSyncElement	Obtiene o establece la sincronización del panel.
defaultLanguage	defaultLanguage	string	Obtiene o establece el idioma predeterminado.
fecha de finalización	endDate	date-time	Obtiene o establece la fecha de finalización.
Idiomas	languages	array of string	Obtiene o establece los idiomas.
Secciones	sections	array of Section	Obtiene o establece las secciones.
customVariables	customVariables	array of CustomVariable	Obtiene o establece las variables personalizadas.
surveyEndText	surveyEndText	array of TranslationElement	Obtiene o establece el texto final de la encuesta.
defaultTextOverrides	defaultTextOverrides	object	Obtiene o establece las invalidaciones de texto predeterminadas.

SurveyElement

Esta clase representa una definición de elemento de encuesta con todos los metadatos y la configuración.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
elementType	elementType	ElementType	ElementType
código	code	string	Obtiene o establece el código.
codeManuallyChanged	codeManuallyChanged	boolean	Obtiene o establece un valor que indica si [código ha cambiado manualmente].
texto	text	array of TranslationElement	Obtiene o establece las traducciones de texto.
hintText	hintText	array of TranslationElement	Obtiene o establece las traducciones de texto de sugerencia.
hasHintText	hasHintText	boolean	Obtiene o establece un valor que indica si esta instancia tiene texto de sugerencia.
hasNotAvailableChoice	hasNotAvailableChoice	boolean	Obtiene o establece un valor que indica si esta instancia no tiene opción disponible.
notAvailableChoiceText	notAvailableChoiceText	array of TranslationElement	Obtiene o establece las traducciones de texto que no están disponibles.
forceResponse	forceResponse	boolean	Obtiene o establece un valor que indica si [forzar respuesta].
opciones	choices	array of Choice	Obtiene o establece las opciones.
randomChoices	randomizeChoices	boolean	Obtiene o establece un valor que indica si [opciones aleatorias].
columnType	columnType	ColumnType	TipoDeColumna
inmediato	prompt	array of TranslationElement	Obtiene o establece el símbolo del sistema.
valor mínimo	minValue	integer	Obtiene o establece el valor mínimo.
valorMáximo	maxValue	integer	Obtiene o establece el valor máximo.
showCenterLabel	showCenterLabel	boolean	Obtiene o establece un valor que indica si [mostrar etiqueta central].
leftLabel	leftLabel	array of TranslationElement	Obtiene o establece la etiqueta izquierda.
centerLabel	centerLabel	array of TranslationElement	Obtiene o establece la etiqueta central.
rightLabel	rightLabel	array of TranslationElement	Obtiene o establece la etiqueta derecha.
showValue	showValue	boolean	Obtiene o establece un valor que indica si [mostrar valor].
maxDecimals	maxDecimals	integer	Obtiene o establece los dígitos máximos después de la coma.
textFieldSize	textFieldSize	TextFieldSize	TextFieldSize
autocompletar	autocomplete	boolean	Obtiene o establece un valor que indica si este Objeto Survalyzer.Contracts.Public.Elements.SurveyElement es autocompletar.
autocompletarText	autocompleteText	array of TranslationElement	Obtiene o establece las traducciones de texto autocompletar.
contentValidation	contentValidation	ContentValidation	Esta clase representa una validación de contenido dentro de una encuesta.
hasPlaceholder	hasPlaceholder	boolean	Obtiene o establece un valor que indica si esta instancia tiene un marcador de posición.
marcador	placeholder	array of TranslationElement	Obtiene o establece el marcador de posición.
isPassword	isPassword	boolean	Obtiene o establece un valor que indica si esta instancia es contraseña.
minMaxValidation	minMaxValidation	boolean	Obtiene o establece un valor que indica si [validación máxima mínima].
minimumCheckedChoices	minimumCheckedChoices	integer	Obtiene o establece las opciones de comprobación mínimas.
maximumCheckedChoices	maximumCheckedChoices	integer	Obtiene o establece las opciones máximas activadas.
columnGroups	columnGroups	array of ColumnGroup	Obtiene o establece los grupos de columnas.
randomRows	randomizeRows	boolean	Obtiene o establece un valor que indica si [filas aleatorias].
Filas	rows	array of MinMaxChoice	Obtiene o establece las filas.
numberOfRanks	numberOfRanks	integer	Obtiene o establece el número de clasificaciones.
likeText	likeText	array of TranslationElement	Obtiene o establece las traducciones de texto similares.
no me gustaText	dislikeText	array of TranslationElement	Obtiene o establece las traducciones de texto que no le gustan.
hasStartText	hasStartText	boolean	Obtiene o establece un valor que indica si esta instancia tiene texto de inicio.
startText	startText	array of TranslationElement	Obtiene o establece el texto inicial.
enableMeasurement	enableMeasurement	boolean	Obtiene o establece un valor que indica si [habilitar medida].
showButtons	showButtons	boolean	Obtiene o establece un valor que indica si [mostrar botones].
likeKey	likeKey	string	Obtiene o establece la clave similar.
dislikeKey	dislikeKey	string	Obtiene o establece la clave que no le gusta.
interviewState	interviewState	string	Obtiene o establece el estado de la respuesta.
acción	action	ActionElement	Esta clase representa un final de la acción de encuesta para completar, pantallar o cuota completa.
desde	from	string	Obtiene o establece el remitente.
to	to	string	Obtiene o establece el receptor.
Asunto	subject	array of TranslationElement	Obtiene o establece las traducciones del asunto.
Mensaje	message	array of TranslationElement	Obtiene o establece las traducciones de mensajes.
valueAssignmentType	valueAssignmentType	ValueAssignmentType	ValueAssignmentType
variableName	variableName	string	Obtiene o establece el nombre de la variable.
functionTerm	functionTerm	array of TranslationElement	Obtiene o establece el término de función.
executionBehavior	executionBehavior	ExecutionBehavior	ExecutionBehavior
apiCallMethod	apiCallMethod	ApiCallMethod	ApiCallMethod
URL	url	array of TranslationElement	Obtiene o establece la dirección URL.
headers	headers	string	Obtiene o establece los encabezados.
body	body	array of TranslationElement	Obtiene o establece el cuerpo.
externalUri	externalUri	string	Obtiene o establece el URI externo.
scriptType	scriptType	ScriptType	ScriptType
contenido	content	string	Obtiene o establece el contenido.
hasRatingLabels	hasRatingLabels	boolean	Obtiene o establece un valor que indica si esta instancia tiene etiquetas de clasificación.
leftRatingLabel	leftRatingLabel	array of TranslationElement	Obtiene o establece la etiqueta de clasificación izquierda.
rightRatingLabel	rightRatingLabel	array of TranslationElement	Obtiene o establece la etiqueta de clasificación correcta.
condition	condition	ConditionDefinition	Esta clase representa la definición de los elementos de condiciones.
evaluateAsJson	evaluateAsJson	boolean	Obtiene o establece un valor que indica si [evaluate as json].
autocompleteListVariable	autocompleteListVariable	string	Obtiene o establece la variable de lista de autocompletar.
arrangementMode	arrangementMode	ArrangementMode	ArrangementMode
enableAnimation	enableAnimation	boolean	Obtiene o establece un valor que indica si [habilitar animación].
useSmiley	useSmiley	boolean	Obtiene o establece un valor que indica si [usar sonriente].
hasPrompt	hasPrompt	boolean	Obtiene o establece un valor que indica si esta instancia tiene un símbolo del sistema.

SurveyLink

La entidad SurveyLink

Nombre	Ruta de acceso	Tipo	Description
URL	url	string	Obtiene o establece la dirección URL.
isCustom	isCustom	boolean	Obtiene o establece un valor que indica si esta instancia es personalizada.
lenguaje	language	string	Obtiene o establece el idioma.

SurveyListItem

Esta clase representa un único elemento de encuesta.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador de la encuesta
nombre	name	string	Nombre de la encuesta
modifiedDate	modifiedDate	string	Fecha de modificación de la encuesta
fecha de finalización	endDate	string	Fecha en la que finaliza la encuesta
isEndDateEnabled	isEndDateEnabled	boolean	Si la fecha de finalización está habilitada para esta encuesta
estado	status	SurveyStatus	SurveyStatus
archiveDate	archiveDate	string	Fecha en la que se ha archivado la encuesta
statusOn	statusOn	boolean	¿Está activada o desactivada la encuesta?
answers	answers	integer	Obtiene o establece las respuestas.

SurveyMetadataItem

Esta clase representa un único elemento de metadatos.

Nombre	Ruta de acceso	Tipo	Description
código	code	string	Obtiene o establece el código.
Tipo de dato	dataType	string	Obtiene o establece el tipo de datos.
questionCode	questionCode	string	Obtiene o establece el código de pregunta.
type	type	string	Obtiene o establece el tipo.
pregunta	question	string	Obtiene o establece la pregunta.
fila	row	string	Obtiene o establece la fila.
choice	choice	string	Obtiene o establece la opción.
values	values	array of RowItem	Obtiene o establece los valores.
sectionName	sectionName	string	Obtiene o establece el nombre de sección.

SurveyStatus

: string

TextBlock

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Obtiene o establece el nombre.
type	type	string	Obtiene o establece el tipo.
texto	text	array of TranslationElement	Obtiene o establece el texto.

TextFieldSize

: string

TranslationElement

Esta clase representa una traducción de texto dentro de una encuesta.

Nombre	Ruta de acceso	Tipo	Description
languageCode	languageCode	string	Obtiene o establece el código de idioma.
texto	text	string	Obtiene o establece el texto.

UpdateMembersResponse

Esta clase representa los parámetros devueltos para updateMembers API.

Nombre	Ruta de acceso	Tipo	Description
validationIssues	validationIssues	array of WritePanelMemberIssue	Obtiene o establece los problemas.
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

UpdateSurveyResponse

Esta clase representa los parámetros devueltos para updateSurvey API.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

UpdateWebHookResponse

Esta clase representa los parámetros devueltos para la API CreateWebHook.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

ValueAssignmentType

: string

VariableGroupElement

Esta clase representa un grupo de campos en un panel.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
nombre	name	string	Obtiene o establece el nombre.
Nombre para mostrar	displayName	string	Obtiene o establece el nombre para mostrar.
fields	fields	array of PanelFieldItem	Obtiene o establece los campos.

VariableType

: string

WebHookElement

Esta clase representa un único webHook

Nombre	Ruta de acceso	Tipo	Description
id	id	uuid	Obtiene o establece el identificador.
eventType	eventType	EventType	Tipo de evento
entityIdentifier	entityIdentifier	string	Obtiene o establece el identificador de entidad.
createdAt	createdAt	date-time	Obtiene o establece el objeto creado en .
createdBy	createdBy	string	Obtiene o establece el objeto creado por.
updatedAt	updatedAt	date-time	Obtiene o establece el objeto actualizado en .
actualizadoPor	updatedBy	string	Obtiene o establece el objeto actualizado por.

WorkflowTransition

Esta clase representa una transición de un estado a otro.

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Obtiene o establece el nombre.
acción	action	string	Obtiene o establece el nombre de la acción.
newState	newState	string	Crea un nuevo estado.
condition	condition	string	Obtiene o establece la condición.

WorkspaceDto

Esta clase representa una entidad de área de trabajo.

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Obtiene o establece el identificador.
nombre	name	string	Obtiene o establece el nombre.
numberOfSurveys	numberOfSurveys	integer	Obtiene o establece el número de encuestas.

WriteOptOutListResponse

Esta clase representa los parámetros devueltos para la API WriteOptOutList.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

WritePanelMemberIssue

Representa algún problema que puede aparecer

Nombre	Ruta de acceso	Tipo	Description
código de error	errorCode	string	Obtiene o establece el código de error.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.

WritePanelResponse

Esta clase representa los parámetros devueltos para writePanel API.

Nombre	Ruta de acceso	Tipo	Description
es-exito	isSuccess	boolean	Obtiene o establece un valor que indica si esta instancia es correcta.
errorMessage	errorMessage	string	Obtiene o establece el mensaje de error.
código de error	errorCode	string	Obtiene o establece el código de error.

Compartir a través de

Survalyzer EU (versión preliminar)

Creación de una conexión

Predeterminado

Limitaciones

Acciones

Actualización de Web Hook

Parámetros

Devoluciones

Actualizar encuesta

Parámetros

Devoluciones

Actualizar miembros

Parámetros

Devoluciones

Actualizar Opt-Outs

Parámetros

Devoluciones

Canjear código de incentivo

Parámetros

Devoluciones

Creación de webHook

Parámetros

Devoluciones

Crear artefacto

Parámetros

Devoluciones

Crear encuesta

Parámetros

Devoluciones

Crear miembros

Parámetros

Devoluciones

Crear panel o ejemplo

Parámetros

Devoluciones

Descargar PDF de entrevista

Parámetros

Devoluciones

Ejecutar transición de flujo de trabajo

Parámetros

Devoluciones

Eliminar distribuidor

Parámetros

Devoluciones

Eliminar encuesta

Parámetros

Devoluciones

Eliminar entrevista

Parámetros

Devoluciones

Eliminar miembros

Parámetros

Devoluciones

Eliminar panel

Parámetros

Devoluciones

Eliminar proyecto de muestreo

Parámetros

Devoluciones

Eliminar un artefacto

Parámetros

Devoluciones

Eliminar webHook

Parámetros

Devoluciones

Enviar correo

Parámetros

Devoluciones

Invitar a miembros

Parámetros

Devoluciones

Invitar a miembros

Parámetros

Devoluciones

Lectura de rebotes

Parámetros

Devoluciones

Leer artefactos

Parámetros