Arlo

REST Auth API: EventTemplateContentFields

EventTemplateContentField resources are a subresource of EventTemplateDescription and represent optional/custom fields that can be used to describe EventTemplate resources beyond the general built-in summary and description fields of the EventTemplateDescription.

For example, EventTemplateContentFields may be added to an EventTemplate to store information about prerequisites for a course, information about special costs or terms associated with the event, or testimonals for promotional purposes. The data stored in the fields is generic content typically used (along with the built-in summary and description fields) when generating the template's website page.

An EventTemplateContentField resource is defined by a reference to a EventTemplateContentFieldDefinition which determines the type of the field (from a common set used across all templates), a RichContent element which contains the actual content for the field, and a priority index which defines ordering of this field relative to others in the EventTemplateDescription field collection.

EventTemplateDescription instance resource

Resource URI

/api/2012-02-01/auth/resources/eventtemplates/{TemplateID}/description/contentfields/{ContentFieldID}

Resource properties

Property Description
ContentFieldID A integer value that uniquely identifies this resource within the platform.
SequenceIndex A integer value that indicates the priority of this field relative to others in the collection associated with a EventTemplateDescription. This index can be used when determining the layout order for content.
FieldContent An inline RichContent resource representing the content of the field.
Link (title) Description
ContentFieldDefinition Reference to a EventTemplateContentFieldDefinition resource that describes the type of the field.

HTTP GET

Returns a representation of an EventTemplateContentField, including the properties and links above.

Optional parameters
Parameter Description
expand Expression referencing Link elements to expand when generating the response. See link expansion.
Example

GET /api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/657/

<EventTemplateContentField>
  <ContentFieldID>657</ContentFieldID>
  <SequenceIndex>0</SequenceIndex>
  <FieldContent>
    <ContentType>application/xhtml</ContentType>
    <Content>
      <![CDATA[<div>
<p>During this course we will cover:</p>
<ul>
  <li>Course Objective 1</li>
  <li>Course Objective 2</li>
  <li>Course Objective 3</li>
  <li>Course Objective 4</li>
</ul>
</div>]]>
    </Content>
  </FieldContent>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/657/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/ContentFieldDefinition" type="application/xml" title="ContentFieldDefinition" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinition/4/"/>
</EventTemplateContentField>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

EventTemplateContentField collection resource

The EventTemplateContentField collection resource represents the set of EventTemplateContentField resources associated with a EventTemplateDescription resource.

Resource URI

/api/2012-02-01/auth/resources/eventtemplates/{TemplateID}/description/contentfields/

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual EventTemplateContentField resources, or link expansion can be used via the expand query parameter to inline the entities with the HTTP GET response. See querying collections for general information on handling resource collections.

Optional parameters
Parameter Description
expand Expression referencing Link elements to expand when generating the response. See link expansion.
filter A filter expression to apply to the collection. See collection filters. The following properties (and link titles) may be used in filter expressions:
  • ContentFieldID
  • SequenceIndex
  • ContentFieldDefinition
orderby A sort expression to apply to the collection. See collection sorting. The following properties may be used in sort expressions:
  • ContentFieldID
  • SequenceIndex
skip Returns a subset of records from the collection, starting at index N+1 specified by this parameter. The skip and top parameters are generally used for collection paging.
top Returns a subset of records from the collection, starting at index 0 or index skip, and returns the first N records. The skip and top parameters are generally used for collection paging.
Example 1

Retrieve a collection of EventTemplateContentField links with the default parameters, and no link expansion.

GET /api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/

<EventTemplateContentFields>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplateContentField" type="application/xml" title="EventTemplateContentField" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/657/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplateContentField" type="application/xml" title="EventTemplateContentField" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/658/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSession" type="application/xml" title="EventSession" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/"/>
</EventTemplateContentFields>
Example 2

Retrieve a collection of EventTemplateContentField links with the default parameters, with EventTemplateContentField link expansion.

GET /api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/?expand=EventTemplateContentField 

<EventTemplateContentFields>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplateContentField" type="application/xml" title="EventTemplateContentField" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/657/">
    <EventTemplateContentField>
      <ContentFieldID>657</ContentFieldID>
      <SequenceIndex>0</SequenceIndex>
      <FieldContent>
        <ContentType>application/xhtml</ContentType>
        <Content>
          <![CDATA[<div>
<p>During this course we will cover:</p>
<ul>
    <li>Course Objective 1</li>
    <li>Course Objective 2</li>
    <li>Course Objective 3</li>
    <li>Course Objective 4</li>
</ul>
</div>]]>
        </Content>
      </FieldContent>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/657/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/ContentFieldDefinition" type="application/xml" title="ContentFieldDefinition" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinition/4/"/>
    </EventTemplateContentField>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplateContentField" type="application/xml" title="EventTemplateContentField" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/658/">
    <EventTemplateContentField>
      <ContentFieldID>658</ContentFieldID>
      <SequenceIndex>1</SequenceIndex>
      <FieldContent>
        <ContentType>application/xhtml</ContentType>
        <Content>
          <![CDATA[<p>
Friendly, approachable and informative tutor. I learnt more than I expected. I recommend this course to anyone interested in improving their management skills.
</p>]]>
        </Content>
      </FieldContent>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/657/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/ContentFieldDefinition" type="application/xml" title="ContentFieldDefinition" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplatecontentfielddefinition/4/"/>
    </EventTemplateContentField>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSession" type="application/xml" title="EventSession" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/contentfields/"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/?expand=EventTemplateContentField"/>
</EventTemplateContentFields>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.