Name
ChartGet
Description
Get a ChartList, a collection of Charts, which itself is a collection of ChartItems
Action
http://schemas.companywebcast.com/pulse/reportservice/v1/ReportService/ChartGet
Style
Document
Parameters
| Name
|
Type
|
Direction
|
Description
|
| Username |
string |
Input |
Username used for authentication
|
| Password |
string |
Input |
Password used for authentication
|
| ObjectType |
string |
Input |
ObjectType for a list of possible values
|
| ObjectIdentifier |
string |
Input |
CustomerCode for ObjectType Customer, WebcastKey for Webcast, Guid for Form
|
| Start |
dateTime |
Input |
Specifies a starting point for gathering timed information
|
| Period |
Period |
Input |
Used for calculating an end point for gathering timed information. This period is added to Start
|
| ChartTypes |
string |
Input |
A comma delimeted list of chart type names from Charts, where "Chart" will be appended to the type name
|
| PageSize |
int |
Input |
Used for paginating Chart results
|
| PageNumber |
int |
Input |
Used for paginating Chart results
|
Parameters
- Username
-
Type: string
Username used for authentication
- Password
-
Type: string
Password used for authentication
- ObjectType
-
Type: string
ObjectType for a list of possible values
- ObjectIdentifier
-
Type: string
CustomerCode for ObjectType Customer, WebcastKey for Webcast, Guid for Form
- Start
-
Type: dateTime
Specifies a starting point for gathering timed information
- Period
-
Type: Period
Used for calculating an end point for gathering timed information. This period is added to Start
- ChartTypes
-
Type: string
A comma delimeted list of chart type names from Charts, where "Chart" will be appended to the type name
- PageSize
-
Type: int
Used for paginating Chart results
- PageNumber
-
Type: int
Used for paginating Chart results
Returns
A ChartGetResponse element having the structure defined by the following table.
Input (Literal)
The input of this method is the document element ChartGet having the structure defined by the following table.
Output (Literal)
a ReturnCodeClientNotAuthorizedOrUnkown when authentication or authorisation fails InvalidInput when ObjectType does not conform to validation InvalidChartForObject when ChartTypes can not be converted to IChartInvalidInput when ObjectType is unexpected