SupportCenter

SupportCenter Service

REST endpoints for interacting with Support Center page configuration. The Support Center page consists of Sections and Section Entries, which can also be manipulated using the SectionService. All of the endpoints in the SectionService also exist in the SupportCenterService, however, the semantics are such that only Section and SectionEntries which are part of the Support Center can be operated upon. Default values are also applied to Sections created via the SupportCenterService relevant to SupportCenter. There are also additional constraints (e.g. one "header" section with two section entries and one "footer" section) that are applied to support center sections and not applied to other section pages.

Since: 3.12

Create Section

POST /solutions/supportCenter/sections

Create a new section owned by the caller, based on the information in the specified Section. Then, return a 201 with a Section reflecting the new section configuration.

The following fields are processed from the incoming section entity:

  • name - the name of the new section (must be unique per user)
  • solutionKey - the name of the solution with which this section should be associated; specify "supportcenter" for the Support Center
  • displayOrder - the ordinal to display this section within it's solution key group
  • sectionType - the type of the section, one of "header", "block", or "footer"; these types can be used to change the display of the section for a UI
  • sectionEntries - the list of section entries to include in this section
Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseFields to be returned on the newly created entity (defaults to @all)
Takes:
  • Configuration information to construct the new section
    • Retrieves:
  • Section describing the newly created section
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)One or more input values is malformed
    409 (Conflict)Requesting to create a section with a name that already exists
    403 (Forbidden)Requester is not allowed to manage sections

    Destroy Section

    DELETE /solutions/supportCenter/sections/{sectionID}

    Delete an existing section.

    Path Parameters:
    NameTypeRequiredDescription
    sectionIDStringtrueID of the section to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    403 (Forbidden)The requester is not allowed to manage section
    404 (Not Found)The specified section cannot be found
    400 (Bad Request)BadRequestException

    Get Avatar

    GET /solutions/supportCenter/sections/{sectionEntryID}/avatar

    Return the binary content of the avatar image for the specified section entry.

    Path Parameters:
    NameTypeRequiredDescription
    sectionEntryIDStringtrueID of the section entry for which to retrieve the avatar image
    Query Parameters:
    NameTypeRequiredDescription
    sizeStringfalseRequested size ("small", "medium", "large"), default is "large"
    Retrieves:
  • The binary content of the avatar image for the specified section entry
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to retrieve this image
    404 (Not Found)The specified section entry or image does not exist

    Get Banner

    GET /solutions/supportCenter/banner
    Get the Banner section for the Support Center. This section is to be displayed at the top. The section consists of two section entries.
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned for each section (default value is @summary)
    Retrieves:
  • Section[]
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)Any of the input fields are malformed
    403 (Forbidden)The requesting user is not authorized to retrieve sections

    Get Blocks

    GET /solutions/supportCenter/blocks
    Get the middle sections for the Support Center, which consist of section entries of "place" type. These sections are to be displayed in order on the page.
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned for each section(default value is @summary)
    Retrieves:
  • Section[]
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)Any of the input fields are malformed
    403 (Forbidden)The requesting user is not authorized to retrieve sections

    Get Channels

    GET /solutions/supportCenter/channels
    Get the Footer section for the Support Center. This section is to be displayed at the bottom of the page. The section contains any number of "channel" section entries.
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned for each section(default value is @summary)
    Retrieves:
  • Section[]
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)Any of the input fields are malformed
    403 (Forbidden)The requesting user is not authorized to retrieve sections

    Get Section

    GET /solutions/supportCenter/sections/{sectionID}

    Return a Section representation of the specified section.

    Path Parameters:
    NameTypeRequiredDescription
    sectionIDStringtrueID of the section to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned (default is "@all")
    Retrieves:
  • Section representation of the specified section
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)One or more input values is malformed
    403 (Forbidden)The requester is not allowed to view sections for the owning user
    404 (Not Found)The specified section cannot be found

    Get Sections

    GET /solutions/supportCenter/sections
    Get a list of sections.
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned for each section(default value is @summary)
    Retrieves:
  • Section[]
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)Any of the input fields are malformed
    403 (Forbidden)The requesting user is not authorized to retrieve sections

    Get Support Center Categories

    GET /solutions/supportCenter/categories
    Get a list of all the categories applied to any place referenced within a SectionEntry within this Section
    Return Status:
    HTTP Status CodeDescription
    403 (Forbidden)Request was successful
    400 (Bad Request)Any of the input fields are malformed
    403 (Forbidden)The requesting user is not authorized to change the publish status

    Create Support Center

    POST /solutions/supportCenter/publish/{published}
    Change the state of the support center to be not published (visible to admin only) or published (visible to everyone).
    Path Parameters:
    NameTypeRequiredDescription
    publishedStringtruethe published status of the support center
    Return Status:
    HTTP Status CodeDescription
    403 (Forbidden)Request was successful
    400 (Bad Request)Any of the input fields are malformed
    403 (Forbidden)The requesting user is not authorized to change the publish status

    Update Section

    PUT /solutions/supportCenter/sections/{sectionID}

    Update an existing section, based on the information in the specified Section. Then, return a Section reflecting the updated section configuration.

    The following fields are processed from the incoming Section:

    • name - the name of the new section (must be unique per user)
    • displayOrder - the ordinal to display this section within it's solution key group
    • sectionEntries - the list of section entries to include in this section

    solutionKey and sectionType cannot be modified

    Path Parameters:
    NameTypeRequiredDescription
    sectionIDStringtrueID of the section to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be included in the response (default is @all)
    Takes:
  • Section containing the configuration information to construct the new section
    • Retrieves:
  • A Section reflecting the updated section configuration
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input value is missing or malformed
    409 (Conflict)Requesting to create a section with a name that already exists
    403 (Forbidden)The requester is not allowed to manage sections
    404 (Not Found)The specified user cannot be found