Plan

The full date string representing all Service Time dates.

A date 15 days after the last service time. Returns in the time zone specified in your organization's localization settings

The total number of items, including regular items, songs, media, and headers, that the current user can see in the plan.

Returns in the time zone specified in your organization's localization settings

The current user's permissions for this plan's Service Type.

True if Public Access has been enabled.

True if the plan is currently auto-published because the Service Type has scheduled publish enabled and the plan's service date has arrived in the organization's timezone.

The shortened date string representing all Service Time dates. Months are abbreviated, and the year is omitted.

A time representing the chronological first Service Time, used to sort plan chronologically. If no Service Times exist, it uses Rehearsal Times, then Other Times, then NOW. Returns in the time zone specified in your organization's localization settings

The total of length of all items, excluding pre-service and post-service items.

include associated contributors

include associated my_schedules

include associated plan_times

include associated series

prefix with a hyphen (-created_at) to reverse the order

prefix with a hyphen (-sort_date) to reverse the order

prefix with a hyphen (-title) to reverse the order

prefix with a hyphen (-updated_at) to reverse the order

Query on a specific created_at

Query on a specific id

Query on a specific series_title

Query on a specific title

Query on a specific updated_at

how many records to return per page (min=1, max=100, default=25)

get results from given offset

Auto-schedule for a team. Returns a collection of scheduled PlanPersonAutoscheduleVertex

Auto-schedule for a team. Returns a collection of scheduled PlanPersonAutoscheduleVertex.

It expects a POST body with a Team relationship. json { "data": { "type": "Autoschedule", "attributes": {}, "relationship": { "team": { "data": { "id": 1, "type": 'Team' } } } } }

Apply a Plan or PlanTemplate to this Plan

This action copies the team members, needed positions, items, and notes from a source Plan or PlanTemplate into this (already existing) Plan.

Accepted attributes: - source_id (Integer) ID of the PlanTemplate or Plan to copy from.

• additional_target_ids (Array[Integer]) IDs of other Plans to apply the source to. These are imported asynchronously. (default nil)

• copy_items (Boolean) Copy Items from the source. Requires editor permissions. (default false)

• copy_people (Boolean) Copy team members and needed positions from the source. (default false)

• copy_notes (Boolean) Copy Notes from the source. Requires editor permissions. (default false)

• team_ids (Array[Integer]) IDs of teams to copy people from when copy_people is set to true. If nil, copy_people copies from all teams. (default nil)

Permissions: requires scheduler on the target plan's service type (and on every additional_target_ids plan's service type). Schedulers may only copy people for teams they lead; copy_items and copy_notes require editor permissions.

Returns a PlanImportMetadata resource describing the outcome (e.g. whether any copied people were missing required background checks).

Reorder plan items in one request.

This can be used to reorder all items in a plan in one request.

It expects a POST body with a sequence of Item ids in order. E.G.

{
  "data": {
    "type": "PlanItemReorder",
    "attributes": {
      "sequence": [
        "5",
        "1",
        "3"
      ]
    }
  }
}

On success you will get back a 204 No Content.

• attachable_type

  filter attachments by their attachable_type as specified in the attachable_type parameter. Default: ["ServiceType", "Plan", "Item", "Media", "Song", "Arrangement", "Key"]. e.g. ?filter=attachable_type&attachable_type=Plan,ServiceType

• extensions

  filter to attachments with a file extension specified in the extensions parameter. e.g. ?filter=extensions&extensions=pdf,txt

• team

• confirmed
• not_archived
• not_declined
• not_deleted

• after

  filter to plans with a time beginning after the after parameter

• before

  filter to plans with a time beginning before the before parameter

• future
• no_dates
• past

• deleted