Option
An option which an attendee may select when checking in.
Options may have extra labels associated with them, denoted by label and quantity.
Example Object
{
"type": "Option",
"id": "1",
"attributes": {
"body": "string",
"created_at": "2000-01-01T12:00:00Z",
"quantity": 1,
"updated_at": "2000-01-01T12:00:00Z"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
body |
string |
|
created_at |
date_time |
|
id |
primary_key |
|
quantity |
integer |
|
updated_at |
date_time |
|
Can Include
| Parameter |
Value |
Description |
Assignable |
| include |
label |
include associated label |
|
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 |
/check-ins/v2/options |
Reading
| HTTP Method |
Endpoint |
| GET |
/check-ins/v2/options/{id} |
Associations
| HTTP Method |
Endpoint |
Returns |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/check-ins/v2/options/{option_id}/check_ins |
CheckIn
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/options/{option_id}/label |
Label
|
|
|
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/options |
CheckIn
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/options |
Location
|
|
|
| GET |
https://api.planningcenteronline.com/check-ins/v2/options |
Organization
|
|
|