Survalyzer EU (Pré-visualização)

O conector Survalyzer fornece acesso simplificado a todos os recursos de API do data center da UE.

Este conector está disponível nos seguintes produtos e regiões:

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Centro de desenvolvedores Survalyzer
URL	https://developer.survalyzer.com/

Metadados do conector
Editora	Survalyzer AG
Sítio Web	https://survalyzer.com
Política de privacidade	https://survalyzer.com/privacy-policy
Categorias	Marketing; Produtividade

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
ID do cliente - Seu Survalyzer ClientId	cadeia (de caracteres)	Introduza o ID do cliente.	Verdade
Segredo do Cliente - Seu Survalyzer ClientSecret	securestring	Introduza o segredo do cliente.	Verdade

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Atualizar Membros	Esta ação oferece a possibilidade de atualizar a lista de membros.
Atualizar Opt-Outs	Esta ação oferece a possibilidade de escrever entradas na lista de Opt-Out de um espaço de trabalho.
Atualizar pesquisa	Esta ação oferece a possibilidade de atualizar o inquérito.
Atualizar Web Hook	Esta ação oferece a possibilidade de atualizar o gancho web.
Convidar Membros	Esta ação oferece a possibilidade de convidar o membro.
Convidar Membros	Esta ação oferece a possibilidade de criar e convidar membros.
Criar artefato	Esta ação oferece a possibilidade de criar novo artefato.
Criar Membros	Esta ação oferece a possibilidade de criar a lista de membros.
Criar painel ou exemplo	Esta ação oferece a possibilidade de criar um novo painel.
Criar pesquisa	Esta ação oferece a possibilidade de criar inquérito.
Criar WebHook	Esta ação oferece a possibilidade de criar o gancho web.
Descarregar Entrevista PDF	Esta ação oferece a possibilidade de descarregar as respostas.
Enviar E-mail	Esta ação oferece a possibilidade de enviar correio.
Excluir artefato	Esta ação oferece a possibilidade de excluir artefato.
Excluir Distribuidor	Esta ação oferece a possibilidade de excluir distribuidor.
Excluir entrevista	Esta ação oferece a possibilidade de apagar a entrevista.
Excluir membros	Esta ação oferece a possibilidade de excluir membros.
Excluir painel	Esta ação oferece a possibilidade de excluir o painel.
Excluir pesquisa	Esta ação oferece a possibilidade de eliminar o inquérito.
Excluir projeto de amostragem	Esta ação oferece a possibilidade de eliminar o projeto de amostragem.
Excluir WebHook	Esta ação oferece a possibilidade de excluir o gancho da web.
Executar transição de fluxo de trabalho	Esta ação oferece a possibilidade de executar a transição do fluxo de trabalho específico para o fluxo de trabalho.
Leia a entrevista	Esta ação oferece a possibilidade de ler os dados da entrevista.
Leia a pesquisa	Esta ação oferece a possibilidade de ler o inquérito.
Leia as entrevistas	Esta ação oferece a possibilidade de ler a lista de entrevistas.
Leia as entrevistas do Compact	Esta ação oferece a possibilidade de ler o compacto da lista de entrevistas.
Leia Incentivos	Esta ação devolve os incentivos/voucher disponíveis para o utilizador autenticado.
Leia os links da pesquisa	Esta ação oferece a possibilidade de ler os links da pesquisa.
Leia Transações de Incentivo	A ação retorna uma visão geral de todos os ganhos e gastos relacionados aos créditos da pesquisa.
Leia WebHooks	Esta ação oferece a possibilidade de ler a lista de ganchos da web.
Lembrar os Membros	Esta ação oferece a possibilidade de lembrar o membro.
Ler Artefactos	Esta ação oferece a possibilidade de ler a lista de artefatos.
Ler Distribuidores	Esta ação oferece a possibilidade de ler a lista de distribuidores.
Ler espaços de trabalho	Esta ação oferece a possibilidade de ler todos os espaços de trabalho disponíveis.
Ler inquéritos	Esta ação oferece a possibilidade de ler todos os inquéritos disponíveis de um determinado espaço de trabalho.
Ler Membros	Esta ação oferece a possibilidade de ler os membros.
Ler modelos de mensagem	Esta ação oferece a possibilidade de receber todos os modelos de mensagens configurados para Email e SMS.
Ler Opt-Outs	Esta ação oferece a possibilidade de ler todos os Opt-Outs de um espaço de trabalho.
Ler projeto de amostragem	Esta ação oferece a possibilidade de ler o projeto de amostragem.
Ler rejeições	Esta ação oferece a possibilidade de ler a lista de rejeição.
Ler Saldo de Crédito	Essa ação retorna o saldo de crédito da pesquisa para o usuário autenticado.
Ler transições de fluxo de trabalho	Esta ação oferece a possibilidade de ler todas as transições de fluxo de trabalho específicas para o fluxo de trabalho.
Painel de Atualização	Esta ação oferece a possibilidade de atualizar o painel.
Painel de Leitura	Esta ação oferece a possibilidade de ler a definição do painel.
Redefinir entrevista	Esta ação oferece a possibilidade de redefinir a resposta dos membros do painel.
Resgatar Código de Incentivo	Esta ação oferece a possibilidade de gastar créditos de pesquisa para incentivos/vouchers.

Atualizar Membros

ID da Operação:: UpdateMembers

Esta ação oferece a possibilidade de atualizar a lista de membros.

Parâmetros

Name	Chave	Necessário	Tipo	Description
inquilino	tenant		string	Obtém ou define o locatário.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
id	id		integer	Obtém ou define o identificador.
campos	fields	True	object	Obtém ou define os campos.
criadosAt	createdAt		date-time	Obtém ou define o criado em.
criado por	createdBy		string	Obtém ou define o criado por.
atualizadoem	updatedAt		date-time	Obtém ou define o atualizado em.
atualizadoPor	updatedBy		string	Obtém ou define o atualizado por.
id	id		string	O id da entrevista
state	state		string	Obtém ou define o estado.
surveyId	surveyId		integer	O id do inquérito por questionário
surveyVersionId	surveyVersionId		integer	O id da versão do inquérito
surveyName	surveyName		string	O nome do inquérito por questionário
surveyState	surveyState		string	Obtém ou define o estado da pesquisa.
respostasLink	answersLink		string	O link para a página de impressão das respostas
entrevistaLink	interviewLink		string	Obtém ou define o link da entrevista.
startDate	startDate		string	Obtém ou define a data de início.
data de término	endDate		string	Obtém ou define a data de término.
amostragemProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
distribuidorId	distributorId		integer	Obtém ou define o identificador do distribuidor.

Devoluções

Essa classe representa os parâmetros de retorno para a API UpdateMembers.

Body: UpdateMembersResponse

Atualizar Opt-Outs

ID da Operação:: WriteOptOutList

Esta ação oferece a possibilidade de escrever entradas na lista de Opt-Out de um espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
workspaceId	workspaceId		integer	Obtém ou define o identificador do espaço de trabalho.
panelId	panelId		integer	Obtém ou define o identificador do painel.
distribuidorId	distributorId		integer	Obtém ou define o identificador do distribuidor.
e-mail	email	True	string	Obtém ou define o e-mail.
optOutOperation	optOutOperation	True	string	OptOutOperation
Telemóvel	cellPhone	True	integer	Obtém ou define o telefone celular.
optOutOperation	optOutOperation	True	string	OptOutOperation

Devoluções

Essa classe representa os parâmetros de retorno para a API WriteOptOutList.

Body: WriteOptOutListResponse

Atualizar pesquisa

ID da Operação:: UpdateSurvey

Esta ação oferece a possibilidade de atualizar o inquérito.

Parâmetros

Name	Chave	Necessário	Tipo	Description
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.
surveyName	surveyName		string	Obtém ou define o nome da pesquisa.
permitirParticipação Múltipla	allowMultipleParticipation	True	boolean	Obtém ou define um valor que indica se [permitir participação múltipla].
allowNavigateBack	allowNavigateBack	True	boolean	Obtém ou define um valor que indica se [permitir navegar de volta].
allowSaveProgress	allowSaveProgress		boolean	Obtém ou define um valor que indica se [permitir salvar progresso].
randomizeSections	randomizeSections	True	boolean	Obtém ou define um valor que indica se [randomizar seções].
habilitarAutoScroll	enableAutoScroll		boolean	Obtém ou define um valor que indica se [ativar rolagem automática].
enableCodeAccess	enableCodeAccess		boolean	Obtém ou define um valor que indica se [habilitar acesso ao código].
tipo de acesso	accessType		string	Tipo de Acesso
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
associatedPanels	associatedPanels		array of integer	Obtém ou define o identificador do painel.
codeAccessMode	codeAccessMode	True	string	Tipo de autenticação
enablePanelSync	enablePanelSync		boolean	Obtém ou define um valor que indica se [enable panel synchronize].
panelSyncBehaviour	panelSyncBehaviour		string	PanelSyncBehaviour
identificador	identifier		string	Obtém ou define o identificador.
panelField	panelField		string	Obtém ou define o campo do painel.
defaultLanguage	defaultLanguage	True	string	Obtém ou define o idioma padrão.
data de término	endDate		date-time	Obtém ou define a data de término.
Idiomas	languages	True	array of string	Obtém ou define os idiomas.
id	id	True	integer	Obtém ou define o identificador.
nome	name	True	string	Obtém ou define o nome.
randomizePages	randomizePages	True	boolean	Obtém ou define um valor que indica se [randomizar páginas].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtém ou define um valor que indica se [excluir da randomização].
id	id	True	integer	Obtém ou define o identificador.
elementType	elementType	True	string	ElementType
código	code		string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [código alterado manualmente].
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
hasHintText	hasHintText		boolean	Obtém ou define um valor que indica se essa instância tem texto de dica.
hasNotAvailableChoice	hasNotAvailableChoice		boolean	Obtém ou define um valor que indica se essa instância não tem opção disponível.
forceResponse	forceResponse		boolean	Obtém ou define um valor que indica se [forçar resposta].
id	id	True	integer	Obtém ou define o identificador.
código	code	True	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [código alterado manualmente].
allowTextEntry	allowTextEntry	True	boolean	Obtém ou define um valor que indica se [permitir entrada de texto].
forceInput	forceInput	True	boolean	Obtém ou define um valor que indica se [forçar entrada].
preenchimento automático	autocomplete	True	boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.Choice é preenchido automaticamente.
exclusivo	exclusive	True	boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.Choice é exclusivo.
excludeFromRandomization	excludeFromRandomization		boolean	Obtém ou define um valor que indica se [excluir da randomização].
validationType	validationType	True	string	ContentValidation
Data mais antiga	earliestDate		string	Obtém ou define a data mais antiga.
Data mais recente	latestDate		string	Obtém ou define a data mais recente.
minValor	minValue		double	Obtém ou define o valor mínimo.
maxValor	maxValue		double	Obtém ou define o valor máximo.
casas decimais	decimalPlaces		integer	Obtém ou define as casas decimais.
disableThousandSeparator	disableThousandSeparator		boolean	Obtém ou define o separador de mil desativado.
condiçãoAção	conditionAction	True	string	FilterAction
autocompleteListVariable	autocompleteListVariable		string	Obtém ou define a variável de lista de preenchimento automático.
randomizeEscolhas	randomizeChoices		boolean	Obtém ou define um valor que indica se [randomizar opções].
columnType	columnType		string	Tipo de coluna
minValor	minValue		integer	Obtém ou define o valor mínimo.
maxValor	maxValue		integer	Obtém ou define o valor máximo.
showCenterLabel	showCenterLabel		boolean	Obtém ou define um valor que indica se [show center label].
showValue	showValue		boolean	Obtém ou define um valor que indica se [mostrar valor].
maxdecimais	maxDecimals		integer	Obtém ou define os dígitos máximos após a vírgula.
textFieldSize	textFieldSize		string	TextFieldSize
preenchimento automático	autocomplete		boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.SurveyElement é de preenchimento automático.
hasPlaceholder	hasPlaceholder		boolean	Obtém ou define um valor que indica se essa instância tem espaço reservado.
isPassword	isPassword		boolean	Obtém ou define um valor que indica se essa instância é senha.
minMaxValidação	minMaxValidation		boolean	Obtém ou define um valor que indica se [validação máxima mínima].
mínimoCheckedChoices	minimumCheckedChoices		integer	Obtém ou define as opções mínimas verificadas.
maximumCheckedChoices	maximumCheckedChoices		integer	Obtém ou define o máximo de opções verificadas.
id	id	True	integer	Obtém ou define o identificador.
hasNotAvailableChoice	hasNotAvailableChoice	True	boolean	Obtém ou define um valor que indica se essa instância não tem opção disponível.
randomizeColumns	randomizeColumns	True	boolean	Obtém ou define um valor que indica se [randomizar colunas].
choiceType	choiceType	True	string	Tipo de escolha
randomizeRows	randomizeRows		boolean	Obtém ou define um valor que indica se [randomizar linhas].
id	id	True	integer	Obtém ou define o identificador.
código	code	True	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [código alterado manualmente].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtém ou define um valor que indica se [excluir da randomização].
númerodeRanks	numberOfRanks		integer	Obtém ou define o número de classificações.
hasStartText	hasStartText		boolean	Obtém ou define um valor que indica se essa instância tem texto inicial.
enableMeasurement	enableMeasurement		boolean	Obtém ou define um valor que indica se [habilitar medição].
showButtons	showButtons		boolean	Obtém ou define um valor que indica se [mostrar botões].
likeKey	likeKey		string	Obtém ou define a chave like.
dislikeKey	dislikeKey		string	Obtém ou define a tecla dislike.
entrevistaEstado	interviewState		string	Obtém ou define o estado da resposta.
actionType	actionType	True	string	QuotaAction
de	from		string	Obtém ou define o remetente.
Para	to		string	Obtém ou define o recetor.
valueAssignmentType	valueAssignmentType		string	ValueAssignmentType
variableName	variableName		string	Obtém ou define o nome da variável.
executionBehavior	executionBehavior		string	ExecutionBehavior
apiCallMethod	apiCallMethod		string	ApiCallMethod
headers	headers		string	Obtém ou define os cabeçalhos.
externalUri	externalUri		string	Obtém ou define o URI externo.
scriptType	scriptType		string	Tipo de script
conteúdo	content		string	Obtém ou define o conteúdo.
hasRatingLabels	hasRatingLabels		boolean	Obtém ou define um valor que indica se essa instância tem rótulos de classificação.
avaliarAsJson	evaluateAsJson		boolean	Obtém ou define um valor que indica se [avaliar como json].
autocompleteListVariable	autocompleteListVariable		string	Obtém ou define a variável de lista de preenchimento automático.
arranjoModo	arrangementMode		string	Modo de Arranjo
enableAnimation	enableAnimation		boolean	Obtém ou define um valor que indica se [ativar animação].
useSmiley	useSmiley		boolean	Obtém ou define um valor que indica se [use smiley].
hasPrompt	hasPrompt		boolean	Obtém ou define um valor que indica se essa instância tem prompt.
id	id	True	integer	Obtém ou define o identificador.
variableName	variableName	True	string	Obtém ou define o nome da variável.
defaultTextOverrides	defaultTextOverrides		object	Obtém ou define as substituições de texto padrão.
surveyDesignLayout	surveyDesignLayout		integer	Obtém ou define o layout de design da pesquisa.
matrixSubQuestionSize	matrixSubQuestionSize		string	MatrixSubQuestionSize
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
anonymizingMode	anonymizingMode	True	string	AnonymizingMode
LogIp	logIp	True	boolean	Obtém ou define um valor que indica se [log ip].
logUserAgent	logUserAgent	True	boolean	Obtém ou define um valor que indica se [log user agent].
logReferer	logReferer	True	boolean	Obtém ou define um valor que indica se [log referer].

Devoluções

Essa classe representa os parâmetros de retorno para a API UpdateSurvey.

Body: UpdateSurveyResponse

Atualizar Web Hook

ID da Operação:: UpdateWebHook

Esta ação oferece a possibilidade de atualizar o gancho web.

Parâmetros

Name	Chave	Tipo	Description
webHookId	webHookId	uuid	Obtém ou define o identificador de gancho da Web.
eventType	eventType	string	Tipo de Evento
entityIdentifier	entityIdentifier	string	Obtém ou define o identificador de entidade.
securityToken	securityToken	string	Obtém ou define o token de segurança.
webHookUrl	webHookUrl	string	Obtém ou define a URL do gancho da Web.

Devoluções

Essa classe representa os parâmetros de retorno para a API CreateWebHook.

Body: UpdateWebHookResponse

Convidar Membros

ID da Operação:: InviteMembers

Esta ação oferece a possibilidade de convidar o membro.

Parâmetros

Name	Chave	Necessário	Tipo	Description
surveyId	surveyId	True	integer	O ID do inquérito
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
amostragemProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
Ids de membro	memberIds		array of integer	Obtém ou define as ids dos membros do painel.
messageTemplateId	messageTemplateId	True	integer	Obtém ou define o identificador do modelo de mensagem.
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
programaçãoDataHora	scheduleDateTime		date-time	Obtém ou define o horário de agendamento.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
canal	channel		string	Canal de Distribuição
asyncProcess	asyncProcess		boolean	Obtém ou define o processo assíncrono.
entrevistaExpiryDate	interviewExpiryDate		string	Obtém ou define a data de validade da entrevista.
de	from		string	Obtém ou define de.
fromName	fromName		string	Obtém ou define a partir do nome.
replyTo	replyTo		string	Obtém ou define a resposta para.
replyToName	replyToName		string	Obtém ou define o nome da resposta para.

Devoluções

Essa classe representa os parâmetros de retorno para a API InviteMembers.

Body: InviteMembersResponse

Convidar Membros

ID da Operação:: CreateAndInviteMembers

Esta ação oferece a possibilidade de criar e convidar membros.

Parâmetros

Name	Chave	Necessário	Tipo	Description
amostragemProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
canal	channel	True	string	Canal de Distribuição
messageTemplateId	messageTemplateId	True	integer	Obtém ou define o identificador do modelo de mensagem.
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
id	id		integer	Obtém ou define o identificador.
campos	fields	True	object	Obtém ou define os campos.
criadosAt	createdAt		date-time	Obtém ou define o criado em.
criado por	createdBy		string	Obtém ou define o criado por.
atualizadoem	updatedAt		date-time	Obtém ou define o atualizado em.
atualizadoPor	updatedBy		string	Obtém ou define o atualizado por.
id	id		string	O id da entrevista
state	state		string	Obtém ou define o estado.
surveyId	surveyId		integer	O id do inquérito por questionário
surveyVersionId	surveyVersionId		integer	O id da versão do inquérito
surveyName	surveyName		string	O nome do inquérito por questionário
surveyState	surveyState		string	Obtém ou define o estado da pesquisa.
respostasLink	answersLink		string	O link para a página de impressão das respostas
entrevistaLink	interviewLink		string	Obtém ou define o link da entrevista.
startDate	startDate		string	Obtém ou define a data de início.
data de término	endDate		string	Obtém ou define a data de término.
amostragemProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
distribuidorId	distributorId		integer	Obtém ou define o identificador do distribuidor.
programaçãoDataHora	scheduleDateTime		string	Obtém ou define a hora da data da agenda.
asyncProcess	asyncProcess		boolean	Obtém ou define o processo assíncrono.
entrevistaExpiryDate	interviewExpiryDate		string	Obtém ou define a data de validade da entrevista.
de	from		string	Obtém ou define de.
fromName	fromName		string	Obtém ou define a partir do nome.
replyTo	replyTo		string	Obtém ou define a resposta para.
replyToName	replyToName		string	Obtém ou define o nome da resposta para.

Devoluções

Essa classe representa os parâmetros de retorno para a API CreateAndInviteMembers.

Body: CreateAndInviteMembersResponse

Criar artefato

ID da Operação:: CreateArtifact

Esta ação oferece a possibilidade de criar novo artefato.

Parâmetros

Name	Chave	Necessário	Tipo	Description
workspaceId	workspaceId		integer	Obtém ou define o identificador do espaço de trabalho.
caminho	path		string	Obtém ou define o caminho.

Devoluções

Essa classe representa a resposta da API CreateArtifact.

Body: CreateArtifactResponse

Criar Membros

ID da Operação:: CreateMembers

Esta ação oferece a possibilidade de criar a lista de membros.

Parâmetros

Name	Chave	Necessário	Tipo	Description
inquilino	tenant		string	Obtém ou define o locatário.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
id	id		integer	Obtém ou define o identificador.
campos	fields	True	object	Obtém ou define os campos.
criadosAt	createdAt		date-time	Obtém ou define o criado em.
criado por	createdBy		string	Obtém ou define o criado por.
atualizadoem	updatedAt		date-time	Obtém ou define o atualizado em.
atualizadoPor	updatedBy		string	Obtém ou define o atualizado por.
id	id		string	O id da entrevista
state	state		string	Obtém ou define o estado.
surveyId	surveyId		integer	O id do inquérito por questionário
surveyVersionId	surveyVersionId		integer	O id da versão do inquérito
surveyName	surveyName		string	O nome do inquérito por questionário
surveyState	surveyState		string	Obtém ou define o estado da pesquisa.
respostasLink	answersLink		string	O link para a página de impressão das respostas
entrevistaLink	interviewLink		string	Obtém ou define o link da entrevista.
startDate	startDate		string	Obtém ou define a data de início.
data de término	endDate		string	Obtém ou define a data de término.
amostragemProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
distribuidorId	distributorId		integer	Obtém ou define o identificador do distribuidor.

Devoluções

Essa classe representa os parâmetros de retorno para a API CreateMembers.

Body: CreateMembersResponse

Criar painel ou exemplo

ID da Operação:: CreatePanel

Esta ação oferece a possibilidade de criar um novo painel.

Parâmetros

Name	Chave	Necessário	Tipo	Description
workspaceId	workspaceId	True	integer	Obtém ou define o identificador do espaço de trabalho.
nome	name	True	string	Obtém ou define o nome do painel.
tipo de painel	panelType	True	string	PanelModelType

Devoluções

Essa classe representa os parâmetros de retorno para a API CreatePanel.

Body: CreatePanelResponse

Criar pesquisa

ID da Operação:: CreateSurvey

Esta ação oferece a possibilidade de criar inquérito.

Parâmetros

Name	Chave	Necessário	Tipo	Description
workspaceId	workspaceId	True	integer	Obtém ou define o identificador do espaço de trabalho.
nome	name	True	string	Obtém ou define o nome.
permitirParticipação Múltipla	allowMultipleParticipation	True	boolean	Obtém ou define um valor que indica se [permitir participação múltipla].
allowNavigateBack	allowNavigateBack	True	boolean	Obtém ou define um valor que indica se [permitir navegar de volta].
allowSaveProgress	allowSaveProgress		boolean	Obtém ou define um valor que indica se [permitir salvar progresso].
randomizeSections	randomizeSections	True	boolean	Obtém ou define um valor que indica se [randomizar seções].
habilitarAutoScroll	enableAutoScroll		boolean	Obtém ou define um valor que indica se [ativar rolagem automática].
enableCodeAccess	enableCodeAccess		boolean	Obtém ou define um valor que indica se [habilitar acesso ao código].
tipo de acesso	accessType		string	Tipo de Acesso
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
associatedPanels	associatedPanels		array of integer	Obtém ou define o identificador do painel.
codeAccessMode	codeAccessMode	True	string	Tipo de autenticação
enablePanelSync	enablePanelSync		boolean	Obtém ou define um valor que indica se [enable panel synchronize].
panelSyncBehaviour	panelSyncBehaviour		string	PanelSyncBehaviour
identificador	identifier		string	Obtém ou define o identificador.
panelField	panelField		string	Obtém ou define o campo do painel.
defaultLanguage	defaultLanguage	True	string	Obtém ou define o idioma padrão.
data de término	endDate		date-time	Obtém ou define a data de término.
Idiomas	languages	True	array of string	Obtém ou define os idiomas.
id	id	True	integer	Obtém ou define o identificador.
nome	name	True	string	Obtém ou define o nome.
randomizePages	randomizePages	True	boolean	Obtém ou define um valor que indica se [randomizar páginas].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtém ou define um valor que indica se [excluir da randomização].
id	id	True	integer	Obtém ou define o identificador.
elementType	elementType	True	string	ElementType
código	code		string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [código alterado manualmente].
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
hasHintText	hasHintText		boolean	Obtém ou define um valor que indica se essa instância tem texto de dica.
hasNotAvailableChoice	hasNotAvailableChoice		boolean	Obtém ou define um valor que indica se essa instância não tem opção disponível.
forceResponse	forceResponse		boolean	Obtém ou define um valor que indica se [forçar resposta].
id	id	True	integer	Obtém ou define o identificador.
código	code	True	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [código alterado manualmente].
allowTextEntry	allowTextEntry	True	boolean	Obtém ou define um valor que indica se [permitir entrada de texto].
forceInput	forceInput	True	boolean	Obtém ou define um valor que indica se [forçar entrada].
preenchimento automático	autocomplete	True	boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.Choice é preenchido automaticamente.
exclusivo	exclusive	True	boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.Choice é exclusivo.
excludeFromRandomization	excludeFromRandomization		boolean	Obtém ou define um valor que indica se [excluir da randomização].
validationType	validationType	True	string	ContentValidation
Data mais antiga	earliestDate		string	Obtém ou define a data mais antiga.
Data mais recente	latestDate		string	Obtém ou define a data mais recente.
minValor	minValue		double	Obtém ou define o valor mínimo.
maxValor	maxValue		double	Obtém ou define o valor máximo.
casas decimais	decimalPlaces		integer	Obtém ou define as casas decimais.
disableThousandSeparator	disableThousandSeparator		boolean	Obtém ou define o separador de mil desativado.
condiçãoAção	conditionAction	True	string	FilterAction
autocompleteListVariable	autocompleteListVariable		string	Obtém ou define a variável de lista de preenchimento automático.
randomizeEscolhas	randomizeChoices		boolean	Obtém ou define um valor que indica se [randomizar opções].
columnType	columnType		string	Tipo de coluna
minValor	minValue		integer	Obtém ou define o valor mínimo.
maxValor	maxValue		integer	Obtém ou define o valor máximo.
showCenterLabel	showCenterLabel		boolean	Obtém ou define um valor que indica se [show center label].
showValue	showValue		boolean	Obtém ou define um valor que indica se [mostrar valor].
maxdecimais	maxDecimals		integer	Obtém ou define os dígitos máximos após a vírgula.
textFieldSize	textFieldSize		string	TextFieldSize
preenchimento automático	autocomplete		boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.SurveyElement é de preenchimento automático.
hasPlaceholder	hasPlaceholder		boolean	Obtém ou define um valor que indica se essa instância tem espaço reservado.
isPassword	isPassword		boolean	Obtém ou define um valor que indica se essa instância é senha.
minMaxValidação	minMaxValidation		boolean	Obtém ou define um valor que indica se [validação máxima mínima].
mínimoCheckedChoices	minimumCheckedChoices		integer	Obtém ou define as opções mínimas verificadas.
maximumCheckedChoices	maximumCheckedChoices		integer	Obtém ou define o máximo de opções verificadas.
id	id	True	integer	Obtém ou define o identificador.
hasNotAvailableChoice	hasNotAvailableChoice	True	boolean	Obtém ou define um valor que indica se essa instância não tem opção disponível.
randomizeColumns	randomizeColumns	True	boolean	Obtém ou define um valor que indica se [randomizar colunas].
choiceType	choiceType	True	string	Tipo de escolha
randomizeRows	randomizeRows		boolean	Obtém ou define um valor que indica se [randomizar linhas].
id	id	True	integer	Obtém ou define o identificador.
código	code	True	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged		boolean	Obtém ou define um valor que indica se [código alterado manualmente].
excludeFromRandomization	excludeFromRandomization	True	boolean	Obtém ou define um valor que indica se [excluir da randomização].
númerodeRanks	numberOfRanks		integer	Obtém ou define o número de classificações.
hasStartText	hasStartText		boolean	Obtém ou define um valor que indica se essa instância tem texto inicial.
enableMeasurement	enableMeasurement		boolean	Obtém ou define um valor que indica se [habilitar medição].
showButtons	showButtons		boolean	Obtém ou define um valor que indica se [mostrar botões].
likeKey	likeKey		string	Obtém ou define a chave like.
dislikeKey	dislikeKey		string	Obtém ou define a tecla dislike.
entrevistaEstado	interviewState		string	Obtém ou define o estado da resposta.
actionType	actionType	True	string	QuotaAction
de	from		string	Obtém ou define o remetente.
Para	to		string	Obtém ou define o recetor.
valueAssignmentType	valueAssignmentType		string	ValueAssignmentType
variableName	variableName		string	Obtém ou define o nome da variável.
executionBehavior	executionBehavior		string	ExecutionBehavior
apiCallMethod	apiCallMethod		string	ApiCallMethod
headers	headers		string	Obtém ou define os cabeçalhos.
externalUri	externalUri		string	Obtém ou define o URI externo.
scriptType	scriptType		string	Tipo de script
conteúdo	content		string	Obtém ou define o conteúdo.
hasRatingLabels	hasRatingLabels		boolean	Obtém ou define um valor que indica se essa instância tem rótulos de classificação.
avaliarAsJson	evaluateAsJson		boolean	Obtém ou define um valor que indica se [avaliar como json].
autocompleteListVariable	autocompleteListVariable		string	Obtém ou define a variável de lista de preenchimento automático.
arranjoModo	arrangementMode		string	Modo de Arranjo
enableAnimation	enableAnimation		boolean	Obtém ou define um valor que indica se [ativar animação].
useSmiley	useSmiley		boolean	Obtém ou define um valor que indica se [use smiley].
hasPrompt	hasPrompt		boolean	Obtém ou define um valor que indica se essa instância tem prompt.
id	id	True	integer	Obtém ou define o identificador.
variableName	variableName	True	string	Obtém ou define o nome da variável.
defaultTextOverrides	defaultTextOverrides		object	Obtém ou define as substituições de texto padrão.
surveyDesignLayout	surveyDesignLayout		integer	Obtém ou define o layout de design da pesquisa.
matrixSubQuestionSize	matrixSubQuestionSize		string	MatrixSubQuestionSize
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
anonymizingMode	anonymizingMode	True	string	AnonymizingMode
LogIp	logIp	True	boolean	Obtém ou define um valor que indica se [log ip].
logUserAgent	logUserAgent	True	boolean	Obtém ou define um valor que indica se [log user agent].
logReferer	logReferer	True	boolean	Obtém ou define um valor que indica se [log referer].

Devoluções

Essa classe representa os parâmetros de retorno para a API CreateSurvey.

Body: CreateSurveyResponse

Criar WebHook

ID da Operação:: CreateWebHook

Esta ação oferece a possibilidade de criar o gancho web.

Parâmetros

Name	Chave	Tipo	Description
eventType	eventType	string	Tipo de Evento
entityIdentifier	entityIdentifier	string	Obtém ou define o identificador de entidade.
securityToken	securityToken	string	Obtém ou define o token de segurança.
webHookUrl	webHookUrl	string	Obtém ou define a URL do gancho da Web.

Devoluções

Essa classe representa os parâmetros de retorno para a API CreateWebHook.

Body: CreateWebHookResponse

Descarregar Entrevista PDF

ID da Operação:: DownloadInterviewPdf

Esta ação oferece a possibilidade de descarregar as respostas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Tenant	tenant	True	string	O inquilino.
SurveyId	surveyId	True	integer	O identificador da pesquisa.
EntrevistaId	interviewId	True	uuid	O identificador da entrevista.
Mostrar Parcial Concluída	showPartialCompleted		boolean	se definido como <c>true</c> [mostrar parcial concluído].
Localidade	locale		string	A localidade.
Thmezone	timeZone		string	O fuso horário.
isCancellationRequested	isCancellationRequested		boolean
canBeCanceled	canBeCanceled		boolean
isInválido	isInvalid		boolean
isFechado	isClosed		boolean

Devoluções

Essa classe representa os parâmetros de retorno para a API DownloadAnswers.

Body: DownloadAnswersResponse

Enviar E-mail

ID da Operação:: ExecuteSendMail

Esta ação oferece a possibilidade de enviar correio.

Parâmetros

Name	Chave	Necessário	Tipo	Description
messageTemplateId	messageTemplateId		integer	Obtém ou define o identificador do modelo de mensagem.
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
linguagem	language	True	string	Obtém ou define o idioma.
Assunto	subject		string	Obtém ou define o assunto.
body	body		string	Obtém ou define o corpo.
de	from	True	string	Obtém ou define de.
fromName	fromName		string	Obtém ou define a partir do nome.
Para	to	True	string	Obtém ou define para.
toNome	toName		string	Converte em nome.
replyTo	replyTo		string	Obtém ou define a resposta para.
replyToName	replyToName		string	Obtém ou define o nome da resposta para.

Devoluções

Essa classe representa os parâmetros de retorno para a API ExecuteSendMail.

Body: ExecuteSendMailResponse

Excluir artefato

ID da Operação:: DeleteArtifact

Esta ação oferece a possibilidade de excluir artefato.

Parâmetros

Name	Chave	Tipo	Description
caminho	path	string	Obtém ou define o caminho.
filename	filename	string	Obtém ou define o nome do arquivo.
workspaceId	workspaceId	integer	Obtém ou define o identificador do espaço de trabalho.

Devoluções

Essa classe representa os parâmetros de retorno para a API DeleteArtifact.

Body: DeleteArtifactResponse

Excluir Distribuidor

ID da Operação:: DeleteDistributor

Esta ação oferece a possibilidade de excluir distribuidor.

Parâmetros

Name	Chave	Necessário	Tipo	Description
distribuidorId	distributorId	True	integer	Obtém ou define o identificador do distribuidor.
manterEntrevistas	keepInterviews		boolean	Obtém ou define um valor que indica se [manter entrevistas].

Devoluções

Esta classe representa os parâmetros de retorno para a API DeleteDistribution.

Body: DeleteDistributorResponse

Excluir entrevista

ID da Operação:: DeleteInterview

Esta ação oferece a possibilidade de apagar a entrevista.

Parâmetros

Name	Chave	Necessário	Tipo	Description
entrevistaId	interviewId		uuid	Obtém ou define o identificador de entrevista.
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.

Devoluções

Essa classe representa os parâmetros de retorno para a API DeleteInterview.

Body: DeleteInterviewResponse

Excluir membros

ID da Operação:: DeleteMembers

Esta ação oferece a possibilidade de excluir membros.

Parâmetros

Name	Chave	Necessário	Tipo	Description
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
panelMembersIds	panelMembersIds	True	array of integer	Obtém ou define o identificador de membro do painel.
manterEntrevistas	keepInterviews		boolean	Obtém ou define um valor que indica se [manter entrevistas].

Devoluções

Essa classe representa os parâmetros de retorno para a API DeleteMember.

Body: DeleteMembersResponse

Excluir painel

ID da Operação:: DeletePanel

Esta ação oferece a possibilidade de excluir o painel.

Parâmetros

Name	Chave	Necessário	Tipo	Description
panelId	panelId	True	integer	Obtém ou define o identificador de exemplo.
manterEntrevistas	keepInterviews		boolean	Obtém ou define um valor que indica se [manter entrevistas].

Devoluções

Essa classe representa os parâmetros de retorno para a API DeleteSample.

Body: DeletePanelResponse

Excluir pesquisa

ID da Operação:: DeleteSurvey

Esta ação oferece a possibilidade de eliminar o inquérito.

Parâmetros

Name	Chave	Necessário	Tipo	Description
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.

Devoluções

Essa classe representa os parâmetros de retorno para a API DeleteSurvey.

Body: DeleteSurveyResponse

Excluir projeto de amostragem

ID da Operação:: DeleteSamplingProject

Esta ação oferece a possibilidade de eliminar o projeto de amostragem.

Parâmetros

Name	Chave	Necessário	Tipo	Description
amostragemProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
manterEntrevistas	keepInterviews		boolean	Obtém ou define um valor que indica se [manter entrevistas].

Devoluções

Essa classe representa os parâmetros de retorno para a API DeleteSamplingProject.

Body: DeleteSamplingProjectResponse

Excluir WebHook

ID da Operação:: DeleteWebHook

Esta ação oferece a possibilidade de excluir o gancho da web.

Parâmetros

Name	Chave	Necessário	Tipo	Description
webHookId	webHookId		uuid	Obtém ou define o identificador de gancho da Web.

Devoluções

Essa classe representa os parâmetros de retorno para a API DeleteWebHook.

Body: DeleteWebHookResponse

Executar transição de fluxo de trabalho

ID da Operação:: ExecuteWorkflowTransition

Esta ação oferece a possibilidade de executar a transição do fluxo de trabalho específico para o fluxo de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
fluxo de trabalho	workflow	True	string	Tipo de fluxo de trabalho
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.
amostragemProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.
distribuidorId	distributorId		integer	Obtém ou define o identificador do distribuidor.
reminderId	reminderId		integer	Obtém ou define o identificador de lembrete.
Estado-alvo	targetState	True	string	Obtém ou define o estado do destino.
dynamicParameters	dynamicParameters		object	Obtém ou define os parâmetros dinâmicos.

Devoluções

Essa classe representa os parâmetros de retorno para a API ExecuteWorkflowTransition.

Body: ExecuteWorkflowTransitionResponse

Leia a entrevista

ID da Operação:: ReadInterview

Esta ação oferece a possibilidade de ler os dados da entrevista.

Parâmetros

Name	Chave	Necessário	Tipo	Description
inquilino	tenant	True	string	Obtém ou define o locatário.
entrevistaId	interviewId	True	uuid	Obtém ou define o identificador de entrevista.
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.
loadSurveyDefinição	loadSurveyDefinition		boolean	Obtém ou define um valor que indica se [definição de pesquisa de carga].

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadInterviewData.

Body: ReadInterviewDataResponse

Leia a pesquisa

ID da Operação:: ReadSurvey

Esta ação oferece a possibilidade de ler o inquérito.

Parâmetros

Name	Chave	Necessário	Tipo	Description
inquilino	tenant		string	Obtém ou define o locatário.
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadSurveyDefinition.

Body: ReadSurveyResponse

Leia as entrevistas

ID da Operação:: ReadInterviewList

Esta ação oferece a possibilidade de ler a lista de entrevistas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
inquilino	tenant		string	Obtém ou define o locatário.
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.
camposToDownload	fieldsToDownload		array of string	Obtém ou define as colunas solicitadas.
loadCodePlan	loadCodePlan		boolean	Obtém ou define um valor que indica se [load code plan].
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadInterviewList.

Body: ReadInterviewListResponseV3

Leia as entrevistas do Compact

ID da Operação:: ReadInterviewListCompact

Esta ação oferece a possibilidade de ler o compacto da lista de entrevistas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
inquilino	tenant		string	Obtém ou define o locatário.
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.
camposToDownload	fieldsToDownload		array of string	Obtém ou define as colunas solicitadas.
loadCodePlan	loadCodePlan		boolean	Obtém ou define um valor que indica se [load code plan].
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadInterviewListCompact.

Body: ReadInterviewListCompactResponseV3

Leia Incentivos

ID da Operação:: ReadIncentiveList

Esta ação devolve os incentivos/voucher disponíveis para o utilizador autenticado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de solicitação para a API ReadIncentiveList.

Body: ReadIncentiveListResponse

Leia os links da pesquisa

ID da Operação:: ReadSurveyLinks

Esta ação oferece a possibilidade de ler os links da pesquisa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.

Devoluções

Esta classe representa a resposta da API ReadSurveyLinks.

Body: ReadSurveyLinksResponse

Leia Transações de Incentivo

ID da Operação:: ReadIncentiveTransactionList

A ação retorna uma visão geral de todos os ganhos e gastos relacionados aos créditos da pesquisa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadIncentiveTransactionList.

Body: ReadIncentiveTransactionListResponse

Leia WebHooks

ID da Operação:: ReadWebHookList

Esta ação oferece a possibilidade de ler a lista de ganchos da web.

Parâmetros

Name	Chave	Necessário	Tipo	Description
eventType	eventType		string	Tipo de Evento
entityIdentifier	entityIdentifier		string	Obtém ou define o identificador de entidade.

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadWebHookList.

Body: ReadWebHookListResponse

Lembrar os Membros

ID da Operação:: RemindMembers

Esta ação oferece a possibilidade de lembrar o membro.

Parâmetros

Name	Chave	Necessário	Tipo	Description
distribuidorId	distributorId	True	integer	O ID do inquérito
messageTemplateId	messageTemplateId	True	integer	Obtém ou define o identificador do modelo de mensagem.
nome	name		string	Obtém ou define o nome.
tipo	type		string	Obtém ou define o tipo.
languageCode	languageCode	True	string	Obtém ou define o código do idioma.
enviar SMS	text		string	Obtém ou define o texto.
programaçãoDataHora	scheduleDateTime		date-time	Obtém ou define o horário de agendamento.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
canal	channel		string	Canal de Distribuição
de	from		string	Obtém ou define de.
fromName	fromName		string	Obtém ou define a partir do nome.
replyTo	replyTo		string	Obtém ou define a resposta para.
replyToName	replyToName		string	Obtém ou define o nome da resposta para.

Devoluções

Essa classe representa os parâmetros de retorno para a API RemindMembers.

Body: RemindMembersResponse

Ler Artefactos

ID da Operação:: ReadArtifactList

Esta ação oferece a possibilidade de ler a lista de artefatos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
caminho	path		string	Obtém ou define o caminho.
workspaceId	workspaceId		integer	Obtém ou define o identificador do espaço de trabalho.

Devoluções

Essa classe representa os parâmetros de solicitação para a API ReadArtifactList.

Body: ReadArtifactListRequest

Ler Distribuidores

ID da Operação:: ReadDistributorList

Esta ação oferece a possibilidade de ler a lista de distribuidores.

Parâmetros

Name	Chave	Necessário	Tipo	Description
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.
panelId	panelId		integer	Obtém ou define o identificador do painel.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadDistributorList.

Body: ReadDistributorListResponse

Ler espaços de trabalho

ID da Operação:: ReadWorkspaceList

Esta ação oferece a possibilidade de ler todos os espaços de trabalho disponíveis.

Parâmetros

Name	Chave	Necessário	Tipo	Description
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de solicitação para a API ReadWorkspaceList.

Body: ReadWorkspaceListResponse

Ler inquéritos

ID da Operação:: ReadSurveyList

Esta ação oferece a possibilidade de ler todos os inquéritos disponíveis de um determinado espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
workspaceId	workspaceId	True	integer	Obtém ou define o identificador do espaço de trabalho.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de resposta para a API ReadSurveyList.

Body: ReadSurveyListResponse

Ler Membros

ID da Operação:: ReadMemberList

Esta ação oferece a possibilidade de ler os membros.

Parâmetros

Name	Chave	Necessário	Tipo	Description
inquilino	tenant		string	Obtém ou define o locatário.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
entrevistasObrigatório	interviewsRequired	True	boolean	Obtém ou define um valor que indica se as informações da sessão são necessárias.
camposToDownload	fieldsToDownload		array of string	Obtém ou define os campos para download.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadMemberList.

Body: ReadMemberListResponse

Ler modelos de mensagem

ID da Operação:: ReadMessageTemplateList

Esta ação oferece a possibilidade de receber todos os modelos de mensagens configurados para Email e SMS.

Parâmetros

Name	Chave	Necessário	Tipo	Description
workspaceId	workspaceId		integer	Obtém ou define o identificador do espaço de trabalho.
linguagem	language	True	string	Obtém ou define o idioma.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadMessageTemplateList.

Body: ReadMessageTemplateListResponse

Ler Opt-Outs

ID da Operação:: ReadOptOutList

Esta ação oferece a possibilidade de ler todos os Opt-Outs de um espaço de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
panelId	panelId		integer	Obtém ou define o identificador do painel.
workspaceId	workspaceId		integer	Obtém ou define o identificador do espaço de trabalho.
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadOptOutList.

Body: ReadOptOutListResponseV3

Ler projeto de amostragem

ID da Operação:: ReadSamplingProject

Esta ação oferece a possibilidade de ler o projeto de amostragem.

Parâmetros

Name	Chave	Necessário	Tipo	Description
amostragemProjectId	samplingProjectId		integer	Obtém ou define o identificador do projeto de amostragem.

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadSamplingProject.

Body: ReadSamplingProjectResponse

Ler rejeições

ID da Operação:: ReadBounceList

Esta ação oferece a possibilidade de ler a lista de rejeição.

Parâmetros

Name	Chave	Necessário	Tipo	Description
surveyId	surveyId	True	integer	Obtém ou define o identificador da pesquisa.
panelId	panelId		integer	Obtém ou define o identificador do painel.
Distribuidores	distributors		array of integer	Obtém ou define os distribuidores.
Tipo de convite	invitationType		string	Tipo de convite
conjunção	conjunction	True	string	Conjunção
conditionType	conditionType	True	string	Tipo de condição
identificador	identifier	True	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	True	string	ConditionOperator
valor	value	True	string	Obtém ou define o valor.
tipovariável	variableType		string	VariableType
jsonValor	jsonValue		boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath		string	Obtém ou define o caminho json.
pageSize	pageSize	True	integer	Obtém ou define o tamanho da página.
página	page	True	integer	Obtém ou define a página.
orderField	orderField		string	Obtém ou define o campo de ordem.
orderDirection	orderDirection		string	OrderDirection

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadBounceList.

Body: ReadBounceListResponseV3

Ler Saldo de Crédito

ID da Operação:: ReadCreditBalance

Essa ação retorna o saldo de crédito da pesquisa para o usuário autenticado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
			object	Essa classe representa os parâmetros de solicitação para a API ReadCreditBalance.

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadCreditBalance.

Body: ReadCreditBalanceResponse

Ler transições de fluxo de trabalho

ID da Operação:: ReadWorkflowTransitions

Esta ação oferece a possibilidade de ler todas as transições de fluxo de trabalho específicas para o fluxo de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
fluxo de trabalho	workflow	True	string	Tipo de fluxo de trabalho
currentState	currentState	True	string	Obtém ou define o estado da corrente.

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadWorkflowTransitions.

Body: ReadWorkflowTransitionsResponse

Painel de Atualização

ID da Operação:: UpdatePanel

Esta ação oferece a possibilidade de atualizar o painel.

Parâmetros

Name	Chave	Necessário	Tipo	Description
inquilino	tenant		string	Obtém ou define o locatário.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.
id	id		integer	O id do campo. Este é um campo obrigatório em caso de mudança de nome.
nome	name		string	O nome do campo. Este é um campo obrigatório.
tipo	type		string	PanelMemberFieldType
valor	value			O valor do campo. O tipo de valor deve corresponder à propriedade Type.
removidoCampos	removedFields		array of integer	Obtém ou define os campos removidos.
id	id		integer	O id do campo. Este é um campo obrigatório em caso de mudança de nome.
nome	name		string	O nome do campo. Este é um campo obrigatório.
tipo	type		string	PanelMemberFieldType
valor	value			O valor do campo. O tipo de valor deve corresponder à propriedade Type.

Devoluções

Essa classe representa os parâmetros de retorno para a API WritePanel.

Body: WritePanelResponse

Painel de Leitura

ID da Operação:: ReadPanel

Esta ação oferece a possibilidade de ler a definição do painel.

Parâmetros

Name	Chave	Necessário	Tipo	Description
inquilino	tenant		string	Obtém ou define o locatário.
panelId	panelId	True	integer	Obtém ou define o identificador do painel.

Devoluções

Essa classe representa os parâmetros de retorno para a API ReadPanelDefinition.

Body: ReadPanelDefinitionResponse

Redefinir entrevista

ID da Operação:: ResetInterview

Esta ação oferece a possibilidade de redefinir a resposta dos membros do painel.

Parâmetros

Name	Chave	Necessário	Tipo	Description
surveyId	surveyId		integer	Obtém ou define o identificador da pesquisa.
entrevistaId	interviewId		uuid	Obtém ou define o identificador de entrevista.

Devoluções

Esta classe representa os parâmetros de retorno para a API ResetInterview.

Body: ResetInterviewResponse

Resgatar Código de Incentivo

ID da Operação:: RedeemIncentiveCode

Esta ação oferece a possibilidade de gastar créditos de pesquisa para incentivos/vouchers.

Parâmetros

Name	Chave	Necessário	Tipo	Description
incentivaId	incentiveId	True	integer	Obtém ou define o identificador de incentivo.

Devoluções

Essa classe representa os parâmetros de retorno para a API RedeemIncentiveCode.

Body: RedeemIncentiveCodeResponse

Definições

Tipo de Acesso

: string

ActionElement

Esta classe representa um fim da ação de pesquisa para completar/excluir/cota cheia.

Name	Caminho	Tipo	Description
actionType	actionType	ActionType	QuotaAction
endOfSurveyText	endOfSurveyText	array of TranslationElement	Obtém ou define o final do texto da pesquisa.
encaminharUrl	forwardUrl	array of TranslationElement	Obtém ou define a URL de encaminhamento.

Tipo de ação

QuotaAction

: string

AnonimizaçãoConfiguração

Essa classe contém as configurações de anonimização que podem ser aplicadas a um grupo de espaços de trabalho, a um espaço de trabalho ou a uma pesquisa individual.

Name	Caminho	Tipo	Description
anonymizingMode	anonymizingMode	AnonymizingMode	AnonymizingMode
LogIp	logIp	boolean	Obtém ou define um valor que indica se [log ip].
logUserAgent	logUserAgent	boolean	Obtém ou define um valor que indica se [log user agent].
logReferer	logReferer	boolean	Obtém ou define um valor que indica se [log referer].

BounceElement

Esta classe representa um fim da ação de pesquisa para completar/excluir/cota cheia.

Name	Caminho	Tipo	Description
distribuidorId	distributorId	integer	Obtém ou define o identificador do distribuidor.
entrevistaId	interviewId	uuid	Obtém ou define o identificador de entrevista.
panelId	panelId	integer	Obtém ou define o identificador do painel.
panelMemberId	panelMemberId	integer	Obtém ou define o identificador de membro do painel.
bounceType	bounceType	BounceType	Tipo de rejeição
carimbo de data/hora	timestamp	date-time	Obtém ou define o carimbo de data/hora.
state	state	string	Obtém ou define o estado.
razão	reason	string	Obtém ou define o motivo.
e-mail	email	string	Obtém ou define o e-mail.
phone	phone	integer	Obtém ou define o telefone.
Tipo de convite	invitationType	InvitationType	Tipo de convite

Tipo de rejeição

: string

Escolha

Esta classe representa uma única escolha que pode ser usada em cada tipo de pergunta de escolha.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
código	code	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged	boolean	Obtém ou define um valor que indica se [código alterado manualmente].
enviar SMS	text	array of TranslationElement	Obtém ou define as traduções de texto.
allowTextEntry	allowTextEntry	boolean	Obtém ou define um valor que indica se [permitir entrada de texto].
forceInput	forceInput	boolean	Obtém ou define um valor que indica se [forçar entrada].
preenchimento automático	autocomplete	boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.Choice é preenchido automaticamente.
preenchimento automáticoTexto	autocompleteText	array of TranslationElement	Obtém ou define as traduções de texto de preenchimento automático.
exclusivo	exclusive	boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.Choice é exclusivo.
excludeFromRandomization	excludeFromRandomization	boolean	Obtém ou define um valor que indica se [excluir da randomização].
contentValidation	contentValidation	ContentValidation	Esta classe representa uma validação de conteúdo dentro de uma pesquisa.
condition	condition	ConditionDefinition	Esta classe representa a definição de elementos de condições.
autocompleteListVariable	autocompleteListVariable	string	Obtém ou define a variável de lista de preenchimento automático.

Tipo de escolha

: string

CodeAccessMode

Tipo de autenticação

: string

ColItem

Esta classe representa uma célula de uma resposta de pesquisa.

Name	Caminho	Tipo	Description
id	id	string	Obtém ou define o identificador.
valor	value		Obtém ou define o valor.

ColumnGroup

Esta classe representa um grupo de colunas dentro de tipos de perguntas complexas, como perguntas matriciais.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
enviar SMS	text	array of TranslationElement	Obtém ou define as traduções de texto.
hasNotAvailableChoice	hasNotAvailableChoice	boolean	Obtém ou define um valor que indica se essa instância não tem opção disponível.
notAvailableChoiceText	notAvailableChoiceText	array of TranslationElement	Obtém ou define as traduções de texto de opção não disponíveis.
randomizeColumns	randomizeColumns	boolean	Obtém ou define um valor que indica se [randomizar colunas].
avisar	prompt	array of TranslationElement	Obtém ou define o prompt.
choiceType	choiceType	ChoiceType	Tipo de escolha
choices	choices	array of Choice	Obtém ou define as opções.
condition	condition	ConditionDefinition	Esta classe representa a definição de elementos de condições.

Tipo de coluna

: string

Condition

Esta classe é a base para todos os elementos de condição.

Name	Caminho	Tipo	Description
conjunção	conjunction	Conjunction	Conjunção
conditionType	conditionType	ConditionType	Tipo de condição
identificador	identifier	string	Obtém ou define o identificador.
condiçãoOperador	conditionOperator	ConditionOperator	ConditionOperator
valor	value	string	Obtém ou define o valor.
tipovariável	variableType	VariableType	VariableType
jsonValor	jsonValue	boolean	Obtém ou define um valor que indica se [json value].
jsonCaminho	jsonPath	string	Obtém ou define o caminho json.

CondiçãoAção

FilterAction

: string

ConditionDefinition

Esta classe representa a definição de elementos de condições.

Name	Caminho	Tipo	Description
condiçãoAção	conditionAction	ConditionAction	FilterAction
elementos	elements	array of Condition	Obtém ou define os elementos.

ConditionOperator

: string

Tipo de condição

: string

Conjunção

: string

ContentValidation

Esta classe representa uma validação de conteúdo dentro de uma pesquisa.

Name	Caminho	Tipo	Description
validationType	validationType	ContentValidationType	ContentValidation
Data mais antiga	earliestDate	string	Obtém ou define a data mais antiga.
Data mais recente	latestDate	string	Obtém ou define a data mais recente.
minValor	minValue	double	Obtém ou define o valor mínimo.
maxValor	maxValue	double	Obtém ou define o valor máximo.
casas decimais	decimalPlaces	integer	Obtém ou define as casas decimais.
disableThousandSeparator	disableThousandSeparator	boolean	Obtém ou define o separador de mil desativado.

ContentValidationType

ContentValidation

: string

CreateAndInviteMembersResponse

Essa classe representa os parâmetros de retorno para a API CreateAndInviteMembers.

Name	Caminho	Tipo	Description
amostragemProjectId	samplingProjectId	integer	Obtém ou define o identificador do projeto de amostragem.
distribuidorId	distributorId	integer	Obtém ou define o identificador do distribuidor.
validaçãoProblemas	validationIssues	array of WritePanelMemberIssue	Obtém ou define os problemas.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CreateArtifactResponse

Essa classe representa a resposta da API CreateArtifact.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CreateMembersResponse

Essa classe representa os parâmetros de retorno para a API CreateMembers.

Name	Caminho	Tipo	Description
membrosIds	membersIds	array of integer	Obtém ou define as ids dos membros.
validaçãoProblemas	validationIssues	array of WritePanelMemberIssue	Obtém ou define os problemas.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CreatePanelResponse

Essa classe representa os parâmetros de retorno para a API CreatePanel.

Name	Caminho	Tipo	Description
id	id	integer	Obtenha o ID do painel criado.
nome	name	string	Obtenha o nome do painel criado.
isExtendedPanel	isExtendedPanel	boolean	Obtenha o tipo de painel criado.
createdDate (Data de criação)	createdDate	string	Obtenha a data de criação do painel criado.
isLock	isLock	boolean	Obtenha o valor que indica se o painel está bloqueado.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CreateSurveyResponse

Essa classe representa os parâmetros de retorno para a API CreateSurvey.

Name	Caminho	Tipo	Description
surveyId	surveyId	integer	Obtém ou define o identificador da pesquisa.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CreateWebHookResponse

Essa classe representa os parâmetros de retorno para a API CreateWebHook.

Name	Caminho	Tipo	Description
webHookId	webHookId	uuid	Obtém ou define o identificador de gancho da Web.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

CustomVariable

Esta classe representa uma única variável personalizada.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
variableName	variableName	string	Obtém ou define o nome da variável.
tipovariável	variableType	VariableType	VariableType

DataAccessControl

Esta classe contém a configuração de como a entidade está sendo acessível

Name	Caminho	Tipo	Description
tipo de acesso	accessType	AccessType	Tipo de Acesso
condições	conditions	array of Condition	Obtém ou define as condições.

DeleteArtifactResponse

Essa classe representa os parâmetros de retorno para a API DeleteArtifact.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteDistributorResponse

Esta classe representa os parâmetros de retorno para a API DeleteDistribution.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteInterviewResponse

Essa classe representa os parâmetros de retorno para a API DeleteInterview.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteMembersResponse

Essa classe representa os parâmetros de retorno para a API DeleteMember.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeletePanelResponse

Essa classe representa os parâmetros de retorno para a API DeleteSample.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteSamplingProjectResponse

Essa classe representa os parâmetros de retorno para a API DeleteSamplingProject.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteSurveyResponse

Essa classe representa os parâmetros de retorno para a API DeleteSurvey.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DeleteWebHookResponse

Essa classe representa os parâmetros de retorno para a API DeleteWebHook.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

DesignConfiguration

Esta classe representa as possibilidades de estilo para uma conta.

Name	Caminho	Tipo	Description
surveyDesignLayout	surveyDesignLayout	integer	Obtém ou define o layout de design da pesquisa.
matrixSubQuestionSize	matrixSubQuestionSize	MatrixSubQuestionSize	MatrixSubQuestionSize
textBlocks	textBlocks	array of TextBlock	Obtém ou define o conteúdo do modelo.

Canal de Distribuição

: string

DistributorElement

Esta classe representa um elemento distribuidor.

Name	Caminho	Tipo	Description
distribuidorId	distributorId	integer	Obtém ou define o identificador do distribuidor.
canal de distribuição	distributionChannel	DistributionChannel	Canal de Distribuição
surveyId	surveyId	integer	Obtém ou define o identificador da pesquisa.
amostragemProjectId	samplingProjectId	integer	Obtém ou define o identificador do projeto de amostragem.
surveyVersion	surveyVersion	integer	Obtém ou define a versão da pesquisa.
panelId	panelId	integer	Obtém ou define o identificador do painel.
scheduledDistribution	scheduledDistribution	date-time	Obtém ou define a distribuição agendada.
executedDistribution	executedDistribution	date-time	Obtém ou define a distribuição executada.
Estado de distribuição	distributionState	string	Obtém ou define o estado da distribuição.
condições	conditions	array of ConditionDefinition	Obtém ou define as condições.

BaixarRespostasResposta

Essa classe representa os parâmetros de retorno para a API DownloadAnswers.

Name	Caminho	Tipo	Description
baixarUrl	downloadUrl	string	Obtém ou define o URL de download.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ElementType

: string

Tipo de Evento

: string

ExecuteSendMailResponse

Essa classe representa os parâmetros de retorno para a API ExecuteSendMail.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ExecuteWorkflowTransitionResponse

Essa classe representa os parâmetros de retorno para a API ExecuteWorkflowTransition.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ExecutionBehavior

: string

Entrevista

Esta aula representa dados de registro de entrevista

Name	Caminho	Tipo	Description
id	id	string	O id da entrevista
state	state	string	Obtém ou define o estado.
surveyId	surveyId	integer	O id do inquérito por questionário
surveyVersionId	surveyVersionId	integer	O id da versão do inquérito
surveyName	surveyName	string	O nome do inquérito por questionário
surveyState	surveyState	string	Obtém ou define o estado da pesquisa.
respostasLink	answersLink	string	O link para a página de impressão das respostas
entrevistaLink	interviewLink	string	Obtém ou define o link da entrevista.
startDate	startDate	string	Obtém ou define a data de início.
data de término	endDate	string	Obtém ou define a data de término.
amostragemProjectId	samplingProjectId	integer	Obtém ou define o identificador do projeto de amostragem.
distribuidorId	distributorId	integer	Obtém ou define o identificador do distribuidor.

Tipo de convite

: string

InviteMembersResponse

Essa classe representa os parâmetros de retorno para a API InviteMembers.

Name	Caminho	Tipo	Description
amostragemProjectId	samplingProjectId	integer	Obtém ou define o identificador do projeto de amostragem.
distribuidorId	distributorId	integer	Obtém ou define o identificador do distribuidor.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

MatrixSubQuestionSize

: string

Membro

Esta classe representa um único membro do painel com uma estrutura dinâmica baseada no painel.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
campos	fields	object	Obtém ou define os campos.
criadosAt	createdAt	date-time	Obtém ou define o criado em.
criado por	createdBy	string	Obtém ou define o criado por.
atualizadoem	updatedAt	date-time	Obtém ou define o atualizado em.
atualizadoPor	updatedBy	string	Obtém ou define o atualizado por.
entrevistas	interviews	array of Interview	Obtém ou define as entrevistas.

MessageTemplateItem

Esta classe representa um item de modelo de mensagem.

Name	Caminho	Tipo	Description
id	id	integer	O id da mensagem de e-mail
nome	name	string	O nome da mensagem de e-mail
conteúdo	content	string	O conteúdo da mensagem de e-mail
Assunto	subject	string	O assunto da mensagem de e-mail
defaultLocale	defaultLocale	string	A localidade padrão da mensagem de email
localidades	locales	array of string	A lista de localidades para esta mensagem de email

MinMaxEscolha

Esta classe representa um elemento de escolha min max dentro de uma pesquisa.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
código	code	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged	boolean	Obtém ou define um valor que indica se [código alterado manualmente].
leftText	leftText	array of TranslationElement	Obtém ou define as traduções de texto à esquerda.
rightText	rightText	array of TranslationElement	Obtém ou define as traduções de texto corretas.
excludeFromRandomization	excludeFromRandomization	boolean	Obtém ou define um valor que indica se [excluir da randomização].
condition	condition	ConditionDefinition	Esta classe representa a definição de elementos de condições.

OptOutItem

Esta classe representa um Opt-Out item.

Name	Caminho	Tipo	Description
e-mail	email	string	Obtém ou define o e-mail.
phone	phone	integer	Obtém ou define o telefone.
optOutAt	optOutAt	string	Obtém ou define o opt-out em.
optOutBy	optOutBy	string	Obtém ou define a opção de exclusão por.

PanelDefinition

Esta classe contém a definição completa de todos os campos contidos em um painel definido pelo cliente.

Name	Caminho	Tipo	Description
groups	groups	array of VariableGroupElement	Obtém ou define os grupos.
dataAccessControl	dataAccessControl	DataAccessControl	Esta classe contém a configuração de como a entidade está sendo acessível

PanelFieldItem

Esta classe representa um campo de painel dentro de um painel.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
nome	name	string	Obtém ou define o nome.
nome de exibição	displayName	string	Obtém ou define o nome para exibição.
isSystem	isSystem	boolean	Obtém ou define um valor que indica se essa instância é system.
obrigatório	mandatory	boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.PanelFieldItem é obrigatório.
anonimizar	anonymize	boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.PanelFieldItem é anonimizado.
validaçãoExpressão	validationExpression	string	Obtém ou define a expressão de validação.
validationErrorMessageId	validationErrorMessageId	string	Obtém ou define o identificador de mensagem de validação.
panelFieldType	panelFieldType	VariableType	VariableType
metadados	metadata	object	Obtém ou define os metadados.

PainelIncentivo

Esta classe representa um único incentivo.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
nome	name	string	Obtém ou define o nome.
priceInCredits	priceInCredits	integer	Obtém ou define o preço em créditos.
descrição	description	string	Obtém ou define a descrição.
disponívelVouchersCount	availableVouchersCount	integer	Obtém ou define o número de vouchers disponíveis.

PanelSyncBehaviour

: string

PanelSyncElement

Essa classe representa um único item de sincronização entre uma pesquisa e um painel.

Name	Caminho	Tipo	Description
identificador	identifier	string	Obtém ou define o identificador.
panelField	panelField	string	Obtém ou define o campo do painel.

ReadArtifactListRequest

Essa classe representa os parâmetros de solicitação para a API ReadArtifactList.

Name	Caminho	Tipo	Description
caminho	path	string	Obtém ou define o caminho.
workspaceId	workspaceId	integer	Obtém ou define o identificador do espaço de trabalho.

ReadBounceListResponseV3

Essa classe representa os parâmetros de retorno para a API ReadBounceList.

Name	Caminho	Tipo	Description
rejeições	bounces	array of BounceElement	Obtém ou define a lista de devoluções.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadCreditBalanceResponse

Essa classe representa os parâmetros de retorno para a API ReadCreditBalance.

Name	Caminho	Tipo	Description
saldo	balance	integer	Obtém ou define o equilíbrio.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadDistributorListResponse

Essa classe representa os parâmetros de retorno para a API ReadDistributorList.

Name	Caminho	Tipo	Description
Distribuidores	distributors	array of DistributorElement	Obtém ou define os distribuidores.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadIncentiveListResponse

Essa classe representa os parâmetros de solicitação para a API ReadIncentiveList.

Name	Caminho	Tipo	Description
painelIncentivos	panelIncentives	array of PanelIncentive	Obtém ou define os incentivos do painel.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadIncentiveTransactionListResponse

Essa classe representa os parâmetros de retorno para a API ReadIncentiveTransactionList.

Name	Caminho	Tipo	Description
Transações de incentivo	incentiveTransactions	array of SurveyCreditLog	Obtém ou define as transações de incentivo.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadInterviewDataResponse

Essa classe representa os parâmetros de retorno para a API ReadInterviewData.

Name	Caminho	Tipo	Description
dadosDeResposta	responseData	object	Obtém ou define os dados de resposta.
surveyDefinição	surveyDefinition	SurveyDefinition	Esta classe representa a definição de uma pesquisa contendo todos os metadados e configurações.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadInterviewListCompactResponseV3

Essa classe representa os parâmetros de retorno para a API ReadInterviewListCompact.

Name	Caminho	Tipo	Description
surveyName	surveyName	string	Obtém ou define o nome da pesquisa.
surveyDefaultLanguage	surveyDefaultLanguage	string	Obtém ou define o idioma padrão da pesquisa.
surveyLanguages	surveyLanguages	array of string	Obtém ou define os idiomas da pesquisa.
entrevistas	interviews	array of object	Obtém ou define as entrevistas.
items	interviews	object
codePlan	codePlan	array of SurveyMetadataItem	Obtém ou define o plano de código.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadInterviewListResponseV3

Essa classe representa os parâmetros de retorno para a API ReadInterviewList.

Name	Caminho	Tipo	Description
surveyName	surveyName	string	Obtém ou define o nome da pesquisa.
surveyDefaultLanguage	surveyDefaultLanguage	string	Obtém ou define o idioma padrão da pesquisa.
surveyLanguages	surveyLanguages	array of string	Obtém ou define os idiomas da pesquisa.
codePlan	codePlan	array of SurveyMetadataItem	Obtém ou define o plano de código.
entrevistas	interviews	array of Row	Obtém ou define as entrevistas.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadMemberListResponse

Essa classe representa os parâmetros de retorno para a API ReadMemberList.

Name	Caminho	Tipo	Description
Membros	members	array of Member	Obtém ou define os membros do painel.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadMessageTemplateListResponse

Essa classe representa os parâmetros de retorno para a API ReadMessageTemplateList.

Name	Caminho	Tipo	Description
messageTemplates	messageTemplates	array of MessageTemplateItem	Obtém ou define os modelos de mensagem.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadOptOutListResponseV3

Essa classe representa os parâmetros de retorno para a API ReadOptOutList.

Name	Caminho	Tipo	Description
optOutItems	optOutItems	array of OptOutItem	Obtém ou define os itens de desativação.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadPanelDefinitionResponse

Essa classe representa os parâmetros de retorno para a API ReadPanelDefinition.

Name	Caminho	Tipo	Description
painel	panel	PanelDefinition	Esta classe contém a definição completa de todos os campos contidos em um painel definido pelo cliente.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadSamplingProjectResponse

Essa classe representa os parâmetros de retorno para a API ReadSamplingProject.

Name	Caminho	Tipo	Description
amostragemProjeto	samplingProject	SamplingProjectElement	Esta classe representa um projeto de amostragem.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadSurveyLinksResponse

Esta classe representa a resposta da API ReadSurveyLinks.

Name	Caminho	Tipo	Description
Lista anónima	anonymousList	array of SurveyLink	Obtém ou define a lista anônima.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadSurveyListResponse

Essa classe representa os parâmetros de resposta para a API ReadSurveyList.

Name	Caminho	Tipo	Description
inquéritos	surveys	array of SurveyListItem	Obtém ou define as pesquisas.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadSurveyResponse

Essa classe representa os parâmetros de retorno para a API ReadSurveyDefinition.

Name	Caminho	Tipo	Description
surveyName	surveyName	string	Obtém ou define o nome da pesquisa.
surveyVersion	surveyVersion	integer	Obtém ou define a versão da pesquisa.
surveyState	surveyState	string	Obtém ou define o estado da pesquisa.
criadosAt	createdAt	string	Obtém ou define o criado em.
criado por	createdBy	string	Obtém ou define o criado por.
inquérito	survey	SurveyDefinition	Esta classe representa a definição de uma pesquisa contendo todos os metadados e configurações.
surveyConfiguration	surveyConfiguration	SurveyConfiguration	Esta classe representa a configuração da pesquisa com todas as configurações que um usuário pode configurar.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadWebHookListResponse

Essa classe representa os parâmetros de retorno para a API ReadWebHookList.

Name	Caminho	Tipo	Description
ganchos web	webHooks	array of WebHookElement	Obtém ou define os ganchos da Web.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadWorkflowTransitionsResponse

Essa classe representa os parâmetros de retorno para a API ReadWorkflowTransitions.

Name	Caminho	Tipo	Description
Transições	transitions	array of WorkflowTransition	Obtém ou define as transições.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ReadWorkspaceListResponse

Essa classe representa os parâmetros de solicitação para a API ReadWorkspaceList.

Name	Caminho	Tipo	Description
workspaces	workspaces	array of WorkspaceDto	Obtém ou define os espaços de trabalho.
totalContagem	totalCount	integer	Obtém ou define a contagem total.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

RedeemIncentiveCodeResponse

Essa classe representa os parâmetros de retorno para a API RedeemIncentiveCode.

Name	Caminho	Tipo	Description
Código do voucher	voucherCode	string	Obtém ou define o código do voucher.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

RemindMembersResponse

Essa classe representa os parâmetros de retorno para a API RemindMembers.

Name	Caminho	Tipo	Description
reminderId	reminderId	integer	Obtém ou define o identificador de lembrete.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ResetInterviewResponse

Esta classe representa os parâmetros de retorno para a API ResetInterview.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

Row

Esta classe representa um item de linha.

Name	Caminho	Tipo	Description
columns	columns	array of ColItem	Obtém ou define as colunas.

RowItem

Esta classe representa uma resposta à pesquisa.

Name	Caminho	Tipo	Description
id	id	string	Obtém ou define o identificador.
valor	value	string	Obtém ou define o valor.

SamplingProjectElement

Esta classe representa um projeto de amostragem.

Name	Caminho	Tipo	Description
amostragemProjectId	samplingProjectId	integer	Obtém ou define o identificador do projeto de amostragem.
nome	name	string	Obtém ou define o nome.
workspaceId	workspaceId	integer	Obtém ou define o identificador do espaço de trabalho.
surveyId	surveyId	integer	Obtém ou define o identificador da pesquisa.
surveyVersion	surveyVersion	integer	Obtém ou define a versão da pesquisa.
panelId	panelId	integer	Obtém ou define o identificador do painel.
samplingProviderId	samplingProviderId	integer	Obtém ou define o identificador do provedor de amostragem.
projectState [en]	projectState	string	Obtém ou define o estado do projeto.
scheduledDistribution	scheduledDistribution	string	Obtém ou define a distribuição agendada.
executedDistribution	executedDistribution	string	Obtém ou define a distribuição executada.
condições	conditions	array of ConditionDefinition	Obtém ou define as condições.

Tipo de script

: string

Seção

Esta classe representa uma seção dentro de uma pesquisa.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
nome	name	string	Obtém ou define o nome.
randomizePages	randomizePages	boolean	Obtém ou define um valor que indica se [randomizar páginas].
excludeFromRandomization	excludeFromRandomization	boolean	Obtém ou define um valor que indica se [excluir da randomização].
elementos	elements	array of SurveyElement	Obtém ou define os elementos.
condition	condition	ConditionDefinition	Esta classe representa a definição de elementos de condições.

SurveyConfiguration

Esta classe representa a configuração da pesquisa com todas as configurações que um usuário pode configurar.

Name	Caminho	Tipo	Description
designConfiguração	designConfiguration	DesignConfiguration	Esta classe representa as possibilidades de estilo para uma conta.
anonimizaçãoConfiguração	anonymizingConfiguration	AnonymizingConfiguration	Essa classe contém as configurações de anonimização que podem ser aplicadas a um grupo de espaços de trabalho, a um espaço de trabalho ou a uma pesquisa individual.

SurveyCreditLog

Esta classe representa uma única operação de crédito.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
oldValue	oldValue	string	Obtém ou define o valor antigo.
novoValor	newValue	string	Obtém ou define o novo valor.
descrição	description	string	Obtém ou define a descrição.
modifiedDate	modifiedDate	string	Obtém ou define a data de modificação.
modificadoPor	modifiedBy	string	Obtém ou define o modificado por.
responseId	responseId	uuid	Obtém ou define o identificador de resposta.
entrevistaLink	interviewLink	string	Obtém ou define o link da entrevista.

SurveyDefinition

Esta classe representa a definição de uma pesquisa contendo todos os metadados e configurações.

Name	Caminho	Tipo	Description
permitirParticipação Múltipla	allowMultipleParticipation	boolean	Obtém ou define um valor que indica se [permitir participação múltipla].
allowNavigateBack	allowNavigateBack	boolean	Obtém ou define um valor que indica se [permitir navegar de volta].
allowSaveProgress	allowSaveProgress	boolean	Obtém ou define um valor que indica se [permitir salvar progresso].
randomizeSections	randomizeSections	boolean	Obtém ou define um valor que indica se [randomizar seções].
habilitarAutoScroll	enableAutoScroll	boolean	Obtém ou define um valor que indica se [ativar rolagem automática].
enableCodeAccess	enableCodeAccess	boolean	Obtém ou define um valor que indica se [habilitar acesso ao código].
dataAccessControl	dataAccessControl	DataAccessControl	Esta classe contém a configuração de como a entidade está sendo acessível
associatedPanels	associatedPanels	array of integer	Obtém ou define o identificador do painel.
codeAccessMode	codeAccessMode	CodeAccessMode	Tipo de autenticação
enablePanelSync	enablePanelSync	boolean	Obtém ou define um valor que indica se [enable panel synchronize].
panelSyncBehaviour	panelSyncBehaviour	PanelSyncBehaviour	PanelSyncBehaviour
panelSyncs	panelSyncs	array of PanelSyncElement	Obtém ou define as sincronizações do painel.
defaultLanguage	defaultLanguage	string	Obtém ou define o idioma padrão.
data de término	endDate	date-time	Obtém ou define a data de término.
Idiomas	languages	array of string	Obtém ou define os idiomas.
secções	sections	array of Section	Obtém ou define as seções.
customVariables	customVariables	array of CustomVariable	Obtém ou define as variáveis personalizadas.
surveyEndText	surveyEndText	array of TranslationElement	Obtém ou define o texto final da pesquisa.
defaultTextOverrides	defaultTextOverrides	object	Obtém ou define as substituições de texto padrão.

SurveyElement

Essa classe representa uma definição de elemento de pesquisa com todos os metadados e configurações.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
elementType	elementType	ElementType	ElementType
código	code	string	Obtém ou define o código.
codeManuallyChanged	codeManuallyChanged	boolean	Obtém ou define um valor que indica se [código alterado manualmente].
enviar SMS	text	array of TranslationElement	Obtém ou define as traduções de texto.
dicaTexto	hintText	array of TranslationElement	Obtém ou define as traduções de texto de dica.
hasHintText	hasHintText	boolean	Obtém ou define um valor que indica se essa instância tem texto de dica.
hasNotAvailableChoice	hasNotAvailableChoice	boolean	Obtém ou define um valor que indica se essa instância não tem opção disponível.
notAvailableChoiceText	notAvailableChoiceText	array of TranslationElement	Obtém ou define as traduções de texto de opção não disponíveis.
forceResponse	forceResponse	boolean	Obtém ou define um valor que indica se [forçar resposta].
choices	choices	array of Choice	Obtém ou define as opções.
randomizeEscolhas	randomizeChoices	boolean	Obtém ou define um valor que indica se [randomizar opções].
columnType	columnType	ColumnType	Tipo de coluna
avisar	prompt	array of TranslationElement	Obtém ou define o prompt.
minValor	minValue	integer	Obtém ou define o valor mínimo.
maxValor	maxValue	integer	Obtém ou define o valor máximo.
showCenterLabel	showCenterLabel	boolean	Obtém ou define um valor que indica se [show center label].
leftLabel	leftLabel	array of TranslationElement	Obtém ou define o rótulo esquerdo.
centerLabel	centerLabel	array of TranslationElement	Obtém ou define o rótulo central.
direitaLabel	rightLabel	array of TranslationElement	Obtém ou define o rótulo certo.
showValue	showValue	boolean	Obtém ou define um valor que indica se [mostrar valor].
maxdecimais	maxDecimals	integer	Obtém ou define os dígitos máximos após a vírgula.
textFieldSize	textFieldSize	TextFieldSize	TextFieldSize
preenchimento automático	autocomplete	boolean	Obtém ou define um valor que indica se este Survalyzer.Contracts.Public.Elements.SurveyElement é de preenchimento automático.
preenchimento automáticoTexto	autocompleteText	array of TranslationElement	Obtém ou define as traduções de texto de preenchimento automático.
contentValidation	contentValidation	ContentValidation	Esta classe representa uma validação de conteúdo dentro de uma pesquisa.
hasPlaceholder	hasPlaceholder	boolean	Obtém ou define um valor que indica se essa instância tem espaço reservado.
marcador de posição	placeholder	array of TranslationElement	Obtém ou define o espaço reservado.
isPassword	isPassword	boolean	Obtém ou define um valor que indica se essa instância é senha.
minMaxValidação	minMaxValidation	boolean	Obtém ou define um valor que indica se [validação máxima mínima].
mínimoCheckedChoices	minimumCheckedChoices	integer	Obtém ou define as opções mínimas verificadas.
maximumCheckedChoices	maximumCheckedChoices	integer	Obtém ou define o máximo de opções verificadas.
columnGroups	columnGroups	array of ColumnGroup	Obtém ou define os grupos de colunas.
randomizeRows	randomizeRows	boolean	Obtém ou define um valor que indica se [randomizar linhas].
linhas	rows	array of MinMaxChoice	Obtém ou define as linhas.
númerodeRanks	numberOfRanks	integer	Obtém ou define o número de classificações.
likeText	likeText	array of TranslationElement	Obtém ou define traduções de texto semelhantes.
dislikeText	dislikeText	array of TranslationElement	Obtém ou define as traduções de texto que não gostam.
hasStartText	hasStartText	boolean	Obtém ou define um valor que indica se essa instância tem texto inicial.
startText	startText	array of TranslationElement	Obtém ou define o texto inicial.
enableMeasurement	enableMeasurement	boolean	Obtém ou define um valor que indica se [habilitar medição].
showButtons	showButtons	boolean	Obtém ou define um valor que indica se [mostrar botões].
likeKey	likeKey	string	Obtém ou define a chave like.
dislikeKey	dislikeKey	string	Obtém ou define a tecla dislike.
entrevistaEstado	interviewState	string	Obtém ou define o estado da resposta.
ação	action	ActionElement	Esta classe representa um fim da ação de pesquisa para completar/excluir/cota cheia.
de	from	string	Obtém ou define o remetente.
Para	to	string	Obtém ou define o recetor.
Assunto	subject	array of TranslationElement	Obtém ou define as traduções do assunto.
mensagem	message	array of TranslationElement	Obtém ou define as traduções da mensagem.
valueAssignmentType	valueAssignmentType	ValueAssignmentType	ValueAssignmentType
variableName	variableName	string	Obtém ou define o nome da variável.
funçãoTermo	functionTerm	array of TranslationElement	Obtém ou define o termo da função.
executionBehavior	executionBehavior	ExecutionBehavior	ExecutionBehavior
apiCallMethod	apiCallMethod	ApiCallMethod	ApiCallMethod
URL	url	array of TranslationElement	Obtém ou define a URL.
headers	headers	string	Obtém ou define os cabeçalhos.
body	body	array of TranslationElement	Obtém ou define o corpo.
externalUri	externalUri	string	Obtém ou define o URI externo.
scriptType	scriptType	ScriptType	Tipo de script
conteúdo	content	string	Obtém ou define o conteúdo.
hasRatingLabels	hasRatingLabels	boolean	Obtém ou define um valor que indica se essa instância tem rótulos de classificação.
leftRatingLabel	leftRatingLabel	array of TranslationElement	Obtém ou define o rótulo de classificação à esquerda.
rightRatingLabel	rightRatingLabel	array of TranslationElement	Obtém ou define o rótulo de classificação correto.
condition	condition	ConditionDefinition	Esta classe representa a definição de elementos de condições.
avaliarAsJson	evaluateAsJson	boolean	Obtém ou define um valor que indica se [avaliar como json].
autocompleteListVariable	autocompleteListVariable	string	Obtém ou define a variável de lista de preenchimento automático.
arranjoModo	arrangementMode	ArrangementMode	Modo de Arranjo
enableAnimation	enableAnimation	boolean	Obtém ou define um valor que indica se [ativar animação].
useSmiley	useSmiley	boolean	Obtém ou define um valor que indica se [use smiley].
hasPrompt	hasPrompt	boolean	Obtém ou define um valor que indica se essa instância tem prompt.

PesquisaLink

A entidade SurveyLink

Name	Caminho	Tipo	Description
URL	url	string	Obtém ou define a URL.
isCustom	isCustom	boolean	Obtém ou define um valor que indica se essa instância é personalizada.
linguagem	language	string	Obtém ou define o idioma.

SurveyListItem

Esta classe representa um único item de pesquisa.

Name	Caminho	Tipo	Description
id	id	integer	O id do inquérito por questionário
nome	name	string	O nome do inquérito por questionário
modifiedDate	modifiedDate	string	A data de modificação do inquérito por questionário
data de término	endDate	string	A data em que o inquérito por questionário termina
isEndDateEnabled	isEndDateEnabled	boolean	Se a data de término estiver habilitada para esta pesquisa
estado	status	SurveyStatus	SurveyStatus
arquivamentoData	archiveDate	string	A data em que o inquérito foi arquivado
statusOn	statusOn	boolean	A pesquisa está ativada ou desativada
answers	answers	integer	Obtém ou define as respostas.

SurveyMetadataItem

Essa classe representa um único item de metadados.

Name	Caminho	Tipo	Description
código	code	string	Obtém ou define o código.
Tipo de dados	dataType	string	Obtém ou define o tipo de dados.
questionCode	questionCode	string	Obtém ou define o código da pergunta.
tipo	type	string	Obtém ou define o tipo.
pergunta	question	string	Obtém ou define a pergunta.
linha	row	string	Obtém ou define a linha.
choice	choice	string	Obtém ou define a escolha.
values	values	array of RowItem	Obtém ou define os valores.
sectionName	sectionName	string	Obtém ou define o nome da seção.

SurveyStatus

: string

Bloco de texto

Name	Caminho	Tipo	Description
nome	name	string	Obtém ou define o nome.
tipo	type	string	Obtém ou define o tipo.
enviar SMS	text	array of TranslationElement	Obtém ou define o texto.

TextFieldSize

: string

TranslationElement

Esta classe representa uma tradução de texto dentro de uma pesquisa.

Name	Caminho	Tipo	Description
languageCode	languageCode	string	Obtém ou define o código do idioma.
enviar SMS	text	string	Obtém ou define o texto.

UpdateMembersResponse

Essa classe representa os parâmetros de retorno para a API UpdateMembers.

Name	Caminho	Tipo	Description
validaçãoProblemas	validationIssues	array of WritePanelMemberIssue	Obtém ou define os problemas.
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

UpdateSurveyResponse

Essa classe representa os parâmetros de retorno para a API UpdateSurvey.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

UpdateWebHookResponse

Essa classe representa os parâmetros de retorno para a API CreateWebHook.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

ValueAssignmentType

: string

VariableGroupElement

Esta classe representa um grupo de campos em um painel.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
nome	name	string	Obtém ou define o nome.
nome de exibição	displayName	string	Obtém ou define o nome para exibição.
campos	fields	array of PanelFieldItem	Obtém ou define os campos.

VariableType

: string

WebHookElement

Esta classe representa um único WebHook

Name	Caminho	Tipo	Description
id	id	uuid	Obtém ou define o identificador.
eventType	eventType	EventType	Tipo de Evento
entityIdentifier	entityIdentifier	string	Obtém ou define o identificador de entidade.
criadosAt	createdAt	date-time	Obtém ou define o criado em.
criado por	createdBy	string	Obtém ou define o criado por.
atualizadoem	updatedAt	date-time	Obtém ou define o atualizado em.
atualizadoPor	updatedBy	string	Obtém ou define o atualizado por.

WorkflowTransition

Esta classe representa uma transição de um estado para outro.

Name	Caminho	Tipo	Description
nome	name	string	Obtém ou define o nome.
ação	action	string	Obtém ou define o nome da ação.
novoEstado	newState	string	Cria um novo estado.
condition	condition	string	Obtém ou define a condição.

Espaço de trabalhoDto

Esta classe representa uma entidade de espaço de trabalho.

Name	Caminho	Tipo	Description
id	id	integer	Obtém ou define o identificador.
nome	name	string	Obtém ou define o nome.
númeroDosInquéritos	numberOfSurveys	integer	Obtém ou define o número de pesquisas.

WriteOptOutListResponse

Essa classe representa os parâmetros de retorno para a API WriteOptOutList.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

WritePanelMemberIssue

Representar algum problema que pode aparecer

Name	Caminho	Tipo	Description
código de erro	errorCode	string	Obtém ou define o código de erro.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.

WritePanelResponse

Essa classe representa os parâmetros de retorno para a API WritePanel.

Name	Caminho	Tipo	Description
éSucesso	isSuccess	boolean	Obtém ou define um valor que indica se essa instância é bem-sucedida.
errorMessage	errorMessage	string	Obtém ou define a mensagem de erro.
código de erro	errorCode	string	Obtém ou define o código de erro.

Partilhar via

Survalyzer EU (Pré-visualização)

A criar uma ligação

Padrão

Limites de Limitação

Ações

Atualizar Membros

Parâmetros

Devoluções

Atualizar Opt-Outs

Parâmetros

Devoluções

Atualizar pesquisa

Parâmetros

Devoluções

Atualizar Web Hook

Parâmetros

Devoluções

Convidar Membros

Parâmetros

Devoluções

Convidar Membros

Parâmetros

Devoluções

Criar artefato

Parâmetros

Devoluções

Criar Membros

Parâmetros

Devoluções

Criar painel ou exemplo

Parâmetros

Devoluções

Criar pesquisa

Parâmetros

Devoluções

Criar WebHook

Parâmetros

Devoluções

Descarregar Entrevista PDF

Parâmetros

Devoluções

Enviar E-mail

Parâmetros

Devoluções

Excluir artefato

Parâmetros

Devoluções

Excluir Distribuidor

Parâmetros

Devoluções

Excluir entrevista

Parâmetros

Devoluções

Excluir membros

Parâmetros

Devoluções

Excluir painel

Parâmetros

Devoluções

Excluir pesquisa

Parâmetros

Devoluções

Excluir projeto de amostragem

Parâmetros

Devoluções

Excluir WebHook

Parâmetros

Devoluções

Executar transição de fluxo de trabalho

Parâmetros

Devoluções

Leia a entrevista

Parâmetros

Devoluções

Leia a pesquisa

Parâmetros

Devoluções

Leia as entrevistas

Parâmetros