Class HeadcountClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_09_03

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Headcount resource.

public class HeadcountClient : SingletonResourceClient<Headcount, HeadcountResource, HeadcountResponse>

Inheritance

object

ResourceClient<Headcount>

SingletonResourceClient<Headcount, HeadcountResource, HeadcountResponse>

HeadcountClient

Inherited Members

SingletonResourceClient<Headcount, HeadcountResource, HeadcountResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Headcount, HeadcountResource, HeadcountResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Headcount, HeadcountResource, HeadcountResponse>.PatchAsync(Headcount, CancellationToken)

SingletonResourceClient<Headcount, HeadcountResource, HeadcountResponse>.PatchAsync(JsonApiDocument<HeadcountResource>, CancellationToken)

SingletonResourceClient<Headcount, HeadcountResource, HeadcountResponse>.DeleteAsync(CancellationToken)

ResourceClient<Headcount>.AddQueryParameter(string, string)

ResourceClient<Headcount>.ReplaceQueryParameter(string, string)

ResourceClient<Headcount>.AddCustomParameter(string, string)

ResourceClient<Headcount>.ClearParameters()

ResourceClient<Headcount>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Headcount>.Uri

ResourceClient<Headcount>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

HeadcountClient(HttpClient, Uri)

Client for interacting with the Headcount resource.

public HeadcountClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

AttendanceType

Associated AttendanceType.

public AttendanceTypeClient AttendanceType { get; }

Property Value

AttendanceTypeClient

EventTime

Associated EventTime.

public EventTimeClient EventTime { get; }

Property Value

EventTimeClient

Methods

GetAsync(CancellationToken)

Fetches the Headcount resource asynchronously.

public Task<HeadcountResponse> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<HeadcountResponse>

A task representing the asynchronous operation, containing the Headcount resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeAttendanceType()

Include related AttendanceType resources in the response.

public HeadcountClient IncludeAttendanceType()

Returns

HeadcountClient

IncludeEventTime()

Include related EventTime resources in the response.

public HeadcountClient IncludeEventTime()

Returns

HeadcountClient