PcoCheckInsPerson class

This class represents a PCO CheckIns Person Object

Application: check-ins
Id: person
Type: Person
ApiVersion: 2019-07-17
Is Deprecated: false
Is Collection Only: false
Default Endpoint: https://api.planningcenteronline.com/check-ins/v2/people
Create Endpoint: NONE

Instantiation

This object cannot be created through the API.
Instantiate from existing JSON data using the PcoCheckInsPerson.fromJson() constructor.
Load an instance from the API using one of the static methods defined on this class.

Usage

Fields exposed by the API are readable through getter methods.
Fields writable by the API are exposed through setter methods.
Original json data is exposed through the read-only attributes map.
Additional data is available through the read-only links and relationships maps.
Available relationships / includes are exposed through typed getters.

Description

An attendee, volunteer or administrator.

Usually, a person who checked in will be present as a Person. In some cases, they may not be present:

The person was manually deleted from the admin interface
The check-in was created as a "Visitor - Label Only" (which doesn't create a corresponding person record)

Attributes (and permissions)

id (ro) -> PCO: id
addresses (ro) -> PCO: addresses
emailAddresses (ro) -> PCO: email_addresses
phoneNumbers (ro) -> PCO: phone_numbers
avatarUrl (ro) -> PCO: avatar_url
namePrefix (ro) -> PCO: name_prefix
firstName (ro) -> PCO: first_name
middleName (ro) -> PCO: middle_name
lastName (ro) -> PCO: last_name
nameSuffix (ro) -> PCO: name_suffix
birthdate (ro) -> PCO: birthdate
grade (ro) -> PCO: grade
gender (ro) -> PCO: gender
medicalNotes (ro) -> PCO: medical_notes
isChild (ro) -> PCO: child
permission (ro) -> PCO: permission
isHeadcounter (ro) -> PCO: headcounter
lastCheckedInAt (ro) -> PCO: last_checked_in_at
checkInCount (ro) -> PCO: check_in_count
createdAt (ro) -> PCO: created_at
updatedAt (ro) -> PCO: updated_at
isPassedBackgroundCheck (ro) -> PCO: passed_background_check
demographicAvatarUrl (ro) -> PCO: demographic_avatar_url
name (ro) -> PCO: name
topPermission (ro) -> PCO: top_permission
searchName (ro) -> PCO: search_name

Edges and Actions

Outbound Edges:

checkin-person-check_ins: https://api.planningcenteronline.com/check-ins/v2/people/1/check_ins
organization-person-organization: https://api.planningcenteronline.com/check-ins/v2/people/1/organization
pass-person-passes: https://api.planningcenteronline.com/check-ins/v2/people/1/passes
personevent-person-person_events: https://api.planningcenteronline.com/check-ins/v2/people/1/person_events

Inbound Edges:

person-checkin-checked_in_by: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/checked_in_by
person-checkin-checked_out_by: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/checked_out_by
person-checkin-person: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/person
person-organization-people: https://api.planningcenteronline.com/check-ins/v2/people
person-pass-person: https://api.planningcenteronline.com/check-ins/v2/passes/1/person
person-personevent-person: https://api.planningcenteronline.com/check-ins/v2/events/1/person_events/1/person

Actions: NONE

Raw Data Object Example

{
  "type": "Person",
  "id": "1",
  "attributes": {
    "addresses": [],
    "email_addresses": [],
    "phone_numbers": [],
    "avatar_url": "string",
    "name_prefix": "string",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "name_suffix": "string",
    "birthdate": "2000-01-01",
    "grade": 1,
    "gender": "string",
    "medical_notes": "string",
    "child": true,
    "permission": "string",
    "headcounter": true,
    "last_checked_in_at": "2000-01-01T12:00:00Z",
    "check_in_count": 1,
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "passed_background_check": true,
    "demographic_avatar_url": "string",
    "name": "string",
    "top_permission": "string"
  },
  "relationships": {}
}

Inheritance

Object
PcoResource
PcoCheckInsPerson

Constructors

PcoCheckInsPerson({String? id, List? addresses, List? emailAddresses, List? phoneNumbers, String? avatarUrl, String? namePrefix, String? firstName, String? middleName, String? lastName, String? nameSuffix, String? birthdate, int? grade, String? gender, String? medicalNotes, bool? isChild, String? permission, bool? isHeadcounter, DateTime? lastCheckedInAt, int? checkInCount, DateTime? createdAt, DateTime? updatedAt, bool? isPassedBackgroundCheck, String? demographicAvatarUrl, String? name, String? topPermission, String? searchName, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded}): Create a new PcoCheckInsPerson object. This object cannot be created with the API
factory
PcoCheckInsPerson.empty(): Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoCheckInsPerson.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

addresses → List: no setter
api → PlanningCenter: planning center resources must be tied to an api
no setterinherited
apiEndpoint → String: no setterinherited
apiPath → String: PcoResources include their own path as a link object but this might be null if we haven't created/fetched the object yet Child classes should redefine this getter to allow for manual path overrides
no setteroverride
apiVersion → String: child classes can override these getters which will allow methods in this class to see static variables from child classes
no setteroverride
attributes → ReadOnlyMapView<String, dynamic>: contains the underlying attributes returned by the api and allows a user to access arbitrary data in the attributes by actual api name
no setterinherited
avatarUrl → String: no setter
birthdate → String: no setter
canCreate → bool: no setteroverride
canDestroy → bool: no setteroverride
canUpdate → bool: no setteroverride
checkInCount → int: no setter
createAllowed → List<String>: no setteroverride
createdAt → DateTime: no setterinherited
createPathTemplate → String: no setteroverride
defaultPathTemplate → String: no setteroverride
demographicAvatarUrl → String: no setter
emailAddresses → List: no setter
fetched ↔ bool: indicate whether an item is full or partial
getter/setter pairinherited
firstName → String: no setter
gender → String: no setter
grade → int: no setter
hashCode → int: The hash code for this object.
no setterinherited
id → String?: no setterinherited
included → List<PcoResource>: contains included items parsed into objects
no setterinherited
includedOrganization → PcoCheckInsOrganization?: no setter
isChild → bool: no setter
isHeadcounter → bool: no setter
isPassedBackgroundCheck → bool: no setter
lastCheckedInAt → DateTime: no setter
lastName → String: no setter
links → ReadOnlyMapView<String, dynamic>: contains the links data returned by the api if present
no setterinherited
medicalNotes → String: no setter
middleName → String: no setter
name → String: no setter
namePrefix → String: no setter
nameSuffix → String: no setter
needsSave → bool: no setterinherited
pcoApplication ↔ String: latefinalinherited
permission → String: no setter
phoneNumbers → List: no setter
relationships → ReadOnlyMapView<String, List<PcoResource>>: contains relationships parsed into objects even though the api sends relationship objects as Maps or Lists we always put them into lists for consistency
no setterinherited
resourceType ↔ String: all planning center resources must have a type
latefinalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
searchName → String: no setter
slug → String: no setterinherited
topPermission → String: no setter
updateAllowed → List<String>: no setteroverride
updatedAt → DateTime: no setterinherited

Methods

coerceDouble(dynamic a) → double: inherited
coerceInt(dynamic a) → int: inherited
delete() → Future<PlanningCenterApiResponse<PlanningCenterApiData>>: inherited
filteredAttributes(List<String> allowedKeys) → Map<String, dynamic>: inherited
fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded}) → dynamic: Takes a full JSON:API Response Object (the contents of a "data" field) will clear and update id, apiPath, attributes and _relationships
inherited
getCheckIns({PcoCheckInsCheckInQuery? query}) → Future<PcoCollection<PcoCheckInsCheckIn>>: Will get a collection of PcoCheckInsCheckIn objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/people/1/check_ins
getOrganization({PcoCheckInsOrganizationQuery? query}) → Future<PcoCollection<PcoCheckInsOrganization>>: Will get a collection of PcoCheckInsOrganization objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/people/1/organization
getPasses({PcoCheckInsPassQuery? query}) → Future<PcoCollection<PcoCheckInsPass>>: Will get a collection of PcoCheckInsPass objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/people/1/passes
getPersonEvents({PcoCheckInsPersonEventQuery? query}) → Future<PcoCollection<PcoCheckInsPersonEvent>>: Will get a collection of PcoCheckInsPersonEvent objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/people/1/person_events
handleIncludes(List<Map<String, dynamic>> included) → void: This function populates the relationships with typed resource objects based on the data in the included map of the json.
inherited
handleItem(Map<String, dynamic> data) → PcoResource?: inherited
handleRelationships(Map<String, dynamic> items, [List<Map<String, dynamic>> included = const []]) → Map<String, List<PcoResource>>: inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
save({Map<String, PcoResource>? withRelated, List<PcoResource>? withIncluded}) → Future<PlanningCenterApiResponse<PlanningCenterApiData>>: Many Planning Center endpoints allow or require additional relationships and/or included items to be sent with a create/update operation. Since these cannot always be determined by the automatic code generation, they may be included as arguments to the save operation.
inherited
toCreateResource() → Map<String, dynamic>: create the attributes Map for this object without the id field using only the attributes allowed in create (post) operations
inherited
toDataMap({Map<String, PcoResource>? withRelated, List<PcoResource>? withIncluded}) → Map<String, dynamic>: create a json-api Map for this object automatically selecting create or update based on the existence of the id field. Will result in something like this:
inherited
toIdResource() → Map<String, dynamic>: returns the simplest representation of this resource with only the type and the id:
inherited
toJson({dynamic includeAttributes = true, dynamic includeRelationships = false}) → Map<String, dynamic>: Some api requests only want the type and id of an object. In those cases, set includeAttributes to false or call toIdResource instead.
inherited
toString() → String: A string representation of this object.
inherited
toUpdateResource() → Map<String, dynamic>: create the attributes Map for this object using only the attributes allowed in update (patch) operations
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

canInclude → List<String>: possible includes with parameter ?include=a,b
no setter
canOrderBy → List<String>: possible orderings with parameter ?order=
no setter
canQuery → List<String>: possible queries using parameters like ?wherekey=value or ?wheregt|lt=value
no setter

Static Methods

get({String? id, PcoCheckInsPersonQuery? query, bool getAll = false, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection of PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/people
getAll({String? id, PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection containing ALL PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/people
getAllCheckedInByFromCheckIn(String checkInId, {String? id, PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection containing ALL PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/checked_in_by
getAllCheckedOutByFromCheckIn(String checkInId, {String? id, PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection containing ALL PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/checked_out_by
getAllFromCheckIn(String checkInId, {String? id, PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection containing ALL PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/person
getAllFromEventAndPersonEvent(String eventId, String personEventId, {String? id, PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection containing ALL PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/events/$eventId/person_events/$personEventId/person
getAllFromPass(String passId, {String? id, PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection containing ALL PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/passes/$passId/person
getCheckedInByFromCheckIn(String checkInId, {String? id, PcoCheckInsPersonQuery? query, bool getAll = false, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection of PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/checked_in_by
getCheckedOutByFromCheckIn(String checkInId, {String? id, PcoCheckInsPersonQuery? query, bool getAll = false, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection of PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/checked_out_by
getFromCheckIn(String checkInId, {String? id, PcoCheckInsPersonQuery? query, bool getAll = false, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection of PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/person
getFromEventAndPersonEvent(String eventId, String personEventId, {String? id, PcoCheckInsPersonQuery? query, bool getAll = false, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection of PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/events/$eventId/person_events/$personEventId/person
getFromPass(String passId, {String? id, PcoCheckInsPersonQuery? query, bool getAll = false, bool includeOrganization = false}) → Future<PcoCollection<PcoCheckInsPerson>>: Will get a PcoCollection of PcoCheckInsPerson objects (expecting many) using a path like this: /check-ins/v2/passes/$passId/person
getSingle(String id, {PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCheckInsPerson?>: Will get a single PcoCheckInsPerson object using a path like this: /check-ins/v2/people/[id]
getSingleCheckedInByFromCheckIn(String checkInId, String id, {PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCheckInsPerson?>: Will get a single PcoCheckInsPerson object using a path like this: /check-ins/v2/check_ins/$checkInId/checked_in_by/[id]
getSingleCheckedOutByFromCheckIn(String checkInId, String id, {PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCheckInsPerson?>: Will get a single PcoCheckInsPerson object using a path like this: /check-ins/v2/check_ins/$checkInId/checked_out_by/[id]
getSingleFromCheckIn(String checkInId, String id, {PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCheckInsPerson?>: Will get a single PcoCheckInsPerson object using a path like this: /check-ins/v2/check_ins/$checkInId/person/[id]
getSingleFromEventAndPersonEvent(String eventId, String personEventId, String id, {PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCheckInsPerson?>: Will get a single PcoCheckInsPerson object using a path like this: /check-ins/v2/events/$eventId/person_events/$personEventId/person/[id]
getSingleFromPass(String passId, String id, {PcoCheckInsPersonQuery? query, bool includeOrganization = false}) → Future<PcoCheckInsPerson?>: Will get a single PcoCheckInsPerson object using a path like this: /check-ins/v2/passes/$passId/person/[id]

Constants

kAddresses → const String
kApiVersion → const String
kAvatarUrl → const String
kBirthdate → const String
kCheckInCount → const String
kChild → const String
kCreatedAt → const String
kCreatePathTemplate → const String
kDefaultPathTemplate → const String
kDemographicAvatarUrl → const String
kEmailAddresses → const String
kFirstName → const String
kGender → const String
kGrade → const String
kHeadcounter → const String
kId → const String
kLastCheckedInAt → const String
kLastName → const String
kMedicalNotes → const String
kMiddleName → const String
kName → const String
kNamePrefix → const String
kNameSuffix → const String
kPassedBackgroundCheck → const String
kPcoApplication → const String
kPermission → const String
kPhoneNumbers → const String
kSearchName → const String
kTopPermission → const String
kTypeId → const String
kTypeString → const String
kUpdatedAt → const String