Arlo

REST Auth API: OnlineActivityRegistrationSettings

OnlineActivityRegistrationSettings resources are a subresource of OnlineActivity, and determine the how registrations for that activity will be handled.

This resource specifies configuration options related to the method of registration, 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 OnlineActivity.

OnlineActivityRegistrationSettings instance resource

Resource URI

/{platform_name}/api/2012-02-01/auth/resources/onlineactivities/{OnlineActivityID}/registrationsettings/

Resource properties

Property Description
RegistrationMethod A RegistrationMethod value representing the method to use for handling registrations for this activity.
RegistrationUrl The URL of an external site which will handle registrations for this activity. Used only when RegistrationMethod has the value Url. This property should not generally be used to obtain the registration URL as it only has a value in specific cases. Always use the WebsiteRegister link on the to obtain the current registration URL, regardless of the registration method.
RegistrationMessage An inline RichContent resource representing a custom message to be displayed instead of a registration link for this activity. Used only when RegistrationMethod has the value CustomMessage.

HTTP GET

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

Example 1

Returns an OnlineActivityRegistrationSettings representation for an OnlineActivity that has been configured to use the QuickRegistrationProcess registration method.

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

<OnlineActivityRegistrationSettings>
  <RegistrationMethod>QuickRegistrationProcess</RegistrationMethod>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/onlineactivities/456/registrationsettings/"/>
</OnlineActivityRegistrationSettings>
Example 2

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

GET /demo/api/2012-02-01/auth/resources/onlineactivities/457/registrationsettings/

<OnlineActivityRegistrationSettings>
  <RegistrationMethod>Url</RegistrationMethod>
  <RegistrationUrl>http://events.acme.org/e-learning/sign-up?49233-3107-4f56-afd5-82bd6a2c284b/</RegistrationUrl>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/onlineactivities/457/registrationsettings/"/>
</OnlineActivityRegistrationSettings>
Example 3

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

GET /demo/api/2012-02-01/auth/resources/onlineactivities/458/registrationsettings/

<OnlineActivityRegistrationSettings>
  <RegistrationMethod>CustomMessage</RegistrationMethod>
  <RegistrationMessage>
    <ContentType>application/xhtml</ContentType>
    <Content>&lt;em&gt;Call us for details!&lt;/em&gt;</Content>
  </RegistrationMessage>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/onlineactivities/458/registrationsettings/"/>
</OnlineActivityRegistrationSettings>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.