Behold the DataTypes of the Management Service
EditCustomer
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.
EditCustomerSummary
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.
EditLocation
An object with the following properties:
Address
A string.
City
A string.
Coordinates
An object with the following properties:
Latitude
A double.
Longitude
A double.
CountryCode
PostalCode
A string.
State
A string.
TimeZoneName
A string. The name of the time zone as defined in
Zone.tab.
ModuleType
An enumeration. Can have one of the following values:
Slides
Speakers
Topics
EditProfile
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.
EditSlide
An object with the following properties:
Id
A string. Uniquely identifies this Slide. While adding new slides to a Webcast object, you can either leave Id blank, or enter a custom identifier that you use for creating Trigger objects. When you call the WebcastSave method, all Slide Ids are replaced by new ones.
Reference
A string. Use this property for your own identifiers. Anything you enter here is available through the MetaService as well, and is your best route to quickly finding this particular slide.
EditSlidesModule
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.
The
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.
Speaker
An object with the following properties:
Category
A string. Defines the Category this Speaker belongs to.
DOB
A DateTime. Defines the date of birth of this Speaker.
Email
A string. The email address of this Speaker.
Gender
An enumeration that can have one of the following values:
Female
Male
Unknown
Id
A string. Uniquely identifies this Speaker. While adding new speakers to a Webcast object, you can either leave Id blank, or enter a custom identifier that you use for creating Trigger objects. Every time you call the WebcastSave method, all Speaker Ids are replaced by new ones.
ImageUrl
A string. A url to a picture of this Speaker.
Name
An object with the following properties:
First
A string. First name of the Speaker.
Last
A string. Last name of the Speaker.
Middle
A string. Middle name of the Speaker.
Title
A string. Title of the Speaker.
Phone
A string. The phone number of the Speaker.
POB
A string. The place of birth of the Speaker.
Reference
A string. Use this property for your own identifiers. Anything you enter here is available through the MetaService as well, and is your best route to quickly finding this particular speaker.
Role
A string. The role of the Speaker.
Url
A string. A url to a web page belonging to this Speaker.
EditSpeakersModule
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.
The
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.
Topic
An object with the following properties:
Attachments
List of Attachment objects.
The Attachment object has the following properties:
Description
A string. Description of the Attachment.
Url
A string. Url that points at the Attachment.
Description
A string. Description of this Topic.
Id
A string. Uniquely identifies this Topic. While adding new topics to a Webcast object, you can either leave Id blank, or enter a custom identifier that you use for creating Trigger objects. When you call the WebcastSave method, all Topic Ids are replaced by new ones.
Reference
A string. Use this property for your own identifiers. Anything you enter here is available through the MetaService as well, and is your best route to quickly finding this particular topic.
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 Topic.
EditTopicsModule
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.
The
LocalizedTopics object is a list of
Topic.
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.
Trigger
An object with the following properties:
ReceiverId
A string. The Id of the data item that receives the trigger to activate.
SenderId
A string. The Id of the data item that sends the trigger to activate.
EditWebcast
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.
Status
A
WebcastStatus object. This is a read only property that indicates what state this Webcast is in. You can use it to determine if you can still make changes to this Webcast and whether is has been accepted for production.
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.
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.
EditWebcastStatus
An enumeration that has one of the following possible values:
Archived
Indicates that the Webcast has been detached from the editable data model and it now only available for reading. A Webcast will never automatically reach this state, it can only be brought into this state manually by Company Webcast personnel.
Indexed
Indicates that the Webcast has been Indexed, and MediaStreams are now available for on demand playback. This state is automatically reached once the PreIndex state ends. Auxiliary files, such as mp3 conversions of the Webcast, are now available or will be very soon. Webcasts cannot currently be changed through the Management Service once this state is reached.
Live
Indicates that the Webcast is now live. Webcasts cannot currently be changed through the Management Service once this state is reached.
PreIndexed
Indicates that the Webcast's MediaStreams and auxiliary files are being post processed for on demand usage. This state is automatically reached once a live Webcast ends. In this state MediaStreams are available, but loop a "please wait" media clip. Webcasts cannot currently be changed through the Management Service once this state is reached.
PreLive
Indicates that the Webcast is soon to go live. This state is automatically reached 30 minutes before Webcast.ScheduledStart. MediaStreams are now available or will be very soon. MediaStreams loop a "starting soon" clip. Webcasts cannot currently be changed through the Management Service once this state is reached.
PreReady
Indicates that the Webcast exists, but cannot yet be taken into production. Webcasts have this state when they're freshly created with WebcastCreate, or when the Webcast object contains data that conflicts with the validation rules. One example of where this might happen is in multi language Webcasts. You can create Webcast objects that have 3 Topics in one language and 2 in another. Our rules say that this isn't allowed. So although we will accept that data, we cannot take it into production and hence its status remains PreReady until you correct it.
Ready
Indicates that the Webcast has been accepted to be taken into production. It will automatically reach the PreLive state 30 minutes before Webcast.ScheduledStart. Webcasts can still be edited while they're in this state.
EditWebcastSummary
An object with the following properties:
CustomerId
A string. Uniquely identifies the Customer to whom this Webcast belongs.
Title
A string. The title of this Webcast.
Revision
A string. The most recent date and time on which this Webcast was changed. When you save a Webcast object, its Revision property always has to contain the current Revision of that Webcast or it will fail to save.
ScheduledStart
A DateTime. The date and time on which this Webcast is or was scheduled to start.
WebcastCode
A string. Uniquely identifies this Webcast.
WebcastStatus