Class PeopleImportHistoryClient

Namespace

Crews.PlanningCenter.Api.People.V2025_07_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PeopleImportHistory resource.

public class PeopleImportHistoryClient : SingletonResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryResponse>

Inheritance

object

ResourceClient<PeopleImportHistory>

SingletonResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryResponse>

PeopleImportHistoryClient

Inherited Members

SingletonResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryResponse>.PatchAsync(PeopleImportHistory, CancellationToken)

SingletonResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryResponse>.PatchAsync(JsonApiDocument<PeopleImportHistoryResource>, CancellationToken)

SingletonResourceClient<PeopleImportHistory, PeopleImportHistoryResource, PeopleImportHistoryResponse>.DeleteAsync(CancellationToken)

ResourceClient<PeopleImportHistory>.AddQueryParameter(string, string)

ResourceClient<PeopleImportHistory>.ReplaceQueryParameter(string, string)

ResourceClient<PeopleImportHistory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PeopleImportHistory>.Uri

ResourceClient<PeopleImportHistory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PeopleImportHistoryClient(HttpClient, Uri)

Client for interacting with the PeopleImportHistory resource.

public PeopleImportHistoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Household

Associated Household.

public HouseholdClient Household { get; }

Property Value

HouseholdClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PeopleImportHistoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PeopleImportHistoryClient

The current PeopleImportHistoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PeopleImportHistoryClient ClearParameters()

Returns

PeopleImportHistoryClient

The current PeopleImportHistoryClient instance.

GetAsync(CancellationToken)

Fetches the PeopleImportHistory resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PeopleImportHistoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeHousehold()

Include related Household resources in the response.

public PeopleImportHistoryClient IncludeHousehold()

Returns

PeopleImportHistoryClient

IncludePerson()

Include related Person resources in the response.

public PeopleImportHistoryClient IncludePerson()

Returns

PeopleImportHistoryClient