Management Service 2.0 : Data Types

A string. Uniquely identifies this Customer.

A string. Description of this Customer.

A list of ModuleType objects. Describes which Modules are available for this Customer.

A string. The name of this Customer.

A list of Profile objects. A Profile contains pre-configured settings and data from which all new Webcasts are created.

A string. Ignore this for now.

A list of strings. This shows all the tags that have been added to Webcasts for this Customer so far.

A string. Uniquely identifies a Customer. Use it as an input parameter for CustomerGet.

A string. The name of a Customer.

A string. Ignore this for now.

A DateTime. UTC representation of the date and time on which an event ended.

A DateTime. UTC representation of the date and time on which an event started.

A string. Description of this Form.

A list of Event objects.

A string. Uniquely identifies this Form.

A list of Question objects.

A string. Use this property for your own identifiers.

A string. Title of this Form.

A string. This allows you to define the context in which this Form is to be used. If you're using the Player API and/or a Player provided to you by Company Webcast, you can enter one of the following types : survey, poll, registration (note that these require the corresponding ModuleTypes to be available to you). If you are creating your own Player or Player Module, just enter any other string that makes sense with your application.

A list of Event objects.

A string. Uniquely identifies this GenericItem.

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 item.

A string. Enter your own custom data here.

A string.

A string.

An object with the following properties:

A double.

A double.

A string. A 2 character ISO 3166-1 country code.

A string.

A string.

A string. The name of the time zone as defined in Zone.tab.

A string. Uniquely identifies this Profile.

A string. The title of this Profile.

A string. Short form descriptive field. Use for whatever you need.

A string. Uniquely identifies this Question.

A boolean. Indicates if an answer to this question is mandatory. If this is set to false, answering this Question is optional.

An integer. Indicates the maximum amount of characters that we want to accept from the user's answer to this Question.

A list of QuestionOption objects. If the Type of this Question is NOT Open, this contains the Options from which a user can make a selection.

A string. Use this property for your own identifiers.

A string. The text of the actual question you are posing the user. E.g. "What is your occupation?"

An enumeration of type QuestionType.

The QuestionType enumeration can have one of the following possible values:

A string. Short form descriptive field. Use for whatever you need.

A boolean. Indicates whether this is the correct option.

A string. Uniquely identifies this QuestionOption.

A string. Use this for your own identifiers.

A string. The actual text of the Option we are presenting to the user.

A list of Event objects.

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.

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.

A list of Slide objects.

A list of WebcastStatus objects. The SlidesModule and all the data it contains is only available in the WebcastStatus phases you explicitly define here.

A string. Defines the Category this Speaker belongs to.

A DateTime. Defines the date of birth of this Speaker.

A string. The email address of this Speaker.

A list of Event objects.

An enumeration that can have one of the following values:

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.

A string. A url to a picture of this Speaker.

An object with the following properties:

A string. First name of the Speaker.

A string. Last name of the Speaker.

A string. Middle name of the Speaker.

A string. Title of the Speaker.

A string. The phone number of the Speaker.

A string. The place of birth of the Speaker.

A string. Use this property for your own identifiers. Anything you enter here is available through the MetaService and PlayerSDK as well, and is your best route to quickly finding this particular speaker.

A string. The role of the Speaker.

A string. Used for mapping speakers to a specific seat.

A string. A url to a web page belonging to this Speaker.

A list of Speaker objects.

A list of WebcastStatus objects. The SpeakersModule and all the data it contains is only available in the WebcastStatus phases you explicitly define here.

List of TopicAttachment objects.

The TopicAttachment object has the following properties:

A string. Uniquely identifies this TopicAttachment.

A string. Description of the Attachment.

A string. Url that points at the Attachment.

A string. Description of this Topic.

A list of Event objects.

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.

A string. Use this property for your own identifiers. Anything you enter here is available through the MetaService and PlayerSDK as well, and is your best route to quickly finding this particular topic.

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.

A string. The title of this Topic.

A list of Topic objects.

A list of WebcastStatus objects. The TopicsModule and all the data it contains is only available in the WebcastStatus phases you explicitly define here.

A string. The Id of the data item that receives the trigger to activate.

A string. The Id of the data item that sends the trigger to activate.

A list of ModuleType objects. Each of the currently supported Modules 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.

A DateTime. UTC representation of the actual date and time on which the Webcast ended.

A DateTime. UTC representation of the actual date and time on which the Webcast started.

A string. Uniquely identifies a Webcast. It is automatically generated during WebcastCreate, and is a read only property.

A string. Gets or sets the 2 character country code that defines the default language.

A string. Description of this Webcast.

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.

A list of Form objects. A Form provides a way of presenting interactive content to a user. Forms can take the shape of registration pages, surveys and polls.

A list of GenericItem objects. A GenericItem allows for completely custom data to be plotted on a Webcast's timeline.

A list of 2 character language codes. Gets or sets the languages in which this Webcast is available.

A Location object. Contains information pertaining to the geographical location of the Webcast.

A string. The Id of the Profile that was used to initially create this Webcast.

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.

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. Webcasts with an out of date Revision will fail to save.

A DateTime. Gets or sets the date and time on which the Webcast should start.

A SlidesModule object. Contains configuration information and meta data for slides.

A SpeakersModule object. Contains configuration information and meta data for speakers.

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.

A list of strings. Tags are generally used for indexing purposes.

A string, the title of the Webcast.

A TopicsModule object. Contains configuration information and meta data for topics.

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.

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.

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.

Indicates that the Webcast is now live. Note that the Management Service only accepts changes to a Webcast's Events once that Webcast has reached the Indexed state.

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.

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. Note that the Management Service only accepts changes to a Webcast's Events once that Webcast has reached the Indexed state.

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.

Indicates that the Webcast has been accepted to be taken into production. It will automatically reach the PreLive state 30 minutes before Webcast.ScheduledStart.

A CustomerSummary object. Describes the Customer to whom this Webcast belongs.

A list of 2 character language codes. Gets or sets the languages in which this Webcast is available.

A string. Every time WebcastSave is called on a Webcast, its Revision is updated to reflect its last change. When you use WebcastSave, your Webcast's Revision has to always contain the latest Revision. Webcasts with an out of date Revision will fail to save.

A DateTime. The date and time on which this Webcast is or was scheduled to start.

A WebcastStatus object. Indicates the current WebcastStatus of this Webcast.

A string. The title of this Webcast.

A string. Uniquely identifies this Webcast.