Page History: Report Service
Compare Page Revisions
Page Revision: 2013/04/12 11:01
ReportService
Table of Contents
ReportService
Sources
Name |
Description |
ReportService |
The Report service interface contains functionality to retreive Statistics and Reports for a webcast. - Statistics contains datetime based data - Reports contains datetime independent data for a webcast, module or visitor All methods return an enum value to indicate error or success. See ReturnCode for the possible values.
|
ReportService Web Service
Description
The Report service interface contains functionality to retreive Statistics and Reports for a webcast. - Statistics contains datetime based data - Reports contains datetime independent data for a webcast, module or visitor All methods return an enum value to indicate error or success. See ReturnCode for the possible values.
Methods: ReportService
Method: ChartGet
Description
Get a ChartList, a collection of Charts, which itself is a collection of ChartItems
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
|
Charts |
Charts |
Output |
A ChartList
|
Output (Literal)
The output of this method is the document element ChartGetResponse having the structure defined by the following table.
Method: CustomerGet
Description
Get a Customer, containing running totals of visitors and views
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
CustomerCode |
string |
Input |
Code used to identify a customer
|
Start |
dateTime |
Input |
Specifies a starting point for gathering running totals
|
Period |
Period |
Input |
Used for calculating an end point for gathering running totals. This period is added to Start
|
Customer |
Customer |
Output |
a Customer, or null if not found
|
Output (Literal)
The output of this method is the document element CustomerGetResponse having the structure defined by the following table.
Method: ExcelSend
Description
Request for an Excel report to be sent to Email
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
WebcastCode |
string |
Input |
Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
|
Email |
string |
Input |
a valid email address
|
Output (Literal)
The output of this method is the document element ExcelSendResponse having the structure defined by the following table.
Method: FormsGet
Description
Get a collection of Forms
Parameters
Name |
Type |
Direction |
Description |
UserName |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
WebcastCode |
string |
Input |
Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
|
Forms |
Forms |
Output |
A collection of Forms
|
Output (Literal)
The output of this method is the document element FormsGetResponse having the structure defined by the following table.
Method: UserGet
Description
Get a User, containing webcast usage statistics
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
CustomerUserName |
string |
Input |
Uniquely identies a User
|
User |
User |
Output |
A User
|
Output (Literal)
The output of this method is the document element UserGetResponse having the structure defined by the following table.
Method: UserSearch
Description
Get a list of UserSummarys based on the specified filters.
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
CustomerCode |
string |
Input |
Code used to identify a customer, returns InvalidInput when not a null or empty
|
UserNameFilter |
string |
Input |
(part of) the user's name
|
UserUsernameFilter |
string |
Input |
(part of) the user's username
|
UserEmailFilter |
string |
Input |
(part of) a valid emailaddress
|
UserTagsFilter |
TagList |
Input |
a collection of Tags
|
PageSize |
int |
Input |
Used for paginating results
|
PageNumber |
int |
Input |
Used for paginating results
|
Order |
UserOrdering |
Input |
Orders the results
|
UserSummaries |
UserSummaryList |
Output |
a list of UserSummarys
|
Output (Literal)
The output of this method is the document element UserSearchResponse having the structure defined by the following table.
Method: VisitorCompletedForm
Description
Tests if a certain form has been completed by a specific visitor
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
WebcastCode |
string |
Input |
Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
|
VisitorId |
string |
Input |
Uniquely identifies a Visitor
|
FormId |
string |
Input |
Uniquely identifies a Form
|
Answered |
boolean |
Output |
true if answered
|
Output (Literal)
The output of this method is the document element VisitorCompletedFormResponse having the structure defined by the following table.
Method: VisitorGet
Description
Get a Visitor, containing detailed reports about visitors
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
WebcastCode |
string |
Input |
Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
|
VisitorId |
string |
Input |
Uniquely identifies a Visitor
|
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
|
Visitor |
Visitor |
Output |
A Visitor, or null if not found
|
Output (Literal)
The output of this method is the document element VisitorGetResponse having the structure defined by the following table.
Method: VisitorSearch
Description
Search Visitors by (part of) email address returns a VisitorSummary, for detailed visitor info see: VisitorGet
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
WebcastCode |
string |
Input |
Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
|
Email |
string |
Input |
(part of) an emailadress used for searching
|
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
|
PageSize |
int |
Input |
Used for paginating results
|
PageNumber |
int |
Input |
Used for paginating results
|
Ordering |
VisitorOrderByList |
Input |
Used to order results
|
VisitorSummaries |
VisitorSummaries |
Output |
a collection of VisitorSummary
|
Output (Literal)
The output of this method is the document element VisitorSearchResponse having the structure defined by the following table.
Method: VisitorWatchedSince
Description
Gets an array of DateTimes, from a specific starting point
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
WebcastCode |
string |
Input |
Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
|
VisitorId |
string |
Input |
Uniquely identifies a Visitor
|
From |
dateTime |
Input |
Specifies a starting point for gathering timed information
|
Watched |
ArrayOfdateTime |
Output |
An array of DateTime
|
Output (Literal)
The output of this method is the document element VisitorWatchedSinceResponse having the structure defined by the following table.
Method: WebcastCurrentViewersGet
Description
Get a count of the current amount of viewers of a specific webcast, this result can be cached for 1 minute.
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
WebcastCode |
string |
Input |
Webcast Code
|
ViewersCount |
long |
Output |
The number of viewers
|
Output (Literal)
The output of this method is the document element WebcastCurrentViewersGetResponse having the structure defined by the following table.
Method: WebcastGet
Description
Get a Webcast containing running totals of minutes watched and amount of viewers for a specified period of time
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
WebcastCode |
string |
Input |
Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
|
Start |
dateTime |
Input |
Specifies a starting point for gathering running totals
|
Period |
Period |
Input |
Used for calculating an end point for gathering running totals. This period is added to Start
|
Filter |
WebcastFilter |
Input |
Use WebcastFilter to retrieve only specific report data (such as poll)
|
Webcast |
Webcast |
Output |
A Webcast, or null if not found
|
Output (Literal)
The output of this method is the document element WebcastGetResponse having the structure defined by the following table.
Method: WebcastSearch
Description
Get a collection of WebcastSummarys
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
CustomerCode |
string |
Input |
Code used to identify a customer
|
Title |
string |
Input |
(part of) a webcast title
|
Tags |
TagList |
Input |
a collection of Tags
|
PageSize |
int |
Input |
Used for paginating results
|
PageNumber |
int |
Input |
Used for paginating results
|
Order |
WebcastOrdering |
Input |
Orders the results
|
WebcastSummaries |
WebcastSummaryList |
Output |
a collection of WebcastSummarys, or null if not found
|
Output (Literal)
The output of this method is the document element WebcastSearchResponse having the structure defined by the following table.
Method: WebcastSummaryGet
Description
Get a WebcastSummary, this data can be cached for 1 minute.
Parameters
Name |
Type |
Direction |
Description |
Username |
string |
Input |
Username used for authentication
|
Password |
string |
Input |
Password used for authentication
|
WebcastCode |
string |
Input |
Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
|
WebcastSummary |
WebcastSummary |
Output |
A WebcastSummary, or null if not found
|
Output (Literal)
The output of this method is the document element WebcastSummaryGetResponse having the structure defined by the following table.
Complex Types: ReportService
Complex Type: Activity
Description
Describes occurance activity for a certain item Examples: - A webcast usually occurs once (Total=1) and has a Duration - A speaker can occur multiple times (Total=n) in a webcast and has a (total)Duration and the average speaking time for a speaker in a webcast = Duration/Total
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Duration |
long |
0..1 |
The total amount of time spent during this activity
|
Total |
int |
0..1 |
Counts the amount of times activity has been registered
|
|
|
|
|
Referenced By
Complex Type: Answer
Description
A form anwser from a web visitor
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Date |
dateTime |
0..1 |
|
Label |
string |
0..1 |
|
Value |
string |
0..1 |
|
VisitorId |
string |
0..1 |
|
|
|
|
|
Referenced By
Complex Type: Answers
Description
A collection of Answers
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: ArrayOfdateTime
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
dateTime |
dateTime |
0..* |
|
|
|
|
|
Referenced By
Complex Type: Chart
Description
Chart data class
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: ChartItem
Description
Data class for retreiving a simple lightweight sortable item - Id refers to the full item for more details. - Value holds the requested chartvalue, for example: number of downloads
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Id |
string |
0..1 |
|
Title |
string |
0..1 |
|
Value |
long |
0..1 |
|
|
|
|
|
Referenced By
Complex Type: ChartItems
Description
A collection of ChartItems
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Charts
Description
A collection of Charts
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Chart |
Chart |
0..* |
|
|
|
|
|
Referenced By
Complex Type: Customer
Description
Describes Customer usage statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Download
Description
Describes download statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Id |
string |
0..1 |
|
Title |
string |
0..1 |
|
Type |
string |
0..1 |
|
Views |
Views |
0..1 |
|
|
|
|
|
Referenced By
Complex Type: Downloads
Description
A collecion of Downloads
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Form
Description
Contains a collection of Questions
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Forms
Description
A Collection of Forms
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Form |
Form |
0..* |
|
|
|
|
|
Referenced By
Complex Type: MediaStream
Description
Describes MediaStream usage statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: MediaStreams
Description
A collection of MediaStreams
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Name
Description
Describes a person's name
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
First |
string |
0..1 |
|
Last |
string |
0..1 |
|
Middle |
string |
0..1 |
|
Title |
string |
0..1 |
|
|
|
|
|
Referenced By
Complex Type: Option
Description
A form question Option
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Options
Description
A collection of Options
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Question
Description
A Survey or poll question containing: -all possible answers (if multiple choice) -correct answers -given answers by visitors
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Questions
Description
A collection of Questions
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Session
Description
Describes Web visitor session statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Sessions
Description
A collection of Sessions
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: SessionTotal
Description
Describes Web visitor session statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Settings
Description
A collection of Strings used to store user settings
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
string |
string |
0..* |
|
|
|
|
|
Referenced By
Complex Type: Span
Description
A collection of SpanParts
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: SpanPart
Description
Holds an amount over a span of time Used for generating graphs (that contains multiple SpanParts)
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: TagList
Description
A collection of Strings used to classify a webcast
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
string |
string |
0..* |
|
|
|
|
|
Referenced By
Complex Type: User
Description
Describes a user's usage statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: UserDetails
Description
Describes a user's name, email and username
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: UserSummary
Description
Describes a user
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: UserSummaryList
Description
A collection of UserSummarys
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Views
Description
Describes views on a webcast element Examples: - a Topic is viewed by 20 visitors (Viewers=20) over 23 sessions (Total=23) The combined duration that an item is viewed is 46 minutes (Duration=46) The average view duration for this topic = Duration/Total = 2 minutes per session
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Visitor
Description
Describes extended visitor usage statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: VisitorOrderByList
Description
A collection of VisitorOrderBys
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: VisitorSummaries
Description
A collection of VisitorSummarys
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: VisitorSummary
Description
Describes visitor usage statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: Webcast
Description
Describes webcast usage statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: WebcastDetails
Description
Describes a webcast
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: WebcastSummary
Description
Describes concise webcast usage statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: WebcastSummaryList
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: WebcastUserSummary
Description
Describes user webcast statistics
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Complex Type: WebcastUserSummaryList
Description
A collection of WebcastUserSummarys
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Referenced By
Simple Types: ReportService
Simple Types
Name |
Description |
char |
|
duration |
|
guid |
|
Period |
Defines a time span
|
ReturnCode |
The return code indicates failure or success on a method call. A possitive error indicates a client side error which needs an action by the client to resolve the error. A negative error indicates a server side error. A client does not need to do a specific task except to retry the action. Zero indicates success.
|
UserOrdering |
Used to order user queries
|
VisitorOrderBy |
Used to order visitor queries
|
WebcastFilter |
Filter for finetuning results
|
WebcastOrdering |
Used to order webcast queries
|
Simple Type: char
Derived By
Restricting int
Referenced By
Simple Type: duration
Derived By
Restricting duration
Restrictions
-
Value must match the following pattern: \-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?
-
The value must be greater than or equal to -P10675199DT2H48M5.4775808S.
-
The value must be less than or equal to P10675199DT2H48M5.4775807S.
Referenced By
Simple Type: guid
Derived By
Restricting string
Restrictions
Referenced By
Simple Type: Period
Description
Defines a time span
Derived By
Restricting string
Enumeration
Value |
Description |
All |
All time periods
|
Year |
Year period
|
Month |
Month period
|
Day |
Day period
|
Hour |
Hour period
|
Minute |
Minute period
|
Referenced By
Simple Type: ReturnCode
Description
The return code indicates failure or success on a method call. A possitive error indicates a client side error which needs an action by the client to resolve the error. A negative error indicates a server side error. A client does not need to do a specific task except to retry the action. Zero indicates success.
Derived By
Restricting string
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Simple Type: UserOrdering
Description
Used to order user queries
Derived By
Restricting string
Enumeration
Value |
Description |
UserNameAsc |
sort by user name ascending
|
UserNameDesc |
sort by user name descending
|
VisitedAsc |
sort by visited ascending
|
VisitedDesc |
sort by visited descending
|
SubscribedAsc |
sort by subscribed ascending
|
SubscribedDesc |
sort by subscribed descending
|
Referenced By
Simple Type: VisitorOrderBy
Description
Used to order visitor queries
Derived By
Restricting string
Enumeration
Value |
Description |
PercentageWatchedDesc |
|
PercentageWatchedAsc |
|
SessionFromAsc |
|
SessionFromDesc |
|
SessionToAsc |
|
SessionToDesc |
|
VisitorIdDesc |
|
VisitorIdAsc |
|
TotalMinutesViewedDesc |
|
TotalMinutesViewedAsc |
|
QuestionsIncorrectDesc |
|
QuestionsIncorrectAsc |
|
EmailAsc |
|
EmailDesc |
|
DomainAsc |
|
DomainDesc |
|
ContinentCodeAsc |
|
ContinentCodeDesc |
|
RegionAsc |
|
RegionDesc |
|
CountryAsc |
|
CountryDesc |
|
CityAsc |
|
CityDesc |
|
LongitudeAsc |
|
LongitudeDesc |
|
LatitudeAsc |
|
LatitudeDesc |
|
IpAddressAsc |
|
IpAddressDesc |
|
RefererAsc |
|
RefererDesc |
|
PlayerUrlAsc |
|
PlayerUrlDesc |
|
UserAgentStringAsc |
|
UserAgentStringDesc |
|
WatchedLiveAsc |
|
WatchedLiveDesc |
|
Referenced By
Simple Type: WebcastFilter
Description
Filter for finetuning results
Derived By
List
Enumeration
Value |
Description |
MediaStreams |
|
Referenced By
Simple Type: WebcastOrdering
Description
Used to order webcast queries
Derived By
Restricting string
Enumeration
Value |
Description |
CodeAsc |
|
CodeDesc |
|
TitleAsc |
|
TitleDesc |
|
SubscribersAsc |
|
SubscribersDesc |
|
StartAsc |
|
StartDesc |
|
ViewersAsc |
|
ViewersDesc |
|
Referenced By
Elements: ReportService
Derived By
Type Activity
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Duration |
long |
0..1 |
The total amount of time spent during this activity
|
Total |
int |
0..1 |
Counts the amount of times activity has been registered
|
|
|
|
|
Referenced By
Definition
See Customer
Derived By
Type Activity
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Duration |
long |
0..1 |
The total amount of time spent during this activity
|
Total |
int |
0..1 |
Counts the amount of times activity has been registered
|
|
|
|
|
Referenced By
Definition
See MediaStream
Derived By
Type Activity
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Duration |
long |
0..1 |
The total amount of time spent during this activity
|
Total |
int |
0..1 |
Counts the amount of times activity has been registered
|
|
|
|
|
Referenced By
Definition
See Webcast
Element: Activity
Derived By
Type Activity
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Duration |
long |
0..1 |
The total amount of time spent during this activity
|
Total |
int |
0..1 |
Counts the amount of times activity has been registered
|
|
|
|
|
Derived By
Type dateTime
Referenced By
Definition
See Webcast
Derived By
Type dateTime
Referenced By
Definition
See WebcastDetails
Derived By
Type dateTime
Referenced By
Definition
See Webcast
Derived By
Type dateTime
Referenced By
Definition
See WebcastDetails
Derived By
Type Answer
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Date |
dateTime |
0..1 |
|
Label |
string |
0..1 |
|
Value |
string |
0..1 |
|
VisitorId |
string |
0..1 |
|
|
|
|
|
Referenced By
Definition
See Answers
Element: Answer
Derived By
Type Answer
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Date |
dateTime |
0..1 |
|
Label |
string |
0..1 |
|
Value |
string |
0..1 |
|
VisitorId |
string |
0..1 |
|
|
|
|
|
Derived By
Type boolean
Referenced By
Definition
See VisitorCompletedFormResponse
Derived By
Type Answers
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Question
Element: Answers
Derived By
Type Answers
Content Model
Contains elements as defined in the following table.
Element: anyType
Element: anyURI
Element: ArrayOfdateTime
Derived By
Type ArrayOfdateTime
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
dateTime |
dateTime |
0..* |
|
|
|
|
|
Element: base64Binary
Derived By
Type base64Binary
Element: boolean
Element: byte
Element: char
Derived By
Type Chart
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Charts
Element: Chart
Derived By
Type Chart
Content Model
Contains elements as defined in the following table.
Element: ChartGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: ChartGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See ChartGetResponse
Derived By
Type ChartItem
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Id |
string |
0..1 |
|
Title |
string |
0..1 |
|
Value |
long |
0..1 |
|
|
|
|
|
Referenced By
Definition
See ChartItems
Element: ChartItem
Derived By
Type ChartItem
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Id |
string |
0..1 |
|
Title |
string |
0..1 |
|
Value |
long |
0..1 |
|
|
|
|
|
Element: ChartItems
Derived By
Type ChartItems
Content Model
Contains elements as defined in the following table.
Derived By
Type Charts
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Chart |
Chart |
0..* |
|
|
|
|
|
Referenced By
Definition
See ChartGetResponse
Element: Charts
Derived By
Type Charts
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Chart |
Chart |
0..* |
|
|
|
|
|
Derived By
Type string
Referenced By
Definition
See ChartGet
Derived By
Type int
Referenced By
Definition
See Webcast
Derived By
Type string
Referenced By
Definition
See Session
Derived By
Type string
Referenced By
Definition
See SessionTotal
Derived By
Type string
Referenced By
Definition
See Webcast
Derived By
Type string
Referenced By
Definition
See WebcastDetails
Derived By
Type string
Referenced By
Definition
See Session
Derived By
Type string
Referenced By
Definition
See SessionTotal
Derived By
Type string
Referenced By
Definition
See Session
Derived By
Type string
Referenced By
Definition
See SessionTotal
Derived By
Type Customer
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See CustomerGetResponse
Element: Customer
Derived By
Type Customer
Content Model
Contains elements as defined in the following table.
Derived By
Type string
Referenced By
Definition
See CustomerGet
Derived By
Type string
Referenced By
Definition
See UserSearch
Derived By
Type string
Referenced By
Definition
See WebcastSearch
Element: CustomerGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: CustomerGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See CustomerGetResponse
Derived By
Type string
Referenced By
Definition
See UserGet
Derived By
Type dateTime
Referenced By
Definition
See Answer
Derived By
Type dateTime
Referenced By
Definition
See ArrayOfdateTime
Element: dateTime
Element: decimal
Derived By
Type UserDetails
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See UserSummary
Derived By
Type WebcastDetails
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastSummary
Derived By
Type string
Referenced By
Definition
See Session
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: double
Derived By
Type Download
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Id |
string |
0..1 |
|
Title |
string |
0..1 |
|
Type |
string |
0..1 |
|
Views |
Views |
0..1 |
|
|
|
|
|
Referenced By
Definition
See Downloads
Element: Download
Derived By
Type Download
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Id |
string |
0..1 |
|
Title |
string |
0..1 |
|
Type |
string |
0..1 |
|
Views |
Views |
0..1 |
|
|
|
|
|
Derived By
Type Downloads
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Visitor
Element: Downloads
Derived By
Type Downloads
Content Model
Contains elements as defined in the following table.
Description
The total amount of downloads
Derived By
Type int
Referenced By
Definition
See Customer
Derived By
Type int
Referenced By
Definition
See VisitorSummary
Description
The total amount of time spent during this activity
Derived By
Type long
Referenced By
Definition
See Activity
Derived By
Type long
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Element: duration
Derived By
Type duration
Restrictions
-
Value must match the following pattern: \-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?
-
The value must be greater than or equal to -P10675199DT2H48M5.4775808S.
-
The value must be less than or equal to P10675199DT2H48M5.4775807S.
Derived By
Type string
Referenced By
Definition
See ExcelSend
Derived By
Type string
Referenced By
Definition
See VisitorSearch
Derived By
Type string
Referenced By
Definition
See UserDetails
Derived By
Type string
Referenced By
Definition
See Visitor
Derived By
Type string
Referenced By
Definition
See VisitorSummary
Derived By
Type dateTime
Referenced By
Definition
See Session
Derived By
Type dateTime
Referenced By
Definition
See SessionTotal
Element: ExcelSend
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: ExcelSendResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See ExcelSendResponse
Derived By
Type WebcastFilter
Referenced By
Definition
See WebcastGet
Derived By
Type string
Referenced By
Name |
Type |
Name |
Complex Type |
Definition
See Name
Element: float
Derived By
Type Form
Content Model
Contains elements as defined in the following table.
Referenced By
Name |
Type |
Forms |
Complex Type |
Definition
See Forms
Element: Form
Derived By
Type Form
Content Model
Contains elements as defined in the following table.
Derived By
Type string
Referenced By
Definition
See VisitorCompletedForm
Derived By
Type Forms
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Form |
Form |
0..* |
|
|
|
|
|
Referenced By
Definition
See FormsGetResponse
Derived By
Type Forms
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Form |
Form |
0..* |
|
|
|
|
|
Referenced By
Definition
See Visitor
Element: Forms
Derived By
Type Forms
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
Form |
Form |
0..* |
|
|
|
|
|
Element: FormsGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: FormsGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See FormsGetResponse
Derived By
Type dateTime
Referenced By
Definition
See VisitorWatchedSince
Derived By
Type dateTime
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Element: guid
Derived By
Type guid
Restrictions
Derived By
Type string
Referenced By
Definition
See ChartItem
Description
This customer's id
Derived By
Type string
Referenced By
Definition
See Customer
Derived By
Type string
Referenced By
Definition
See Download
Derived By
Type guid
Restrictions
Referenced By
Name |
Type |
Form |
Complex Type |
Definition
See Form
Derived By
Type string
Referenced By
Definition
See MediaStream
Derived By
Type guid
Restrictions
Referenced By
Definition
See Option
Derived By
Type guid
Restrictions
Referenced By
Definition
See Question
Derived By
Type string
Referenced By
Definition
See Session
Derived By
Type string
Referenced By
Definition
See SessionTotal
Derived By
Type string
Referenced By
Definition
See Visitor
Derived By
Type string
Referenced By
Definition
See VisitorSummary
Derived By
Type string
Referenced By
Definition
See Webcast
Element: int
Derived By
Type string
Referenced By
Definition
See Session
Derived By
Type string
Referenced By
Definition
See SessionTotal
Derived By
Type boolean
Referenced By
Definition
See Option
Derived By
Type ChartItems
Content Model
Contains elements as defined in the following table.
Referenced By
Name |
Type |
Chart |
Complex Type |
Definition
See Chart
Derived By
Type string
Referenced By
Definition
See Answer
Derived By
Type string
Referenced By
Name |
Type |
Name |
Complex Type |
Definition
See Name
Derived By
Type float
Referenced By
Definition
See Session
Derived By
Type float
Referenced By
Definition
See SessionTotal
Description
Is this a live stream?
Derived By
Type boolean
Referenced By
Definition
See MediaStream
Derived By
Type dateTime
Referenced By
Definition
See Webcast
Element: long
Derived By
Type float
Referenced By
Definition
See Session
Derived By
Type float
Referenced By
Definition
See SessionTotal
Derived By
Type boolean
Referenced By
Definition
See Question
Derived By
Type MediaStream
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See MediaStreams
Element: MediaStream
Derived By
Type MediaStream
Content Model
Contains elements as defined in the following table.
Derived By
Type MediaStreams
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Webcast
Element: MediaStreams
Derived By
Type MediaStreams
Content Model
Contains elements as defined in the following table.
Derived By
Type string
Referenced By
Name |
Type |
Name |
Complex Type |
Definition
See Name
Derived By
Type int
Referenced By
Definition
See WebcastUserSummary
Derived By
Type dateTime
Referenced By
Definition
See Webcast
Derived By
Type Name
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
First |
string |
0..1 |
|
Last |
string |
0..1 |
|
Middle |
string |
0..1 |
|
Title |
string |
0..1 |
|
|
|
|
|
Referenced By
Definition
See UserDetails
Element: Name
Derived By
Type Name
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
First |
string |
0..1 |
|
Last |
string |
0..1 |
|
Middle |
string |
0..1 |
|
Title |
string |
0..1 |
|
|
|
|
|
Derived By
Type string
Referenced By
Definition
See ChartGet
Derived By
Type string
Referenced By
Definition
See ChartGet
Derived By
Type Option
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Options
Element: Option
Derived By
Type Option
Content Model
Contains elements as defined in the following table.
Derived By
Type Options
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Question
Element: Options
Derived By
Type Options
Content Model
Contains elements as defined in the following table.
Derived By
Type UserOrdering
Enumeration
Value |
Description |
UserNameAsc |
sort by user name ascending
|
UserNameDesc |
sort by user name descending
|
VisitedAsc |
sort by visited ascending
|
VisitedDesc |
sort by visited descending
|
SubscribedAsc |
sort by subscribed ascending
|
SubscribedDesc |
sort by subscribed descending
|
Referenced By
Definition
See UserSearch
Derived By
Type WebcastOrdering
Enumeration
Value |
Description |
CodeAsc |
|
CodeDesc |
|
TitleAsc |
|
TitleDesc |
|
SubscribersAsc |
|
SubscribersDesc |
|
StartAsc |
|
StartDesc |
|
ViewersAsc |
|
ViewersDesc |
|
Referenced By
Definition
See WebcastSearch
Derived By
Type VisitorOrderByList
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See VisitorSearch
Derived By
Type int
Referenced By
Definition
See ChartGet
Derived By
Type int
Referenced By
Definition
See UserSearch
Derived By
Type int
Referenced By
Definition
See VisitorSearch
Derived By
Type int
Referenced By
Definition
See WebcastSearch
Derived By
Type int
Referenced By
Definition
See ChartGet
Derived By
Type int
Referenced By
Definition
See UserSearch
Derived By
Type int
Referenced By
Definition
See VisitorSearch
Derived By
Type int
Referenced By
Definition
See WebcastSearch
Derived By
Type boolean
Referenced By
Definition
See VisitorSummary
Derived By
Type string
Referenced By
Definition
See ChartGet
Derived By
Type string
Referenced By
Definition
See CustomerGet
Derived By
Type string
Referenced By
Definition
See ExcelSend
Derived By
Type string
Referenced By
Definition
See FormsGet
Derived By
Type string
Referenced By
Definition
See UserGet
Derived By
Type string
Referenced By
Definition
See UserSearch
Derived By
Type string
Referenced By
Definition
See VisitorCompletedForm
Derived By
Type string
Referenced By
Definition
See VisitorGet
Derived By
Type string
Referenced By
Definition
See VisitorSearch
Derived By
Type string
Referenced By
Definition
See VisitorWatchedSince
Derived By
Type string
Referenced By
Definition
See WebcastCurrentViewersGet
Derived By
Type string
Referenced By
Definition
See WebcastGet
Derived By
Type string
Referenced By
Definition
See WebcastSearch
Derived By
Type string
Referenced By
Definition
See WebcastSummaryGet
Derived By
Type decimal
Referenced By
Definition
See SessionTotal
Derived By
Type Period
Enumeration
Value |
Description |
All |
All time periods
|
Year |
Year period
|
Month |
Month period
|
Day |
Day period
|
Hour |
Hour period
|
Minute |
Minute period
|
Referenced By
Definition
See ChartGet
Derived By
Type Period
Enumeration
Value |
Description |
All |
All time periods
|
Year |
Year period
|
Month |
Month period
|
Day |
Day period
|
Hour |
Hour period
|
Minute |
Minute period
|
Referenced By
Definition
See CustomerGet
Derived By
Type Period
Enumeration
Value |
Description |
All |
All time periods
|
Year |
Year period
|
Month |
Month period
|
Day |
Day period
|
Hour |
Hour period
|
Minute |
Minute period
|
Referenced By
Definition
See VisitorGet
Derived By
Type Period
Enumeration
Value |
Description |
All |
All time periods
|
Year |
Year period
|
Month |
Month period
|
Day |
Day period
|
Hour |
Hour period
|
Minute |
Minute period
|
Referenced By
Definition
See VisitorSearch
Derived By
Type Period
Enumeration
Value |
Description |
All |
All time periods
|
Year |
Year period
|
Month |
Month period
|
Day |
Day period
|
Hour |
Hour period
|
Minute |
Minute period
|
Referenced By
Definition
See WebcastGet
Derived By
Type Period
Enumeration
Value |
Description |
All |
All time periods
|
Year |
Year period
|
Month |
Month period
|
Day |
Day period
|
Hour |
Hour period
|
Minute |
Minute period
|
Referenced By
Definition
See SpanPart
Element: Period
Derived By
Type Period
Enumeration
Value |
Description |
All |
All time periods
|
Year |
Year period
|
Month |
Month period
|
Day |
Day period
|
Hour |
Hour period
|
Minute |
Minute period
|
Derived By
Type string
Referenced By
Definition
See Session
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: QName
Derived By
Type Question
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Questions
Element: Question
Derived By
Type Question
Content Model
Contains elements as defined in the following table.
Derived By
Type Questions
Content Model
Contains elements as defined in the following table.
Referenced By
Name |
Type |
Form |
Complex Type |
Definition
See Form
Element: Questions
Derived By
Type Questions
Content Model
Contains elements as defined in the following table.
Derived By
Type int
Referenced By
Definition
See SessionTotal
Derived By
Type string
Referenced By
Definition
See Session
Derived By
Type string
Referenced By
Definition
See SessionTotal
Derived By
Type string
Referenced By
Definition
See Session
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: ReturnCode
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Derived By
Type Session
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Sessions
Derived By
Type SessionTotal
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See VisitorSummary
Element: Session
Derived By
Type Session
Content Model
Contains elements as defined in the following table.
Derived By
Type Sessions
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Visitor
Derived By
Type int
Referenced By
Definition
See WebcastSummary
Element: Sessions
Derived By
Type Sessions
Content Model
Contains elements as defined in the following table.
Element: SessionTotal
Derived By
Type SessionTotal
Content Model
Contains elements as defined in the following table.
Derived By
Type Settings
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
string |
string |
0..* |
|
|
|
|
|
Referenced By
Definition
See WebcastUserSummary
Element: Settings
Derived By
Type Settings
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
string |
string |
0..* |
|
|
|
|
|
Element: short
Derived By
Type Span
Content Model
Contains elements as defined in the following table.
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Element: Span
Derived By
Type Span
Content Model
Contains elements as defined in the following table.
Derived By
Type SpanPart
Content Model
Contains elements as defined in the following table.
Referenced By
Name |
Type |
Span |
Complex Type |
Definition
See Span
Element: SpanPart
Derived By
Type SpanPart
Content Model
Contains elements as defined in the following table.
Derived By
Type dateTime
Referenced By
Definition
See ChartGet
Derived By
Type dateTime
Referenced By
Definition
See CustomerGet
Derived By
Type dateTime
Referenced By
Definition
See VisitorGet
Derived By
Type dateTime
Referenced By
Definition
See VisitorSearch
Derived By
Type dateTime
Referenced By
Definition
See WebcastGet
Derived By
Type dateTime
Referenced By
Definition
See Session
Derived By
Type dateTime
Referenced By
Definition
See SessionTotal
Derived By
Type dateTime
Referenced By
Definition
See SpanPart
Derived By
Type string
Referenced By
Definition
See Settings
Derived By
Type string
Referenced By
Definition
See TagList
Element: string
Derived By
Type int
Referenced By
Definition
See UserSummary
Derived By
Type int
Referenced By
Definition
See Webcast
Derived By
Type int
Referenced By
Definition
See WebcastSummary
Element: TagList
Derived By
Type TagList
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
string |
string |
0..* |
|
|
|
|
|
Derived By
Type TagList
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
string |
string |
0..* |
|
|
|
|
|
Referenced By
Definition
See WebcastSearch
Derived By
Type TagList
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
string |
string |
0..* |
|
|
|
|
|
Referenced By
Definition
See WebcastSummary
Derived By
Type string
Referenced By
Definition
See Option
Derived By
Type string
Referenced By
Definition
See Question
Derived By
Type string
Referenced By
Definition
See WebcastSearch
Derived By
Type string
Referenced By
Definition
See ChartItem
Description
This customer's title
Derived By
Type string
Referenced By
Definition
See Customer
Derived By
Type string
Referenced By
Definition
See Download
Derived By
Type string
Referenced By
Name |
Type |
Form |
Complex Type |
Definition
See Form
Derived By
Type string
Referenced By
Definition
See MediaStream
Derived By
Type string
Referenced By
Name |
Type |
Name |
Complex Type |
Definition
See Name
Derived By
Type string
Referenced By
Definition
See Webcast
Derived By
Type string
Referenced By
Definition
See WebcastDetails
Derived By
Type dateTime
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Description
Counts the amount of times activity has been registered
Derived By
Type int
Referenced By
Definition
See Activity
Derived By
Type int
Referenced By
Definition
See Option
Derived By
Type int
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Derived By
Type string
Referenced By
Name |
Type |
Chart |
Complex Type |
Definition
See Chart
Derived By
Type string
Referenced By
Definition
See Download
Derived By
Type string
Referenced By
Name |
Type |
Form |
Complex Type |
Definition
See Form
Derived By
Type string
Referenced By
Definition
See Question
Derived By
Type int
Referenced By
Definition
See WebcastUserSummary
Element: unsignedByte
Derived By
Type unsignedByte
Element: unsignedInt
Derived By
Type unsignedInt
Element: unsignedLong
Derived By
Type unsignedLong
Element: unsignedShort
Derived By
Type unsignedShort
Derived By
Type User
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See UserGetResponse
Element: User
Derived By
Type User
Content Model
Contains elements as defined in the following table.
Derived By
Type string
Referenced By
Definition
See Session
Derived By
Type string
Referenced By
Definition
See SessionTotal
Derived By
Type UserDetails
Content Model
Contains elements as defined in the following table.
Referenced By
Name |
Type |
User |
Complex Type |
Definition
See User
Derived By
Type UserDetails
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Visitor
Derived By
Type UserDetails
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See VisitorSummary
Element: UserDetails
Derived By
Type UserDetails
Content Model
Contains elements as defined in the following table.
Derived By
Type string
Referenced By
Definition
See UserSearch
Element: UserGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: UserGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See UserGetResponse
Derived By
Type string
Referenced By
Definition
See ChartGet
Derived By
Type string
Referenced By
Definition
See CustomerGet
Derived By
Type string
Referenced By
Definition
See ExcelSend
Derived By
Type string
Referenced By
Definition
See FormsGet
Derived By
Type string
Referenced By
Definition
See UserGet
Derived By
Type string
Referenced By
Definition
See UserSearch
Derived By
Type string
Referenced By
Definition
See VisitorCompletedForm
Derived By
Type string
Referenced By
Definition
See VisitorGet
Derived By
Type string
Referenced By
Definition
See VisitorSearch
Derived By
Type string
Referenced By
Definition
See VisitorWatchedSince
Derived By
Type string
Referenced By
Definition
See WebcastCurrentViewersGet
Derived By
Type string
Referenced By
Definition
See WebcastGet
Derived By
Type string
Referenced By
Definition
See WebcastSearch
Derived By
Type string
Referenced By
Definition
See WebcastSummaryGet
Derived By
Type string
Referenced By
Definition
See UserDetails
Derived By
Type string
Referenced By
Definition
See UserSearch
Element: UserOrdering
Derived By
Type UserOrdering
Enumeration
Value |
Description |
UserNameAsc |
sort by user name ascending
|
UserNameDesc |
sort by user name descending
|
VisitedAsc |
sort by visited ascending
|
VisitedDesc |
sort by visited descending
|
SubscribedAsc |
sort by subscribed ascending
|
SubscribedDesc |
sort by subscribed descending
|
Element: UserSearch
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: UserSearchResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See UserSearchResponse
Derived By
Type UserSummaryList
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See UserSearchResponse
Derived By
Type UserSummary
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See UserSummaryList
Element: UserSummary
Derived By
Type UserSummary
Content Model
Contains elements as defined in the following table.
Element: UserSummaryList
Derived By
Type UserSummaryList
Content Model
Contains elements as defined in the following table.
Derived By
Type TagList
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
string |
string |
0..* |
|
|
|
|
|
Referenced By
Definition
See UserSearch
Derived By
Type string
Referenced By
Definition
See UserSearch
Derived By
Type string
Referenced By
Definition
See Answer
Derived By
Type long
Referenced By
Definition
See ChartItem
Derived By
Type int
Referenced By
Definition
See SpanPart
Derived By
Type int
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Derived By
Type int
Referenced By
Definition
See WebcastSummary
Derived By
Type long
Referenced By
Definition
See WebcastCurrentViewersGetResponse
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Customer
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Download
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See MediaStream
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Visitor
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Webcast
Element: Views
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Derived By
Type int
Referenced By
Definition
See UserSummary
Derived By
Type Visitor
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See VisitorGetResponse
Element: Visitor
Derived By
Type Visitor
Content Model
Contains elements as defined in the following table.
Element: VisitorCompletedForm
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: VisitorCompletedFormResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See VisitorCompletedFormResponse
Element: VisitorGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: VisitorGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See VisitorGetResponse
Derived By
Type string
Referenced By
Definition
See VisitorCompletedForm
Derived By
Type string
Referenced By
Definition
See VisitorGet
Derived By
Type string
Referenced By
Definition
See VisitorWatchedSince
Derived By
Type string
Referenced By
Definition
See Answer
Derived By
Type string
Referenced By
Definition
See WebcastUserSummary
Derived By
Type VisitorOrderBy
Enumeration
Value |
Description |
PercentageWatchedDesc |
|
PercentageWatchedAsc |
|
SessionFromAsc |
|
SessionFromDesc |
|
SessionToAsc |
|
SessionToDesc |
|
VisitorIdDesc |
|
VisitorIdAsc |
|
TotalMinutesViewedDesc |
|
TotalMinutesViewedAsc |
|
QuestionsIncorrectDesc |
|
QuestionsIncorrectAsc |
|
EmailAsc |
|
EmailDesc |
|
DomainAsc |
|
DomainDesc |
|
ContinentCodeAsc |
|
ContinentCodeDesc |
|
RegionAsc |
|
RegionDesc |
|
CountryAsc |
|
CountryDesc |
|
CityAsc |
|
CityDesc |
|
LongitudeAsc |
|
LongitudeDesc |
|
LatitudeAsc |
|
LatitudeDesc |
|
IpAddressAsc |
|
IpAddressDesc |
|
RefererAsc |
|
RefererDesc |
|
PlayerUrlAsc |
|
PlayerUrlDesc |
|
UserAgentStringAsc |
|
UserAgentStringDesc |
|
WatchedLiveAsc |
|
WatchedLiveDesc |
|
Referenced By
Definition
See VisitorOrderByList
Element: VisitorOrderBy
Derived By
Type VisitorOrderBy
Enumeration
Value |
Description |
PercentageWatchedDesc |
|
PercentageWatchedAsc |
|
SessionFromAsc |
|
SessionFromDesc |
|
SessionToAsc |
|
SessionToDesc |
|
VisitorIdDesc |
|
VisitorIdAsc |
|
TotalMinutesViewedDesc |
|
TotalMinutesViewedAsc |
|
QuestionsIncorrectDesc |
|
QuestionsIncorrectAsc |
|
EmailAsc |
|
EmailDesc |
|
DomainAsc |
|
DomainDesc |
|
ContinentCodeAsc |
|
ContinentCodeDesc |
|
RegionAsc |
|
RegionDesc |
|
CountryAsc |
|
CountryDesc |
|
CityAsc |
|
CityDesc |
|
LongitudeAsc |
|
LongitudeDesc |
|
LatitudeAsc |
|
LatitudeDesc |
|
IpAddressAsc |
|
IpAddressDesc |
|
RefererAsc |
|
RefererDesc |
|
PlayerUrlAsc |
|
PlayerUrlDesc |
|
UserAgentStringAsc |
|
UserAgentStringDesc |
|
WatchedLiveAsc |
|
WatchedLiveDesc |
|
Element: VisitorOrderByList
Derived By
Type VisitorOrderByList
Content Model
Contains elements as defined in the following table.
Derived By
Type int
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Element: VisitorSearch
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: VisitorSearchResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See VisitorSearchResponse
Derived By
Type VisitorSummaries
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See VisitorSearchResponse
Element: VisitorSummaries
Derived By
Type VisitorSummaries
Content Model
Contains elements as defined in the following table.
Derived By
Type VisitorSummary
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See VisitorSummaries
Element: VisitorSummary
Derived By
Type VisitorSummary
Content Model
Contains elements as defined in the following table.
Element: VisitorWatchedSince
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: VisitorWatchedSinceResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See VisitorWatchedSinceResponse
Derived By
Type ArrayOfdateTime
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
dateTime |
dateTime |
0..* |
|
|
|
|
|
Referenced By
Definition
See VisitorWatchedSinceResponse
Derived By
Type ArrayOfdateTime
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|
|
1..1 |
|
dateTime |
dateTime |
0..* |
|
|
|
|
|
Referenced By
Definition
See Session
Derived By
Type boolean
Referenced By
Definition
See VisitorSummary
Derived By
Type Webcast
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastGetResponse
Derived By
Type WebcastDetails
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastUserSummary
Element: Webcast
Derived By
Type Webcast
Content Model
Contains elements as defined in the following table.
Derived By
Type string
Referenced By
Definition
See ExcelSend
Derived By
Type string
Referenced By
Definition
See FormsGet
Derived By
Type string
Referenced By
Definition
See VisitorCompletedForm
Derived By
Type string
Referenced By
Definition
See VisitorGet
Derived By
Type string
Referenced By
Definition
See VisitorSearch
Derived By
Type string
Referenced By
Definition
See VisitorWatchedSince
Derived By
Type string
Referenced By
Definition
See WebcastCurrentViewersGet
Derived By
Type string
Referenced By
Definition
See WebcastGet
Derived By
Type string
Referenced By
Definition
See WebcastSummaryGet
Element: WebcastCurrentViewersGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: WebcastCurrentViewersGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See WebcastCurrentViewersGetResponse
Element: WebcastDetails
Derived By
Type WebcastDetails
Content Model
Contains elements as defined in the following table.
Element: WebcastFilter
Derived By
Type WebcastFilter
Element: WebcastGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: WebcastGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See WebcastGetResponse
Element: WebcastOrdering
Derived By
Type WebcastOrdering
Enumeration
Value |
Description |
CodeAsc |
|
CodeDesc |
|
TitleAsc |
|
TitleDesc |
|
SubscribersAsc |
|
SubscribersDesc |
|
StartAsc |
|
StartDesc |
|
ViewersAsc |
|
ViewersDesc |
|
Element: WebcastSearch
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: WebcastSearchResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See WebcastSearchResponse
Derived By
Type WebcastSummaryList
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastSearchResponse
Derived By
Type WebcastSummary
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastSummaryGetResponse
Derived By
Type WebcastSummary
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastSummaryList
Element: WebcastSummary
Derived By
Type WebcastSummary
Content Model
Contains elements as defined in the following table.
Element: WebcastSummaryGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: WebcastSummaryGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Derived By
Type ReturnCode
Enumeration
Value |
Description |
ServerError |
Unknown error caused on server.
|
Success |
Completed successfully.
|
ClientNotAuthorizedOrUnkown |
Username/password combination incorrect, unknown or not authorized.
|
NoData |
This data document is not available.
|
InvalidInput |
|
InvalidChartForObject |
Chart either unknown or not supported for supplied objecttype
|
Referenced By
Definition
See WebcastSummaryGetResponse
Element: WebcastSummaryList
Derived By
Type WebcastSummaryList
Content Model
Contains elements as defined in the following table.
Derived By
Type WebcastUserSummaryList
Content Model
Contains elements as defined in the following table.
Referenced By
Name |
Type |
User |
Complex Type |
Definition
See User
Derived By
Type WebcastUserSummary
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastUserSummaryList
Element: WebcastUserSummary
Derived By
Type WebcastUserSummary
Content Model
Contains elements as defined in the following table.
Element: WebcastUserSummaryList
Derived By
Type WebcastUserSummaryList
Content Model
Contains elements as defined in the following table.