API
⌘K
My Developer Account

ResourceSuggestion

A resource and quantity suggested by a room setup.

Example Request

curl https://api.planningcenteronline.com/calendar/v2/room_setups/{room_setup_id}/resource_suggestions

View in API Explorer →

Example Object

{
  "type": "ResourceSuggestion",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "quantity": 1,
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "resource": {
      "data": {
        "type": "Resource",
        "id": "1"
      }
    },
    "room_setup": {
      "data": {
        "type": "RoomSetup",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time UTC time at which the suggestion was created
id primary_key Unique identifier for the suggestion
quantity integer How many resources should be requested
updated_at date_time UTC time at which the suggestion was updated

Relationships

Name Type Association Type Note
resource Resource to_one
room_setup RoomSetup to_one

Can Include

Parameter Value Description Assignable
include resource include associated resource create and update

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/{room_setup_id}/resource_suggestions

Reading

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/room_setups/{room_setup_id}/resource_suggestions/{resource_suggestion_id}/resource Resource

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/room_setups/{room_setup_id}/resource_suggestions RoomSetup