Class PaginatedPersonTeamPositionAssignmentClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PersonTeamPositionAssignment collection resources.

public class PaginatedPersonTeamPositionAssignmentClient : PaginatedResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentCollectionResponse, PersonTeamPositionAssignmentResponse>

Inheritance

object

ResourceClient<PersonTeamPositionAssignment>

PaginatedResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentCollectionResponse, PersonTeamPositionAssignmentResponse>

PaginatedPersonTeamPositionAssignmentClient

Inherited Members

PaginatedResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentCollectionResponse, PersonTeamPositionAssignmentResponse>.PerPage(int)

PaginatedResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentCollectionResponse, PersonTeamPositionAssignmentResponse>.Offset(int)

PaginatedResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentCollectionResponse, PersonTeamPositionAssignmentResponse>.Filter(string)

PaginatedResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentCollectionResponse, PersonTeamPositionAssignmentResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentCollectionResponse, PersonTeamPositionAssignmentResponse>.PostAsync(PersonTeamPositionAssignment, CancellationToken)

PaginatedResourceClient<PersonTeamPositionAssignment, PersonTeamPositionAssignmentResource, PersonTeamPositionAssignmentCollectionResponse, PersonTeamPositionAssignmentResponse>.PostAsync(JsonApiDocument<PersonTeamPositionAssignmentResource>, CancellationToken)

ResourceClient<PersonTeamPositionAssignment>.AddQueryParameter(string, string)

ResourceClient<PersonTeamPositionAssignment>.ReplaceQueryParameter(string, string)

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

PaginatedPersonTeamPositionAssignmentClient(HttpClient, Uri)

Client for interacting with PersonTeamPositionAssignment collection resources.

public PaginatedPersonTeamPositionAssignmentClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPersonTeamPositionAssignmentClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPersonTeamPositionAssignmentClient

The current PaginatedPersonTeamPositionAssignmentClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPersonTeamPositionAssignmentClient ClearParameters()

Returns

PaginatedPersonTeamPositionAssignmentClient

The current PaginatedPersonTeamPositionAssignmentClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPersonTeamPositionAssignmentClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPersonTeamPositionAssignmentClient

The current PaginatedPersonTeamPositionAssignmentClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of PersonTeamPositionAssignment resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonTeamPositionAssignmentCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of PersonTeamPositionAssignment resources.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPersonTeamPositionAssignmentClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPersonTeamPositionAssignmentClient

The current PaginatedPersonTeamPositionAssignmentClient instance.

OrderByFirstName()

Sort response items by the FirstName attribute.

public PersonTeamPositionAssignmentClient OrderByFirstName()

Returns

PersonTeamPositionAssignmentClient

OrderByFirstNameDescending()

Sort response items by the FirstName attribute. Use reverse order.

public PersonTeamPositionAssignmentClient OrderByFirstNameDescending()

Returns

PersonTeamPositionAssignmentClient

OrderByLastName()

Sort response items by the LastName attribute.

public PersonTeamPositionAssignmentClient OrderByLastName()

Returns

PersonTeamPositionAssignmentClient

OrderByLastNameDescending()

Sort response items by the LastName attribute. Use reverse order.

public PersonTeamPositionAssignmentClient OrderByLastNameDescending()

Returns

PersonTeamPositionAssignmentClient

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedPersonTeamPositionAssignmentClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPersonTeamPositionAssignmentClient

The current PaginatedPersonTeamPositionAssignmentClient instance.

PostAsync(PersonTeamPositionAssignment, CancellationToken)

Creates a new PersonTeamPositionAssignment resource asynchronously.

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

Parameters

resource PersonTeamPositionAssignment

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonTeamPositionAssignmentResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<PersonTeamPositionAssignmentResource>, CancellationToken)

Creates a new PersonTeamPositionAssignment resource asynchronously.

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

Parameters

document JsonApiDocument<PersonTeamPositionAssignmentResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonTeamPositionAssignmentResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

Creates a new instance of a PersonTeamPositionAssignment client for a specific resource ID.

public PersonTeamPositionAssignmentClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PersonTeamPositionAssignmentClient

A new instance of the resource client for the specified resource ID.