Class RosterListPersonClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2025_05_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the RosterListPerson resource.

public class RosterListPersonClient : SingletonResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonResponse>

Inheritance

object

ResourceClient<RosterListPerson>

SingletonResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonResponse>

RosterListPersonClient

Inherited Members

SingletonResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonResponse>.GetAsync(CancellationToken)

SingletonResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonResponse>.PatchAsync(RosterListPerson, CancellationToken)

SingletonResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonResponse>.PatchAsync(JsonApiDocument<RosterListPersonResource>, CancellationToken)

SingletonResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonResponse>.DeleteAsync(CancellationToken)

ResourceClient<RosterListPerson>.AddQueryParameter(string, string)

ResourceClient<RosterListPerson>.ReplaceQueryParameter(string, string)

ResourceClient<RosterListPerson>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<RosterListPerson>.Uri

ResourceClient<RosterListPerson>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RosterListPersonClient(HttpClient, Uri)

Client for interacting with the RosterListPerson resource.

public RosterListPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public RosterListPersonClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

RosterListPersonClient

The current RosterListPersonClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public RosterListPersonClient ClearParameters()

Returns

RosterListPersonClient

The current RosterListPersonClient instance.

GetAsync(CancellationToken)

Fetches the RosterListPerson resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RosterListPersonResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.