PcoCheckInsCheckIn class
This class represents a PCO CheckIns CheckIn Object
- Application: check-ins
- Id: check_in
- Type: CheckIn
- ApiVersion: 2019-07-17
- Is Deprecated: false
- Is Collection Only: false
- Default Endpoint: https://api.planningcenteronline.com/check-ins/v2/check_ins
- Create Endpoint: NONE
Instantiation
- This object cannot be created through the API.
- Instantiate from existing
JSON
data using thePcoCheckInsCheckIn.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-onlyattributes
map. - Additional data is available through the read-only
links
andrelationships
maps. - Available relationships / includes are exposed through typed getters.
Description
An attendance record for an event.
If someone was checked out, checked_out_at
will be present.
You can scope check-ins in a few ways:
regular
s,guest
s, andvolunteer
s correspond to the option selected when checking in.attendee
s areregular
s andguest
s together.one_time_guest
s are check-ins which were created without a corresponding person record.not_one_time_guest
s are check-ins which had a corresponding person record when they were created.checked_out
are check-ins wherechecked_out_at
is present (meaning they were checked out from a station).first_time
s are check-ins which are the person's first for a given event. (Label-only visitors are not included here.)
Attributes (and permissions)
id
(ro) -> PCO:id
firstName
(ro) -> PCO:first_name
lastName
(ro) -> PCO:last_name
medicalNotes
(ro) -> PCO:medical_notes
number
(ro) -> PCO:number
securityCode
(ro) -> PCO:security_code
createdAt
(ro) -> PCO:created_at
updatedAt
(ro) -> PCO:updated_at
checkedOutAt
(ro) -> PCO:checked_out_at
confirmedAt
(ro) -> PCO:confirmed_at
emergencyContactName
(ro) -> PCO:emergency_contact_name
emergencyContactPhoneNumber
(ro) -> PCO:emergency_contact_phone_number
kind
(ro) -> PCO:kind
isConfirmed
(ro) -> PCO:confirmed
Edges and Actions
Outbound Edges:
checkingroup-checkin-check_in_group
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/check_in_groupcheckintime-checkin-check_in_times
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/check_in_timesstation-checkin-checked_in_at
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/checked_in_atperson-checkin-checked_in_by
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/checked_in_byperson-checkin-checked_out_by
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/checked_out_byevent-checkin-event
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/eventeventperiod-checkin-event_period
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/event_periodeventtime-checkin-event_times
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/event_timeslocation-checkin-locations
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locationsoption-checkin-options
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/optionsperson-checkin-person
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/person
Inbound Edges:
checkin-checkingroup-check_ins
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/check_in_group/1/check_inscheckin-event-check_ins
: https://api.planningcenteronline.com/check-ins/v2/events/1/check_inscheckin-eventperiod-check_ins
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/event_period/1/check_inscheckin-eventtime-check_ins
: https://api.planningcenteronline.com/check-ins/v2/event_times/1/check_inscheckin-location-check_ins
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations/1/check_inscheckin-locationeventperiod-check_ins
: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/event_period/1/location_event_periods/1/check_inscheckin-locationeventtime-check_ins
: https://api.planningcenteronline.com/check-ins/v2/event_times/1/location_event_times/1/check_inscheckin-option-check_ins
: https://api.planningcenteronline.com/check-ins/v2/options/1/check_inscheckin-organization-check_ins
: https://api.planningcenteronline.com/check-ins/v2/check_inscheckin-person-check_ins
: https://api.planningcenteronline.com/check-ins/v2/people/1/check_inscheckin-personevent-first_check_in
: https://api.planningcenteronline.com/check-ins/v2/events/1/person_events/1/first_check_incheckin-personevent-last_check_in
: https://api.planningcenteronline.com/check-ins/v2/events/1/person_events/1/last_check_incheckin-station-checked_in_at_check_ins
: https://api.planningcenteronline.com/check-ins/v2/stations/1/checked_in_at_check_ins
Actions: NONE
Raw Data Object Example
{
"type": "CheckIn",
"id": "1",
"attributes": {
"first_name": "string",
"last_name": "string",
"medical_notes": "string",
"number": 1,
"security_code": "string",
"created_at": "2000-01-01T12:00:00Z",
"updated_at": "2000-01-01T12:00:00Z",
"checked_out_at": "2000-01-01T12:00:00Z",
"confirmed_at": "2000-01-01T12:00:00Z",
"emergency_contact_name": "string",
"emergency_contact_phone_number": "string",
"kind": "string"
},
"relationships": {
"event_period": {
"data": {
"type": "EventPeriod",
"id": "1"
}
},
"person": {
"data": {
"type": "Person",
"id": "1"
}
}
}
}
- Inheritance
-
- Object
- PcoResource
- PcoCheckInsCheckIn
Constructors
-
PcoCheckInsCheckIn({String? id, String? firstName, String? lastName, String? medicalNotes, int? number, String? securityCode, DateTime? createdAt, DateTime? updatedAt, DateTime? checkedOutAt, DateTime? confirmedAt, String? emergencyContactName, String? emergencyContactPhoneNumber, String? kind, bool? isConfirmed, Map<
String, List< ? withRelationships, List<PcoResource> >PcoResource> ? withIncluded}) -
Create a new PcoCheckInsCheckIn object. This object cannot be created with the API
factory
- PcoCheckInsCheckIn.empty()
- Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
-
PcoCheckInsCheckIn.fromJson(Map<
String, dynamic> data, {List<Map< ? withIncluded})String, dynamic> >
Properties
- 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
- canCreate → bool
-
no setteroverride
- canDestroy → bool
-
no setteroverride
- canUpdate → bool
-
no setteroverride
- checkedOutAt → DateTime
-
no setter
- confirmedAt → DateTime
-
no setter
-
createAllowed
→ List<
String> -
no setteroverride
- createdAt → DateTime
-
no setterinherited
- createPathTemplate → String
-
no setteroverride
- defaultPathTemplate → String
-
no setteroverride
- emergencyContactName → String
-
no setter
- emergencyContactPhoneNumber → String
-
no setter
- fetched ↔ bool
-
indicate whether an item is full or partial
getter/setter pairinherited
- firstName → String
-
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
-
includedCheckInTimes
→ List<
PcoCheckInsCheckInTime> -
no setter
- includedEvent → PcoCheckInsEvent?
-
no setter
- includedEventPeriod → PcoCheckInsEventPeriod?
-
no setter
-
includedEventTimes
→ List<
PcoCheckInsEventTime> -
no setter
-
includedLocations
→ List<
PcoCheckInsLocation> -
no setter
-
includedOptions
→ List<
PcoCheckInsOption> -
no setter
- includedPerson → PcoCheckInsPerson?
-
no setter
- isConfirmed → bool
-
no setter
- kind → String
-
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
- needsSave → bool
-
no setterinherited
- number → int
-
no setter
- pcoApplication ↔ String
-
latefinalinherited
-
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
- securityCode → String
-
no setter
- slug → String
-
no setterinherited
-
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< ? withIncluded}) → dynamicString, dynamic> > -
Takes a full JSON:API Response Object (the contents of a "data" field)
will clear and update id, apiPath, attributes and
_relationships
inherited -
getCheckedInAt(
{PcoCheckInsStationQuery? query}) → Future< PcoCollection< PcoCheckInsStation> > -
Will get a collection of PcoCheckInsStation objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/checked_in_at
-
getCheckedInBy(
{PcoCheckInsPersonQuery? query}) → Future< PcoCollection< PcoCheckInsPerson> > -
Will get a collection of PcoCheckInsPerson objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/checked_in_by
-
getCheckedOutBy(
{PcoCheckInsPersonQuery? query}) → Future< PcoCollection< PcoCheckInsPerson> > -
Will get a collection of PcoCheckInsPerson objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/checked_out_by
-
getCheckInGroup(
{PcoCheckInsCheckInGroupQuery? query}) → Future< PcoCollection< PcoCheckInsCheckInGroup> > -
Will get a collection of PcoCheckInsCheckInGroup objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/check_in_group
-
getCheckInTimes(
{PcoCheckInsCheckInTimeQuery? query}) → Future< PcoCollection< PcoCheckInsCheckInTime> > -
Will get a collection of PcoCheckInsCheckInTime objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/check_in_times
-
getEvent(
{PcoCheckInsEventQuery? query}) → Future< PcoCollection< PcoCheckInsEvent> > -
Will get a collection of PcoCheckInsEvent objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/event
-
getEventPeriod(
{PcoCheckInsEventPeriodQuery? query}) → Future< PcoCollection< PcoCheckInsEventPeriod> > -
Will get a collection of PcoCheckInsEventPeriod objects (expecting one)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/event_period
-
getEventTimes(
{PcoCheckInsEventTimeQuery? query}) → Future< PcoCollection< PcoCheckInsEventTime> > -
Will get a collection of PcoCheckInsEventTime objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/event_times
-
getLocations(
{PcoCheckInsLocationQuery? query}) → Future< PcoCollection< PcoCheckInsLocation> > -
Will get a collection of PcoCheckInsLocation objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations
-
getOptions(
{PcoCheckInsOptionQuery? query}) → Future< PcoCollection< PcoCheckInsOption> > -
Will get a collection of PcoCheckInsOption objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/options
-
getPerson(
{PcoCheckInsPersonQuery? query}) → Future< PcoCollection< PcoCheckInsPerson> > -
Will get a collection of PcoCheckInsPerson objects (expecting one)
using a path like this:
https://api.planningcenteronline.com/check-ins/v2/check_ins/1/person
-
handleIncludes(
List< Map< included) → voidString, dynamic> > -
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< included = const []]) → Map<String, dynamic> >String, List< PcoResource> > -
inherited
-
includedCheckedInAt<
T extends PcoResource> () → List< T> - The code generator could not automatically determine the resource type of this relationship. For type safe code, you should specify it in the type argument when calling.
-
includedCheckedInBy<
T extends PcoResource> () → List< T> - The code generator could not automatically determine the resource type of this relationship. For type safe code, you should specify it in the type argument when calling.
-
includedCheckedOutBy<
T extends PcoResource> () → List< T> - The code generator could not automatically determine the resource type of this relationship. For type safe code, you should specify it in the type argument when calling.
-
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) operationsinherited -
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 ?where
key
=value or ?wheregt|lt
=valueno setter
Static Methods
-
get(
{String? id, PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/check_ins
-
getAll(
{String? id, PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/check_ins
-
getAllFromCheckInAndCheckInGroup(
String checkInId, String checkInGroupId, {String? id, PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/check_ins/$checkInId/check_in_group/$checkInGroupId/check_ins
-
getAllFromCheckInAndEventPeriod(
String checkInId, String eventPeriodId, {String? id, PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/check_ins
-
getAllFromCheckInAndEventPeriodAndLocationEventPeriod(
String checkInId, String eventPeriodId, String locationEventPeriodId, {String? id, PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/location_event_periods/$locationEventPeriodId/check_ins
-
getAllFromCheckInAndLocation(
String checkInId, String locationId, {String? id, PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/check_ins/$checkInId/locations/$locationId/check_ins
-
getAllFromEvent(
String eventId, {String? id, PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/events/$eventId/check_ins
-
getAllFromEventTime(
String eventTimeId, {String? id, PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/event_times/$eventTimeId/check_ins
-
getAllFromEventTimeAndLocationEventTime(
String eventTimeId, String locationEventTimeId, {String? id, PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/event_times/$eventTimeId/location_event_times/$locationEventTimeId/check_ins
-
getAllFromOption(
String optionId, {String? id, PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/options/$optionId/check_ins
-
getAllFromPerson(
String personId, {String? id, PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/people/$personId/check_ins
-
getCheckedInAtCheckInsFromStation(
String stationId, {PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting one) using a path like this:/check-ins/v2/stations/$stationId/checked_in_at_check_ins
-
getFirstCheckInFromEventAndPersonEvent(
String eventId, String personEventId, {PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting one) using a path like this:/check-ins/v2/events/$eventId/person_events/$personEventId/first_check_in
-
getFromCheckInAndCheckInGroup(
String checkInId, String checkInGroupId, {String? id, PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/check_ins/$checkInId/check_in_group/$checkInGroupId/check_ins
-
getFromCheckInAndEventPeriod(
String checkInId, String eventPeriodId, {String? id, PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/check_ins
-
getFromCheckInAndEventPeriodAndLocationEventPeriod(
String checkInId, String eventPeriodId, String locationEventPeriodId, {String? id, PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/location_event_periods/$locationEventPeriodId/check_ins
-
getFromCheckInAndLocation(
String checkInId, String locationId, {String? id, PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/check_ins/$checkInId/locations/$locationId/check_ins
-
getFromEvent(
String eventId, {String? id, PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/events/$eventId/check_ins
-
getFromEventTime(
String eventTimeId, {String? id, PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/event_times/$eventTimeId/check_ins
-
getFromEventTimeAndLocationEventTime(
String eventTimeId, String locationEventTimeId, {String? id, PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/event_times/$eventTimeId/location_event_times/$locationEventTimeId/check_ins
-
getFromOption(
String optionId, {String? id, PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/options/$optionId/check_ins
-
getFromPerson(
String personId, {String? id, PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting many) using a path like this:/check-ins/v2/people/$personId/check_ins
-
getLastCheckInFromEventAndPersonEvent(
String eventId, String personEventId, {PcoCheckInsCheckInQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCollection< PcoCheckInsCheckIn> > -
Will get a
PcoCollection
of PcoCheckInsCheckIn objects (expecting one) using a path like this:/check-ins/v2/events/$eventId/person_events/$personEventId/last_check_in
-
getSingle(
String id, {PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCheckInsCheckIn?> -
Will get a single
PcoCheckInsCheckIn
object using a path like this:/check-ins/v2/check_ins/[id]
-
getSingleFromCheckInAndCheckInGroup(
String checkInId, String checkInGroupId, String id, {PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCheckInsCheckIn?> -
Will get a single
PcoCheckInsCheckIn
object using a path like this:/check-ins/v2/check_ins/$checkInId/check_in_group/$checkInGroupId/check_ins/[id]
-
getSingleFromCheckInAndEventPeriod(
String checkInId, String eventPeriodId, String id, {PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCheckInsCheckIn?> -
Will get a single
PcoCheckInsCheckIn
object using a path like this:/check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/check_ins/[id]
-
getSingleFromCheckInAndEventPeriodAndLocationEventPeriod(
String checkInId, String eventPeriodId, String locationEventPeriodId, String id, {PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCheckInsCheckIn?> -
Will get a single
PcoCheckInsCheckIn
object using a path like this:/check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/location_event_periods/$locationEventPeriodId/check_ins/[id]
-
getSingleFromCheckInAndLocation(
String checkInId, String locationId, String id, {PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCheckInsCheckIn?> -
Will get a single
PcoCheckInsCheckIn
object using a path like this:/check-ins/v2/check_ins/$checkInId/locations/$locationId/check_ins/[id]
-
getSingleFromEvent(
String eventId, String id, {PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCheckInsCheckIn?> -
Will get a single
PcoCheckInsCheckIn
object using a path like this:/check-ins/v2/events/$eventId/check_ins/[id]
-
getSingleFromEventTime(
String eventTimeId, String id, {PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCheckInsCheckIn?> -
Will get a single
PcoCheckInsCheckIn
object using a path like this:/check-ins/v2/event_times/$eventTimeId/check_ins/[id]
-
getSingleFromEventTimeAndLocationEventTime(
String eventTimeId, String locationEventTimeId, String id, {PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCheckInsCheckIn?> -
Will get a single
PcoCheckInsCheckIn
object using a path like this:/check-ins/v2/event_times/$eventTimeId/location_event_times/$locationEventTimeId/check_ins/[id]
-
getSingleFromOption(
String optionId, String id, {PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCheckInsCheckIn?> -
Will get a single
PcoCheckInsCheckIn
object using a path like this:/check-ins/v2/options/$optionId/check_ins/[id]
-
getSingleFromPerson(
String personId, String id, {PcoCheckInsCheckInQuery? query, bool includeAllRelated = false, bool includeCheckInTimes = false, bool includeCheckedInAt = false, bool includeCheckedInBy = false, bool includeCheckedOutBy = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeEventTimes = false, bool includeLocations = false, bool includeOptions = false, bool includePerson = false}) → Future< PcoCheckInsCheckIn?> -
Will get a single
PcoCheckInsCheckIn
object using a path like this:/check-ins/v2/people/$personId/check_ins/[id]
Constants
- kApiVersion → const String
- kCheckedOutAt → const String
- kConfirmed → const String
- kConfirmedAt → const String
- kCreatedAt → const String
- kCreatePathTemplate → const String
- kDefaultPathTemplate → const String
- kEmergencyContactName → const String
- kEmergencyContactPhoneNumber → const String
- kFirstName → const String
- kId → const String
- kKind → const String
- kLastName → const String
- kMedicalNotes → const String
- kNumber → const String
- kPcoApplication → const String
- kSecurityCode → const String
- kTypeId → const String
- kTypeString → const String
- kUpdatedAt → const String