| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | MediaSchedule |
| TypeScript | Services.MediaSchedule, attributes Services.MediaScheduleAttributes, schema Services.MediaScheduleSchema |
| Planning Center path | /services/v2/media/{media_id}/media_schedules |
| Planning Center docs | MediaSchedule |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.media.id(mediaId).media_schedules |
Collection | No |
From a collection, .id(mediaScheduleId) addresses one MediaSchedule: pco.services.media.id(mediaId).media_schedules.id(mediaScheduleId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.MediaScheduleAttributes. Every resource also has id and type ('MediaSchedule') next to its attributes.
| Name | Type | Description |
|---|---|---|
plan_dates |
string | null |
|
plan_short_dates |
string | null |
|
plan_sort_date |
string | null |
|
service_type_name |
string | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
plan |
To one | Plan | No |
service_type |
To one | ServiceType | No |
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Services } from '@mackenly/planningcenterkit';
const mediaId = '1'; // Media id
const page = await pco.services.media.id(mediaId).media_schedules.perPage(25).list();
const items: Services.MediaSchedule[] = page.data;