Class SurveysScreenerChildrenClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysScreenerChildrenClient

Inheritance

object

SurveysScreenerChildrenClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysScreenerChildrenClient(string, HttpClient)

public SurveysScreenerChildrenClient(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

CreateScreenerChildAsync(string, ScreenerChildCreateRequestModel, CancellationToken)

Create a new screener child survey belonging to the provided screener survey.

public virtual Task<SurveyModel> CreateScreenerChildAsync(string screenerId, ScreenerChildCreateRequestModel newChild, CancellationToken cancellationToken = default)

Parameters

screenerId string

The screener survey id

newChild ScreenerChildCreateRequestModel

A model describing the details for the new screener child 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.

GetScreenerChildrenAsync(string, CancellationToken)

This method retrieves a list of children belonging to the provided screener survey. This list can be filtered and sorted
using standard OData syntax.

public virtual Task<ICollection<SurveyModel>> GetScreenerChildrenAsync(string screenerId, CancellationToken cancellationToken = default)

Parameters

screenerId string

The survey id of the screener 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.

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

protected virtual Task<SurveysScreenerChildrenClient.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<SurveysScreenerChildrenClient.ObjectResponseResult<T>>

Type Parameters

T