Class OrganizationClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

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>.AddCustomParameter(string, string)

ResourceClient<Organization>.ClearParameters()

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

Addresses

Associated Addresses.

public PaginatedAddressClient Addresses { get; }

Property Value

PaginatedAddressClient

Apps

Associated Apps.

public PaginatedAppClient Apps { get; }

Property Value

PaginatedAppClient

BackgroundChecks

Associated BackgroundChecks.

public PaginatedBackgroundCheckClient BackgroundChecks { get; }

Property Value

PaginatedBackgroundCheckClient

BirthdayPeople

Associated BirthdayPeople.

public BirthdayPeopleClient BirthdayPeople { get; }

Property Value

BirthdayPeopleClient

Campuses

Associated Campuses.

public PaginatedCampusClient Campuses { get; }

Property Value

PaginatedCampusClient

Carriers

Associated Carriers.

public PaginatedCarrierClient Carriers { get; }

Property Value

PaginatedCarrierClient

CustomSenders

Associated CustomSenders.

public PaginatedCustomSenderClient CustomSenders { get; }

Property Value

PaginatedCustomSenderClient

Emails

Associated Emails.

public PaginatedEmailClient Emails { get; }

Property Value

PaginatedEmailClient

FieldData

Associated FieldData.

public PaginatedFieldDatumClient FieldData { get; }

Property Value

PaginatedFieldDatumClient

FieldDefinitions

Associated FieldDefinitions.

public PaginatedFieldDefinitionClient FieldDefinitions { get; }

Property Value

PaginatedFieldDefinitionClient

FormCategories

Associated FormCategories.

public PaginatedFormCategoryClient FormCategories { get; }

Property Value

PaginatedFormCategoryClient

Forms

Associated Forms.

public PaginatedFormClient Forms { get; }

Property Value

PaginatedFormClient

Grades

Associated Grades.

public PaginatedGradeClient Grades { get; }

Property Value

PaginatedGradeClient

Households

Associated Households.

public PaginatedHouseholdClient Households { get; }

Property Value

PaginatedHouseholdClient

InactiveReasons

Associated InactiveReasons.

public PaginatedInactiveReasonClient InactiveReasons { get; }

Property Value

PaginatedInactiveReasonClient

ListCategories

Associated ListCategories.

public PaginatedListCategoryClient ListCategories { get; }

Property Value

PaginatedListCategoryClient

Lists

Associated Lists.

public PaginatedListClient Lists { get; }

Property Value

PaginatedListClient

MaritalStatuses

Associated MaritalStatuses.

public PaginatedMaritalStatusClient MaritalStatuses { get; }

Property Value

PaginatedMaritalStatusClient

MessageGroups

Associated MessageGroups.

public PaginatedMessageGroupClient MessageGroups { get; }

Property Value

PaginatedMessageGroupClient

Messages

Associated Messages.

public PaginatedMessageClient Messages { get; }

Property Value

PaginatedMessageClient

NamePrefixes

Associated NamePrefixes.

public PaginatedNamePrefixClient NamePrefixes { get; }

Property Value

PaginatedNamePrefixClient

NameSuffixes

Associated NameSuffixes.

public PaginatedNameSuffixClient NameSuffixes { get; }

Property Value

PaginatedNameSuffixClient

NoteCategories

Associated NoteCategories.

public PaginatedNoteCategoryClient NoteCategories { get; }

Property Value

PaginatedNoteCategoryClient

NoteCategorySubscriptions

Associated NoteCategorySubscriptions.

public PaginatedNoteCategorySubscriptionClient NoteCategorySubscriptions { get; }

Property Value

PaginatedNoteCategorySubscriptionClient

Notes

Associated Notes.

public PaginatedNoteClient Notes { get; }

Property Value

PaginatedNoteClient

People

Associated People.

public PaginatedPersonClient People { get; }

Property Value

PaginatedPersonClient

PeopleImports

Associated PeopleImports.

public PaginatedPeopleImportClient PeopleImports { get; }

Property Value

PaginatedPeopleImportClient

PersonMergers

Associated PersonMergers.

public PaginatedPersonMergerClient PersonMergers { get; }

Property Value

PaginatedPersonMergerClient

PhoneNumbers

Associated PhoneNumbers.

public PaginatedPhoneNumberClient PhoneNumbers { get; }

Property Value

PaginatedPhoneNumberClient

Reports

Associated Reports.

public PaginatedReportClient Reports { get; }

Property Value

PaginatedReportClient

SchoolOptions

Associated SchoolOptions.

public PaginatedSchoolOptionClient SchoolOptions { get; }

Property Value

PaginatedSchoolOptionClient

SocialProfiles

Associated SocialProfiles.

public PaginatedSocialProfileClient SocialProfiles { get; }

Property Value

PaginatedSocialProfileClient

SpamEmailAddresses

Associated SpamEmailAddresses.

public PaginatedSpamEmailAddressClient SpamEmailAddresses { get; }

Property Value

PaginatedSpamEmailAddressClient

Stats

Associated Stats.

public OrganizationStatisticsClient Stats { get; }

Property Value

OrganizationStatisticsClient

Tabs

Associated Tabs.

public PaginatedTabClient Tabs { get; }

Property Value

PaginatedTabClient

Workflows

Associated Workflows.

public PaginatedWorkflowClient Workflows { get; }

Property Value

PaginatedWorkflowClient

Methods

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.