TimePreferenceOption - Services API

Example Request

curl https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/time_preference_options

View in API Explorer →

Example Object

{
  "type": "TimePreferenceOption",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "day_of_week": 1,
    "description": "string",
    "minute_of_day": 1,
    "sort_index": "string",
    "starts_at": "2000-01-01T12:00:00Z",
    "time_type": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`created_at`	`date_time`
`day_of_week`	`integer`
`description`	`string`
`id`	`primary_key`
`minute_of_day`	`integer`	0 for 12:00 am, 1 for 12:01 am, 100 for 1:00 am, through 2359 for 11:59pm
`sort_index`	`string`
`starts_at`	`date_time`
`time_type`	`string`
`updated_at`	`date_time`

Order By

Parameter	Value	Type	Description
order	day_of_week	string	prefix with a hyphen (-day_of_week) to reverse the order
order	hour_of_day	string	prefix with a hyphen (-hour_of_day) to reverse the order

Pagination

Name	Parameter	Type	Description
per_page	per_page	integer	how many records to return per page (min=1, max=100, default=25)
offset	offset	integer	get results from given offset

Endpoints

Listing

HTTP Method	Endpoint
GET	`/services/v2/service_types/{service_type_id}/time_preference_options`

Reading

HTTP Method	Endpoint
GET	`/services/v2/service_types/{service_type_id}/time_preference_options/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/time_preference_options`	ServiceType