Arlo

REST Auth API: EventPublicationStatus

EventPublicationStatus resources are a subresource of Event, and provide read-only information about the publication status of the event.

EventPublicationStatus instance resource

Resource URI

/{platform_name}/api/2012-02-01/auth/resources/events/{EventID}/publicationstatus/

Resource properties

Property Description
IsPublished A Boolean value indicating whether the associated Event is currently published and accessible to the public.
RegistrationPeriod An EventRegistrationPeriod value representing the current period of registration the associated Event is in.
PublishStartDateTime A computed DateTimeOffset value representing when the assocated Event will become accessible to the public. This value is specified only if the Event is configured to remain unpublished after being created. This value is generally not required.
PublishFinishDateTime A computed DateTimeOffset value representing when the assocated Event will become unpublished and inaccessible to the public. This value is derived from all available settings for the Event, and is generally equal to the StartDateTime of the Event, after which registrations are no longer accepted.

HTTP GET

Returns a representation of an EventPublicationStatus resource, including the properties above.

Example

GET /demo/api/2012-02-01/auth/resources/events/456/publicationstatus/

<EventPublicationStatus>
  <IsPublishedOnWebsite>false</IsPublishedOnWebsite>
  <RegistrationPeriod>Closed</RegistrationPeriod>
  <WebsitePublishFinishDateTime>2011-11-13T07:30:00+13:00</WebsitePublishFinishDateTime>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/events/456/publicationstatus/"/>
</EventPublicationStatus>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.