Arlo

REST Auth API: EventRegistrationSettings

EventRegistrationSettings resources are a subresource of Event, and determine the how registrations for that event will be handled.

This resource specifies configuration options related to the method of registration, any attendee limits, any external URLs to use and messages to show when registration is not available.

Configuration options defined in this resource are used directly by the website when determining how to present and process registrations for the associated Event.

EventRegistrationSettings instance resource

Resource URI

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

Resource properties

Property Description
RegistrationMethod An EventRegistrationMethod value representing the method to use for handling registrations for this event.
RegistrationLimit An integer value specifying the maximum number of registrations to accept before marking the event as 'full'. If the value is blank, this field will be omitted.
RegistrationMinimum

Supported in next release

An integer value specifying the minimum number of registrations to accept. Used to trigger the miniumum registrant allert if not reached by a specified date. If the value is blank, this field will be omitted.
RegistrationUrl The URL of an external site which will handle registrations for this event. Used only when RegistrationMethod has the value Url.
WebsiteRegistrationEnabled A Boolean value determining whether public website visitors are allowed register for this event.
RegistrationMessage An inline RichContent resource representing a custom message to be displayed instead of a registration link for this event. Used only when RegistrationMethod has the value CustomMessage.

HTTP GET

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

Example 1

Returns an EventRegistrationSettings representation for an Event that has been configured with a limit of 30 and uses the QuickRegistrationProcess registration method.

GET /api/2012-02-01/auth/resources/events/456/registrationsettings/

<EventRegistrationSettings>
  <RegistrationMethod>QuickRegistrationProcess</RegistrationMethod>
  <RegistrationLimit>30</RegistrationLimit>
  <RegistrationMinimum>5</RegistrationMinimum>
  <WebsiteRegistrationEnabled>true</WebsiteRegistrationEnabled>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/registrationsettings/"/>
</EventRegistrationSettings>
Example 2

Returns an EventRegistrationSettings representation for an Event that has registrations handled by a third-party website (external URL).

GET /api/2012-02-01/auth/resources/events/457/registrationsettings/

<EventRegistrationSettings>
  <RegistrationMethod>Url</RegistrationMethod>
  <RegistrationUrl>http://events.acme.org/eventsignup/49233-3107-4f56-afd5-82bd6a2c284b/</RegistrationUrl>
  <WebsiteRegistrationEnabled>true</WebsiteRegistrationEnabled>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/457/registrationsettings/"/>
</EventRegistrationSettings>
Example 3

Returns an EventRegistrationSettings representation for an Event that has a custom message to show instead of a registration link.

GET /api/2012-02-01/auth/resources/events/458/registrationsettings/

<EventRegistrationSettings>
  <RegistrationMethod>CustomMessage</RegistrationMethod>
  <RegistrationMessage>
    <ContentType>application/xhtml</ContentType>
    <Content><![CDATA[<em>Call us for details!</em>]]></Content>
  </RegistrationMessage>
  <WebsiteRegistrationEnabled>true</WebsiteRegistrationEnabled>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/458/registrationsettings/"/>
</EventRegistrationSettings>
Example 4

Returns an EventRegistrationSettings representation for an Event that has no specified registration limit.

GET /api/2012-02-01/auth/resources/events/459/registrationsettings/

<EventRegistrationSettings>
  <RegistrationMethod>QuickRegistrationProcess</RegistrationMethod>
  <WebsiteRegistrationEnabled>true</WebsiteRegistrationEnabled>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/459/registrationsettings/"/>
</EventRegistrationSettings>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.