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
Management Service 2.0 : Methods
These are the methods of the Management Service: {TOC} ===CustomerGet=== Retrieves information about a Customer. Input parameters: :''Username'' ::A string. The username you received from Company Webcast. :''Password'' ::A string. The password you received from Company Webcast. :''CustomerCode'' ::A string. The unique Id of this Customer. Retrieve a Customer's Id through CustomerList. Returns: :''CustomerGetResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''Customer'' ::A ''[ManagementService_2.0_DataTypes.ashx#Customer|Customer]'' object. Contains information about a Customer. ===CustomerList=== Retrieves the list of Customers you have access to. Input parameters: :''Username'' ::A string. The username you received from Company Webcast. :''Password'' ::A string. The password you received from Company Webcast. :''PageNumber'' ::An integer. The amount of results returned by CustomerList 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. :''PageSize'' ::An integer. The maximum amount of results returned by CustomerList. Note that CustomerList can not return more than 100 results per call, and attempting to do so will result in an error. Returns: :''CustomerListResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''CustomerSummaries'' ::A list of ''[ManagementService_2.0_DataTypes.ashx#CustomerSummary|CustomerSummary]'' objects. ===WebcastCreate=== Creates a new Webcast based on a pre-existing Profile. Input parameters: :''Username'' ::A string. The username you received from Company Webcast. :''Password'' ::A string. The password you received from Company Webcast. :''CustomerCode'' ::A string. The unique Code of the Customer you want to create this Webcast for. Retrieve a Customer's Code through CustomerList or CustomerGet. :''ProfileId'' ::A string. The unique Id of the Customer you want to create this Webcast for. Retrieve a Customer's Profile Id's through CustomerGet. :''ScheduledStart'' ::A DateTime. Defines the date and time on which this new Webcast should start. :''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 webcast. Returns: :''WebcastCreateResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''WebcastCode'' ::A string. This is the automatically generated unique identifier for the Webcast you just created. You can now use this with WebcastGet in both the Management and the MetaService. ===WebcastDelete=== Deletes a Webcast. Input parameters: :''Username'' ::A string. The username you received from Company Webcast. :''Password'' ::A string. The password you received from Company Webcast. :''WebcastCode'' ::A string. The unique identifier for this Webcast. :''WebcastRevision'' ::A string. When you first create a Webcast, the Webcast object receives a Revision property, which is then automatically updated every time WebcastSave is called to reflect its last change date. Deleting a Webcast will only succeed if you enter the latest Revision date here. Retrieve a Webcast with WebcastGet and look at its Revision property. Returns: :''WebcastDeleteResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. ===WebcastGet=== Retrieves a Webcast. Input parameters: :''Username'' ::A string. The username you received from Company Webcast. :''Password'' ::A string. The password you received from Company Webcast. :''WebcastCode'' ::A string. The unique identifier for this Webcast. Returns: :''WebcastGetResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''Webcast'' ::A ''[ManagementService_2.0_DataTypes.ashx#Webcast|Webcast]'' object. Contains detailed information about a Webcast, which you can then modify and save back to the Management Service. ===WebcastSearch=== Retrieve a list of Webcasts. Input parameters: :''Username'' ::A string. The username you received from Company Webcast. :''Password'' ::A string. The password you received from Company Webcast. :''CustomerCode'' ::A string. The unique code of the person or organization that commissioned the Webcast. :''CustomerName'' ::A string. The (partial) name of the person or organization that commissioned the Webcast. :''TopicTitle'' ::A string. The (partial) title of a topic that was, is or will be discussed during a Webcast. :''SpeakerLastName'' ::A string. The (partial) last name of a speaker who was, is or will be present during a Webcast. :''WebcastTitle'' ::A string. The (partial) title of a Webcast. :''Reference'' ::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'' ::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'' ::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'' ::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'' ::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'' ::An enumeration of type ''[ManagementService_2.0_DataTypes.ashx#WebcastStatus|WebcastStatus]''. Multiple values can be set. :''PageNumber'' ::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. :''PageSize'' ::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. :''Order'' ::An enumeration of type ''[ManagementService_2.0_DataTypes.ashx#WebcastSearchOrder|WebcastSearchOrder]''. This defines the order in which the WebcastSearch results are returned to you. Returns: :''WebcastSearchResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''WebcastSummaries'' ::A list of ''[ManagementService_2.0_DataTypes.ashx#WebcastSummary|WebcastSummary]'' objects. ===WebcastSave=== Save changes to a Webcast. Input parameters: :''Username'' ::A string. The username you received from Company Webcast. :''Password'' ::A string. The password you received from Company Webcast. :''Webcast'' ::A ''[ManagementService_2.0_DataTypes.ashx#Webcast|Webcast]'' object. With WebcastGet you retrieved a ''Webcast'' object, which you then changed based on your parameters. This now modified ''Webcast'' object is being passed back to the service here. Returns: :''WebcastSaveResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''WebcastRevision'' ::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. WebcastSave always returns the updated Revision. ===WebcastHistoryList=== Retrieves a list of the versions that exist of a particular Webcast. Input parameters: :''Username'' ::A string. The username you received from Company Webcast. :''Password'' ::A string. The password you received from Company Webcast. :''WebcastCode'' ::A string. The unique identifier for this Webcast. Returns: :''WebcastHistoryListResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''WebcastRevisions'' ::A list of ''[ManagementService_2.0_DataTypes.ashx#WebcastRevision|WebcastRevision]'' objects. A WebcastRevision object contains information about when and by whom changes were made to a Webcast. You can use data retrieved here in combination with WebcastGetRevision to retrieve an older version of a Webcast. ===WebcastGetRevision=== Retrieves an older version of a Webcast. Input parameters: :''Username'' ::A string. The username you received from Company Webcast. :''Password'' ::A string. The password you received from Company Webcast. :''WebcastCode'' ::A string. The unique identifier for this Webcast. :''WebcastRevision'' ::A string. When you first create a Webcast, the Webcast object receives a Revision property, which is then automatically updated every time WebcastSave is called to reflect its last change date. Enter it here to retrieve a specific version of a Webcast. You can see which versions exist by calling WebcastHistoryList. Returns: :''WebcastGetRevisionResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''Webcast'' ::A ''[ManagementService_2.0_DataTypes.ashx#Webcast|Webcast]'' object. Contains detailed information about a Webcast, which you can then modify and save back to the Management Service. [anchor|#ResultCodes] ===Result codes=== All methods of the Management 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. ::-2 : Backend Service Error. ::-1 : Management Service Error. ::0 : Success ::1 : Invalid username or password. ::2 : Inconsistancy error, object was out of date. ::3 : This data document is not available. ::4 : ClientPageSizeError ::6 : Webcast cannot be deleted in its current state. ::1000: A validation error prevented this action. A data value is incorrect. ::1001: Webcast default language is not available in the selected language(s). ::1002: Webcast has no languages set. ::1003: Scheduled start date must not be in the past or very near future. ::1006: Webcast default language is not set. ::1007: Invalid timezone. ::1008: The webcast has two or more duplicate ID's. ::1009: At least one triggers refer to a non existing ID's.