Class SurveysInterviewQualityClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysInterviewQualityClient

Inheritance

object

SurveysInterviewQualityClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysInterviewQualityClient(string, HttpClient)

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

GetAllAsync(string, CancellationToken)

This method retrieves the interview details list defined for the survey with the specified surveyId surveyId.
This list can be filtered and sorted using standard OData syntax.

public virtual Task<ICollection<InterviewDetailsModel>> GetAllAsync(string surveyId, CancellationToken cancellationToken = default)

Parameters

surveyId string

The survey id

cancellationToken CancellationToken

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

Returns

Task<ICollection<InterviewDetailsModel>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

GetAsync(string, string, CancellationToken)

This method retrieves a specific interview detail defined for the survey with the specified surveyId
and interviewId.

public virtual Task<InterviewDetailsModel> GetAsync(string surveyId, string interviewId, CancellationToken cancellationToken = default)

Parameters

surveyId string

The survey id

interviewId string

The interview Id

cancellationToken CancellationToken

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

Returns

Task<InterviewDetailsModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutAsync(string, QualityNewStateChangeModel, CancellationToken)

Update the quality state of an existing interview.

public virtual Task<InterviewDetails> PutAsync(string surveyId, QualityNewStateChangeModel stateChange, CancellationToken cancellationToken = default)

Parameters

surveyId string

The survey Id of the interview is defined for

stateChange QualityNewStateChangeModel

The updated quality state

cancellationToken CancellationToken

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

Returns

Task<InterviewDetails>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T