API
⌘K
My Developer Account

RoomSetup

A diagram and list of suggested resources useful for predefined room setups.

Example Request

curl https://api.planningcenteronline.com/calendar/v2/room_setups

View in API Explorer →

Example Object

{
  "type": "RoomSetup",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "diagram": "string",
    "diagram_thumbnail_url": "string",
    "diagram_url": "string",
    "name": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "room_setup": {
      "data": {
        "type": "RoomSetup",
        "id": "1"
      }
    },
    "resource_suggestions": {
      "data": [
        {
          "type": "ResourceSuggestion",
          "id": "1"
        }
      ]
    },
    "containing_resource": {
      "data": {
        "type": "Resource",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time UTC time at which the room setup was created
description string A description of the room setup
diagram string An object containing `url` and `thumbnail`. `url` is path to where room setup is stored. `thumbnail` contains `url` path to where thumbnail is stored.
diagram_thumbnail_url string Path to where thumbnail version of room setup is stored
diagram_url string Path to where room setup is stored
id primary_key Unique identifier for the room setup
name string The name of the room setup
updated_at date_time UTC time at which the room setup was updated

Relationships

Name Type Association Type Note
room_setup RoomSetup to_one The shared room setup this is linked to
resource_suggestions ResourceSuggestion to_many A list of suggested resources for this room setup
containing_resource Resource to_one The resource this room setup is attached to

Can Include

Parameter Value Description Assignable
include containing_resource include associated containing_resource create and update
include resource_suggestions include associated resource_suggestions create and update

Order By

Parameter Value Type Description
order created_at string prefix with a hyphen (-created_at) to reverse the order
order name string prefix with a hyphen (-name) to reverse the order
order updated_at string prefix with a hyphen (-updated_at) to reverse the order

Query By

Name Parameter Type Description Example
created_at where[created_at] date_time Query on a specific created_at ?where[created_at]=2000-01-01T12:00:00Z
name where[name] string Query on a specific name ?where[name]=string
updated_at where[updated_at] date_time Query on a specific updated_at ?where[updated_at]=2000-01-01T12:00:00Z

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 /calendar/v2/room_setups

Reading

HTTP Method Endpoint
GET /calendar/v2/room_setups/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/room_setups/{room_setup_id}/containing_resource ContainingResource
GET https://api.planningcenteronline.com/calendar/v2/room_setups/{room_setup_id}/resource_suggestions ResourceSuggestion

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/room_setup EventResourceRequest
GET https://api.planningcenteronline.com/calendar/v2/room_setups Organization
  • shared_room_setups
GET https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/room_setups Resource