Skip to content

SplitTeamRehearsalAssignment (Services)

For Rehearsal/Other Times, maps a Split Team to selected Time Preference Options.

For Rehearsal/Other Times, maps a Split Team to selected Time Preference Options. For example, used to assign 8am Ushers to 7:30am call time, and 11am Ushers to 10:30am call time.

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type SplitTeamRehearsalAssignment
TypeScript Services.SplitTeamRehearsalAssignment, attributes Services.SplitTeamRehearsalAssignmentAttributes, schema Services.SplitTeamRehearsalAssignmentSchema
Planning Center path /services/v2/service_types/{service_type_id}/plan_times/{plan_time_id}/split_team_rehearsal_assignments
Planning Center docs SplitTeamRehearsalAssignment

How to reach it

Client path Returns Filters Create
pco.services.service_types.id(serviceTypeId).plan_times.id(planTimeId).split_team_rehearsal_assignments Collection Yes

From a collection, .id(splitTeamRehearsalAssignmentId) addresses one SplitTeamRehearsalAssignment: pco.services.service_types.id(serviceTypeId).plan_times.id(planTimeId).split_team_rehearsal_assignments.id(splitTeamRehearsalAssignmentId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Services.SplitTeamRehearsalAssignmentAttributes. Every resource also has id and type ('SplitTeamRehearsalAssignment') next to its attributes.

Name Type Description
schedule_special_service_times boolean | null Controls if the related rehearsal/other time is assigned when a person is scheduled to a split team service time that does not match a Time Preference Option. This is the default for special service times; writing it clears any per-time choices.

Relationships and includes

Planning Center documents no includes for this resource.

Relationship Type To Includable
included_special_service_times To many PlanTime No
team To one Team No
time_preference_options To many TimePreferenceOption No

Querying

No documented where fields.

No documented order fields.

Edges

Follow these from one SplitTeamRehearsalAssignment, ref = pco.services.service_types.id(serviceTypeId).plan_times.id(planTimeId).split_team_rehearsal_assignments.id(splitTeamRehearsalAssignmentId):

Edge Leads to Returns Filters Create
ref.team Team Collection No

Writing

Property Value
Create Yes, create() on split_team_rehearsal_assignments on PlanTime
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Services.SplitTeamRehearsalAssignmentSchema['create'].

Attribute Type
assigned_to unknown
included_special_service_times_ids string[]
schedule_special_service_times boolean | null
team_id string
time_preference_options_ids string[]

Update attributes

Typed as Services.SplitTeamRehearsalAssignmentSchema['update'].

Attribute Type
assigned_to unknown
included_special_service_times_ids string[]
schedule_special_service_times boolean | null
team_id string
time_preference_options_ids string[]

See Writing data.

Example

import type { Services } from '@mackenly/planningcenterkit';

const serviceTypeId = '1'; // ServiceType id
const planTimeId = '1'; // PlanTime id

const page = await pco.services.service_types.id(serviceTypeId).plan_times.id(planTimeId).split_team_rehearsal_assignments.perPage(25).list();
const items: Services.SplitTeamRehearsalAssignment[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close