Arlo

REST Auth API: OnlineActivityPublicationSettings

OnlineActivityPublicationSettings resources are a subresource of OnlineActivity, and determine the level of public access to activity details.

This resource specifies configuration options determining whether the details of the activity should be published for public viewing, and whether the activity should be included in lists such as search results.

These options are used primarily for restricting access to private or invite-only activities 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.

OnlineActivityPublicationSettings instance resource

Resource URI

/{platform_name}/api/2012-02-01/auth/resources/onlineactivities/{EventID}/publicationsettings/

Resource properties

Property Description
AllowPublication A Boolean value indicating whether the associated activity should be published and accessible to the public.
AllowPublicationInLists A Boolean value indicating whether the associated activity 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 OnlineActivityPublicationSettings resource, including the properties above.

Example

GET /demo/api/2012-02-01/auth/resources/onlineactivities/456/publicationsettings/

<OnlineActivityPublicationSettings>
  <AllowPublication>true</AllowPublication>
  <AllowPublicationInLists>false</AllowPublicationInLists>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/onlineactivities/456/publicationsettings/"/>
</OnlineActivityPublicationSettings>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.