Namespace Nfield.SDK
Classes
- ActivateSpareSamplingPointRequestModel
Model representing the activation of a single spare sampling point.
It allows to set a target during the activation
- ActivateSpareSamplingPointsRequestModel
Model representing the activation of list of spare sampling point.
- ActivateSpareSamplingPointsResponseModel
Model representing the result of the activation of sampling points
- AddInvitationImageResult
Dto for the result of an add image for invitation operation
- AddressModel
The model representing an Sampling Point's Address, this is a Data Transfer Object (DTO).
- AddressSampleDataModel
Sample data for an address
- Amount
The amount model.
- BackgroundActivityResponseBaseModel
DTO for returning the content of an activity
- BackgroundActivityResponseModel
DTO for returning the content of an activity
- BackgroundActivityStatus
DTO for returning the confirmation of a started activity
- BlacklistUploadStatusResponseModel
Model to obtain the status of the blacklist upload
- CapiInterviewerResponseModel
Model representing a local user.
- CatiInterviewer
The CATI interviewer
- ChangePasswordLocalUserResponseModel
Model for changing local user password.
- CheckMaskingStatusResponseModel
Response model for the masking status check
- ClearSurveySampleModel
Model for the clear request
- CreateDomainSurveyPropertyModel
The model to create a domain survey property
- CreateRepositoryModel
The model for creating a repository
- CreateRepositorySubscriptionModel
Describes the properties of a new repository subscription.
- CreateSubscriptionModel
The necessary information to create a subscription
- CreateSurveyGroupModel
Create a new survey group
- DeleteDomainAssignmentsModel
Model for a batch of domain assignments to delete
- DeleteInvitationTemplateResponse
Model for a response to a DeleteInvitation request
- DeleteScriptFragmentResult
DTO class for the script fragments deletion result
- DialModeModel
model to send/recieve dialmode
- DirectoryIdentityModel
Model for directory identity
- DomainAssignmentsModel
Model for a batch of domain assignments
- DomainLanguageTranslationsRequestModel
The model (dto) for a translation item
- DomainLanguageTranslationsResponseModel
The model (dto) for a translation item
- DomainResponseCodeCreateModel
Model representing a domain response used to create a new response code (POST mehtod)
- DomainResponseCodeResponseModel
Model representing a domain response code
- DomainResponseCodeResponseModelBase
Model representing a domain response code
- DomainResponseCodeUpdateModel
Model representing a domain response used to update a new response code (PATCH mehtod)
- DomainSurveyModel
Describes the properties of a domain survey
- DomainSurveyPropertyModel
The domain survey property model.
- EditCapiInterviewerRequestModel
Model representing modification of an interviewer.
- EmailSettingsModel
Base model for the email settings (for a survey or a domain)
- EmailSettingsModelBase
Base model for the email settings (for a survey or a domain)
- FabricDataShareCreateRequestModel
Class that represents the data needed to create a new Fabric Data Share.
- FabricDataShareListResponseModel
Class that represents the information for a Fabric Data Share.
- FabricDataShareResponseModel
Class that represents the information for a Fabric Data Share.
- FabricDataShareSurveyListResponseModel
Class that represents the information regarding a survey in a Fabric Data Share.
- FirewallRuleModel
Describes the firewall rule for an Azure Sql Database.
- GetDataRetentionSettingsModel
The model for Survey data retention settings
- GetHintsResponseModel
The API response model representing Hints
- InternalSurveyModel
The model representing a Survey, this is a Data Transfer Object (DTO).
- Interviewer
The CAPI interviewer
- InterviewerSamplingPointAssignmentModel
Model used for querying interviewer assignments to sampling points
- InvitationBatch
DTO defining an invitation batch
- InvitationBatchStatus
Status of the sending of the invitation to a respondent
- InvitationMonitorBatchStatus
Represents the status of an invitation batch
- InvitationMonitorStatusBase
Base class to monitor the invitation status
- InvitationMonitorSurveyStatus
Represent an overview of the status of all the invitation batches for a survey
- InvitationSurveyEmailSettings
Defines email settings for a survey
- InvitationTemplateModel
Email invitation template
- InvitationTemplateModelUpdate
Model for creating and updating an email invitation template
- InvitationTemplateModelValidated
Extension of InvitationTemplateModel that says whether the template is valid
- InviteRespondentsStatus
DTO for inviting respondents status
- LandingPageExportStatusResponseModel
Represents the response model returned after exporting a landing page file.
- LandingPageUploadStatusResponseModel
Represents the response model returned after importing a landing page file.
- LanguageTranslationsRequestModel
The model (dto) for a translation item
- LanguageTranslationsResponseModel
The model (dto) for a translation item
- LocalUserRequestModel
Model representing a new local user.
- LocalUserResponseModel
Model representing a local user.
- MaskDataResponseModel
Response model for the mask sample data operation
- MaskingDataRequestModel
Model for the masking request
- MetricCounts
The metric count
- NativeIdentityModel
Model for native identity
- NewCapiInterviewerRequestModel
Model representing a new interviewer.
- NfieldUser
Model for an Nfield NfieldUser
- OfficesRequestModel
Create request model to create an office
- OfficesResponseModel
The API response model representing a fieldwork office
- PasswordSettingsModelBase
The password settings of the domain
- PasswordSettingsRequestModel
Model representing a domain password request
- PasswordSettingsResponseModel
Model representing a domain password response
- QualityNewStateChangeModel
A model for setting new state for an Interview
- QuotaFrameModel
This model is used to query survey quota frame.
- QuotaFrameVersionModel
This model is used to query survey quota frame versions.
- ReplaceSamplingPointWithSpareRequestModel
Model representing the replacement of a single spare sampling point.
- ReplaceSamplingPointWithSpareResponseModel
Model representing the result of the replacement of sampling points
- RepositoryActivityLogModel
The repository activity log model.
- RepositoryConnectionInfo
Class that holds all the required data to connect to a repository database
- RepositoryMetricsModel
The repository metrics model.
- RepositoryModel
Contains information about a repository.
- RepositoryPlan
Represents a subscription plan for Data Repositories.
- RepositoryStatusListModel
The repository status list model.
- RepositorySubscriptionLogModel
The repository subscription log model.
- RepositorySurveyModel
Contains information about a repository survey
- RepositoryUserModel
Contains information about a repository user.
- RequestHeaderModel
Configuration for a request header
- RequestModel
Configuration for a request
- ResetPasswordModel
The model that is used for resetting the interviewer's password
- ResourceMetricModel
The resource metric model
- RespondentDataCryptographyModel
Model used in cryptography operations
- ResponseCodeCount
Class for the screen out interviews overview
- SampleClearBackgroundActivity
DTO for returning the content of an activity representing the clearing of a sample
- SampleFilterModel
Class to define sample filters
- SampleResetBackgroundActivity
DTO for returning the content of an activity representing resetting sample
- SampleUpdateStatus
DTO for returning the result of a SampleData update operation
- SampleUploadStatus
DTO for upload sample data result objects
(hiding all internal IDs, DateTimes and skipping data passed as parameter with the request)
- SamplingMethodModel
Model for SurveySamplingMethodController
- SamplingPointBaseModel
The model representing an SamplingPoint.
- SamplingPointCreateRequestModel
The model representing an SamplingPoint.
- SamplingPointCustomDataModel
The model representing each SamplingPoint custom column
- SamplingPointImageUploadResponseModel
Model for multiple sampling points to multiple interviewers assignments
- SamplingPointInterviewerAssignmentsModel
Model for multiple sampling points to multiple interviewers assignments
- SamplingPointQuotaTargetModel
The model representing an SamplingPointQuotaTarget.
- SamplingPointResponseModel
The model representing an SamplingPoint.
- SamplingPointUpdateRequestModel
The model representing an SamplingPoint.
- SearchFieldsRequestModel
The API request model representing a the list of fields to search for an respondant
- SearchFieldsResponseModel
The API response model representing a the list of fields to search for an respondant
- SubscriptionModel
The Event Grid Domain topic subscription
- SurveyBaseModel
The basic model representing a Survey, this is a Data Transfer Object (DTO).
- SurveyCountsModel
Holds various counts for a survey
- SurveyCreateManualTestSurveyBackgroundActivity
DTO for returning the content of an activity representing a manual test survey
- SurveyCreateScriptFragmentResponseModel
Model containing the odin script fragment relative path
- SurveyDataInterviewRequestModel
Fields required to create a survey data download request on nfield manager surveys
- SurveyDataRequestModel
Fields required to create a survey data download request on nfield manager surveys
- SurveyEmailSettingsModel
Model for a survey's email settings
- SurveyEmailSettingsResponse
Model for the response to a GetSurveyEmailSettings request
- SurveyFieldworkCountsResponseModel
The API response model representing the fieldwork counts
- SurveyFromBlueprintModel
The model used to create a new survey from a blueprint survey
- SurveyGeneralSettingsRequestV1Model
Model representing a survey general settings
- SurveyGeneralSettingsResponseModel
Model representing a survey general settings
- SurveyGetScriptFragmentModel
Model containing the odin script
- SurveyGetScriptModel
Model containing the odin script
- SurveyGroupDirectoryAssignmentModel
Model for survey group directory assignment
- SurveyGroupModel
Model for Survey Group
- SurveyGroupNativeAssignmentModel
Model for survey group native assignment
- SurveyInterviewInteractionsSettingsRequestModel
Base model for the interview interactions settings (for a survey)
It defines which actions are available during the interviews
These settings are only used in the Online channel
- SurveyInterviewInteractionsSettingsResponseModel
Base model for the interview interactions settings (for a survey)
It defines which actions are available during the interviews
These settings are only used in the Online channel
- SurveyInterviewSimulationModel
The model representing a survey simulation. It is the same as survey model including the OriginalSurveyId
- SurveyInterviewerAddRequestModel
Model used to add an interviewer to a survey
- SurveyInterviewerAssignmentRequestModel
Model for multiple sampling points to multiple interviewers assignments
- SurveyInterviewerModel
Interviewer model assigned to a survey
- SurveyInterviewerQuotaLevelDistributeRequestModel
SurveyInterviewerDistribute model
- SurveyInterviewerQuotaLevelTargetRequestModel
Model for interviewers assignments quota levels targets.
- SurveyInterviewerQuotaLevelTargetResponseModel
Model for interviewers assignments quota targets and Successful counts at survey and interviewer level.
- SurveyLanguageTranslationsRequestModel
The model (dto) for a translation item
- SurveyLanguageTranslationsResponseModel
The model (dto) for a translation item
- SurveyManualTestModel
The model representing a manual test survey. It is the same as survey model including the OriginalSurveyId
- SurveyMetricCounts
The counts per metric
- SurveyMetrics
Represents the metrics for the specified survey
- SurveyModel
The model representing a Survey, this is a Data Transfer Object (DTO).
- SurveyMoveModel
Model for moving a survey to another group
- SurveyPackageFileV1Model
Describes a file that is contained in the package.
- SurveyPackageLanguageV1Model
Languages and translations defined in the package
- SurveyPackageRelocationV1Model
Relocations defined in the package
- SurveyPackageV1Model
Models the content of a published package (live/test) for a survey.
- SurveyProcessAndSaveMediaFilesBackgroundActivity
DTO for returning the content of an activity representing ProcessAndSaveMediaFiles
- SurveyPublicIdModel
A public id for a survey. Model used in the Manager API.
- SurveyPublishBackgroundActivity
DTO for returning the content of an activity representing publish survey
- SurveyPublishTypeUpgradeModel
A model for Survey Publish Type and force Upgrade
- SurveyQuotaFrameEtagLevelTargetModel
Survey quota level Targets. Used only for Quota ETag requests and responses
- SurveyQuotaFrameEtagRequestModel
The API request model representing a quota level targets for an specific ETag
- SurveyQuotaFrameEtagResponseModel
The API response model representing a quota level targets for an specific ETag
- SurveyQuotaFrameLevelModel
Survey quota Frame Level. Need to be bound to a Quota Level DefinitionModel
- SurveyQuotaFrameRequestModel
The API request model representing the Survey quota frame
- SurveyQuotaFrameResponseModel
The API response model representing the Survey quota frame
- SurveyQuotaFrameVariableModel
Survey quota Frame Variable. Need to be bound to a Quota Variable Definition
- SurveyQuotaLevelDefinitionModel
Survey quota Level Definition. Represents only the definition of the Levvel and not the assignment to the Survey
- SurveyQuotaVariableDefinitionModel
Survey quota Variable Definition. Represents only the definition of the variable and not the assignment to the Survey
- SurveyResourceModel
Information about a survey's resource usage
- SurveyResponseCodeModel
Model representing SurveySpecificResponseCode
- SurveyResponseCodeModelForPatch
Entity class for Survey response code (only used for patch endpoint)
- SurveyResponseCodeV1Model
Model representing SurveySpecificResponseCode
- SurveySetScriptModel
Model containing the odin script
- SurveySettingModel
The model representing a Survey settings
- SurveyTranslationModel
The model (dto) for a translation item
- SurveyTranslationV1Model
The model (dto) for a translation item
- SurveyUpdateModel
The model representing a Survey, this is a Data Transfer Object (DTO).
- SurveyUpdateSampleRecordModel
Model for updating a sample record
- SurveyVarFileModel
Model containing the varfile
- SurveyVersionModel
Model for the survey version
- SurveysFieldworkStopRequestModel
Stop fieldwork model
- SurveysQuotaFrameEtagResponseModel
The API response model representing a Quota Frame
- SurveysQuotaFrameResponseBaseModel
The API response model representing a Quota Frame
- SurveysQuotaFrameResponseModel
The API response model representing a Quota Frame
- TemplatesResponseModel
The API response model representing a template
- ThemeResponseModel
The API response model representing a theme
- TimeMetricElementModel
The time metric element model.
- TokenRefreshRequestModel
The token refresh request model
NOTE: We keep this model with only one property, in the case that we'll most probably need more
- TokenRequestModel
The credentials used to sign in to the Nfield Api
- TokenResponseModel
The credentials used to sign in to the Nfield Api
- TranslationWarning
A warning from a language translation
- UnassignDirectoryIdentityModel
Minimal model for directory identity, used for deleting a survey group assignment
For delete action we don't need to verify the object type, so it is not in this model.
- UpdateBlueprintModel
The model used to update a blueprint based on a survey
- UpdateDataRetentionSettingsModel
The update model for survey data retention settings
- UpdateDomainSurveyPropertyModel
Contains information needed to update a domain survey property
- UpdateSubscriptionModel
The data that can be updated on an event grid domain topic subscription
- UpdateSurveyGroupModel
Update an existing survey group
- UploadBlacklistError
Error message for blacklist upload
- UploadSampleRecordError
Error message for upload of sample data
- UserRoleModel
Contains the user role for the currently authenticated user.
- WaveCheckMinSuccessfulsBeforeAutoStartModel
Model for accessing the setting of whether to check the minimum number of successful responses before auto-starting a wave
- WaveMinSuccessfulsBeforeAutoStartModel
Model for accessing the minimum number of successful responses required before auto-starting a wave
- WaveStartDateModel
Model for SurveysWaveStartDateController
- WaveStopDateModel
Model for SurveysWaveStopDateController
Structs
Enums
- CopyableSurveyConfigurationModel
Survey configuration items that may be copied when creating a survey from a blueprint
- SamplingPointKindForRequestModel
Restricted enum for Create and Update methods. The only accepted values are "Regular" and "Spare".
SamplingPointKind>