Page History: Management Service 2.0 : Methods
Compare Page Revisions
Page Revision: 2011/07/04 13:08
These are 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. Look at
Result Codes for more information.
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. 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
Result Codes for more information.
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.
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
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
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
Result Codes for more information.
Webcast
A
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.
CustomerId
A string. The unique Id of this Customer. Retrieve a Customer's Id through CustomerList.
PageNumber
An integer. The amount of results returned by WebcastList 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.
Returns:
WebcastSearchResult
An integer. An indicator for the success or failure of your request. Look at
Result Codes for more information.
WebcastSummaries
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
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
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.
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.