EventResourceRequest - Calendar API

Example Request

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

View in API Explorer →

Example Object

{
  "type": "EventResourceRequest",
  "id": "1",
  "attributes": {
    "approval_sent": true,
    "approval_status": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "notes": "string",
    "quantity": 1,
    "updated_at": "2000-01-01T12:00:00Z",
    "visible_on_kiosks": true
  },
  "relationships": {
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    },
    "resource": {
      "data": {
        "type": "Resource",
        "id": "1"
      }
    },
    "event_resource_request": {
      "data": {
        "type": "EventResourceRequest",
        "id": "1"
      }
    },
    "created_by": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "updated_by": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "room_setup": {
      "data": {
        "type": "RoomSetup",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`approval_sent`	`boolean`	Whether or not an email has been sent to request approval
`approval_status`	`string`	Possible values: - `A`: approved - `P`: pending - `R`: rejected
`created_at`	`date_time`	UTC time at which request was created
`id`	`primary_key`	Unique identifier for the request
`notes`	`string`	Additional information about the room or resource request
`quantity`	`integer`	How many of the rooms or resources are being requested
`updated_at`	`date_time`	UTC time at which request was updated
`visible_on_kiosks`	`boolean`	Whether this resource request is visible on kiosks

Relationships

Name	Type	Association Type
event	Event	to_one
resource	Resource	to_one
event_resource_request	EventResourceRequest	to_one
created_by	Person	to_one
updated_by	Person	to_one
room_setup	RoomSetup	to_one

Can Include

Parameter	Value	Description	Assignable
include	created_by	include associated created_by	create and update
include	event	include associated event	create and update
include	resource	include associated resource	create and update
include	room_setup	include associated room_setup	create and update
include	updated_by	include associated updated_by	create and update

Query By

Name	Parameter	Type	Description	Example
approval_sent	`where[approval_sent]`	boolean	Query on a specific approval_sent	`?where[approval_sent]=true`
approval_status	`where[approval_status]`	string	Query on a specific approval_status	`?where[approval_status]=string`
created_at	`where[created_at]`	date_time	Query on a specific created_at	`?where[created_at]=2000-01-01T12:00:00Z`
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/event_resource_requests`

Reading

HTTP Method	Endpoint
GET	`/calendar/v2/event_resource_requests/{id}`

Associations

HTTP Method	Endpoint	Returns	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/answers`	EventResourceAnswer
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/created_by`	Person
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/event`	Event
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/resource_bookings`	ResourceBooking	`approved` `approved_pending` `approved_pending_rejected` `approved_rejected` `future` `pending` `pending_rejected` `rejected`
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/resource`	Resource
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/room_setup`	RoomSetup
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/updated_by`	Person

Belongs To

HTTP Method	Endpoint	Association	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/event_resource_requests`	Event
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests`	Organization
GET	`https://api.planningcenteronline.com/calendar/v2/people/{person_id}/event_resource_requests`	Person	`awaiting_response` `future` `not_in_conflict` `not_overbooked` `overbooked`
GET	`https://api.planningcenteronline.com/calendar/v2/resource_approval_groups/{resource_approval_group_id}/event_resource_requests`	ResourceApprovalGroup	`awaiting_response` `future` `not_in_conflict` `not_overbooked` `overbooked`
GET	`https://api.planningcenteronline.com/calendar/v2/resource_bookings/{resource_booking_id}/event_resource_request`	ResourceBooking
GET	`https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/event_resource_requests`	Resource