Class PaginatedMaritalStatusClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with MaritalStatus collection resources.

public class PaginatedMaritalStatusClient : PaginatedResourceClient<MaritalStatus, MaritalStatusResource, MaritalStatusCollectionResponse, MaritalStatusResponse>

Inheritance

object

ResourceClient<MaritalStatus>

PaginatedResourceClient<MaritalStatus, MaritalStatusResource, MaritalStatusCollectionResponse, MaritalStatusResponse>

PaginatedMaritalStatusClient

Inherited Members

PaginatedResourceClient<MaritalStatus, MaritalStatusResource, MaritalStatusCollectionResponse, MaritalStatusResponse>.PerPage(int)

PaginatedResourceClient<MaritalStatus, MaritalStatusResource, MaritalStatusCollectionResponse, MaritalStatusResponse>.Offset(int)

PaginatedResourceClient<MaritalStatus, MaritalStatusResource, MaritalStatusCollectionResponse, MaritalStatusResponse>.Filter(string)

PaginatedResourceClient<MaritalStatus, MaritalStatusResource, MaritalStatusCollectionResponse, MaritalStatusResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<MaritalStatus, MaritalStatusResource, MaritalStatusCollectionResponse, MaritalStatusResponse>.PostAsync(MaritalStatus, CancellationToken)

PaginatedResourceClient<MaritalStatus, MaritalStatusResource, MaritalStatusCollectionResponse, MaritalStatusResponse>.PostAsync(JsonApiDocument<MaritalStatusResource>, CancellationToken)

ResourceClient<MaritalStatus>.AddQueryParameter(string, string)

ResourceClient<MaritalStatus>.ReplaceQueryParameter(string, string)

ResourceClient<MaritalStatus>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<MaritalStatus>.Uri

ResourceClient<MaritalStatus>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedMaritalStatusClient(HttpClient, Uri)

Client for interacting with MaritalStatus collection resources.

public PaginatedMaritalStatusClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedMaritalStatusClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedMaritalStatusClient

The current PaginatedMaritalStatusClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedMaritalStatusClient ClearParameters()

Returns

PaginatedMaritalStatusClient

The current PaginatedMaritalStatusClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedMaritalStatusClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedMaritalStatusClient

The current PaginatedMaritalStatusClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of MaritalStatus resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MaritalStatusCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedMaritalStatusClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedMaritalStatusClient

The current PaginatedMaritalStatusClient instance.

OrderBySequence()

Sort response items by the Sequence attribute.

public MaritalStatusClient OrderBySequence()

Returns

MaritalStatusClient

OrderBySequenceDescending()

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

public MaritalStatusClient OrderBySequenceDescending()

Returns

MaritalStatusClient

OrderByValue()

Sort response items by the Value attribute.

public MaritalStatusClient OrderByValue()

Returns

MaritalStatusClient

OrderByValueDescending()

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

public MaritalStatusClient OrderByValueDescending()

Returns

MaritalStatusClient

PerPage(int)

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

public PaginatedMaritalStatusClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedMaritalStatusClient

The current PaginatedMaritalStatusClient instance.

PostAsync(MaritalStatus, CancellationToken)

Creates a new MaritalStatus resource asynchronously.

public Task<MaritalStatusResponse> PostAsync(MaritalStatus resource, CancellationToken cancellationToken = default)

Parameters

resource MaritalStatus

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MaritalStatusResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<MaritalStatusResource>, CancellationToken)

Creates a new MaritalStatus resource asynchronously.

public Task<MaritalStatusResponse> PostAsync(JsonApiDocument<MaritalStatusResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<MaritalStatusResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<MaritalStatusResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereValue(string)

Query response items by the Value attribute.

public MaritalStatusClient WhereValue(string value)

Parameters

value string

Returns

MaritalStatusClient

WithId(string)

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

public MaritalStatusClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

MaritalStatusClient

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