Class PaginatedSchoolOptionClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SchoolOption collection resources.

public class PaginatedSchoolOptionClient : PaginatedResourceClient<SchoolOption, SchoolOptionResource, SchoolOptionCollectionResponse, SchoolOptionResponse>

Inheritance

object

ResourceClient<SchoolOption>

PaginatedResourceClient<SchoolOption, SchoolOptionResource, SchoolOptionCollectionResponse, SchoolOptionResponse>

PaginatedSchoolOptionClient

Inherited Members

PaginatedResourceClient<SchoolOption, SchoolOptionResource, SchoolOptionCollectionResponse, SchoolOptionResponse>.PerPage(int)

PaginatedResourceClient<SchoolOption, SchoolOptionResource, SchoolOptionCollectionResponse, SchoolOptionResponse>.Offset(int)

PaginatedResourceClient<SchoolOption, SchoolOptionResource, SchoolOptionCollectionResponse, SchoolOptionResponse>.Filter(string)

PaginatedResourceClient<SchoolOption, SchoolOptionResource, SchoolOptionCollectionResponse, SchoolOptionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SchoolOption, SchoolOptionResource, SchoolOptionCollectionResponse, SchoolOptionResponse>.PostAsync(SchoolOption, CancellationToken)

PaginatedResourceClient<SchoolOption, SchoolOptionResource, SchoolOptionCollectionResponse, SchoolOptionResponse>.PostAsync(JsonApiDocument<SchoolOptionResource>, CancellationToken)

ResourceClient<SchoolOption>.AddQueryParameter(string, string)

ResourceClient<SchoolOption>.ReplaceQueryParameter(string, string)

ResourceClient<SchoolOption>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SchoolOption>.Uri

ResourceClient<SchoolOption>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSchoolOptionClient(HttpClient, Uri)

Client for interacting with SchoolOption collection resources.

public PaginatedSchoolOptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSchoolOptionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSchoolOptionClient

The current PaginatedSchoolOptionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSchoolOptionClient ClearParameters()

Returns

PaginatedSchoolOptionClient

The current PaginatedSchoolOptionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSchoolOptionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSchoolOptionClient

The current PaginatedSchoolOptionClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of SchoolOption resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SchoolOptionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSchoolOptionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSchoolOptionClient

The current PaginatedSchoolOptionClient instance.

OrderByBeginningGrade()

Sort response items by the BeginningGrade attribute.

public SchoolOptionClient OrderByBeginningGrade()

Returns

SchoolOptionClient

OrderByBeginningGradeDescending()

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

public SchoolOptionClient OrderByBeginningGradeDescending()

Returns

SchoolOptionClient

OrderByEndingGrade()

Sort response items by the EndingGrade attribute.

public SchoolOptionClient OrderByEndingGrade()

Returns

SchoolOptionClient

OrderByEndingGradeDescending()

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

public SchoolOptionClient OrderByEndingGradeDescending()

Returns

SchoolOptionClient

OrderBySequence()

Sort response items by the Sequence attribute.

public SchoolOptionClient OrderBySequence()

Returns

SchoolOptionClient

OrderBySequenceDescending()

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

public SchoolOptionClient OrderBySequenceDescending()

Returns

SchoolOptionClient

OrderByValue()

Sort response items by the Value attribute.

public SchoolOptionClient OrderByValue()

Returns

SchoolOptionClient

OrderByValueDescending()

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

public SchoolOptionClient OrderByValueDescending()

Returns

SchoolOptionClient

PerPage(int)

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

public PaginatedSchoolOptionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSchoolOptionClient

The current PaginatedSchoolOptionClient instance.

PostAsync(SchoolOption, CancellationToken)

Creates a new SchoolOption resource asynchronously.

public Task<SchoolOptionResponse> PostAsync(SchoolOption resource, CancellationToken cancellationToken = default)

Parameters

resource SchoolOption

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SchoolOptionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<SchoolOptionResource>, CancellationToken)

Creates a new SchoolOption resource asynchronously.

public Task<SchoolOptionResponse> PostAsync(JsonApiDocument<SchoolOptionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<SchoolOptionResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SchoolOptionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereBeginningGrade(string)

Query response items by the BeginningGrade attribute.

public SchoolOptionClient WhereBeginningGrade(string value)

Parameters

value string

Returns

SchoolOptionClient

WhereEndingGrade(string)

Query response items by the EndingGrade attribute.

public SchoolOptionClient WhereEndingGrade(string value)

Parameters

value string

Returns

SchoolOptionClient

WhereSchoolTypes(JsonArray)

Query response items by the SchoolTypes attribute.

public SchoolOptionClient WhereSchoolTypes(JsonArray value)

Parameters

value JsonArray

Returns

SchoolOptionClient

WhereSequence(int)

Query response items by the Sequence attribute.

public SchoolOptionClient WhereSequence(int value)

Parameters

value int

Returns

SchoolOptionClient

WhereValue(string)

Query response items by the Value attribute.

public SchoolOptionClient WhereValue(string value)

Parameters

value string

Returns

SchoolOptionClient

WithId(string)

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

public SchoolOptionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SchoolOptionClient

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