Station
A device where people can be checked in. A device may also be connected to a printer and print labels for itself or other stations.
Example Request
curl https://api.planningcenteronline.com/check-ins/v2/stations
Example Object
{
"type": "Station",
"id": "1",
"attributes": {
"check_in_count": 1,
"closes_at": "2000-01-01T12:00:00Z",
"created_at": "2000-01-01T12:00:00Z",
"input_type": "value",
"input_type_options": "value",
"mode": 1,
"name": "string",
"next_shows_at": "2000-01-01T12:00:00Z",
"online": true,
"open_for_check_in": true,
"timeout_seconds": 1,
"updated_at": "2000-01-01T12:00:00Z"
},
"relationships": {}
}
Attributes
| Name | Type | Description |
|---|---|---|
check_in_count |
integer |
Only available when requested with the |
closes_at |
date_time |
Only available when requested with the |
created_at |
date_time |
|
id |
primary_key |
|
input_type |
string |
Possible values: |
input_type_options |
string |
Possible values: |
mode |
integer |
|
name |
string |
|
next_shows_at |
date_time |
Only available when requested with the |
online |
boolean |
Only available when requested with the |
open_for_check_in |
boolean |
Only available when requested with the |
timeout_seconds |
integer |
|
updated_at |
date_time |
Can Include
| Parameter | Value | Description | Assignable |
|---|---|---|---|
| include | event | include associated event |
|
| include | location | include associated location |
|
| include | print_station | include associated print_station |
|
| include | theme | include associated theme |
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/stations |
Reading
| HTTP Method | Endpoint |
|---|---|
| GET | /check-ins/v2/stations/{id} |
Associations
| HTTP Method | Endpoint | Returns | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/check_in_groups |
CheckInGroup |
|
|
| GET | https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/checked_in_at_check_ins |
CheckIn |
|
|
| GET | https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/event |
Event | ||
| GET | https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/location |
Location | ||
| GET | https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/print_station |
Station | ||
| GET | https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/theme |
Theme |
Belongs To
| HTTP Method | Endpoint | Association | Details | Filter By |
|---|---|---|---|---|
| GET | https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/checked_in_at |
CheckIn | ||
| GET | https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/check_in_groups/{check_in_group_id}/print_station |
CheckInGroup | ||
| GET | https://api.planningcenteronline.com/check-ins/v2/stations |
Organization | ||
| GET | https://api.planningcenteronline.com/check-ins/v2/stations/{station_id}/print_station |
Station |