Class SurveysParentSurveysWavesClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysParentSurveysWavesClient

Inheritance

object

SurveysParentSurveysWavesClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysParentSurveysWavesClient(string, HttpClient)

public SurveysParentSurveysWavesClient(string baseUrl, HttpClient httpClient)

Parameters

baseUrl string

httpClient HttpClient

Properties

BaseUrl

public string BaseUrl { get; set; }

Property Value

string

JsonSerializerSettings

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

JsonSerializerSettings

ReadResponseAsString

public bool ReadResponseAsString { get; set; }

Property Value

bool

Methods

GetParentSurveyWavesAsync(string, CancellationToken)

This method retrieves a list of waves belonging to the provided parent survey. This list can be filtered and sorted
using standard OData syntax.
Parent surveys and waves are a logical nested organization of surveys

public virtual Task<ICollection<SurveyModel>> GetParentSurveyWavesAsync(string parentSurveyId, CancellationToken cancellationToken = default)

Parameters

parentSurveyId string

The survey id of the parent survey

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ICollection<SurveyModel>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PostAsync(string, ParentSurveyWaveCreateRequestModel, CancellationToken)

Create new ONLINE wave survey belonging to the provided parent survey.
Parent surveys and waves are a logical nested organization of surveys

public virtual Task<SurveyModel> PostAsync(string parentSurveyId, ParentSurveyWaveCreateRequestModel newSurvey, CancellationToken cancellationToken = default)

Parameters

parentSurveyId string

The parent survey id

newSurvey ParentSurveyWaveCreateRequestModel

An object describing the details for the new survey

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SurveyModel>

Created

Exceptions

NfieldSdkException

A server side error occurred.

PostCopyWaveAsync(string, string, ParentSurveyWaveCopyRequestModel, CancellationToken)

Creates a new ONLINE wave survey and copies artifact from existing wave.

public virtual Task<SurveyModel> PostCopyWaveAsync(string parentSurveyId, string waveId, ParentSurveyWaveCopyRequestModel newSurvey, CancellationToken cancellationToken = default)

Parameters

parentSurveyId string

The parent survey id

waveId string

The unique id of the survey (Guid) to be copy. The Survey Id must be a wave (Has a parent Survey)

newSurvey ParentSurveyWaveCopyRequestModel

An object describing the details for the new survey

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SurveyModel>

Created

Exceptions

NfieldSdkException

A server side error occurred.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

protected virtual Task<SurveysParentSurveysWavesClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

response HttpResponseMessage

headers IReadOnlyDictionary<string, IEnumerable<string>>

cancellationToken CancellationToken

Returns

Task<SurveysParentSurveysWavesClient.ObjectResponseResult<T>>

Type Parameters

T