Skip to content

Channel Management

Module Version 1.30.1.0

Overview#

This module is used to manage channels within a Tenant. The majority of the module’s functionality is at the Channel level.

Roles#

Role Purpose
Admin Full access and editing permissions within a Tenant. This role extends to all modules in the EMS.
ChannelManager Edit existing channels within the tenant via the EMS
Developer Role is redundant for this version of the module

Settings#

The module exposes a number of settings allow customisation of function and behaviour

Name Type Default Value Purpose
AuthorisedRolesCsv String Admin,ChannelManager,
Developer
List of roles allowed to access this interface in the EMS portal
AutoRedirectRolesWhenOneChannelCsv String [empty] List of roles allowed to bypass the EMS channel list page for users accessing a single channel. Bypass functionality is also dependent on AutoRedirectToModuleName and AutoRedirectWhenOneChannelAndOneModule settings being configured
AutoRedirectToModuleName String [empty] Module to navigate to from home page when bypassing the EMS channel list page. Module name can be found in top right corner of the module’s EMS settings page, above the module’s version number. Bypass functionality is also dependent on AutoRedirectRolesWhenOneChannelCsv and AutoRedirectWhenOneChannelAndOneModule settings being configured
AutoRedirectWhenOneChannelAndOneModule Boolean false Toggle navigation bypass of channel listing in EMS portal. Bypass functionality is also dependent on AutoRedirectToModuleName and AutoRedirectWhenOneChannelAndOneModule settings being configured
CanManageDefaultSettingsViaWebApi Boolean false Toggle editing of this module’s default settings by API
DefaultModuleName String [empty] From EMS channel list page, skip channel dialog and go straight to named module user interface. Module name can be found in top right corner of the module’s EMS settings page, above the module’s version number.
ExposeChannelsViaPublicApi Boolean true Toggle visibility of channel information by API
IsEnabled Boolean true Toggle visibility of this module’s interfaces and APIs for all users in the EMS portal

APIs#

Management APIs#

The following APIs can be accessed by a user with role Admin, while the UpdateSettings API also allows execution by users with role ChannelManager. Interfaces within this section work either at the Tenant or Channel Level.

Name, URL, Type, API Version Roles Purpose
InvitePersonaToChannel
/{tenant}/api/Channel/InvitePersonaToChannel/{id}
(API Version 2)
Admin Send an email invitation to select members within a Persona group to join the channel (Packaging module must be enabled and configured with this invitation). The value of {id} matches the “channelId” output from the List API
UpdateSettings
/{tenant}/api/Channel/UpdateSettings/{id}
(API Version 2)
ChannelManager Edit and delete custom settings. The value of {id} matches the “channelId” output from the List API
Create
/{tenant}/api/Channel/Create/{id}
(API Version 2)
Admin Create a new channel. The value of {id} defaults to “0”

Read Only APIs#

The following APIs can be accessed by any registered user. Interfaces within this section work either at the Tenant or Channel Level.

Name, URL, Type, API Version Roles Purpose
List
/{tenant}/api/Channel/List/{id}
(API Version 2)
Any List all permitted channels and unencrypted custom settings for current user account matching the authentication token. The value of {id} defaults to “0”
Get
/{tenant}/api/Channel/Get/{id}
(API Version 2)
Any List single permitted channel and unencrypted custom settings for current user account matching the authentication token. The value of {id} matches the “channelId” output from the Channel/List API
MediaFile
/{tenant}/api/Channel/MediaFile/{id}
(API Version 2)
None Download media file in byte format for a single permitted channel. Alternative to downloading using the media file’s full URI. The value of {id} matches the “channelImageId” output from the Channel/List and Channel/Get APIs. Note that Swagger generated cURL commands require an additional output switch and filename destination defined.
ListMediaTypes
/{tenant}/api/Channel/ListMediaTypes/{id}
(API Version 2)
Any Retrieve a list of media types configured for use by a selected channel. The response is based on the media types list from AR module setting AllowedMediaTypesCsv (refer to AR Target Image and Media ). The value of {id} matches the “channelId” output from the Channel/List API
GetSettings
/{tenant}/api/Channel/GetSettings/{id}
(API Version 2)
None Retrieve custom settings of a permitted channel. Custom settings will only be visible if applied to a specific channel. The value of {id} matches the “channelId” output from the Channel/List API

Miscellaneous APIs#

Name, URL, Type, API Version Roles Purpose
Ping
/{tenant}/api/Health/Ping/{id}
(API Version 2)
None Health check for hosting providers to see if tenant web services are still alive. The value of {id} defaults to “0”
Submit
/{tenant}/api/Feedback/Submit/{id}
(API Version 1)
N/A Deprecated
Back to top