Companywebcast API Wiki

Page History: ManagementService 1.1 : Methods

Compare Page Revisions



« Older Revision - Back to Page History - Newer Revision »


Page Revision: 2010/03/28 14:06


Behold the methods of the Management Service:

Table of Contents [Hide/Show]


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
A list of 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.
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

Input parameters:
Username
Password
WebcastCode
WebcastRevision

Returns:
WebcastDeleteResult

WebcastGet

Input parameters:
Username
Password
WebcastCode

Returns:
WebcastGetResult
Webcast

WebcastList

Input parameters:
Username
Password
CustomerId
PageNumber
PageSize

Returns:
WebcastListResult
WebcastSummaries

WebcastSave

Input parameters:
Username
Password
Webcast

Returns:
WebcastSaveResult
WebcastRevision