Section

You can partition your Support Center page (or other solution page) into regions using Sections. Depending on the section type (specified by the sectionType field), a section can be used for the header, the footer, or for one of the main blocks of the page. A section can contain Section Entries (specified by the sectionEntries field), which define the elements inside a section. If, for example, you want to feature content from three related groups in three connected panels, you would create three section entries inside one section.

Specify "supportcenter" in the solutionKey field to asssociate this section with the Support Center.

Related services: Support Center Service, Section Service.

Examples:
SectionEntity Fields and Resources

JSON including important fields and a SectionEntity's resources. See the tables below for a list of all fields and resources.

 {
      "id" : "6551",
      "resources" : {
          "self" : {
              "allowed" : [ "DELETE", "GET", "PUT" ],
              "ref" : "http://example.jiveon.com/api/core/v3/sections/6551"
          }
      },
      "name" : "headerSection",
      "displayOrder" : 1,
      "sectionType" : "header",
      "solutionKey" : "supportcenter",
      "sectionEntries" : [
          {
              "id" : "6552",
              "resources" : {
                  "avatar" : {
                      "allowed" : [ "GET" ],
                      "ref" : "http://example.jiveon.com/api/core/v3/sections/6552/avatar"
                  }
              },
              "sectionEntryType" : "banner",
              "name" : "Need Help?",
              "description" : "You can get it here.",
              "type" : "sectionEntry",
              "typeCode" : 3301
          }, {
              "id" : "6553",
              "resources" : {
                  "avatar" : {
                      "allowed" : [ "GET" ],
                      "ref" : "http://example.jiveon.com/api/core/v3/sections/6553/avatar"
                  }
              },
              "sectionEntryType" : "banner",
              "name" : "asfasdf",
              "description" : "asdfasdfasdf",
              "type" : "sectionEntry",
              "typeCode" : 3301
          }, {
              "id" : "6554",
              "resources" : {
                  "avatar" : {
                      "allowed" : [ "GET" ],
                      "ref" : "http://example.jiveon.com/api/core/v3/sections/6554/avatar"
                  }
              },
              "sectionEntryType" : "banner",
              "name" : "photo.JPG",
              "bgColor" : "#2adf32",
              "bgLinkColor" : "#234343",
              "bgImage" : "http://example.jiveon.com/resources/statics/1001/photo.JPG?a=1432071172015",
              "bgPosition" : "right bottom",
              "type" : "sectionEntry",
              "typeCode" : 3301
              }
          ],
          "type" : "section",
          "typeCode" : 3300
 }
Create Section (minimum information)

POST to /sections creates a new section. The minimum set of fields you must include are:

 {
      "type" : "section",
      "name" : "Find information about your device",
      "solutionKey" : "supportcenter",
      "sectionType" : "block"
 }
Create Block Section with Two Place Section Entries

POST to /sections creates a new section. The minimum set of fields you must include are:

 {
      "type" : "section",
      "sectionType" : "block",
      "name" : "Find information about your device",
      "solutionKey" : "supportcenter",
      "sectionEntries" : [
          {
              "type" : "sectionEntry",
              "sectionEntryType" : "place",
              "place" : {
                  "type" : "space",
                  "placeID" : "6414"
              }
          },
          {
              "type" : "sectionEntry",
              "sectionEntryType" : "place",
              "place" : {
                  "type" : "socialgroup",
                  "placeID" : "6415"
              }
          }
      ]
 }
Create Header Section

POST to /sections creates a new section.

 {
      "type" : "section",
      "sectionType" : "header",
      "name" : "headerSection",
      "solutionKey" : "supportcenter",
      "sectionEntries" : [
          {
              "sectionEntryType" : "banner",
              "name" : "Need some help?",
              "description" : "We bet you do.",
              "type" : "sectionEntry"
          },
          {
              "sectionEntryType" : "banner",
              "name" : "photo.JPG",
              "bgColor" : "#2adf32",
              "bgLinkColor" : "#234343",
              "bgImage" : "http://varner.example.com/resources/statics/1001/photo.JPG?a=1432071172015",
              "bgPosition" : "right bottom",
              "type" : "sectionEntry",
              "typeCode" : 3301
          }
      ]
 }
Create Footer Section

POST to /sections creates a new section.

 {
      "type" : "section",
      "name" : "Still need help?",
      "solutionKey" : "supportcenter",
      "sectionType" : "footer",
      "sectionEntries" : [
          {
              "sectionEntryType" : "channel",
              "name" : "Ask a Question in our Community",
              "nameTextColor" : "",
              "description" : "Average response time is 1.5 days",
              "descriptionTextColor" : "",
              "glyph" : "icon-j-discussion-question",
              "glyphColor" : "#008de6",
              "uri" : "/discussion/create.jspa?question=true",
              "linkText" : "Ask a Question",
              "type" : "sectionEntry"
           },
           {
              "sectionEntryType" : "channel",
              "name" : "Ask a Question in our Community",
              "nameTextColor" : "#aa2bb3",
              "description" : "Average response time is 1.5 days",
              "descriptionTextColor" : "#aa2bb3",
              "glyph" : "icon-facebook2",
              "glyphColor" : "#008de6",
              "uri" : "http://www.facebook.com/GetSupportForThisProduct",
              "linkText" : "Like Us on Facebook",
              "type" : "sectionEntry"
           }]
 }
Update Section

PUT to /sections/{sectionID} updates a section. All section fields must be included. Modifying the displayOrder value for a section will reorder the section to that ordinal among all sections within that section's solution key group.

Get Section

GET to /sections/{sectionID} gets a section.

Since: 3.12

Fields

FieldTypeMode Description
displayOrderIntegeroptional

The index of the total ordering in which this section should be displayed with it's solution key group. If this is not specified in a call to create a section, it will default to the last position. If this is not specified in a call to update a section, the order will not be modified.

idStringread-only

Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs.

nameStringrequired

Name of this section.

publishedISO 8601 Dateread-only

Date and time this object was originally created.

resourcesObjectread-only

Resource links (and related permissions for the requesting person) relevant to this object.

sectionEntriesSectionEntry[]optional

An ordered list of section entries associated with this section.

sectionTypeStringoptional

The section type of this section. Must be one of "header", "block", or "footer". "header" is intended to be used as the top "banner" section of a page. "block" is intended to be used for the middle sections on a page that contains "place" section entries. "footer" is intended to contain "channel" section entries that link to other media channels.

solutionKeyStringrequired

The solution key associated with this section. Each solution page (e.g. Support Center) will have its own solution key. Currently, the only valid value is "supportcenter".

typeStringread-only

The object type of this object.

updatedISO 8601 Dateread-only

Date and time this object was most recently updated.

→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Resources

ResourceMethodDescription
selfGET

Return an updated version of this section.

Availability:

Available to Jive admins only

Retrieves:
  • Section representing the updated section
  • selfPUT

    Update the information about this section.

    Availability:

    Available to Jive admins only

    Retrieves:
  • Section representing the updated section
  • selfDELETE

    Delete this section.

    Availability:

    Available to Jive admins only