Class OrganizationClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2020_04_08

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

Attachments

Associated Attachments.

public PaginatedAttachmentClient Attachments { get; }

Property Value

PaginatedAttachmentClient

Conflicts

Associated Conflicts.

public PaginatedConflictClient Conflicts { get; }

Property Value

PaginatedConflictClient

EventInstances

Associated EventInstances.

public PaginatedEventInstanceClient EventInstances { get; }

Property Value

PaginatedEventInstanceClient

EventResourceRequests

Associated EventResourceRequests.

public PaginatedEventResourceRequestClient EventResourceRequests { get; }

Property Value

PaginatedEventResourceRequestClient

Events

Associated Events.

public PaginatedEventClient Events { get; }

Property Value

PaginatedEventClient

Feeds

Associated Feeds.

public PaginatedFeedClient Feeds { get; }

Property Value

PaginatedFeedClient

JobStatuses

Associated JobStatuses.

public PaginatedJobStatusClient JobStatuses { get; }

Property Value

PaginatedJobStatusClient

People

Associated People.

public PaginatedPersonClient People { get; }

Property Value

PaginatedPersonClient

ReportTemplates

Associated ReportTemplates.

public PaginatedReportTemplateClient ReportTemplates { get; }

Property Value

PaginatedReportTemplateClient

ResourceApprovalGroups

Associated ResourceApprovalGroups.

public PaginatedResourceApprovalGroupClient ResourceApprovalGroups { get; }

Property Value

PaginatedResourceApprovalGroupClient

ResourceBookings

Associated ResourceBookings.

public PaginatedResourceBookingClient ResourceBookings { get; }

Property Value

PaginatedResourceBookingClient

ResourceFolders

Associated ResourceFolders.

public PaginatedResourceFolderClient ResourceFolders { get; }

Property Value

PaginatedResourceFolderClient

ResourceQuestions

Associated ResourceQuestions.

public PaginatedResourceQuestionClient ResourceQuestions { get; }

Property Value

PaginatedResourceQuestionClient

Resources

Associated Resources.

public PaginatedResourceClient Resources { get; }

Property Value

PaginatedResourceClient

RoomSetups

Associated RoomSetups.

public PaginatedRoomSetupClient RoomSetups { get; }

Property Value

PaginatedRoomSetupClient

TagGroups

Associated TagGroups.

public PaginatedTagGroupClient TagGroups { get; }

Property Value

PaginatedTagGroupClient

Tags

Associated Tags.

public PaginatedTagClient Tags { get; }

Property Value

PaginatedTagClient

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.