Class Person

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the Person resource.

public record Person : IEquatable<Person>

Inheritance

object

Person

Implements

IEquatable<Person>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Person()

public Person()

Person(Person)

protected Person(Person original)

Parameters

original Person

Properties

AvatarUrl

Path to where the avatar image is stored

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

Property Value

string

CanEditPeople

Indicates whether the person can edit other people

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

Property Value

bool?

CanEditResources

Indicates whether the person can edit resources

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

Property Value

bool?

CanEditRooms

Indicates whether the person can edit rooms

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

Property Value

bool?

Child

Indicates whether the person is a child

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

Property Value

bool?

ContactData

An object containing the person's contact data.

This can include an array of email_addresses, addresses and phone_numbers

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("contact_data")]
public ContactData? ContactData { get; init; }

Property Value

ContactData

CreatedAt

UTC time at which the person was created

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("created_at")]
public DateTime? CreatedAt { get; init; }

Property Value

DateTime?

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

EventPermissionsType

Event permissions for the person

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

Property Value

string

FirstName

The person's first name

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

Property Value

string

Gender

M indicates male, F indicates female

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

Property Value

string

HasAccess

Indicates whether the person has access to Calendar

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

Property Value

bool?

LastName

The person's last name

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

Property Value

string

MemberOfApprovalGroups

Indicates whether the person is a member of at least one approval group

Only available when requested with the ?fields param

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

Property Value

bool?

MiddleName

The person's middle name

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

Property Value

string

Name

The person's first name, last name, and name suffix

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

Property Value

string

NamePrefix

Possible values:
- Mr.
- Mrs.
- Ms.
- Miss
- Dr.
- Rev.

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

Property Value

string

NameSuffix

Possible values:
- Jr.
- Sr.
- Ph.D.
- II
- III

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

Property Value

string

PendingRequestCount

If the person is a member of an approval group, the number of EventResourceRequests needing resolution.

If resolves_conflicts is true, the count will also include the number of Conflicts needing resolution.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("pending_request_count")]
public int? PendingRequestCount { get; init; }

Property Value

int?

PeoplePermissionsType

People permissions for the person

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

Property Value

string

Permissions

Integer that corresponds to the person's permissions in Calendar

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("permissions")]
public int? Permissions { get; init; }

Property Value

int?

ResolvesConflicts

Indicates whether the person is able to resolve Conflicts

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

Property Value

bool?

ResourcesPermissionsType

Resource permissions for the person

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

Property Value

string

RoomPermissionsType

Room permissions for the person

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

Property Value

string

SiteAdministrator

Indicates whether the person is a Organization Administrator

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

Property Value

bool?

Status

Possible values:
- active: The person is marked "active" in People
- inactive: The person is marked "inactive" in People


Possible values: active, pending, or inactive

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

Property Value

string

UpdatedAt

UTC time at which the person was updated

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("updated_at")]
public DateTime? UpdatedAt { get; init; }

Property Value

DateTime?

Methods

Equals(Person?)

public virtual bool Equals(Person? other)

Parameters

other Person

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 ==(Person?, Person?)

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

Parameters

left Person

right Person

Returns

bool

operator !=(Person?, Person?)

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

Parameters

left Person

right Person

Returns

bool