Page History: ManagementService 1.1 : Data Types
Compare Page Revisions
Page Revision: 2010/03/28 00:10
Behold the DataTypes of the Management Service
Customer
An object with the following properties:
Description
A string. Description of this Customer.
Id
A string. Uniquely identifies this Customer.
Modules
A list of
ModuleType objects. Describes which Modules are available for this Customer.
Name
A string. The name of this Customer.
Profiles
A list of
Profile objects. A Profile contains pre-configured settings and data from which all new Webcasts are created.
Tags
A list of strings. This shows all the tags that have been added to Webcasts for this Customer so far.
CustomerSummary
An object with the following properties:
Id
A string. Uniquely identifies a Customer. Use it as an input parameter for CustomerGet.
Name
A string. The name of a Customer.
ModuleType
An enumeration. Can have one of the following values:
Slides
Speakers
Topics
Profile
An object with the following properties:
Description
A string. Description of this Profile.
Id
A string. Uniquely identifies this Profile.
Title
A string. The title of this Profile.
SlidesModule
An object with the following properties:
Slides
A list of LocalizedSlides objects. Each language set in Webcast.LanguageCodes is required to have its own LocalizedSlides object in this list.
Each
LocalizedSlides object is a list of
Slide.
StatusEnabled
A list of
WebcastStatus objects. The SlidesModule and all the data it contains is only available in the
WebcastStatus phases you explicitly define here.
SpeakersModule
An object with the following properties:
Speakers
A list of
LocalizedSpeakers objects. Each language set in LanguageCodes is required to have its own
LocalizedSpeakers object in this list.
Each
LocalizedSpeakers object is a list of
Speaker.
StatusEnabled
A list of
WebcastStatus objects. The SpeakersModule and all the data it contains is only available in the
WebcastStatus phases you explicitly define here.
TopicsModule
An object with the following properties:
Topics
A list of
LocalizedTopics objects. Each language set in LanguageCodes is required to have its own
LocalizedTopics object in this list.
StatusEnabled
A list of
WebcastStatus objects. The TopicsModule and all the data it contains is only available in the
WebcastStatus phases you explicitly define here.
Webcast
An object with the following properties:
ActiveModules
A list of
ModuleType objects. Each of the currently supported Modules (SlidesModule, SpeakersModule and TopicsModule) that you want to activate for this Webcast must be included in this list. Note that not all Customers have access to all Modules. Customer.Modules is a list of all Modules this Customer has access to.
Code
A string. Uniquely identifies a Webcast. It is automatically generated during WebcastCreate, and is a read only property.
DefaultLanguage
A string. Gets or sets the 2 character country code that defines the default language.
Enlist
A boolean. Gets or sets whether this Webcast should be available through the MetaService's WebcastSearch method. If Enlist is set to true, this Webcast can appear in the results of WebcastSearch.
LanguageCodes
A list of 2 character language codes. Gets or sets the languages in which this Webcast is available.
Localization
A list of
WebcastData objects. Contains localized meta data for this Webcast. Each language set in LanguageCodes is required to have its own
WebcastData object in this list.
Location
A
Location object. Contains information pertaining to the geographical location of the Webcast.
Reference
A string. You can use this property for your own purposes. Whatever you place here will be available through the MetaService as well. One of its intended uses is for you to place your own identifier here.
Revision
A string. Every time WebcastSave is called on a Webcast, its Revision is updated to reflect its last change date. When you use WebcastSave, your Webcast's Revision has to always contain the latest Revision date. Webcasts with an out of date Revision will fail to save.
ScheduledStart
A DateTime. Gets or sets the date and time on which the Webcast should start.
SlidesModule
A
SlidesModule object. Contains configuration information and meta data for slides.
SpeakersModule
A
SpeakersModule object. Contains configuration information and meta data for speakers.
TopicsModule
A
TopicsModule object. Contains configuration information and meta data for topics.
Triggers
A list of
Trigger objects. During the Live phase of a Webcast, the activation of one Module's data element can automatically trigger the activation of another. For example, when Slide5 is activated, it can "trigger" Topic2 to become active is well. This list contains a Webcast's triggers.
WebcastData
An object with the following properties:
Description
A string. Description of this Webcast.
Tags
A list of strings. This allows you to add tags to this Webcast. The Customer.Tags property contains a list of all Tags used before in the context of this Customer. You can re-use those, or add a new one by just entering it here.
Title
A string. The title of this Webcast.