Page History: ManagementService 1.1 : Methods
Compare Page Revisions
Page Revision: 2010/03/28 14:16
Behold the methods of the Management Service:
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.
CustomerId
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.
Customer
A
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.
PageSize
An integer.
Returns:
CustomerListResult
An integer. An indicator for the success or failure of your request.
CustomerSummaries
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.
CustomerId
A string. The unique Id of the Customer you want to create this Webcast for. Retrieve a Customer's Id 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.
PlannedStartDateTimeUtc
A DateTime. Defines the date and time on which this new Webcast should start.
Returns:
WebcastCreateResult
An integer. An indicator for the success or failure of your request.
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.
WebcastGet
Retrieve 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.
Webcast
A
Webcast object. Contains detailed information about a Webcast, which you can then modify and save back to the Management Service.WebcastList
Input parameters:
Username
Password
CustomerId
PageNumber
PageSize
Returns:
WebcastListResult
WebcastSummaries
WebcastSave
Input parameters:
Username
Password
Webcast
Returns:
WebcastSaveResult
WebcastRevision''