Class RegistrationClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Registration resource.

public class RegistrationClient : SingletonResourceClient<Registration, RegistrationResource, RegistrationResponse>

Inheritance

object

ResourceClient<Registration>

SingletonResourceClient<Registration, RegistrationResource, RegistrationResponse>

RegistrationClient

Inherited Members

SingletonResourceClient<Registration, RegistrationResource, RegistrationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Registration, RegistrationResource, RegistrationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Registration, RegistrationResource, RegistrationResponse>.PatchAsync(Registration, CancellationToken)

SingletonResourceClient<Registration, RegistrationResource, RegistrationResponse>.PatchAsync(JsonApiDocument<RegistrationResource>, CancellationToken)

SingletonResourceClient<Registration, RegistrationResource, RegistrationResponse>.DeleteAsync(CancellationToken)

ResourceClient<Registration>.AddQueryParameter(string, string)

ResourceClient<Registration>.ReplaceQueryParameter(string, string)

ResourceClient<Registration>.AddCustomParameter(string, string)

ResourceClient<Registration>.ClearParameters()

ResourceClient<Registration>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Registration>.Uri

ResourceClient<Registration>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RegistrationClient(HttpClient, Uri)

Client for interacting with the Registration resource.

public RegistrationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CreatedBy

Associated CreatedBy.

public PersonClient CreatedBy { get; }

Property Value

PersonClient

RegistrantContact

Associated RegistrantContact.

public PersonClient RegistrantContact { get; }

Property Value

PersonClient

Methods

GetAsync(CancellationToken)

Fetches the Registration resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RegistrationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCreatedBy()

Include related CreatedBy resources in the response.

public RegistrationClient IncludeCreatedBy()

Returns

RegistrationClient

IncludeRegistrantContact()

Include related RegistrantContact resources in the response.

public RegistrationClient IncludeRegistrantContact()

Returns

RegistrationClient