REST Auth API: EventPublicationSettings
EventPublicationSettings resources are a subresource of Event, and determine the level of public access to event details.
This resource specifies configuration options determining whether the details of the event should be published for public viewing, and whether the event should be included in lists such as upcoming lists and search results.
These options are used primarily for restricting access to private or invite-only events where registrations may be accepted on a public website, but only from individuals with direct links to registration pages.
Configuration options defined in this resource are used directly by the website when determining how to publish the event.
EventPublicationSettings instance resource
Resource URI
/api/2012-02-01/auth/resources/events/{EventID}/publicationsettings/
Resource properties
Property | Description |
---|---|
AllowPublication | A Boolean value indicating whether the associated Event should be published and accessible to the public. |
AllowPublicationInLists |
A Boolean value indicating whether the associated Event should be included in public lists such as upcoming lists and search results. This setting is used only if AllowPublication has the value true .
|
HTTP GET
Returns a representation of an EventPublicationSettings resource, including the properties above.
Example
GET /api/2012-02-01/auth/resources/events/456/publicationsettings/
<EventPublicationSettings> <AllowPublication>true</AllowPublication> <AllowPublicationInLists>true</AllowPublicationInLists> <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/publicationsettings/"/> </EventPublicationSettings>
HTTP POST
Not supported.
HTTP PUT
Not supported.
HTTP DELETE
Not supported.