A single exception for the dates generated from the blockout
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | BlockoutException |
| TypeScript | Services.BlockoutException, attributes Services.BlockoutExceptionAttributes, schema Services.BlockoutExceptionSchema |
| Planning Center path | /services/v2/people/{person_id}/blockouts/{blockout_id}/blockout_exceptions |
| Planning Center docs | BlockoutException |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.people.id(personId).blockouts.id(blockoutId).blockout_exceptions |
Collection | Yes |
From a collection, .id(blockoutExceptionId) addresses one BlockoutException: pco.services.people.id(personId).blockouts.id(blockoutId).blockout_exceptions.id(blockoutExceptionId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.BlockoutExceptionAttributes. Every resource also has id and type ('BlockoutException') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
date |
string | null |
|
updated_at |
string | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
blockout |
To one | Blockout | No |
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on blockout_exceptions on Blockout |
| Update | No |
| Delete | No |
Create attributes
Typed as Services.BlockoutExceptionSchema['create'].
| Attribute | Type |
|---|---|
date |
string | null |
See Writing data.
Example
import type { Services } from '@mackenly/planningcenterkit';
const personId = '1'; // Person id
const blockoutId = '1'; // Blockout id
const page = await pco.services.people.id(personId).blockouts.id(blockoutId).blockout_exceptions.perPage(25).list();
const items: Services.BlockoutException[] = page.data;