Class OrganizationClient

Namespace

Crews.PlanningCenter.Api.Current.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Organization resource.

public class OrganizationClient : SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>

Inheritance

object

ResourceClient<Organization>

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>

OrganizationClient

Inherited Members

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>.PatchAsync(Organization, CancellationToken)

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>.PatchAsync(JsonApiDocument<OrganizationResource>, CancellationToken)

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>.DeleteAsync(CancellationToken)

ResourceClient<Organization>.AddQueryParameter(string, string)

ResourceClient<Organization>.ReplaceQueryParameter(string, string)

ResourceClient<Organization>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Organization>.Uri

ResourceClient<Organization>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

OrganizationClient(HttpClient, Uri)

Client for interacting with the Organization resource.

public OrganizationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Me

The current user.

public PersonClient Me { get; }

Property Value

PersonClient

People

Associated People.

public PaginatedPersonClient People { get; }

Property Value

PaginatedPersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public OrganizationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

OrganizationClient

The current OrganizationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public OrganizationClient ClearParameters()

Returns

OrganizationClient

The current OrganizationClient instance.

GetAsync(CancellationToken)

Fetches the Organization resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OrganizationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.