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
ReportService 1.0 : Methods
These are the methods of the Report Service: {TOC} ===ChartGet=== Retrieves a Chart. Input parameters: :''Username'' ::A string. The username you received from Company Webcast. :''Password'' ::A string. The password you received from Company Webcast. :''ObjectType'' ::A string. :''ObjectIdentifier'' ::A string. :''Start'' ::A DateTime. :''Period'' ::An enumeration value. :''CustomerChartTypes'' ::A string. :''PageSize'' ::An integer. :''PageNumber'' ::An integer. Returns: :''ChartGetResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''Charts'' ::A collection of ''Chart'' objects. ===CustomerGet=== Retrieves 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. :''Start'' ::A DateTime. :''Period'' ::An enumeration value. Returns: :''CustomerGetResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''Charts'' ::A ''Customer'' object. ===FormsGet=== Retrieves Forms. 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. Returns: :''FormsGetResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''Forms'' ::A collection of ''Form'' objects. ===ExcelSend=== Sends an Excel file. 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. :''Email'' ::A string. Returns: :''SendExcelResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. ===VisitorGet=== Retrieves a Visitor. 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. :''VisitorId'' ::A string. :''Start'' ::A DateTime. :''Period'' ::An enumeration value. Returns: :''ChartGetResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''Visitor'' ::A ''Visitor'' object. ===VisitorSearch=== Searches for Visitors. 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. :''Email'' ::A string. :''Start'' ::A DateTime. :''Period'' ::An enumeration value. :''PageSize'' ::An integer. :''PageNumber'' ::An integer. Returns: :''VisitorSearchResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''VisitorSummaries'' ::A collection of ''VisitorSummary'' objects. ===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. :''Start'' ::A DateTime. :''Period'' ::An enumeration value. :''Filter'' ::An enumeration value. Returns: :''WebcastGetResult'' ::An integer. An indicator for the success or failure of your request. Look at [#ResultCodes|Result Codes] for more information. :''Webcast'' ::A ''Webcast'' object. [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.