ResourceQuestion - Calendar API

Example Request

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

View in API Explorer →

Example Object

{
  "type": "ResourceQuestion",
  "id": "1",
  "attributes": {
    "choices": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "kind": "string",
    "multiple_select": true,
    "optional": true,
    "position": 1,
    "question": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "resource": {
      "data": {
        "type": "Resource",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`choices`	`string`	If `kind` is `dropdown`, represents a string of dropdown choices separated by the `\|` character
`created_at`	`date_time`	UTC time at which the question was created
`description`	`string`	Optional description of the question
`id`	`primary_key`	Unique identifier for the question
`kind`	`string`	Possible values: - `dropdown`: predefined list of choices as an answer - `paragraph`: expected answer is a paragraph - `text`: expected answer is a sentence - `yesno`: expected answer is 'Yes' or 'No' - `section_header`: used to separate questions in the UI, no expected answer
`multiple_select`	`boolean`	If `kind` is `dropdown`, `true` indicates that more than one selection is permitted
`optional`	`boolean`	- `true` indicates answering the question is not required when booking - `false` indicates answering the question is required when booking
`position`	`integer`	Position of question in list in the UI
`question`	`string`	The question to be answered
`updated_at`	`date_time`	UTC time at which the question was updated

Relationships

Name	Type	Association Type	Note
resource	Resource	to_one

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`
kind	`where[kind]`	string	Query on a specific kind	`?where[kind]=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/resource_questions`

Reading

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

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/calendar/v2/resources/{resource_id}/resource_questions`	choices description kind multiple_select optional position question

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/calendar/v2/resource_questions/{id}`	choices description kind multiple_select optional position question

Deleting

HTTP Method	Endpoint
DELETE	`/calendar/v2/resource_questions/{id}`

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/resource_questions`	Organization
GET	`https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/resource_questions`	Resource