Survalyzer Swiss (Preview)
The Survalyzer connector provides simplified access to all API capabilities of the Swiss data center.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Survalyzer Developer Center |
URL | https://developer.survalyzer.com/ |
Connector Metadata | |
---|---|
Publisher | Survalyzer AG |
Website | https://survalyzer.com |
Privacy policy | https://survalyzer.com/privacy-policy |
Categories | Marketing;Productivity |
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Client Id - Your Survalyzer ClientId | string | Please enter the client Id. | True |
Client Secret - Your Survalyzer ClientSecret | securestring | Please enter the client secret. | True |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Create Artifact |
This action offers the possibility to create new artifact. |
Create Members |
This action offers the possibility to create the member list. |
Create Panel or Sample |
This action offers the possibility to create new panel. |
Create Survey |
This action offers the possibility to create survey. |
Create Web |
This action offers the possibility to create the web hook. |
Delete Artifact |
This action offers the possibility to delete artifact. |
Delete Distributor |
This action offers the possibility to delete distributor. |
Delete Interview |
This action offers the possibility to deletes the interview. |
Delete Members |
This action offers the possibility to delete members. |
Delete Panel |
This action offers the possibility to delete the panel. |
Delete Sampling Project |
This action offers the possibility to delete the sampling project. |
Delete Survey |
This action offers the possibility to delete the survey. |
Delete Web |
This action offers the possibility to deletes the web hook. |
Download Interview PDF |
This action offers the possibility to downloads the answers. |
Execute Workflow Transition |
This action offers the possibility to execute workflow transition specific for the workflow. |
Invite Members |
This action offers the possibility to invite the member. |
Invite Members |
This action offers the possibility to create and invite members. |
Read Artifacts |
This action offers the possibility to read the artifact list. |
Read Bounces |
This action offers the possibility to read the bounce list. |
Read Credit Balance |
This action returns the survey credit balance for the authenticated user. |
Read Distributors |
This action offers the possibility to read the distributor list. |
Read Incentive Transactions |
The action returns an overview over all earnings and spending related to survey credits. |
Read Incentives |
This action returns the available incentives/voucher for the authenticated user. |
Read Interview |
This action offers the possibility to read the interview data. |
Read Interviews |
This action offers the possibility to read the interview list. |
Read Interviews Compact |
This action offers the possibility to read the interview list compact. |
Read Members |
This action offers the possibility to read members. |
Read Message Templates |
This action offers the possibility to receive all configured message templates for Email and SMS. |
Read Opt-Outs |
This action offers the possibility to read all Opt-Outs for a workspace. |
Read Panel |
This action offers the possibility to read panel definition. |
Read Sampling Project |
This action offers the possibility to read the sampling project. |
Read Survey |
This action offers the possibility to read the survey. |
Read Survey Links |
This action offers the possibility to reads the survey links. |
Read Surveys |
This action offers the possibility to read all available surveys of a given workspace. |
Read Web |
This action offers the possibility to reads the web hook list. |
Read Workflow Transitions |
This action offers the possibility to read all workflow transitions specific for the workflow. |
Read Workspaces |
This action offers the possibility to read all available workspaces. |
Redeem Incentive Code |
This action offers the possibility to spend survey credits for incentives/vouchers. |
Remind Members |
This action offers the possibility to remind the member. |
Reset Interview |
This action offers the possibility to reset panel member response. |
Send Email |
This action offers the possibility to send mail. |
Update Members |
This action offers the possibility to update the member list. |
Update Opt-Outs |
This action offers the possibility to write entries to the Opt-Out list for a workspace. |
Update Panel |
This action offers the possibility to update the panel. |
Update Survey |
This action offers the possibility to update the survey. |
Update Web Hook |
This action offers the possibility to update the web hook. |
This action offers the possibility to create new artifact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
workspaceId
|
workspaceId | integer |
Gets or sets the workspace identifier. |
|
path
|
path | string |
Gets or sets the path. |
Returns
This class represents the response of the CreateArtifact API.
This action offers the possibility to create the member list.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
tenant
|
tenant | string |
Gets or sets the tenant. |
|
panelId
|
panelId | True | integer |
Gets or sets the panel identifier. |
id
|
id | integer |
Gets or sets the identifier. |
|
fields
|
fields | True | object |
Gets or sets the fields. |
createdAt
|
createdAt | date-time |
Gets or sets the created at. |
|
createdBy
|
createdBy | string |
Gets or sets the created by. |
|
updatedAt
|
updatedAt | date-time |
Gets or sets the updated at. |
|
updatedBy
|
updatedBy | string |
Gets or sets the updated by. |
|
id
|
id | string |
The id of the interview |
|
state
|
state | string |
Gets or sets the state. |
|
surveyId
|
surveyId | integer |
The id of the survey |
|
surveyVersionId
|
surveyVersionId | integer |
The id of the survey version |
|
surveyName
|
surveyName | string |
The name of the survey |
|
surveyState
|
surveyState | string |
Gets or sets the state of the survey. |
|
answersLink
|
answersLink | string |
The link to the answers print page |
|
interviewLink
|
interviewLink | string |
Gets or sets the interview link. |
|
startDate
|
startDate | string |
Gets or sets the start date. |
|
endDate
|
endDate | string |
Gets or sets the end date. |
|
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
|
distributorId
|
distributorId | integer |
Gets or sets the distributor identifier. |
Returns
This class represents the return parameters for the CreateMembers API.
This action offers the possibility to create new panel.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
workspaceId
|
workspaceId | True | integer |
Gets or sets the workspace identifier. |
name
|
name | True | string |
Gets or sets the panel name. |
panelType
|
panelType | True | string |
PanelModelType |
Returns
This class represents the return parameters for the CreatePanel API.
- Body
- CreatePanelResponse
This action offers the possibility to create survey.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
workspaceId
|
workspaceId | True | integer |
Gets or sets the workspace identifier. |
name
|
name | True | string |
Gets or sets the name. |
allowMultipleParticipation
|
allowMultipleParticipation | True | boolean |
Gets or sets a value indicating whether [allow multiple participation]. |
allowNavigateBack
|
allowNavigateBack | True | boolean |
Gets or sets a value indicating whether [allow navigate back]. |
allowSaveProgress
|
allowSaveProgress | boolean |
Gets or sets a value indicating whether [allow save progress]. |
|
randomizeSections
|
randomizeSections | True | boolean |
Gets or sets a value indicating whether [randomize sections]. |
enableAutoScroll
|
enableAutoScroll | boolean |
Gets or sets a value indicating whether [enable automatic scroll]. |
|
enableCodeAccess
|
enableCodeAccess | boolean |
Gets or sets a value indicating whether [enable code access]. |
|
accessType
|
accessType | string |
AccessType |
|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
associatedPanels
|
associatedPanels | array of integer |
Gets or sets the panel identifier. |
|
codeAccessMode
|
codeAccessMode | True | string |
AuthenticationType |
enablePanelSync
|
enablePanelSync | boolean |
Gets or sets a value indicating whether [enable panel synchronize]. |
|
panelSyncBehaviour
|
panelSyncBehaviour | string |
PanelSyncBehaviour |
|
identifier
|
identifier | string |
Gets or sets the identifier. |
|
panelField
|
panelField | string |
Gets or sets the panel field. |
|
defaultLanguage
|
defaultLanguage | True | string |
Gets or sets the default language. |
endDate
|
endDate | date-time |
Gets or sets the end date. |
|
languages
|
languages | True | array of string |
Gets or sets the languages. |
id
|
id | True | integer |
Gets or sets the identifier. |
name
|
name | True | string |
Gets or sets the name. |
randomizePages
|
randomizePages | True | boolean |
Gets or sets a value indicating whether [randomize pages]. |
excludeFromRandomization
|
excludeFromRandomization | True | boolean |
Gets or sets a value indicating whether [exclude from randomization]. |
id
|
id | True | integer |
Gets or sets the identifier. |
elementType
|
elementType | True | string |
ElementType |
code
|
code | string |
Gets or sets the code. |
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Gets or sets a value indicating whether [code manually changed]. |
|
languageCode
|
languageCode | True | string |
Gets or sets the language code. |
text
|
text | string |
Gets or sets the text. |
|
hasHintText
|
hasHintText | boolean |
Gets or sets a value indicating whether this instance has hint text. |
|
hasNotAvailableChoice
|
hasNotAvailableChoice | boolean |
Gets or sets a value indicating whether this instance has not available choice. |
|
forceResponse
|
forceResponse | boolean |
Gets or sets a value indicating whether [force response]. |
|
id
|
id | True | integer |
Gets or sets the identifier. |
code
|
code | True | string |
Gets or sets the code. |
codeManuallyChanged
|
codeManuallyChanged | boolean |
Gets or sets a value indicating whether [code manually changed]. |
|
allowTextEntry
|
allowTextEntry | True | boolean |
Gets or sets a value indicating whether [allow text entry]. |
forceInput
|
forceInput | True | boolean |
Gets or sets a value indicating whether [force input]. |
autocomplete
|
autocomplete | True | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.Choice is autocomplete. |
exclusive
|
exclusive | True | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.Choice is exclusive. |
excludeFromRandomization
|
excludeFromRandomization | boolean |
Gets or sets a value indicating whether [exclude from randomization]. |
|
validationType
|
validationType | True | string |
ContentValidation |
earliestDate
|
earliestDate | string |
Gets or sets the earliest date. |
|
latestDate
|
latestDate | string |
Gets or sets the latest date. |
|
minValue
|
minValue | double |
Gets or sets the minimum value. |
|
maxValue
|
maxValue | double |
Gets or sets the maximum value. |
|
decimalPlaces
|
decimalPlaces | integer |
Gets or sets the decimal places. |
|
disableThousandSeparator
|
disableThousandSeparator | boolean |
Gets or sets the disable thousand separator. |
|
conditionAction
|
conditionAction | True | string |
FilterAction |
autocompleteListVariable
|
autocompleteListVariable | string |
Gets or sets the autocomplete list variable. |
|
randomizeChoices
|
randomizeChoices | boolean |
Gets or sets a value indicating whether [randomize choices]. |
|
columnType
|
columnType | string |
ColumnType |
|
minValue
|
minValue | integer |
Gets or sets the minimum value. |
|
maxValue
|
maxValue | integer |
Gets or sets the maximum value. |
|
showCenterLabel
|
showCenterLabel | boolean |
Gets or sets a value indicating whether [show center label]. |
|
showValue
|
showValue | boolean |
Gets or sets a value indicating whether [show value]. |
|
maxDecimals
|
maxDecimals | integer |
Gets or sets the maximum digits after comma. |
|
textFieldSize
|
textFieldSize | string |
TextFieldSize |
|
autocomplete
|
autocomplete | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.SurveyElement is autocomplete. |
|
hasPlaceholder
|
hasPlaceholder | boolean |
Gets or sets a value indicating whether this instance has placeholder. |
|
isPassword
|
isPassword | boolean |
Gets or sets a value indicating whether this instance is password. |
|
minMaxValidation
|
minMaxValidation | boolean |
Gets or sets a value indicating whether [minimum maximum validation]. |
|
minimumCheckedChoices
|
minimumCheckedChoices | integer |
Gets or sets the minimum checked choices. |
|
maximumCheckedChoices
|
maximumCheckedChoices | integer |
Gets or sets the maximum checked choices. |
|
id
|
id | True | integer |
Gets or sets the identifier. |
hasNotAvailableChoice
|
hasNotAvailableChoice | True | boolean |
Gets or sets a value indicating whether this instance has not available choice. |
randomizeColumns
|
randomizeColumns | True | boolean |
Gets or sets a value indicating whether [randomize columns]. |
choiceType
|
choiceType | True | string |
ChoiceType |
randomizeRows
|
randomizeRows | boolean |
Gets or sets a value indicating whether [randomize rows]. |
|
id
|
id | True | integer |
Gets or sets the identifier. |
code
|
code | True | string |
Gets or sets the code. |
codeManuallyChanged
|
codeManuallyChanged | boolean |
Gets or sets a value indicating whether [code manually changed]. |
|
excludeFromRandomization
|
excludeFromRandomization | True | boolean |
Gets or sets a value indicating whether [exclude from randomization]. |
numberOfRanks
|
numberOfRanks | integer |
Gets or sets the number of ranks. |
|
hasStartText
|
hasStartText | boolean |
Gets or sets a value indicating whether this instance has start text. |
|
enableMeasurement
|
enableMeasurement | boolean |
Gets or sets a value indicating whether [enable measurement]. |
|
showButtons
|
showButtons | boolean |
Gets or sets a value indicating whether [show buttons]. |
|
likeKey
|
likeKey | string |
Gets or sets the like key. |
|
dislikeKey
|
dislikeKey | string |
Gets or sets the dislike key. |
|
interviewState
|
interviewState | string |
Gets or sets the state of the response. |
|
actionType
|
actionType | True | string |
QuotaAction |
from
|
from | string |
Gets or sets the sender. |
|
to
|
to | string |
Gets or sets the receiver. |
|
valueAssignmentType
|
valueAssignmentType | string |
ValueAssignmentType |
|
variableName
|
variableName | string |
Gets or sets the name of the variable. |
|
executionBehavior
|
executionBehavior | string |
ExecutionBehavior |
|
apiCallMethod
|
apiCallMethod | string |
ApiCallMethod |
|
headers
|
headers | string |
Gets or sets the headers. |
|
externalUri
|
externalUri | string |
Gets or sets the external URI. |
|
scriptType
|
scriptType | string |
ScriptType |
|
content
|
content | string |
Gets or sets the content. |
|
hasRatingLabels
|
hasRatingLabels | boolean |
Gets or sets a value indicating whether this instance has rating labels. |
|
evaluateAsJson
|
evaluateAsJson | boolean |
Gets or sets a value indicating whether [evaluate as json]. |
|
autocompleteListVariable
|
autocompleteListVariable | string |
Gets or sets the autocomplete list variable. |
|
arrangementMode
|
arrangementMode | string |
ArrangementMode |
|
enableAnimation
|
enableAnimation | boolean |
Gets or sets a value indicating whether [enable animation]. |
|
useSmiley
|
useSmiley | boolean |
Gets or sets a value indicating whether [use smiley]. |
|
hasPrompt
|
hasPrompt | boolean |
Gets or sets a value indicating whether this instance has prompt. |
|
id
|
id | True | integer |
Gets or sets the identifier. |
variableName
|
variableName | True | string |
Gets or sets the name of the variable. |
defaultTextOverrides
|
defaultTextOverrides | object |
Gets or sets the default text overrides. |
|
surveyDesignLayout
|
surveyDesignLayout | integer |
Gets or sets the survey design layout. |
|
matrixSubQuestionSize
|
matrixSubQuestionSize | string |
MatrixSubQuestionSize |
|
name
|
name | string |
Gets or sets the name. |
|
type
|
type | string |
Gets or sets the type. |
|
languageCode
|
languageCode | True | string |
Gets or sets the language code. |
text
|
text | string |
Gets or sets the text. |
|
anonymizingMode
|
anonymizingMode | True | string |
AnonymizingMode |
logIp
|
logIp | True | boolean |
Gets or sets a value indicating whether [log ip]. |
logUserAgent
|
logUserAgent | True | boolean |
Gets or sets a value indicating whether [log user agent]. |
logReferer
|
logReferer | True | boolean |
Gets or sets a value indicating whether [log referer]. |
Returns
This class represents the return parameters for the CreateSurvey API.
- Body
- CreateSurveyResponse
This action offers the possibility to create the web hook.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
eventType
|
eventType | string |
EventType |
|
entityIdentifier
|
entityIdentifier | string |
Gets or sets the entity identifier. |
|
securityToken
|
securityToken | string |
Gets or sets the security token. |
|
webHookUrl
|
webHookUrl | string |
Gets or sets the web hook URL. |
Returns
This class represents the return parameters for the CreateWebHook API.
This action offers the possibility to delete artifact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
path
|
path | string |
Gets or sets the path. |
|
filename
|
filename | string |
Gets or sets the filename. |
|
workspaceId
|
workspaceId | integer |
Gets or sets the workspace identifier. |
Returns
This class represents the return parameters for the DeleteArtifact API.
This action offers the possibility to delete distributor.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
distributorId
|
distributorId | True | integer |
Gets or sets the distributor identifier. |
keepInterviews
|
keepInterviews | boolean |
Gets or sets a value indicating whether [keep interviews]. |
Returns
This class represents the return parameters for the DeleteDistributor API.
This action offers the possibility to deletes the interview.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
interviewId
|
interviewId | uuid |
Gets or sets the interview identifier. |
|
surveyId
|
surveyId | integer |
Gets or sets the survey identifier. |
Returns
This class represents the return parameters for the DeleteInterview API.
This action offers the possibility to delete members.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
panelId
|
panelId | True | integer |
Gets or sets the panel identifier. |
panelMembersIds
|
panelMembersIds | True | array of integer |
Gets or sets the panel member identifier. |
keepInterviews
|
keepInterviews | boolean |
Gets or sets a value indicating whether [keep interviews]. |
Returns
This class represents the return parameters for the DeleteMember API.
This action offers the possibility to delete the panel.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
panelId
|
panelId | True | integer |
Gets or sets the sample identifier. |
keepInterviews
|
keepInterviews | boolean |
Gets or sets a value indicating whether [keep interviews]. |
Returns
This class represents the return parameters for the DeleteSample API.
- Body
- DeletePanelResponse
This action offers the possibility to delete the sampling project.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
|
keepInterviews
|
keepInterviews | boolean |
Gets or sets a value indicating whether [keep interviews]. |
Returns
This class represents the return parameters for the DeleteSamplingProject API.
This action offers the possibility to delete the survey.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
surveyId
|
surveyId | True | integer |
Gets or sets the survey identifier. |
Returns
This class represents the return parameters for the DeleteSurvey API.
- Body
- DeleteSurveyResponse
This action offers the possibility to deletes the web hook.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
webHookId
|
webHookId | uuid |
Gets or sets the web hook identifier. |
Returns
This class represents the return parameters for the DeleteWebHook API.
This action offers the possibility to downloads the answers.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Tenant
|
tenant | True | string |
The tenant. |
SurveyId
|
surveyId | True | integer |
The survey identifier. |
InterviewId
|
interviewId | True | uuid |
The interview identifier. |
Show Partial Completed
|
showPartialCompleted | boolean |
if set to true [show partial completed]. |
|
Locale
|
locale | string |
The locale. |
|
Thmezone
|
timeZone | string |
The time zone. |
|
isCancellationRequested
|
isCancellationRequested | boolean | ||
canBeCanceled
|
canBeCanceled | boolean | ||
isInvalid
|
isInvalid | boolean | ||
isClosed
|
isClosed | boolean |
Returns
This class represents the return parameters for the DownloadAnswers API.
This action offers the possibility to execute workflow transition specific for the workflow.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
workflow
|
workflow | True | string |
Workflow type |
surveyId
|
surveyId | integer |
Gets or sets the survey identifier. |
|
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
|
distributorId
|
distributorId | integer |
Gets or sets the distributor identifier. |
|
reminderId
|
reminderId | integer |
Gets or sets the reminder identifier. |
|
targetState
|
targetState | True | string |
Gets or sets the state of the target. |
dynamicParameters
|
dynamicParameters | object |
Gets or sets the dynamic parameters. |
Returns
This class represents the return parameters for the ExecuteWorkflowTransition API.
This action offers the possibility to invite the member.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
surveyId
|
surveyId | True | integer |
The Id of the survey |
panelId
|
panelId | True | integer |
Gets or sets the panel identifier. |
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
|
memberIds
|
memberIds | array of integer |
Gets or sets the panel members ids. |
|
messageTemplateId
|
messageTemplateId | True | integer |
Gets or sets the message template identifier. |
name
|
name | string |
Gets or sets the name. |
|
type
|
type | string |
Gets or sets the type. |
|
languageCode
|
languageCode | True | string |
Gets or sets the language code. |
text
|
text | string |
Gets or sets the text. |
|
scheduleDateTime
|
scheduleDateTime | date-time |
Gets or sets the schedule time. |
|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
channel
|
channel | string |
Distribution Channel |
|
asyncProcess
|
asyncProcess | boolean |
Gets or sets the async process. |
|
interviewExpiryDate
|
interviewExpiryDate | string |
Gets or sets the interview expiry date. |
|
from
|
from | string |
Gets or sets from. |
|
fromName
|
fromName | string |
Gets or sets from name. |
|
replyTo
|
replyTo | string |
Gets or sets the reply to. |
|
replyToName
|
replyToName | string |
Gets or sets the name of the reply to. |
Returns
This class represents the return parameters for the InviteMembers API.
This action offers the possibility to create and invite members.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
|
surveyId
|
surveyId | True | integer |
Gets or sets the survey identifier. |
panelId
|
panelId | True | integer |
Gets or sets the panel identifier. |
channel
|
channel | True | string |
Distribution Channel |
messageTemplateId
|
messageTemplateId | True | integer |
Gets or sets the message template identifier. |
name
|
name | string |
Gets or sets the name. |
|
type
|
type | string |
Gets or sets the type. |
|
languageCode
|
languageCode | True | string |
Gets or sets the language code. |
text
|
text | string |
Gets or sets the text. |
|
id
|
id | integer |
Gets or sets the identifier. |
|
fields
|
fields | True | object |
Gets or sets the fields. |
createdAt
|
createdAt | date-time |
Gets or sets the created at. |
|
createdBy
|
createdBy | string |
Gets or sets the created by. |
|
updatedAt
|
updatedAt | date-time |
Gets or sets the updated at. |
|
updatedBy
|
updatedBy | string |
Gets or sets the updated by. |
|
id
|
id | string |
The id of the interview |
|
state
|
state | string |
Gets or sets the state. |
|
surveyId
|
surveyId | integer |
The id of the survey |
|
surveyVersionId
|
surveyVersionId | integer |
The id of the survey version |
|
surveyName
|
surveyName | string |
The name of the survey |
|
surveyState
|
surveyState | string |
Gets or sets the state of the survey. |
|
answersLink
|
answersLink | string |
The link to the answers print page |
|
interviewLink
|
interviewLink | string |
Gets or sets the interview link. |
|
startDate
|
startDate | string |
Gets or sets the start date. |
|
endDate
|
endDate | string |
Gets or sets the end date. |
|
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
|
distributorId
|
distributorId | integer |
Gets or sets the distributor identifier. |
|
scheduleDateTime
|
scheduleDateTime | string |
Gets or sets the schedule date time. |
|
asyncProcess
|
asyncProcess | boolean |
Gets or sets the async process. |
|
interviewExpiryDate
|
interviewExpiryDate | string |
Gets or sets the interview expiry date. |
|
from
|
from | string |
Gets or sets from. |
|
fromName
|
fromName | string |
Gets or sets from name. |
|
replyTo
|
replyTo | string |
Gets or sets the reply to. |
|
replyToName
|
replyToName | string |
Gets or sets the name of the reply to. |
Returns
This class represents the return parameters for the CreateAndInviteMembers API.
This action offers the possibility to read the artifact list.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
path
|
path | string |
Gets or sets the path. |
|
workspaceId
|
workspaceId | integer |
Gets or sets the workspace identifier. |
Returns
This class represents the request parameters for the ReadArtifactList API.
This action offers the possibility to read the bounce list.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
surveyId
|
surveyId | True | integer |
Gets or sets the survey identifier. |
panelId
|
panelId | integer |
Gets or sets the panel identifier. |
|
distributors
|
distributors | array of integer |
Gets or sets the distributors. |
|
invitationType
|
invitationType | string |
InvitationType |
|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the return parameters for the ReadBounceList API.
This action returns the survey credit balance for the authenticated user.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
|
object |
This class represents the request parameters for the ReadCreditBalance API. |
Returns
This class represents the return parameters for the ReadCreditBalance API.
This action offers the possibility to read the distributor list.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
surveyId
|
surveyId | integer |
Gets or sets the survey identifier. |
|
panelId
|
panelId | integer |
Gets or sets the panel identifier. |
|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the return parameters for the ReadDistributorList API.
The action returns an overview over all earnings and spending related to survey credits.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the return parameters for the ReadIncentiveTransactionList API.
This action returns the available incentives/voucher for the authenticated user.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the request parameters for the ReadIncentiveList API.
This action offers the possibility to read the interview data.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
tenant
|
tenant | True | string |
Gets or sets the tenant. |
interviewId
|
interviewId | True | uuid |
Gets or sets the interview identifier. |
surveyId
|
surveyId | True | integer |
Gets or sets the survey identifier. |
loadSurveyDefinition
|
loadSurveyDefinition | boolean |
Gets or sets a value indicating whether [load survey definition]. |
Returns
This class represents the return parameters for the ReadInterviewData API.
This action offers the possibility to read the interview list.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
tenant
|
tenant | string |
Gets or sets the tenant. |
|
surveyId
|
surveyId | integer |
Gets or sets the survey identifier. |
|
fieldsToDownload
|
fieldsToDownload | array of string |
Gets or sets the requested columns. |
|
loadCodePlan
|
loadCodePlan | boolean |
Gets or sets a value indicating whether [load code plan]. |
|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the return parameters for the ReadInterviewList API.
This action offers the possibility to read the interview list compact.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
tenant
|
tenant | string |
Gets or sets the tenant. |
|
surveyId
|
surveyId | integer |
Gets or sets the survey identifier. |
|
fieldsToDownload
|
fieldsToDownload | array of string |
Gets or sets the requested columns. |
|
loadCodePlan
|
loadCodePlan | boolean |
Gets or sets a value indicating whether [load code plan]. |
|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the return parameters for the ReadInterviewListCompact API.
This action offers the possibility to read members.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
tenant
|
tenant | string |
Gets or sets the tenant. |
|
panelId
|
panelId | True | integer |
Gets or sets the panel identifier. |
interviewsRequired
|
interviewsRequired | True | boolean |
Gets or sets a value indicating whether the session information is required. |
fieldsToDownload
|
fieldsToDownload | array of string |
Gets or sets the fields to download. |
|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the return parameters for the ReadMemberList API.
This action offers the possibility to receive all configured message templates for Email and SMS.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
workspaceId
|
workspaceId | integer |
Gets or sets the workspace identifier. |
|
language
|
language | True | string |
Gets or sets the language. |
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the return parameters for the ReadMessageTemplateList API.
This action offers the possibility to read all Opt-Outs for a workspace.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
panelId
|
panelId | integer |
Gets or sets the panel identifier. |
|
workspaceId
|
workspaceId | integer |
Gets or sets the workspace identifier. |
|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the return parameters for the ReadOptOutList API.
This action offers the possibility to read panel definition.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
tenant
|
tenant | string |
Gets or sets the tenant. |
|
panelId
|
panelId | True | integer |
Gets or sets the panel identifier. |
Returns
This class represents the return parameters for the ReadPanelDefinition API.
This action offers the possibility to read the sampling project.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
Returns
This class represents the return parameters for the ReadSamplingProject API.
This action offers the possibility to read the survey.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
tenant
|
tenant | string |
Gets or sets the tenant. |
|
surveyId
|
surveyId | True | integer |
Gets or sets the survey identifier. |
Returns
This class represents the return parameters for the ReadSurveyDefinition API.
- Body
- ReadSurveyResponse
This action offers the possibility to reads the survey links.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
surveyId
|
surveyId | integer |
Gets or sets the survey identifier. |
Returns
This class represents the response of the ReadSurveyLinks API.
This action offers the possibility to read all available surveys of a given workspace.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
workspaceId
|
workspaceId | True | integer |
Gets or sets the workspace identifier. |
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the response parameters for the ReadSurveyList API.
This action offers the possibility to reads the web hook list.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
eventType
|
eventType | string |
EventType |
|
entityIdentifier
|
entityIdentifier | string |
Gets or sets the entity identifier. |
Returns
This class represents the return parameters for the ReadWebHookList API.
This action offers the possibility to read all workflow transitions specific for the workflow.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
workflow
|
workflow | True | string |
Workflow type |
currentState
|
currentState | True | string |
Gets or sets the state of the current. |
Returns
This class represents the return parameters for the ReadWorkflowTransitions API.
This action offers the possibility to read all available workspaces.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
pageSize
|
pageSize | True | integer |
Gets or sets the size of the page. |
page
|
page | True | integer |
Gets or sets the page. |
orderField
|
orderField | string |
Gets or sets the order field. |
|
orderDirection
|
orderDirection | string |
OrderDirection |
Returns
This class represents the request parameters for the ReadWorkspaceList API.
This action offers the possibility to spend survey credits for incentives/vouchers.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
incentiveId
|
incentiveId | True | integer |
Gets or sets the incentive identifier. |
Returns
This class represents the return parameters for the RedeemIncentiveCode API.
This action offers the possibility to remind the member.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
distributorId
|
distributorId | True | integer |
The Id of the survey |
messageTemplateId
|
messageTemplateId | True | integer |
Gets or sets the message template identifier. |
name
|
name | string |
Gets or sets the name. |
|
type
|
type | string |
Gets or sets the type. |
|
languageCode
|
languageCode | True | string |
Gets or sets the language code. |
text
|
text | string |
Gets or sets the text. |
|
scheduleDateTime
|
scheduleDateTime | date-time |
Gets or sets the schedule time. |
|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
channel
|
channel | string |
Distribution Channel |
|
from
|
from | string |
Gets or sets from. |
|
fromName
|
fromName | string |
Gets or sets from name. |
|
replyTo
|
replyTo | string |
Gets or sets the reply to. |
|
replyToName
|
replyToName | string |
Gets or sets the name of the reply to. |
Returns
This class represents the return parameters for the RemindMembers API.
This action offers the possibility to reset panel member response.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
surveyId
|
surveyId | integer |
Gets or sets the survey identifier. |
|
interviewId
|
interviewId | uuid |
Gets or sets the interview identifier. |
Returns
This class represents the return parameters for the ResetInterview API.
This action offers the possibility to send mail.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
messageTemplateId
|
messageTemplateId | integer |
Gets or sets the message template identifier. |
|
name
|
name | string |
Gets or sets the name. |
|
type
|
type | string |
Gets or sets the type. |
|
languageCode
|
languageCode | True | string |
Gets or sets the language code. |
text
|
text | string |
Gets or sets the text. |
|
language
|
language | True | string |
Gets or sets the language. |
subject
|
subject | string |
Gets or sets the subject. |
|
body
|
body | string |
Gets or sets the body. |
|
from
|
from | True | string |
Gets or sets from. |
fromName
|
fromName | string |
Gets or sets from name. |
|
to
|
to | True | string |
Gets or sets to. |
toName
|
toName | string |
Converts to name. |
|
replyTo
|
replyTo | string |
Gets or sets the reply to. |
|
replyToName
|
replyToName | string |
Gets or sets the name of the reply to. |
Returns
This class represents the return parameters for the ExecuteSendMail API.
This action offers the possibility to update the member list.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
tenant
|
tenant | string |
Gets or sets the tenant. |
|
panelId
|
panelId | True | integer |
Gets or sets the panel identifier. |
id
|
id | integer |
Gets or sets the identifier. |
|
fields
|
fields | True | object |
Gets or sets the fields. |
createdAt
|
createdAt | date-time |
Gets or sets the created at. |
|
createdBy
|
createdBy | string |
Gets or sets the created by. |
|
updatedAt
|
updatedAt | date-time |
Gets or sets the updated at. |
|
updatedBy
|
updatedBy | string |
Gets or sets the updated by. |
|
id
|
id | string |
The id of the interview |
|
state
|
state | string |
Gets or sets the state. |
|
surveyId
|
surveyId | integer |
The id of the survey |
|
surveyVersionId
|
surveyVersionId | integer |
The id of the survey version |
|
surveyName
|
surveyName | string |
The name of the survey |
|
surveyState
|
surveyState | string |
Gets or sets the state of the survey. |
|
answersLink
|
answersLink | string |
The link to the answers print page |
|
interviewLink
|
interviewLink | string |
Gets or sets the interview link. |
|
startDate
|
startDate | string |
Gets or sets the start date. |
|
endDate
|
endDate | string |
Gets or sets the end date. |
|
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
|
distributorId
|
distributorId | integer |
Gets or sets the distributor identifier. |
Returns
This class represents the return parameters for the UpdateMembers API.
This action offers the possibility to write entries to the Opt-Out list for a workspace.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
workspaceId
|
workspaceId | integer |
Gets or sets the workspace identifier. |
|
panelId
|
panelId | integer |
Gets or sets the panel identifier. |
|
distributorId
|
distributorId | integer |
Gets or sets the distributor identifier. |
|
email
|
True | string |
Gets or sets the email. |
|
optOutOperation
|
optOutOperation | True | string |
OptOutOperation |
cellPhone
|
cellPhone | True | integer |
Gets or sets the cell phone. |
optOutOperation
|
optOutOperation | True | string |
OptOutOperation |
Returns
This class represents the return parameters for the WriteOptOutList API.
This action offers the possibility to update the panel.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
tenant
|
tenant | string |
Gets or sets the tenant. |
|
panelId
|
panelId | True | integer |
Gets or sets the panel identifier. |
id
|
id | integer |
The id of the field. This is a mandatory field in case of renaming. |
|
name
|
name | string |
The name of the field. This is a mandatory field. |
|
type
|
type | string |
PanelMemberFieldType |
|
value
|
value |
The value of the field. The value type must match the Type property. |
||
removedFields
|
removedFields | array of integer |
Gets or sets the removed fields. |
|
id
|
id | integer |
The id of the field. This is a mandatory field in case of renaming. |
|
name
|
name | string |
The name of the field. This is a mandatory field. |
|
type
|
type | string |
PanelMemberFieldType |
|
value
|
value |
The value of the field. The value type must match the Type property. |
Returns
This class represents the return parameters for the WritePanel API.
- Body
- WritePanelResponse
This action offers the possibility to update the survey.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
surveyId
|
surveyId | True | integer |
Gets or sets the survey identifier. |
surveyName
|
surveyName | string |
Gets or sets the name of the survey. |
|
allowMultipleParticipation
|
allowMultipleParticipation | True | boolean |
Gets or sets a value indicating whether [allow multiple participation]. |
allowNavigateBack
|
allowNavigateBack | True | boolean |
Gets or sets a value indicating whether [allow navigate back]. |
allowSaveProgress
|
allowSaveProgress | boolean |
Gets or sets a value indicating whether [allow save progress]. |
|
randomizeSections
|
randomizeSections | True | boolean |
Gets or sets a value indicating whether [randomize sections]. |
enableAutoScroll
|
enableAutoScroll | boolean |
Gets or sets a value indicating whether [enable automatic scroll]. |
|
enableCodeAccess
|
enableCodeAccess | boolean |
Gets or sets a value indicating whether [enable code access]. |
|
accessType
|
accessType | string |
AccessType |
|
conjunction
|
conjunction | True | string |
Conjunction |
conditionType
|
conditionType | True | string |
ConditionType |
identifier
|
identifier | True | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | True | string |
ConditionOperator |
value
|
value | True | string |
Gets or sets the value. |
variableType
|
variableType | string |
VariableType |
|
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
|
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
|
associatedPanels
|
associatedPanels | array of integer |
Gets or sets the panel identifier. |
|
codeAccessMode
|
codeAccessMode | True | string |
AuthenticationType |
enablePanelSync
|
enablePanelSync | boolean |
Gets or sets a value indicating whether [enable panel synchronize]. |
|
panelSyncBehaviour
|
panelSyncBehaviour | string |
PanelSyncBehaviour |
|
identifier
|
identifier | string |
Gets or sets the identifier. |
|
panelField
|
panelField | string |
Gets or sets the panel field. |
|
defaultLanguage
|
defaultLanguage | True | string |
Gets or sets the default language. |
endDate
|
endDate | date-time |
Gets or sets the end date. |
|
languages
|
languages | True | array of string |
Gets or sets the languages. |
id
|
id | True | integer |
Gets or sets the identifier. |
name
|
name | True | string |
Gets or sets the name. |
randomizePages
|
randomizePages | True | boolean |
Gets or sets a value indicating whether [randomize pages]. |
excludeFromRandomization
|
excludeFromRandomization | True | boolean |
Gets or sets a value indicating whether [exclude from randomization]. |
id
|
id | True | integer |
Gets or sets the identifier. |
elementType
|
elementType | True | string |
ElementType |
code
|
code | string |
Gets or sets the code. |
|
codeManuallyChanged
|
codeManuallyChanged | boolean |
Gets or sets a value indicating whether [code manually changed]. |
|
languageCode
|
languageCode | True | string |
Gets or sets the language code. |
text
|
text | string |
Gets or sets the text. |
|
hasHintText
|
hasHintText | boolean |
Gets or sets a value indicating whether this instance has hint text. |
|
hasNotAvailableChoice
|
hasNotAvailableChoice | boolean |
Gets or sets a value indicating whether this instance has not available choice. |
|
forceResponse
|
forceResponse | boolean |
Gets or sets a value indicating whether [force response]. |
|
id
|
id | True | integer |
Gets or sets the identifier. |
code
|
code | True | string |
Gets or sets the code. |
codeManuallyChanged
|
codeManuallyChanged | boolean |
Gets or sets a value indicating whether [code manually changed]. |
|
allowTextEntry
|
allowTextEntry | True | boolean |
Gets or sets a value indicating whether [allow text entry]. |
forceInput
|
forceInput | True | boolean |
Gets or sets a value indicating whether [force input]. |
autocomplete
|
autocomplete | True | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.Choice is autocomplete. |
exclusive
|
exclusive | True | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.Choice is exclusive. |
excludeFromRandomization
|
excludeFromRandomization | boolean |
Gets or sets a value indicating whether [exclude from randomization]. |
|
validationType
|
validationType | True | string |
ContentValidation |
earliestDate
|
earliestDate | string |
Gets or sets the earliest date. |
|
latestDate
|
latestDate | string |
Gets or sets the latest date. |
|
minValue
|
minValue | double |
Gets or sets the minimum value. |
|
maxValue
|
maxValue | double |
Gets or sets the maximum value. |
|
decimalPlaces
|
decimalPlaces | integer |
Gets or sets the decimal places. |
|
disableThousandSeparator
|
disableThousandSeparator | boolean |
Gets or sets the disable thousand separator. |
|
conditionAction
|
conditionAction | True | string |
FilterAction |
autocompleteListVariable
|
autocompleteListVariable | string |
Gets or sets the autocomplete list variable. |
|
randomizeChoices
|
randomizeChoices | boolean |
Gets or sets a value indicating whether [randomize choices]. |
|
columnType
|
columnType | string |
ColumnType |
|
minValue
|
minValue | integer |
Gets or sets the minimum value. |
|
maxValue
|
maxValue | integer |
Gets or sets the maximum value. |
|
showCenterLabel
|
showCenterLabel | boolean |
Gets or sets a value indicating whether [show center label]. |
|
showValue
|
showValue | boolean |
Gets or sets a value indicating whether [show value]. |
|
maxDecimals
|
maxDecimals | integer |
Gets or sets the maximum digits after comma. |
|
textFieldSize
|
textFieldSize | string |
TextFieldSize |
|
autocomplete
|
autocomplete | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.SurveyElement is autocomplete. |
|
hasPlaceholder
|
hasPlaceholder | boolean |
Gets or sets a value indicating whether this instance has placeholder. |
|
isPassword
|
isPassword | boolean |
Gets or sets a value indicating whether this instance is password. |
|
minMaxValidation
|
minMaxValidation | boolean |
Gets or sets a value indicating whether [minimum maximum validation]. |
|
minimumCheckedChoices
|
minimumCheckedChoices | integer |
Gets or sets the minimum checked choices. |
|
maximumCheckedChoices
|
maximumCheckedChoices | integer |
Gets or sets the maximum checked choices. |
|
id
|
id | True | integer |
Gets or sets the identifier. |
hasNotAvailableChoice
|
hasNotAvailableChoice | True | boolean |
Gets or sets a value indicating whether this instance has not available choice. |
randomizeColumns
|
randomizeColumns | True | boolean |
Gets or sets a value indicating whether [randomize columns]. |
choiceType
|
choiceType | True | string |
ChoiceType |
randomizeRows
|
randomizeRows | boolean |
Gets or sets a value indicating whether [randomize rows]. |
|
id
|
id | True | integer |
Gets or sets the identifier. |
code
|
code | True | string |
Gets or sets the code. |
codeManuallyChanged
|
codeManuallyChanged | boolean |
Gets or sets a value indicating whether [code manually changed]. |
|
excludeFromRandomization
|
excludeFromRandomization | True | boolean |
Gets or sets a value indicating whether [exclude from randomization]. |
numberOfRanks
|
numberOfRanks | integer |
Gets or sets the number of ranks. |
|
hasStartText
|
hasStartText | boolean |
Gets or sets a value indicating whether this instance has start text. |
|
enableMeasurement
|
enableMeasurement | boolean |
Gets or sets a value indicating whether [enable measurement]. |
|
showButtons
|
showButtons | boolean |
Gets or sets a value indicating whether [show buttons]. |
|
likeKey
|
likeKey | string |
Gets or sets the like key. |
|
dislikeKey
|
dislikeKey | string |
Gets or sets the dislike key. |
|
interviewState
|
interviewState | string |
Gets or sets the state of the response. |
|
actionType
|
actionType | True | string |
QuotaAction |
from
|
from | string |
Gets or sets the sender. |
|
to
|
to | string |
Gets or sets the receiver. |
|
valueAssignmentType
|
valueAssignmentType | string |
ValueAssignmentType |
|
variableName
|
variableName | string |
Gets or sets the name of the variable. |
|
executionBehavior
|
executionBehavior | string |
ExecutionBehavior |
|
apiCallMethod
|
apiCallMethod | string |
ApiCallMethod |
|
headers
|
headers | string |
Gets or sets the headers. |
|
externalUri
|
externalUri | string |
Gets or sets the external URI. |
|
scriptType
|
scriptType | string |
ScriptType |
|
content
|
content | string |
Gets or sets the content. |
|
hasRatingLabels
|
hasRatingLabels | boolean |
Gets or sets a value indicating whether this instance has rating labels. |
|
evaluateAsJson
|
evaluateAsJson | boolean |
Gets or sets a value indicating whether [evaluate as json]. |
|
autocompleteListVariable
|
autocompleteListVariable | string |
Gets or sets the autocomplete list variable. |
|
arrangementMode
|
arrangementMode | string |
ArrangementMode |
|
enableAnimation
|
enableAnimation | boolean |
Gets or sets a value indicating whether [enable animation]. |
|
useSmiley
|
useSmiley | boolean |
Gets or sets a value indicating whether [use smiley]. |
|
hasPrompt
|
hasPrompt | boolean |
Gets or sets a value indicating whether this instance has prompt. |
|
id
|
id | True | integer |
Gets or sets the identifier. |
variableName
|
variableName | True | string |
Gets or sets the name of the variable. |
defaultTextOverrides
|
defaultTextOverrides | object |
Gets or sets the default text overrides. |
|
surveyDesignLayout
|
surveyDesignLayout | integer |
Gets or sets the survey design layout. |
|
matrixSubQuestionSize
|
matrixSubQuestionSize | string |
MatrixSubQuestionSize |
|
name
|
name | string |
Gets or sets the name. |
|
type
|
type | string |
Gets or sets the type. |
|
languageCode
|
languageCode | True | string |
Gets or sets the language code. |
text
|
text | string |
Gets or sets the text. |
|
anonymizingMode
|
anonymizingMode | True | string |
AnonymizingMode |
logIp
|
logIp | True | boolean |
Gets or sets a value indicating whether [log ip]. |
logUserAgent
|
logUserAgent | True | boolean |
Gets or sets a value indicating whether [log user agent]. |
logReferer
|
logReferer | True | boolean |
Gets or sets a value indicating whether [log referer]. |
Returns
This class represents the return parameters for the UpdateSurvey API.
- Body
- UpdateSurveyResponse
This action offers the possibility to update the web hook.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
webHookId
|
webHookId | uuid |
Gets or sets the web hook identifier. |
|
eventType
|
eventType | string |
EventType |
|
entityIdentifier
|
entityIdentifier | string |
Gets or sets the entity identifier. |
|
securityToken
|
securityToken | string |
Gets or sets the security token. |
|
webHookUrl
|
webHookUrl | string |
Gets or sets the web hook URL. |
Returns
This class represents the return parameters for the CreateWebHook API.
This class represents an end of survey action for complete/screenout/quota full.
Name | Path | Type | Description |
---|---|---|---|
actionType
|
actionType | ActionType |
QuotaAction |
endOfSurveyText
|
endOfSurveyText | array of TranslationElement |
Gets or sets the end of survey text. |
forwardUrl
|
forwardUrl | array of TranslationElement |
Gets or sets the forward URL. |
This class contains the anonymizing settings which could be applied to a workspace group, a workspace or an individual survey.
Name | Path | Type | Description |
---|---|---|---|
anonymizingMode
|
anonymizingMode | AnonymizingMode |
AnonymizingMode |
logIp
|
logIp | boolean |
Gets or sets a value indicating whether [log ip]. |
logUserAgent
|
logUserAgent | boolean |
Gets or sets a value indicating whether [log user agent]. |
logReferer
|
logReferer | boolean |
Gets or sets a value indicating whether [log referer]. |
This class represents an end of survey action for complete/screenout/quota full.
Name | Path | Type | Description |
---|---|---|---|
distributorId
|
distributorId | integer |
Gets or sets the distributor identifier. |
interviewId
|
interviewId | uuid |
Gets or sets the interview identifier. |
panelId
|
panelId | integer |
Gets or sets the panel identifier. |
panelMemberId
|
panelMemberId | integer |
Gets or sets the panel member identifier. |
bounceType
|
bounceType | BounceType |
BounceType |
timestamp
|
timestamp | date-time |
Gets or sets the timestamp. |
state
|
state | string |
Gets or sets the state. |
reason
|
reason | string |
Gets or sets the reason. |
email
|
string |
Gets or sets the email. |
|
phone
|
phone | integer |
Gets or sets the phone. |
invitationType
|
invitationType | InvitationType |
InvitationType |
This class represents a single choice which could be used in every choice question type.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
code
|
code | string |
Gets or sets the code. |
codeManuallyChanged
|
codeManuallyChanged | boolean |
Gets or sets a value indicating whether [code manually changed]. |
text
|
text | array of TranslationElement |
Gets or sets the text translations. |
allowTextEntry
|
allowTextEntry | boolean |
Gets or sets a value indicating whether [allow text entry]. |
forceInput
|
forceInput | boolean |
Gets or sets a value indicating whether [force input]. |
autocomplete
|
autocomplete | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.Choice is autocomplete. |
autocompleteText
|
autocompleteText | array of TranslationElement |
Gets or sets the autocomplete text translations. |
exclusive
|
exclusive | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.Choice is exclusive. |
excludeFromRandomization
|
excludeFromRandomization | boolean |
Gets or sets a value indicating whether [exclude from randomization]. |
contentValidation
|
contentValidation | ContentValidation |
This class represents a content validation inside a survey. |
condition
|
condition | ConditionDefinition |
This class represents the definition of conditions elements. |
autocompleteListVariable
|
autocompleteListVariable | string |
Gets or sets the autocomplete list variable. |
This class represents a cell of a survey response.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string |
Gets or sets the identifier. |
value
|
value |
Gets or sets the value. |
This class represents a column group inside complex question types like matrix questions.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
text
|
text | array of TranslationElement |
Gets or sets the text translations. |
hasNotAvailableChoice
|
hasNotAvailableChoice | boolean |
Gets or sets a value indicating whether this instance has not available choice. |
notAvailableChoiceText
|
notAvailableChoiceText | array of TranslationElement |
Gets or sets the not available choice text translations. |
randomizeColumns
|
randomizeColumns | boolean |
Gets or sets a value indicating whether [randomize columns]. |
prompt
|
prompt | array of TranslationElement |
Gets or sets the prompt. |
choiceType
|
choiceType | ChoiceType |
ChoiceType |
choices
|
choices | array of Choice |
Gets or sets the choices. |
condition
|
condition | ConditionDefinition |
This class represents the definition of conditions elements. |
This class is the base for all condition elements.
Name | Path | Type | Description |
---|---|---|---|
conjunction
|
conjunction | Conjunction |
Conjunction |
conditionType
|
conditionType | ConditionType |
ConditionType |
identifier
|
identifier | string |
Gets or sets the identifier. |
conditionOperator
|
conditionOperator | ConditionOperator |
ConditionOperator |
value
|
value | string |
Gets or sets the value. |
variableType
|
variableType | VariableType |
VariableType |
jsonValue
|
jsonValue | boolean |
Gets or sets a value indicating whether [json value]. |
jsonPath
|
jsonPath | string |
Gets or sets the json path. |
This class represents the definition of conditions elements.
Name | Path | Type | Description |
---|---|---|---|
conditionAction
|
conditionAction | ConditionAction |
FilterAction |
elements
|
elements | array of Condition |
Gets or sets the elements. |
This class represents a content validation inside a survey.
Name | Path | Type | Description |
---|---|---|---|
validationType
|
validationType | ContentValidationType |
ContentValidation |
earliestDate
|
earliestDate | string |
Gets or sets the earliest date. |
latestDate
|
latestDate | string |
Gets or sets the latest date. |
minValue
|
minValue | double |
Gets or sets the minimum value. |
maxValue
|
maxValue | double |
Gets or sets the maximum value. |
decimalPlaces
|
decimalPlaces | integer |
Gets or sets the decimal places. |
disableThousandSeparator
|
disableThousandSeparator | boolean |
Gets or sets the disable thousand separator. |
This class represents the return parameters for the CreateAndInviteMembers API.
Name | Path | Type | Description |
---|---|---|---|
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
distributorId
|
distributorId | integer |
Gets or sets the distributor identifier. |
validationIssues
|
validationIssues | array of WritePanelMemberIssue |
Gets or sets the issues. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the response of the CreateArtifact API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the CreateMembers API.
Name | Path | Type | Description |
---|---|---|---|
membersIds
|
membersIds | array of integer |
Gets or sets the members ids. |
validationIssues
|
validationIssues | array of WritePanelMemberIssue |
Gets or sets the issues. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the CreatePanel API.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Get the Id of created panel. |
name
|
name | string |
Get the name of created panel. |
isExtendedPanel
|
isExtendedPanel | boolean |
Get the type of created panel. |
createdDate
|
createdDate | string |
Get the date of creation of created panel. |
isLock
|
isLock | boolean |
Get the value which indicates if panel is lock. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the CreateSurvey API.
Name | Path | Type | Description |
---|---|---|---|
surveyId
|
surveyId | integer |
Gets or sets the survey identifier. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the CreateWebHook API.
Name | Path | Type | Description |
---|---|---|---|
webHookId
|
webHookId | uuid |
Gets or sets the web hook identifier. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents a single custom variable.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
variableName
|
variableName | string |
Gets or sets the name of the variable. |
variableType
|
variableType | VariableType |
VariableType |
This class contains the configuration of how the entity is being accessible
Name | Path | Type | Description |
---|---|---|---|
accessType
|
accessType | AccessType |
AccessType |
conditions
|
conditions | array of Condition |
Gets or sets the conditions. |
This class represents the return parameters for the DeleteArtifact API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the DeleteDistributor API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the DeleteInterview API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the DeleteMember API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the DeleteSample API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the DeleteSamplingProject API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the DeleteSurvey API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the DeleteWebHook API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the styling possibilities for an account.
Name | Path | Type | Description |
---|---|---|---|
surveyDesignLayout
|
surveyDesignLayout | integer |
Gets or sets the survey design layout. |
matrixSubQuestionSize
|
matrixSubQuestionSize | MatrixSubQuestionSize |
MatrixSubQuestionSize |
textBlocks
|
textBlocks | array of TextBlock |
Gets or sets the content of the template. |
This class represents a distributor element.
Name | Path | Type | Description |
---|---|---|---|
distributorId
|
distributorId | integer |
Gets or sets the distributor identifier. |
distributionChannel
|
distributionChannel | DistributionChannel |
Distribution Channel |
surveyId
|
surveyId | integer |
Gets or sets the survey identifier. |
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
surveyVersion
|
surveyVersion | integer |
Gets or sets the survey version. |
panelId
|
panelId | integer |
Gets or sets the panel identifier. |
scheduledDistribution
|
scheduledDistribution | date-time |
Gets or sets the scheduled distribution. |
executedDistribution
|
executedDistribution | date-time |
Gets or sets the executed distribution. |
distributionState
|
distributionState | string |
Gets or sets the state of the distribution. |
conditions
|
conditions | array of ConditionDefinition |
Gets or sets the conditions. |
This class represents the return parameters for the DownloadAnswers API.
Name | Path | Type | Description |
---|---|---|---|
downloadUrl
|
downloadUrl | string |
Gets or sets the download URL. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ExecuteSendMail API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ExecuteWorkflowTransition API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represent interview record data
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string |
The id of the interview |
state
|
state | string |
Gets or sets the state. |
surveyId
|
surveyId | integer |
The id of the survey |
surveyVersionId
|
surveyVersionId | integer |
The id of the survey version |
surveyName
|
surveyName | string |
The name of the survey |
surveyState
|
surveyState | string |
Gets or sets the state of the survey. |
answersLink
|
answersLink | string |
The link to the answers print page |
interviewLink
|
interviewLink | string |
Gets or sets the interview link. |
startDate
|
startDate | string |
Gets or sets the start date. |
endDate
|
endDate | string |
Gets or sets the end date. |
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
distributorId
|
distributorId | integer |
Gets or sets the distributor identifier. |
This class represents the return parameters for the InviteMembers API.
Name | Path | Type | Description |
---|---|---|---|
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
distributorId
|
distributorId | integer |
Gets or sets the distributor identifier. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represent a single panel member with a dynamic structure based on the Panel.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
fields
|
fields | object |
Gets or sets the fields. |
createdAt
|
createdAt | date-time |
Gets or sets the created at. |
createdBy
|
createdBy | string |
Gets or sets the created by. |
updatedAt
|
updatedAt | date-time |
Gets or sets the updated at. |
updatedBy
|
updatedBy | string |
Gets or sets the updated by. |
interviews
|
interviews | array of Interview |
Gets or sets the interviews. |
This class represents one message template item.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
The id of the email message |
name
|
name | string |
The name of the email message |
content
|
content | string |
The content of the email message |
subject
|
subject | string |
The subject of the email message |
defaultLocale
|
defaultLocale | string |
The default locale of the email message |
locales
|
locales | array of string |
The list of locales for this email message |
This class represents a min max choice element inside a survey.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
code
|
code | string |
Gets or sets the code. |
codeManuallyChanged
|
codeManuallyChanged | boolean |
Gets or sets a value indicating whether [code manually changed]. |
leftText
|
leftText | array of TranslationElement |
Gets or sets the left text translations. |
rightText
|
rightText | array of TranslationElement |
Gets or sets the right text translations. |
excludeFromRandomization
|
excludeFromRandomization | boolean |
Gets or sets a value indicating whether [exclude from randomization]. |
condition
|
condition | ConditionDefinition |
This class represents the definition of conditions elements. |
This class represents one Opt-Out item.
Name | Path | Type | Description |
---|---|---|---|
email
|
string |
Gets or sets the email. |
|
phone
|
phone | integer |
Gets or sets the phone. |
optOutAt
|
optOutAt | string |
Gets or sets the opt out at. |
optOutBy
|
optOutBy | string |
Gets or sets the opt out by. |
This class contains the complete definition of all fields which are contained in a customer defined panel.
Name | Path | Type | Description |
---|---|---|---|
groups
|
groups | array of VariableGroupElement |
Gets or sets the groups. |
dataAccessControl
|
dataAccessControl | DataAccessControl |
This class contains the configuration of how the entity is being accessible |
This class represents a panel field inside a panel.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
name
|
name | string |
Gets or sets the name. |
displayName
|
displayName | string |
Gets or sets the display name. |
isSystem
|
isSystem | boolean |
Gets or sets a value indicating whether this instance is system. |
mandatory
|
mandatory | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.PanelFieldItem is mandatory. |
anonymize
|
anonymize | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.PanelFieldItem is anonymize. |
validationExpression
|
validationExpression | string |
Gets or sets the validation expression. |
validationErrorMessageId
|
validationErrorMessageId | string |
Gets or sets the validation message identifier. |
panelFieldType
|
panelFieldType | VariableType |
VariableType |
metadata
|
metadata | object |
Gets or sets the metadata. |
This class represents a single incentive.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
name
|
name | string |
Gets or sets the name. |
priceInCredits
|
priceInCredits | integer |
Gets or sets the price in credits. |
description
|
description | string |
Gets or sets the description. |
availableVouchersCount
|
availableVouchersCount | integer |
Gets or sets the number of Available vouchers. |
This class represents a single sync item between a survey and a panel.
Name | Path | Type | Description |
---|---|---|---|
identifier
|
identifier | string |
Gets or sets the identifier. |
panelField
|
panelField | string |
Gets or sets the panel field. |
This class represents the request parameters for the ReadArtifactList API.
Name | Path | Type | Description |
---|---|---|---|
path
|
path | string |
Gets or sets the path. |
workspaceId
|
workspaceId | integer |
Gets or sets the workspace identifier. |
This class represents the return parameters for the ReadBounceList API.
Name | Path | Type | Description |
---|---|---|---|
bounces
|
bounces | array of BounceElement |
Gets or sets the list of bounces. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadCreditBalance API.
Name | Path | Type | Description |
---|---|---|---|
balance
|
balance | integer |
Gets or sets the balance. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadDistributorList API.
Name | Path | Type | Description |
---|---|---|---|
distributors
|
distributors | array of DistributorElement |
Gets or sets the distributors. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the request parameters for the ReadIncentiveList API.
Name | Path | Type | Description |
---|---|---|---|
panelIncentives
|
panelIncentives | array of PanelIncentive |
Gets or sets the panel incentives. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadIncentiveTransactionList API.
Name | Path | Type | Description |
---|---|---|---|
incentiveTransactions
|
incentiveTransactions | array of SurveyCreditLog |
Gets or sets the incentive transactions. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadInterviewData API.
Name | Path | Type | Description |
---|---|---|---|
responseData
|
responseData | object |
Gets or sets the response data. |
surveyDefinition
|
surveyDefinition | SurveyDefinition |
This class represents the definition of a survey containing all metadata and settings. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadInterviewListCompact API.
Name | Path | Type | Description |
---|---|---|---|
surveyName
|
surveyName | string |
Gets or sets the name of the survey. |
surveyDefaultLanguage
|
surveyDefaultLanguage | string |
Gets or sets the survey default language. |
surveyLanguages
|
surveyLanguages | array of string |
Gets or sets the survey languages. |
interviews
|
interviews | array of object |
Gets or sets the interviews. |
items
|
interviews | object | |
codePlan
|
codePlan | array of SurveyMetadataItem |
Gets or sets the code plan. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadInterviewList API.
Name | Path | Type | Description |
---|---|---|---|
surveyName
|
surveyName | string |
Gets or sets the name of the survey. |
surveyDefaultLanguage
|
surveyDefaultLanguage | string |
Gets or sets the survey default language. |
surveyLanguages
|
surveyLanguages | array of string |
Gets or sets the survey languages. |
codePlan
|
codePlan | array of SurveyMetadataItem |
Gets or sets the code plan. |
interviews
|
interviews | array of Row |
Gets or sets the interviews. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadMemberList API.
Name | Path | Type | Description |
---|---|---|---|
members
|
members | array of Member |
Gets or sets the panel members. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadMessageTemplateList API.
Name | Path | Type | Description |
---|---|---|---|
messageTemplates
|
messageTemplates | array of MessageTemplateItem |
Gets or sets the message templates. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadOptOutList API.
Name | Path | Type | Description |
---|---|---|---|
optOutItems
|
optOutItems | array of OptOutItem |
Gets or sets the opt out items. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadPanelDefinition API.
Name | Path | Type | Description |
---|---|---|---|
panel
|
panel | PanelDefinition |
This class contains the complete definition of all fields which are contained in a customer defined panel. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadSamplingProject API.
Name | Path | Type | Description |
---|---|---|---|
samplingProject
|
samplingProject | SamplingProjectElement |
This class represents a sampling project. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the response of the ReadSurveyLinks API.
Name | Path | Type | Description |
---|---|---|---|
anonymousList
|
anonymousList | array of SurveyLink |
Gets or sets the anonymous list. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the response parameters for the ReadSurveyList API.
Name | Path | Type | Description |
---|---|---|---|
surveys
|
surveys | array of SurveyListItem |
Gets or sets the surveys. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadSurveyDefinition API.
Name | Path | Type | Description |
---|---|---|---|
surveyName
|
surveyName | string |
Gets or sets the name of the survey. |
surveyVersion
|
surveyVersion | integer |
Gets or sets the survey version. |
surveyState
|
surveyState | string |
Gets or sets the state of the survey. |
createdAt
|
createdAt | string |
Gets or sets the created at. |
createdBy
|
createdBy | string |
Gets or sets the created by. |
survey
|
survey | SurveyDefinition |
This class represents the definition of a survey containing all metadata and settings. |
surveyConfiguration
|
surveyConfiguration | SurveyConfiguration |
This class represents the survey configuration with all the settings a user could configure. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadWebHookList API.
Name | Path | Type | Description |
---|---|---|---|
webHooks
|
webHooks | array of WebHookElement |
Gets or sets the web hooks. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ReadWorkflowTransitions API.
Name | Path | Type | Description |
---|---|---|---|
transitions
|
transitions | array of WorkflowTransition |
Gets or sets the transitions. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the request parameters for the ReadWorkspaceList API.
Name | Path | Type | Description |
---|---|---|---|
workspaces
|
workspaces | array of WorkspaceDto |
Gets or sets the workspaces. |
totalCount
|
totalCount | integer |
Gets or sets the total count. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the RedeemIncentiveCode API.
Name | Path | Type | Description |
---|---|---|---|
voucherCode
|
voucherCode | string |
Gets or sets the voucher code. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the RemindMembers API.
Name | Path | Type | Description |
---|---|---|---|
reminderId
|
reminderId | integer |
Gets or sets the reminder identifier. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the ResetInterview API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents one Row item.
Name | Path | Type | Description |
---|---|---|---|
columns
|
columns | array of ColItem |
Gets or sets the columns. |
This class represents a survey response.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string |
Gets or sets the identifier. |
value
|
value | string |
Gets or sets the value. |
This class represents a sampling project.
Name | Path | Type | Description |
---|---|---|---|
samplingProjectId
|
samplingProjectId | integer |
Gets or sets the sampling project identifier. |
name
|
name | string |
Gets or sets the name. |
workspaceId
|
workspaceId | integer |
Gets or sets the workspace identifier. |
surveyId
|
surveyId | integer |
Gets or sets the survey identifier. |
surveyVersion
|
surveyVersion | integer |
Gets or sets the survey version. |
panelId
|
panelId | integer |
Gets or sets the panel identifier. |
samplingProviderId
|
samplingProviderId | integer |
Gets or sets the sampling provider identifier. |
projectState
|
projectState | string |
Gets or sets the state of the project. |
scheduledDistribution
|
scheduledDistribution | string |
Gets or sets the scheduled distribution. |
executedDistribution
|
executedDistribution | string |
Gets or sets the executed distribution. |
conditions
|
conditions | array of ConditionDefinition |
Gets or sets the conditions. |
This class represents a section inside a survey.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
name
|
name | string |
Gets or sets the name. |
randomizePages
|
randomizePages | boolean |
Gets or sets a value indicating whether [randomize pages]. |
excludeFromRandomization
|
excludeFromRandomization | boolean |
Gets or sets a value indicating whether [exclude from randomization]. |
elements
|
elements | array of SurveyElement |
Gets or sets the elements. |
condition
|
condition | ConditionDefinition |
This class represents the definition of conditions elements. |
This class represents the survey configuration with all the settings a user could configure.
Name | Path | Type | Description |
---|---|---|---|
designConfiguration
|
designConfiguration | DesignConfiguration |
This class represents the styling possibilities for an account. |
anonymizingConfiguration
|
anonymizingConfiguration | AnonymizingConfiguration |
This class contains the anonymizing settings which could be applied to a workspace group, a workspace or an individual survey. |
This class represents a single credit transaction.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
oldValue
|
oldValue | string |
Gets or sets the old value. |
newValue
|
newValue | string |
Gets or sets the new value. |
description
|
description | string |
Gets or sets the description. |
modifiedDate
|
modifiedDate | string |
Gets or sets the modified date. |
modifiedBy
|
modifiedBy | string |
Gets or sets the modified by. |
responseId
|
responseId | uuid |
Gets or sets the response identifier. |
interviewLink
|
interviewLink | string |
Gets or sets the interview link. |
This class represents the definition of a survey containing all metadata and settings.
Name | Path | Type | Description |
---|---|---|---|
allowMultipleParticipation
|
allowMultipleParticipation | boolean |
Gets or sets a value indicating whether [allow multiple participation]. |
allowNavigateBack
|
allowNavigateBack | boolean |
Gets or sets a value indicating whether [allow navigate back]. |
allowSaveProgress
|
allowSaveProgress | boolean |
Gets or sets a value indicating whether [allow save progress]. |
randomizeSections
|
randomizeSections | boolean |
Gets or sets a value indicating whether [randomize sections]. |
enableAutoScroll
|
enableAutoScroll | boolean |
Gets or sets a value indicating whether [enable automatic scroll]. |
enableCodeAccess
|
enableCodeAccess | boolean |
Gets or sets a value indicating whether [enable code access]. |
dataAccessControl
|
dataAccessControl | DataAccessControl |
This class contains the configuration of how the entity is being accessible |
associatedPanels
|
associatedPanels | array of integer |
Gets or sets the panel identifier. |
codeAccessMode
|
codeAccessMode | CodeAccessMode |
AuthenticationType |
enablePanelSync
|
enablePanelSync | boolean |
Gets or sets a value indicating whether [enable panel synchronize]. |
panelSyncBehaviour
|
panelSyncBehaviour | PanelSyncBehaviour |
PanelSyncBehaviour |
panelSyncs
|
panelSyncs | array of PanelSyncElement |
Gets or sets the panel syncs. |
defaultLanguage
|
defaultLanguage | string |
Gets or sets the default language. |
endDate
|
endDate | date-time |
Gets or sets the end date. |
languages
|
languages | array of string |
Gets or sets the languages. |
sections
|
sections | array of Section |
Gets or sets the sections. |
customVariables
|
customVariables | array of CustomVariable |
Gets or sets the custom variables. |
surveyEndText
|
surveyEndText | array of TranslationElement |
Gets or sets the survey end text. |
defaultTextOverrides
|
defaultTextOverrides | object |
Gets or sets the default text overrides. |
This class represents a survey element definition with all metadata and settings.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
elementType
|
elementType | ElementType |
ElementType |
code
|
code | string |
Gets or sets the code. |
codeManuallyChanged
|
codeManuallyChanged | boolean |
Gets or sets a value indicating whether [code manually changed]. |
text
|
text | array of TranslationElement |
Gets or sets the text translations. |
hintText
|
hintText | array of TranslationElement |
Gets or sets the hint text translations. |
hasHintText
|
hasHintText | boolean |
Gets or sets a value indicating whether this instance has hint text. |
hasNotAvailableChoice
|
hasNotAvailableChoice | boolean |
Gets or sets a value indicating whether this instance has not available choice. |
notAvailableChoiceText
|
notAvailableChoiceText | array of TranslationElement |
Gets or sets the not available choice text translations. |
forceResponse
|
forceResponse | boolean |
Gets or sets a value indicating whether [force response]. |
choices
|
choices | array of Choice |
Gets or sets the choices. |
randomizeChoices
|
randomizeChoices | boolean |
Gets or sets a value indicating whether [randomize choices]. |
columnType
|
columnType | ColumnType |
ColumnType |
prompt
|
prompt | array of TranslationElement |
Gets or sets the prompt. |
minValue
|
minValue | integer |
Gets or sets the minimum value. |
maxValue
|
maxValue | integer |
Gets or sets the maximum value. |
showCenterLabel
|
showCenterLabel | boolean |
Gets or sets a value indicating whether [show center label]. |
leftLabel
|
leftLabel | array of TranslationElement |
Gets or sets the left label. |
centerLabel
|
centerLabel | array of TranslationElement |
Gets or sets the center label. |
rightLabel
|
rightLabel | array of TranslationElement |
Gets or sets the right label. |
showValue
|
showValue | boolean |
Gets or sets a value indicating whether [show value]. |
maxDecimals
|
maxDecimals | integer |
Gets or sets the maximum digits after comma. |
textFieldSize
|
textFieldSize | TextFieldSize |
TextFieldSize |
autocomplete
|
autocomplete | boolean |
Gets or sets a value indicating whether this Survalyzer.Contracts.Public.Elements.SurveyElement is autocomplete. |
autocompleteText
|
autocompleteText | array of TranslationElement |
Gets or sets the autocomplete text translations. |
contentValidation
|
contentValidation | ContentValidation |
This class represents a content validation inside a survey. |
hasPlaceholder
|
hasPlaceholder | boolean |
Gets or sets a value indicating whether this instance has placeholder. |
placeholder
|
placeholder | array of TranslationElement |
Gets or sets the placeholder. |
isPassword
|
isPassword | boolean |
Gets or sets a value indicating whether this instance is password. |
minMaxValidation
|
minMaxValidation | boolean |
Gets or sets a value indicating whether [minimum maximum validation]. |
minimumCheckedChoices
|
minimumCheckedChoices | integer |
Gets or sets the minimum checked choices. |
maximumCheckedChoices
|
maximumCheckedChoices | integer |
Gets or sets the maximum checked choices. |
columnGroups
|
columnGroups | array of ColumnGroup |
Gets or sets the column groups. |
randomizeRows
|
randomizeRows | boolean |
Gets or sets a value indicating whether [randomize rows]. |
rows
|
rows | array of MinMaxChoice |
Gets or sets the rows. |
numberOfRanks
|
numberOfRanks | integer |
Gets or sets the number of ranks. |
likeText
|
likeText | array of TranslationElement |
Gets or sets the like text translations. |
dislikeText
|
dislikeText | array of TranslationElement |
Gets or sets the dislike text translations. |
hasStartText
|
hasStartText | boolean |
Gets or sets a value indicating whether this instance has start text. |
startText
|
startText | array of TranslationElement |
Gets or sets the start text. |
enableMeasurement
|
enableMeasurement | boolean |
Gets or sets a value indicating whether [enable measurement]. |
showButtons
|
showButtons | boolean |
Gets or sets a value indicating whether [show buttons]. |
likeKey
|
likeKey | string |
Gets or sets the like key. |
dislikeKey
|
dislikeKey | string |
Gets or sets the dislike key. |
interviewState
|
interviewState | string |
Gets or sets the state of the response. |
action
|
action | ActionElement |
This class represents an end of survey action for complete/screenout/quota full. |
from
|
from | string |
Gets or sets the sender. |
to
|
to | string |
Gets or sets the receiver. |
subject
|
subject | array of TranslationElement |
Gets or sets the subject translations. |
message
|
message | array of TranslationElement |
Gets or sets the message translations. |
valueAssignmentType
|
valueAssignmentType | ValueAssignmentType |
ValueAssignmentType |
variableName
|
variableName | string |
Gets or sets the name of the variable. |
functionTerm
|
functionTerm | array of TranslationElement |
Gets or sets the function term. |
executionBehavior
|
executionBehavior | ExecutionBehavior |
ExecutionBehavior |
apiCallMethod
|
apiCallMethod | ApiCallMethod |
ApiCallMethod |
url
|
url | array of TranslationElement |
Gets or sets the URL. |
headers
|
headers | string |
Gets or sets the headers. |
body
|
body | array of TranslationElement |
Gets or sets the body. |
externalUri
|
externalUri | string |
Gets or sets the external URI. |
scriptType
|
scriptType | ScriptType |
ScriptType |
content
|
content | string |
Gets or sets the content. |
hasRatingLabels
|
hasRatingLabels | boolean |
Gets or sets a value indicating whether this instance has rating labels. |
leftRatingLabel
|
leftRatingLabel | array of TranslationElement |
Gets or sets the left rating label. |
rightRatingLabel
|
rightRatingLabel | array of TranslationElement |
Gets or sets the right rating label. |
condition
|
condition | ConditionDefinition |
This class represents the definition of conditions elements. |
evaluateAsJson
|
evaluateAsJson | boolean |
Gets or sets a value indicating whether [evaluate as json]. |
autocompleteListVariable
|
autocompleteListVariable | string |
Gets or sets the autocomplete list variable. |
arrangementMode
|
arrangementMode | ArrangementMode |
ArrangementMode |
enableAnimation
|
enableAnimation | boolean |
Gets or sets a value indicating whether [enable animation]. |
useSmiley
|
useSmiley | boolean |
Gets or sets a value indicating whether [use smiley]. |
hasPrompt
|
hasPrompt | boolean |
Gets or sets a value indicating whether this instance has prompt. |
The SurveyLink entity
Name | Path | Type | Description |
---|---|---|---|
url
|
url | string |
Gets or sets the URL. |
isCustom
|
isCustom | boolean |
Gets or sets a value indicating whether this instance is custom. |
language
|
language | string |
Gets or sets the language. |
This class represents a single survey item.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
The id of the survey |
name
|
name | string |
The name of the survey |
modifiedDate
|
modifiedDate | string |
The modified date of the survey |
endDate
|
endDate | string |
The date when the survey ends |
isEndDateEnabled
|
isEndDateEnabled | boolean |
If the end date is enabled for this survey |
status
|
status | SurveyStatus |
SurveyStatus |
archiveDate
|
archiveDate | string |
The date when the survey archived |
statusOn
|
statusOn | boolean |
Is survey on or off |
answers
|
answers | integer |
Gets or sets the answers. |
This class represents a single metadata item.
Name | Path | Type | Description |
---|---|---|---|
code
|
code | string |
Gets or sets the code. |
dataType
|
dataType | string |
Gets or sets the data type. |
questionCode
|
questionCode | string |
Gets or sets the question code. |
type
|
type | string |
Gets or sets the type. |
question
|
question | string |
Gets or sets the question. |
row
|
row | string |
Gets or sets the row. |
choice
|
choice | string |
Gets or sets the choice. |
values
|
values | array of RowItem |
Gets or sets the values. |
sectionName
|
sectionName | string |
Gets or sets the section name. |
TextBlock
Name | Path | Type | Description |
---|---|---|---|
name
|
name | string |
Gets or sets the name. |
type
|
type | string |
Gets or sets the type. |
text
|
text | array of TranslationElement |
Gets or sets the text. |
This class represents a text translation inside a survey.
Name | Path | Type | Description |
---|---|---|---|
languageCode
|
languageCode | string |
Gets or sets the language code. |
text
|
text | string |
Gets or sets the text. |
This class represents the return parameters for the UpdateMembers API.
Name | Path | Type | Description |
---|---|---|---|
validationIssues
|
validationIssues | array of WritePanelMemberIssue |
Gets or sets the issues. |
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the UpdateSurvey API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents the return parameters for the CreateWebHook API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
This class represents a group of fields in a panel.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
name
|
name | string |
Gets or sets the name. |
displayName
|
displayName | string |
Gets or sets the display name. |
fields
|
fields | array of PanelFieldItem |
Gets or sets the fields. |
This class represents a single WebHook
Name | Path | Type | Description |
---|---|---|---|
id
|
id | uuid |
Gets or sets the identifier. |
eventType
|
eventType | EventType |
EventType |
entityIdentifier
|
entityIdentifier | string |
Gets or sets the entity identifier. |
createdAt
|
createdAt | date-time |
Gets or sets the created at. |
createdBy
|
createdBy | string |
Gets or sets the created by. |
updatedAt
|
updatedAt | date-time |
Gets or sets the updated at. |
updatedBy
|
updatedBy | string |
Gets or sets the updated by. |
This class represents one transition from one state to another.
Name | Path | Type | Description |
---|---|---|---|
name
|
name | string |
Gets or sets the name. |
action
|
action | string |
Gets or sets the name of the action. |
newState
|
newState | string |
Creates new state. |
condition
|
condition | string |
Gets or sets the condition. |
This class represents one workspace entity.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | integer |
Gets or sets the identifier. |
name
|
name | string |
Gets or sets the name. |
numberOfSurveys
|
numberOfSurveys | integer |
Gets or sets the number of surveys. |
This class represents the return parameters for the WriteOptOutList API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |
Represent some issue that can be appear
Name | Path | Type | Description |
---|---|---|---|
errorCode
|
errorCode | string |
Gets or sets the error code. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
This class represents the return parameters for the WritePanel API.
Name | Path | Type | Description |
---|---|---|---|
isSuccess
|
isSuccess | boolean |
Gets or sets a value indicating whether this instance is success. |
errorMessage
|
errorMessage | string |
Gets or sets the error message. |
errorCode
|
errorCode | string |
Gets or sets the error code. |