Class PaginatedFormSubmissionClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with FormSubmission collection resources.

public class PaginatedFormSubmissionClient : PaginatedResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionCollectionResponse, FormSubmissionResponse>

Inheritance

object

ResourceClient<FormSubmission>

PaginatedResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionCollectionResponse, FormSubmissionResponse>

PaginatedFormSubmissionClient

Inherited Members

PaginatedResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionCollectionResponse, FormSubmissionResponse>.PerPage(int)

PaginatedResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionCollectionResponse, FormSubmissionResponse>.Offset(int)

PaginatedResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionCollectionResponse, FormSubmissionResponse>.Filter(string)

PaginatedResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionCollectionResponse, FormSubmissionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionCollectionResponse, FormSubmissionResponse>.PostAsync(FormSubmission, CancellationToken)

PaginatedResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionCollectionResponse, FormSubmissionResponse>.PostAsync(JsonApiDocument<FormSubmissionResource>, CancellationToken)

ResourceClient<FormSubmission>.AddQueryParameter(string, string)

ResourceClient<FormSubmission>.ReplaceQueryParameter(string, string)

ResourceClient<FormSubmission>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormSubmission>.Uri

ResourceClient<FormSubmission>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFormSubmissionClient(HttpClient, Uri)

Client for interacting with FormSubmission collection resources.

public PaginatedFormSubmissionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFormSubmissionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFormSubmissionClient

The current PaginatedFormSubmissionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFormSubmissionClient ClearParameters()

Returns

PaginatedFormSubmissionClient

The current PaginatedFormSubmissionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFormSubmissionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFormSubmissionClient

The current PaginatedFormSubmissionClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of FormSubmission resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormSubmissionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeForm()

Include related Form resources in the response.

public FormSubmissionClient IncludeForm()

Returns

FormSubmissionClient

IncludeFormFields()

Include related FormFields resources in the response.

public FormSubmissionClient IncludeFormFields()

Returns

FormSubmissionClient

IncludeFormSubmissionValues()

Include related FormSubmissionValues resources in the response.

public FormSubmissionClient IncludeFormSubmissionValues()

Returns

FormSubmissionClient

IncludePerson()

Include related Person resources in the response.

public FormSubmissionClient IncludePerson()

Returns

FormSubmissionClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFormSubmissionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFormSubmissionClient

The current PaginatedFormSubmissionClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public FormSubmissionClient OrderByCreatedAt()

Returns

FormSubmissionClient

OrderByCreatedAtDescending()

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

public FormSubmissionClient OrderByCreatedAtDescending()

Returns

FormSubmissionClient

OrderByPersonFirstName()

Sort response items by the Person.FirstName attribute.

public FormSubmissionClient OrderByPersonFirstName()

Returns

FormSubmissionClient

OrderByPersonFirstNameDescending()

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

public FormSubmissionClient OrderByPersonFirstNameDescending()

Returns

FormSubmissionClient

OrderByPersonLastName()

Sort response items by the Person.LastName attribute.

public FormSubmissionClient OrderByPersonLastName()

Returns

FormSubmissionClient

OrderByPersonLastNameDescending()

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

public FormSubmissionClient OrderByPersonLastNameDescending()

Returns

FormSubmissionClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public FormSubmissionClient OrderByUpdatedAt()

Returns

FormSubmissionClient

OrderByUpdatedAtDescending()

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

public FormSubmissionClient OrderByUpdatedAtDescending()

Returns

FormSubmissionClient

PerPage(int)

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

public PaginatedFormSubmissionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFormSubmissionClient

The current PaginatedFormSubmissionClient instance.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public FormSubmissionClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

FormSubmissionClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public FormSubmissionClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

FormSubmissionClient

WithId(string)

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

public FormSubmissionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FormSubmissionClient

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