Class PersonTeamPositionAssignmentClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PersonTeamPositionAssignment resource.

public class PersonTeamPositionAssignmentClient : SingletonResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentResponse>

Inheritance

object

ResourceClient<PersonTeamPositionAssignment>

SingletonResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentResponse>

PersonTeamPositionAssignmentClient

Inherited Members

SingletonResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentResponse>.PatchAsync(PersonTeamPositionAssignment, CancellationToken)

SingletonResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentResponse>.PatchAsync(JsonApiDocument<PersonTeamPositionAssignmentResource>, CancellationToken)

SingletonResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentResponse>.DeleteAsync(CancellationToken)

ResourceClient<PersonTeamPositionAssignment>.AddQueryParameter(string, string)

ResourceClient<PersonTeamPositionAssignment>.ReplaceQueryParameter(string, string)

ResourceClient<PersonTeamPositionAssignment>.AddCustomParameter(string, string)

ResourceClient<PersonTeamPositionAssignment>.ClearParameters()

ResourceClient<PersonTeamPositionAssignment>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PersonTeamPositionAssignment>.Uri

ResourceClient<PersonTeamPositionAssignment>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PersonTeamPositionAssignmentClient(HttpClient, Uri)

Client for interacting with the PersonTeamPositionAssignment resource.

public PersonTeamPositionAssignmentClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

TeamPosition

Associated TeamPosition.

public TeamPositionClient TeamPosition { get; }

Property Value

TeamPositionClient

Methods

DeleteAsync(CancellationToken)

Deletes the PersonTeamPositionAssignment resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the PersonTeamPositionAssignment resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonTeamPositionAssignmentResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public PersonTeamPositionAssignmentClient IncludePerson()

Returns

PersonTeamPositionAssignmentClient

IncludeTeamPosition()

Include related TeamPosition resources in the response.

public PersonTeamPositionAssignmentClient IncludeTeamPosition()

Returns

PersonTeamPositionAssignmentClient

PatchAsync(PersonTeamPositionAssignment, CancellationToken)

Updates an existing PersonTeamPositionAssignment resource asynchronously.

public Task<PersonTeamPositionAssignmentResponse> PatchAsync(PersonTeamPositionAssignment resource, CancellationToken cancellationToken = default)

Parameters

resource PersonTeamPositionAssignment

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonTeamPositionAssignmentResponse>

A task representing the asynchronous operation, containing the updated PersonTeamPositionAssignment resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<PersonTeamPositionAssignmentResource>, CancellationToken)

Updates an existing PersonTeamPositionAssignment resource asynchronously.

public Task<PersonTeamPositionAssignmentResponse> PatchAsync(JsonApiDocument<PersonTeamPositionAssignmentResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PersonTeamPositionAssignmentResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonTeamPositionAssignmentResponse>

A task representing the asynchronous operation, containing the updated PersonTeamPositionAssignment resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.