Class HouseholdMembership

Namespace

Crews.PlanningCenter.Api.People.V2025_07_02

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the HouseholdMembership resource.

public record HouseholdMembership : IEquatable<HouseholdMembership>

Inheritance

object

HouseholdMembership

Implements

IEquatable<HouseholdMembership>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

HouseholdMembership()

public HouseholdMembership()

HouseholdMembership(HouseholdMembership)

protected HouseholdMembership(HouseholdMembership original)

Parameters

original HouseholdMembership

Properties

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

HouseholdRole

The role of the person within the household. Possible values are: adult, child_or_dependent, other_adultorparent_guardian.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("household_role")]
public string? HouseholdRole { get; init; }

Property Value

string

Pending

False when a person's membership in a household is unverified.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("pending")]
public bool? Pending { get; init; }

Property Value

bool?

PersonName

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("person_name")]
public string? PersonName { get; init; }

Property Value

string

Methods

Equals(HouseholdMembership?)

public virtual bool Equals(HouseholdMembership? other)

Parameters

other HouseholdMembership

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(HouseholdMembership?, HouseholdMembership?)

public static bool operator ==(HouseholdMembership? left, HouseholdMembership? right)

Parameters

left HouseholdMembership

right HouseholdMembership

Returns

bool

operator !=(HouseholdMembership?, HouseholdMembership?)

public static bool operator !=(HouseholdMembership? left, HouseholdMembership? right)

Parameters

left HouseholdMembership

right HouseholdMembership

Returns

bool