Class SurveysSamplingPointsQuotaTargetsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysSamplingPointsQuotaTargetsClient

Inheritance

object

SurveysSamplingPointsQuotaTargetsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysSamplingPointsQuotaTargetsClient(string, HttpClient)

public SurveysSamplingPointsQuotaTargetsClient(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, string, CancellationToken)

This method retrieves a list of quota level targets based on survey and sampling point.

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

Parameters

surveyId string

The id of the survey

samplingPointId string

The id of the sampling point

cancellationToken CancellationToken

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

Returns

Task<ICollection<SamplingPointQuotaTargetModel>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

GetAsync(string, string, string, CancellationToken)

This method retrieves detail of quota level targets based on survey and sampling point.

public virtual Task<SamplingPointQuotaTargetModel> GetAsync(string surveyId, string samplingPointId, string quotaLevelId, CancellationToken cancellationToken = default)

Parameters

surveyId string

The id of the survey

samplingPointId string

The id of the sampling point

quotaLevelId string

The id of the quota level

cancellationToken CancellationToken

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

Returns

Task<SamplingPointQuotaTargetModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PatchAsync(string, string, string, SamplingPointQuotaLevelTargetModel, CancellationToken)

Update an sampling point's quota level with the specified fields.

public virtual Task<SamplingPointQuotaTargetModel> PatchAsync(string surveyId, string samplingPointId, string quotaLevelId, SamplingPointQuotaLevelTargetModel samplingPointQuotaLevel, CancellationToken cancellationToken = default)

Parameters

surveyId string

The id of the survey

samplingPointId string

The id of the sampling point

quotaLevelId string

The id of the quota level

samplingPointQuotaLevel SamplingPointQuotaLevelTargetModel

Supply SamplingPointQuotaLevelTarget object with only the properties and values you would like to update. Only the Target property can be supplied.

cancellationToken CancellationToken

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

Returns

Task<SamplingPointQuotaTargetModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T