Companywebcast API Wiki
Navigation
Cwc API Home
PlayerSDK
Meta Service
Getting Started
Creating a client
Methods
Data Types
Understanding Webcast security
Management Service
Getting Started
Creating a client
Methods
Data Types
Quick Search
Advanced Search »
Back
History
MetaService 1.1 : Methods
The Meta Service exposes 2 methods that you can use to find webcasts and retrieve their metadata. You'll need to explain to the MetaService which data you're after, and below is the list of input parameters that you can do that with. {TOC} Typically a client would call WebcastSearch to retrieve WebcastSummaries, which give some basic info about the webcasts that match the search parameters. A client would then use elements from a WebcastSummary as input parameters for a call to WebcastGet. WebcastGet returns a Webcast object, which contains detailed information about a single webcast, in a single language. ====WebcastSearch==== Input parameters: :''Username'' ::Required, a string. The user name provided to you by Companywebcast that allows access to the Webcast Management System, or was specifically created for consuming the MetaService. :''Password'' ::Required, a string. The password provided to you by Companywebcast that allows access to the Webcast Management System, or was specifically created for consuming the MetaService. :''CustomerName'' ::Optional, a string. The (partial) name of the person or organization that commissioned the Webcast. If you do not set CustomerName, you'll search in all Webcasts your MetaService account has access to. :''TopicTitle'' ::Optional, a string. The (partial) title of a topic that was discussed during a Webcast. :''SpeakerLastName'' ::Optional, a string. The (partial) last name of a speaker who was present during a Webcast. :''WebcastTitle'' ::Optional, a string. The (partial) title of a Webcast. :''Reference'' ::Optional, a string. The Reference string attached to a Webcast or data item. Note: a Reference will only create a Hit if it matches exactly. Unlike most other WebcastSearch input parameters, Reference does not hit on substrings. :''TagNames'' ::Optional, a ''Tags'' object, which is essentially an Array of String. A collection of tags that may be attached to a Webcast or data item. Note : Unlike most other WebcastSearch input parameters, Tags do not hit on substrings. :''QueryText'' ::Optional, a string. Can contain one or more words which are matched against all available data items in Webcasts. Multiple words between double quotes are matched as a sentence. :''PeriodFrom'' ::Optional, a DateTime/Calendar. The date and time at which to start WebcastSearch. Older webcasts will not be returned. Note that all dates and times used throughout the MetaService are UTC. You will have to compensate for your timezone when working with any DateTime in the MetaService. :''PeriodTo'' ::Optional, a DateTime/Calendar. The date and time at which to end WebcastSearch. Newer webcasts will not be returned. Note that all dates and times used throughout the MetaService are UTC. You will have to compensate for your timezone when working with any DateTime in the MetaService. :''Status'' ::Optional, an enumeration of type WebcastStatus. Multiple values can be set. :''PageSize'' ::Optional, an integer. The maximum amount of results returned by WebcastSearch. Note that WebcastSearch can not return more than 100 results per call, and attempting to do so will result in an error. :''PageNumber'' ::Optional, an integer. The amount of results returned by WebcastSearch is less or equal to the value of PageSize, with a maximum of 100. If more results are available they are spread out across Pages, which you can navigate with PageNumber. The first page is 0. returns: :''WebcastSearchResult'' ::An integer that indicates the success or failure of your WebcastSearch request. Look at [#ResponseCodes|Response Codes] for more information. :''WebcastSummaries'' ::A list of ''[MetaService_1.1_DataTypes.ashx#WebcastSummary|WebcastSummary]'' objects. A WebcastSummary object contains basic information about a Webcast, and elements you need for WebcastGet. ====WebcastGet==== Input parameters: :''Username'' ::Required, a string. The username provided to you by Companywebcast that allows access to the Webcast Management System, or was specifically created for consuming the MetaService. :''Password'' ::Required, a string. The password provided to you by Companywebcast that allows access to the Webcast Management System, or was specifically created for consuming the MetaService. :''Code'' ::Required, a string. Uniquely identifies the Webcast for which you want to retrieve metadata. To find out what the Code of a Webcast is, call WebcastSearch to retrieve a WebcastSummary and use its Code property. :''Language'' ::Optional, a string. The language for which you want to retrieve metadata. To find out which languages are available for a Webcast, call WebcastSearch to retrieve a WebcastSummary and use its Languages property. If you don't set a language, the default language will be returned. returns: :''WebcastGetResult'' ::An integer that indicates the success or failure of your WebcastGet request. Look at [#ResponseCodes|Response Codes] for more information. :''Webcast'' ::A ''[MetaService_1.1_DataTypes.ashx#Webcast|Webcast]'' object. The Webcast object contains detailed information about a Webcast. [anchor|#ResponseCodes] ====Response codes==== All methods of the Meta Service return a Result code, which is always an integer which defines the success or failure of your request. The table below maps these codes onto their corresponding messages. ::0 = success :Positive / client error: ::1 = Invalid Webcast Code ::2 = Page size exceeds 100 ::3 = Not authorized :Negative / server error: ::-1 = Server error ::-2 = Service temporarily offline