Class PaginatedPersonClient
- Namespace
- Crews.PlanningCenter.Api.People.V2020_04_06
- Assembly
- Crews.PlanningCenter.Api.dll
Client for interacting with Person collection resources.
public class PaginatedPersonClient : PaginatedResourceClient<Person, PersonResource, PersonCollectionResponse, PersonResponse>- Inheritance
-
PaginatedPersonClient
- Inherited Members
Constructors
PaginatedPersonClient(HttpClient, Uri)
Client for interacting with Person collection resources.
public PaginatedPersonClient(HttpClient httpClient, Uri uri)Parameters
httpClientHttpClienturiUri
Methods
GetAsync(CancellationToken)
Fetches a paginated list of Person resources asynchronously.
public Task<PersonCollectionResponse> GetAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA token to monitor for cancellation requests.
Returns
- Task<PersonCollectionResponse>
A task representing the asynchronous operation, containing a paginated list of Person resources.
Exceptions
- JsonApiException
Thrown when the HTTP response indicates a failure status code.
IncludeAddresses()
Include related Addresses resources in the response.
public PersonClient IncludeAddresses()Returns
IncludeEmails()
Include related Emails resources in the response.
public PersonClient IncludeEmails()Returns
IncludeFieldData()
Include related FieldData resources in the response.
public PersonClient IncludeFieldData()Returns
IncludeHouseholds()
Include related Households resources in the response.
public PersonClient IncludeHouseholds()Returns
IncludeInactiveReason()
Include related InactiveReason resources in the response.
public PersonClient IncludeInactiveReason()Returns
IncludeMaritalStatus()
Include related MaritalStatus resources in the response.
public PersonClient IncludeMaritalStatus()Returns
IncludeNamePrefix()
Include related NamePrefix resources in the response.
public PersonClient IncludeNamePrefix()Returns
IncludeNameSuffix()
Include related NameSuffix resources in the response.
public PersonClient IncludeNameSuffix()Returns
IncludeOrganization()
Include related Organization resources in the response.
public PersonClient IncludeOrganization()Returns
IncludePersonApps()
Include related PersonApps resources in the response.
public PersonClient IncludePersonApps()Returns
IncludePhoneNumbers()
Include related PhoneNumbers resources in the response.
public PersonClient IncludePhoneNumbers()Returns
IncludePlatformNotifications()
Include related PlatformNotifications resources in the response.
public PersonClient IncludePlatformNotifications()Returns
IncludePrimaryCampus()
Include related PrimaryCampus resources in the response.
public PersonClient IncludePrimaryCampus()Returns
IncludeSchool()
Include related School resources in the response.
public PersonClient IncludeSchool()Returns
IncludeSocialProfiles()
Include related SocialProfiles resources in the response.
public PersonClient IncludeSocialProfiles()Returns
OrderByAccountingAdministrator()
Sort response items by the AccountingAdministrator attribute.
public PersonClient OrderByAccountingAdministrator()Returns
OrderByAccountingAdministratorDescending()
Sort response items by the AccountingAdministrator attribute. Use reverse order.
public PersonClient OrderByAccountingAdministratorDescending()Returns
OrderByAnniversary()
Sort response items by the Anniversary attribute.
public PersonClient OrderByAnniversary()Returns
OrderByAnniversaryDescending()
Sort response items by the Anniversary attribute. Use reverse order.
public PersonClient OrderByAnniversaryDescending()Returns
OrderByBirthdate()
Sort response items by the Birthdate attribute.
public PersonClient OrderByBirthdate()Returns
OrderByBirthdateDescending()
Sort response items by the Birthdate attribute. Use reverse order.
public PersonClient OrderByBirthdateDescending()Returns
OrderByChild()
Sort response items by the Child attribute.
public PersonClient OrderByChild()Returns
OrderByChildDescending()
Sort response items by the Child attribute. Use reverse order.
public PersonClient OrderByChildDescending()Returns
OrderByCreatedAt()
Sort response items by the CreatedAt attribute.
public PersonClient OrderByCreatedAt()Returns
OrderByCreatedAtDescending()
Sort response items by the CreatedAt attribute. Use reverse order.
public PersonClient OrderByCreatedAtDescending()Returns
OrderByFirstName()
Sort response items by the FirstName attribute.
public PersonClient OrderByFirstName()Returns
OrderByFirstNameDescending()
Sort response items by the FirstName attribute. Use reverse order.
public PersonClient OrderByFirstNameDescending()Returns
OrderByGender()
Sort response items by the Gender attribute.
public PersonClient OrderByGender()Returns
OrderByGenderDescending()
Sort response items by the Gender attribute. Use reverse order.
public PersonClient OrderByGenderDescending()Returns
OrderByGivenName()
Sort response items by the GivenName attribute.
public PersonClient OrderByGivenName()Returns
OrderByGivenNameDescending()
Sort response items by the GivenName attribute. Use reverse order.
public PersonClient OrderByGivenNameDescending()Returns
OrderByGrade()
Sort response items by the Grade attribute.
public PersonClient OrderByGrade()Returns
OrderByGradeDescending()
Sort response items by the Grade attribute. Use reverse order.
public PersonClient OrderByGradeDescending()Returns
OrderByGraduationYear()
Sort response items by the GraduationYear attribute.
public PersonClient OrderByGraduationYear()Returns
OrderByGraduationYearDescending()
Sort response items by the GraduationYear attribute. Use reverse order.
public PersonClient OrderByGraduationYearDescending()Returns
OrderByInactivatedAt()
Sort response items by the InactivatedAt attribute.
public PersonClient OrderByInactivatedAt()Returns
OrderByInactivatedAtDescending()
Sort response items by the InactivatedAt attribute. Use reverse order.
public PersonClient OrderByInactivatedAtDescending()Returns
OrderByLastName()
Sort response items by the LastName attribute.
public PersonClient OrderByLastName()Returns
OrderByLastNameDescending()
Sort response items by the LastName attribute. Use reverse order.
public PersonClient OrderByLastNameDescending()Returns
OrderByMembership()
Sort response items by the Membership attribute.
public PersonClient OrderByMembership()Returns
OrderByMembershipDescending()
Sort response items by the Membership attribute. Use reverse order.
public PersonClient OrderByMembershipDescending()Returns
OrderByMiddleName()
Sort response items by the MiddleName attribute.
public PersonClient OrderByMiddleName()Returns
OrderByMiddleNameDescending()
Sort response items by the MiddleName attribute. Use reverse order.
public PersonClient OrderByMiddleNameDescending()Returns
OrderByNickname()
Sort response items by the Nickname attribute.
public PersonClient OrderByNickname()Returns
OrderByNicknameDescending()
Sort response items by the Nickname attribute. Use reverse order.
public PersonClient OrderByNicknameDescending()Returns
OrderByPeoplePermissions()
Sort response items by the PeoplePermissions attribute.
public PersonClient OrderByPeoplePermissions()Returns
OrderByPeoplePermissionsDescending()
Sort response items by the PeoplePermissions attribute. Use reverse order.
public PersonClient OrderByPeoplePermissionsDescending()Returns
OrderByRemoteId()
Sort response items by the RemoteId attribute.
public PersonClient OrderByRemoteId()Returns
OrderByRemoteIdDescending()
Sort response items by the RemoteId attribute. Use reverse order.
public PersonClient OrderByRemoteIdDescending()Returns
OrderBySiteAdministrator()
Sort response items by the SiteAdministrator attribute.
public PersonClient OrderBySiteAdministrator()Returns
OrderBySiteAdministratorDescending()
Sort response items by the SiteAdministrator attribute. Use reverse order.
public PersonClient OrderBySiteAdministratorDescending()Returns
OrderByStatus()
Sort response items by the Status attribute.
public PersonClient OrderByStatus()Returns
OrderByStatusDescending()
Sort response items by the Status attribute. Use reverse order.
public PersonClient OrderByStatusDescending()Returns
OrderByUpdatedAt()
Sort response items by the UpdatedAt attribute.
public PersonClient OrderByUpdatedAt()Returns
OrderByUpdatedAtDescending()
Sort response items by the UpdatedAt attribute. Use reverse order.
public PersonClient OrderByUpdatedAtDescending()Returns
PostAsync(Person, CancellationToken)
Creates a new Person resource asynchronously.
public Task<PersonResponse> PostAsync(Person resource, CancellationToken cancellationToken = default)Parameters
resourcePersonThe resource data to be sent in the POST request.
cancellationTokenCancellationTokenA token to monitor for cancellation requests.
Returns
- Task<PersonResponse>
A task representing the asynchronous operation, containing the created Person resource.
Exceptions
- JsonApiException
Thrown when the HTTP response indicates a failure status code.
PostAsync(JsonApiDocument<PersonResource>, CancellationToken)
Creates a new Person resource asynchronously.
public Task<PersonResponse> PostAsync(JsonApiDocument<PersonResource> document, CancellationToken cancellationToken = default)Parameters
documentJsonApiDocument<PersonResource>The JSON:API document to be sent in the POST request.
cancellationTokenCancellationTokenA token to monitor for cancellation requests.
Returns
- Task<PersonResponse>
A task representing the asynchronous operation, containing the created Person resource.
Exceptions
- JsonApiException
Thrown when the HTTP response indicates a failure status code.
WhereAccountingAdministrator(bool)
Query response items by the AccountingAdministrator attribute.
public PersonClient WhereAccountingAdministrator(bool value)Parameters
valuebool
Returns
WhereAnniversary(DateOnly)
Query response items by the Anniversary attribute.
public PersonClient WhereAnniversary(DateOnly value)Parameters
valueDateOnly
Returns
WhereBirthdate(DateOnly)
Query response items by the Birthdate attribute.
public PersonClient WhereBirthdate(DateOnly value)Parameters
valueDateOnly
Returns
WhereChild(bool)
Query response items by the Child attribute.
public PersonClient WhereChild(bool value)Parameters
valuebool
Returns
WhereCreatedAt(DateTime)
Query response items by the CreatedAt attribute.
public PersonClient WhereCreatedAt(DateTime value)Parameters
valueDateTime
Returns
WhereFirstName(string)
Query response items by the FirstName attribute.
public PersonClient WhereFirstName(string value)Parameters
valuestring
Returns
WhereGender(string)
Query response items by the Gender attribute.
public PersonClient WhereGender(string value)Parameters
valuestring
Returns
WhereGivenName(string)
Query response items by the GivenName attribute.
public PersonClient WhereGivenName(string value)Parameters
valuestring
Returns
WhereGrade(int)
Query response items by the Grade attribute.
public PersonClient WhereGrade(int value)Parameters
valueint
Returns
WhereGraduationYear(int)
Query response items by the GraduationYear attribute.
public PersonClient WhereGraduationYear(int value)Parameters
valueint
Returns
WhereId(string)
Query response items by the Id attribute.
public PersonClient WhereId(string value)Parameters
valuestring
Returns
WhereInactivatedAt(DateTime)
Query response items by the InactivatedAt attribute.
public PersonClient WhereInactivatedAt(DateTime value)Parameters
valueDateTime
Returns
WhereLastName(string)
Query response items by the LastName attribute.
public PersonClient WhereLastName(string value)Parameters
valuestring
Returns
WhereMedicalNotes(string)
Query response items by the MedicalNotes attribute.
public PersonClient WhereMedicalNotes(string value)Parameters
valuestring
Returns
WhereMembership(string)
Query response items by the Membership attribute.
public PersonClient WhereMembership(string value)Parameters
valuestring
Returns
WhereMfaConfigured(bool)
Query response items by the MfaConfigured attribute.
public PersonClient WhereMfaConfigured(bool value)Parameters
valuebool
Returns
WhereMiddleName(string)
Query response items by the MiddleName attribute.
public PersonClient WhereMiddleName(string value)Parameters
valuestring
Returns
WhereNickname(string)
Query response items by the Nickname attribute.
public PersonClient WhereNickname(string value)Parameters
valuestring
Returns
WherePeoplePermissions(string)
Query response items by the PeoplePermissions attribute.
public PersonClient WherePeoplePermissions(string value)Parameters
valuestring
Returns
WherePrimaryCampusId(int)
Query response items by the PrimaryCampusId attribute.
public PersonClient WherePrimaryCampusId(int value)Parameters
valueint
Returns
WhereRemoteId(int)
Query response items by the RemoteId attribute.
public PersonClient WhereRemoteId(int value)Parameters
valueint
Returns
WhereSearchName(string)
Query response items by the SearchName attribute.
public PersonClient WhereSearchName(string value)Parameters
valuestring
Returns
WhereSearchNameOrEmail(string)
Query response items by the SearchNameOrEmail attribute.
public PersonClient WhereSearchNameOrEmail(string value)Parameters
valuestring
Returns
WhereSearchNameOrEmailOrPhoneNumber(string)
Query response items by the SearchNameOrEmailOrPhoneNumber attribute.
public PersonClient WhereSearchNameOrEmailOrPhoneNumber(string value)Parameters
valuestring
Returns
WhereSearchPhoneNumber(string)
Query response items by the SearchPhoneNumber attribute.
public PersonClient WhereSearchPhoneNumber(string value)Parameters
valuestring
Returns
WhereSearchPhoneNumberE164(string)
Query response items by the SearchPhoneNumberE164 attribute.
public PersonClient WhereSearchPhoneNumberE164(string value)Parameters
valuestring
Returns
WhereSiteAdministrator(bool)
Query response items by the SiteAdministrator attribute.
public PersonClient WhereSiteAdministrator(bool value)Parameters
valuebool
Returns
WhereStatus(string)
Query response items by the Status attribute.
public PersonClient WhereStatus(string value)Parameters
valuestring
Returns
WhereUpdatedAt(DateTime)
Query response items by the UpdatedAt attribute.
public PersonClient WhereUpdatedAt(DateTime value)Parameters
valueDateTime
Returns
WithId(string)
Creates a new instance of a Person client for a specific resource ID.
public PersonClient WithId(string id)Parameters
idstringThe ID of the resource to create a client for.
Returns
- PersonClient
A new instance of the resource client for the specified resource ID.