Used to get the status of an in progress songbook action. When FINISHED, will contain the url of the songbook.
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | SongbookStatus |
| TypeScript | Services.SongbookStatus, attributes Services.SongbookStatusAttributes, schema Services.SongbookStatusSchema |
| Planning Center path | /services/v2 |
| Planning Center docs | SongbookStatus |
How to reach it
No documented path leads to this resource. It may appear in included or as a relationship of other resources; use pco.request() for undocumented endpoints.
Attributes
On Services.SongbookStatusAttributes. Every resource also has id and type ('SongbookStatus') next to its attributes.
| Name | Type | Description |
|---|---|---|
status |
string | null |
|
status_code |
string | null |
|
status_token |
string | null |
|
url |
string | null |
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';
function describe(resource: Services.SongbookStatus): string {
return `${resource.type} ${resource.id}`;
}