ConventionWebfiltered

This is for webfiltered (HTML) data "fields" used by a Convention. ConventionWebfiltereds are accessed via /api/conventionwebfiltered.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in ConventionWebfilteredProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

convention

The Convention this conventionwebfiltered belongs to.

Allowed "field" names

These are the only names allowed for Webfiltered data associated with a convention.

You can also _include these names in a GET request for a Convention to include the Webfiltered data with the response.

description

Requires the pages privilege to edit.

exhibitor_application_header

Requires the exhibitors privilege to edit.

exhibitor_info_email

Requires the exhibitors privilege to edit.

venue_notes
volunteer_scheduled_greeting

Requires the volunteers privilege to edit.

Services

The services used to fetch and manipulate conventionwebfiltereds.

Search ConventionWebfiltereds

Searching across all conventions is not enabled. To search within a single convention's ConventionWebfiltereds, see "Relationships" in Convention.

Create ConventionWebfiltered

 POST /api/conventionwebfiltered
Required Params
session_id

Passed in the request's Cookie header.

convention_id
name
webfiltered

Note that webfiltered_html always updates automatically based on the text in webfiltered. Do not update webfiltered_html directly.

Returns the same as a normal read.

Read ConventionWebfiltered

 GET /api/conventionwebfiltered/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "metatags",
   "webfiltered" : "..",
   "webfiltered_html" : "..",
   ...
 }

Update ConventionWebfiltered

 PUT /api/conventionwebfiltered/xxx

Note that webfiltered_html always updates automatically based on the text in webfiltered. Do not update webfiltered_html directly.

Returns the same as a normal read.

Delete ConventionWebfiltered

 DELETE /api/conventionwebfiltered/xxx

Returns:

 {
   "success" : 1
 }