Namespace Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Classes

AttendanceType: Attributes for the AttendanceType resource.

AttendanceTypeClient: Client for interacting with the AttendanceType resource.

AttendanceTypeCollectionResponse: Collection Response model for AttendanceType resource.

AttendanceTypeRelationships: Relationships for the AttendanceType resource.

AttendanceTypeResource: A kind of attendee which is tracked by headcount, not by check-in.

AttendanceTypeResponse: Response model for AttendanceType resource.

CheckIn: Attributes for the CheckIn resource.

CheckInClient: Client for interacting with the CheckIn resource.

CheckInCollectionResponse: Collection Response model for CheckIn resource.

CheckInGroup: Attributes for the CheckInGroup resource.

CheckInGroupClient: Client for interacting with the CheckInGroup resource.

CheckInGroupCollectionResponse: Collection Response model for CheckInGroup resource.

CheckInGroupResource: When one or more people check in, they're grouped in a CheckInGroup.
These check-ins all have the same "checked-in by" person.

CheckInGroupResponse: Response model for CheckInGroup resource.

CheckInRelationships: Relationships for the CheckIn resource.

CheckInResource: 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:

- regulars, guests, and volunteers correspond to the option selected when checking in.
- attendees are regulars and guests together.
- one_time_guests are check-ins which were created without a corresponding person record.
- not_one_time_guests are check-ins which had a corresponding person record when they were created.
- checked_out are check-ins where checked_out_at is present (meaning they were checked out from a station).
- first_times are check-ins which are the person's first for a given event. (Label-only visitors are not included here.)

CheckInResponse: Response model for CheckIn resource.

CheckInTime: Attributes for the CheckInTime resource.

CheckInTimeClient: Client for interacting with the CheckInTime resource.

CheckInTimeCollectionResponse: Collection Response model for CheckInTime resource.

CheckInTimeRelationships: Relationships for the CheckInTime resource.

CheckInTimeResource: A CheckInTime combines an EventTime and a Location, and associates it with
the parent CheckIn.

CheckInTimeResponse: Response model for CheckInTime resource.

Event: Attributes for the Event resource.

EventClient: Client for interacting with the Event resource.

EventCollectionResponse: Collection Response model for Event resource.

EventLabel: Attributes for the EventLabel resource.

EventLabelClient: Client for interacting with the EventLabel resource.

EventLabelCollectionResponse: Collection Response model for EventLabel resource.

EventLabelResource: Says how many of a given label to print for this event and
whether to print it for regulars, guests, and/or volunteers.

EventLabelResponse: Response model for EventLabel resource.

EventPeriod: Attributes for the EventPeriod resource.

EventPeriodClient: Client for interacting with the EventPeriod resource.

EventPeriodCollectionResponse: Collection Response model for EventPeriod resource.

EventPeriodRelationships: Relationships for the EventPeriod resource.

EventPeriodResource: A recurrence of an event, sometimes called a "session".
For weekly events, an event period is a week. For daily events, an event period is a day.
An event period has event times, which is what people select
when they actually check in. When new sessions are created, times
are copied from one session to the next.

EventPeriodResponse: Response model for EventPeriod resource.

EventRelationships: Relationships for the Event resource.

EventResource: A recurring event which people may attend.

Each recurrence is an event period (which often corresponds to a week).

Event periods have event times where people may actually check in.

EventResponse: Response model for Event resource.

EventTime: Attributes for the EventTime resource.

EventTimeClient: Client for interacting with the EventTime resource.

EventTimeCollectionResponse: Collection Response model for EventTime resource.

EventTimeRelationships: Relationships for the EventTime resource.

EventTimeResource: A time that someone may check in. Times are copied from session to session.

EventTimeResponse: Response model for EventTime resource.

Headcount: Attributes for the Headcount resource.

HeadcountClient: Client for interacting with the Headcount resource.

HeadcountCollectionResponse: Collection Response model for Headcount resource.

HeadcountRelationships: Relationships for the Headcount resource.

HeadcountResource: A tally of attendees for a given event time and attendance type.
If one does not exist, the count may have been zero.

HeadcountResponse: Response model for Headcount resource.

IntegrationLink: Attributes for the IntegrationLink resource.

IntegrationLinkClient: Client for interacting with the IntegrationLink resource.

IntegrationLinkCollectionResponse: Collection Response model for IntegrationLink resource.

IntegrationLinkRelationships: Relationships for the IntegrationLink resource.

IntegrationLinkResource: A record linking another product's resource to a Check-Ins resource.

IntegrationLinkResponse: Response model for IntegrationLink resource.

Label: Attributes for the Label resource.

LabelClient: Client for interacting with the Label resource.

LabelCollectionResponse: Collection Response model for Label resource.

LabelResource: Labels can be set to print for events (through EventLabels),
locations (through LocationLabels) or options.
Label type (security label / name label) is expressed with the
prints_for attribute. prints_for="Person" is a name label,
prints_for="Group" is a security label.

LabelResponse: Response model for Label resource.

Location: Attributes for the Location resource.

LocationClient: Client for interacting with the Location resource.

LocationCollectionResponse: Collection Response model for Location resource.

LocationEventPeriod: Attributes for the LocationEventPeriod resource.

LocationEventPeriodClient: Client for interacting with the LocationEventPeriod resource.

LocationEventPeriodCollectionResponse: Collection Response model for LocationEventPeriod resource.

LocationEventPeriodResource: Counts check-ins for a location during a certain event period.

LocationEventPeriodResponse: Response model for LocationEventPeriod resource.

LocationEventTime: Attributes for the LocationEventTime resource.

LocationEventTimeClient: Client for interacting with the LocationEventTime resource.

LocationEventTimeCollectionResponse: Collection Response model for LocationEventTime resource.

LocationEventTimeResource: Counts check-ins for a location for a given event time.
This is useful for checking occupancy.

LocationEventTimeResponse: Response model for LocationEventTime resource.

LocationLabel: Attributes for the LocationLabel resource.

LocationLabelClient: Client for interacting with the LocationLabel resource.

LocationLabelCollectionResponse: Collection Response model for LocationLabel resource.

LocationLabelResource: Says how many of a given label to print for this location and
whether to print it for regulars, guests, and/or volunteers.

LocationLabelResponse: Response model for LocationLabel resource.

LocationRelationships: Relationships for the Location resource.

LocationResource: A place where people may check in to for a given event.
Some locations have kind="Folder", which means that people
can't check-in here, but this location contains other locations.
You can get its contents from the locations attribute.
You can get a location's parent folder from the parent attribute.
(If it's not in a folder, parent will be empty.)

LocationResponse: Response model for Location resource.

Option: Attributes for the Option resource.

OptionClient: Client for interacting with the Option resource.

OptionCollectionResponse: Collection Response model for Option resource.

OptionResource: An option which an attendee may select when checking in.

Options may have extra labels associated with them, denoted by label and quantity.

OptionResponse: Response model for Option resource.

Organization: Attributes for the Organization resource.

OrganizationClient: Client for interacting with the Organization resource.

OrganizationCollectionResponse: Collection Response model for Organization resource.

OrganizationResource: An organization which has people and events.
This contains its date format & time zone preferences.

OrganizationResponse: Response model for Organization resource.

PaginatedAttendanceTypeClient: Client for interacting with AttendanceType collection resources.

PaginatedCheckInClient: Client for interacting with CheckIn collection resources.

PaginatedCheckInGroupClient: Client for interacting with CheckInGroup collection resources.

PaginatedCheckInTimeClient: Client for interacting with CheckInTime collection resources.

PaginatedEventClient: Client for interacting with Event collection resources.

PaginatedEventLabelClient: Client for interacting with EventLabel collection resources.

PaginatedEventPeriodClient: Client for interacting with EventPeriod collection resources.

PaginatedEventTimeClient: Client for interacting with EventTime collection resources.

PaginatedHeadcountClient: Client for interacting with Headcount collection resources.

PaginatedIntegrationLinkClient: Client for interacting with IntegrationLink collection resources.

PaginatedLabelClient: Client for interacting with Label collection resources.

PaginatedLocationClient: Client for interacting with Location collection resources.

PaginatedLocationEventPeriodClient: Client for interacting with LocationEventPeriod collection resources.

PaginatedLocationEventTimeClient: Client for interacting with LocationEventTime collection resources.

PaginatedLocationLabelClient: Client for interacting with LocationLabel collection resources.

PaginatedOptionClient: Client for interacting with Option collection resources.

PaginatedOrganizationClient: Client for interacting with Organization collection resources.

PaginatedPassClient: Client for interacting with Pass collection resources.

PaginatedPersonClient: Client for interacting with Person collection resources.

PaginatedPersonEventClient: Client for interacting with PersonEvent collection resources.

PaginatedPreCheckClient: Client for interacting with PreCheck collection resources.

PaginatedRosterListPersonClient: Client for interacting with RosterListPerson collection resources.

PaginatedStationClient: Client for interacting with Station collection resources.

PaginatedThemeClient: Client for interacting with Theme collection resources.

Pass: Attributes for the Pass resource.

PassClient: Client for interacting with the Pass resource.

PassCollectionResponse: Collection Response model for Pass resource.

PassResource: Enables quick lookup of a person via barcode reader.

PassResponse: Response model for Pass resource.

Person: Attributes for the Person resource.

PersonClient: Client for interacting with the Person resource.

PersonCollectionResponse: Collection Response model for Person resource.

PersonEvent: Attributes for the PersonEvent resource.

PersonEventClient: Client for interacting with the PersonEvent resource.

PersonEventCollectionResponse: Collection Response model for PersonEvent resource.

PersonEventResource: Counts a person's attendence for a given event.

PersonEventResponse: Response model for PersonEvent resource.

PersonResource: 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)

PersonResponse: Response model for Person resource.

PreCheck: Attributes for the PreCheck resource.

PreCheckClient: Client for interacting with the PreCheck resource.

PreCheckCollectionResponse: Collection Response model for PreCheck resource.

PreCheckResource: Planning Center does not provide a description for this resource.

PreCheckResponse: Response model for PreCheck resource.

RosterListPerson: Attributes for the RosterListPerson resource.

RosterListPersonClient: Client for interacting with the RosterListPerson resource.

RosterListPersonCollectionResponse: Collection Response model for RosterListPerson resource.

RosterListPersonResource: Planning Center does not provide a description for this resource.

RosterListPersonResponse: Response model for RosterListPerson resource.

Station: Attributes for the Station resource.

StationClient: Client for interacting with the Station resource.

StationCollectionResponse: Collection Response model for Station resource.

StationResource: A device where people can be checked in.
A device may also be connected to a printer
and print labels for itself or other stations.

StationResponse: Response model for Station resource.

Theme: Attributes for the Theme resource.

ThemeClient: Client for interacting with the Theme resource.

ThemeCollectionResponse: Collection Response model for Theme resource.

ThemeResource: A custom style which may be applied to stations.

ThemeResponse: Response model for Theme resource.

Table of Contents

Namespace Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Classes