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
|
Input (Literal)
The input of this method is the document element ChartGet having the structure defined by the following table.
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
|
Input (Literal)
The input of this method is the document element CustomerGet having the structure defined by the following table.
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 CustomerCode/YYYYMMDD_serialnumber
|
Email |
string |
Input |
a valid email address
|
Input (Literal)
The input of this method is the document element ExcelSend having the structure defined by the following table.
Name |
Type |
Required? |
Occurs |
Nillable? |
Description |
Username |
string |
No |
0..1 |
Yes |
|
Password |
string |
No |
0..1 |
Yes |
|
WebcastCode |
string |
No |
0..1 |
Yes |
|
Email |
string |
No |
0..1 |
Yes |
|
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 CustomerCode/YYYYMMDD_serialnumber
|
Forms |
Forms |
Output |
A collection of Forms
|
Input (Literal)
The input of this method is the document element FormsGet having the structure defined by the following table.
Name |
Type |
Required? |
Occurs |
Nillable? |
Description |
UserName |
string |
No |
0..1 |
Yes |
|
Password |
string |
No |
0..1 |
Yes |
|
WebcastCode |
string |
No |
0..1 |
Yes |
|
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
|
Input (Literal)
The input of this method is the document element UserGet having the structure defined by the following table.
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
|
Input (Literal)
The input of this method is the document element UserSearch having the structure defined by the following table.
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 CustomerCode/YYYYMMDD_serialnumber
|
VisitorId |
string |
Input |
Uniquely identifies a Visitor
|
FormId |
string |
Input |
Uniquely identifies a Form
|
Answered |
boolean |
Output |
true if answered
|
Input (Literal)
The input of this method is the document element VisitorCompletedForm having the structure defined by the following table.
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 CustomerCode/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
|
Input (Literal)
The input of this method is the document element VisitorGet having the structure defined by the following table.
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 CustomerCode/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
|
Input (Literal)
The input of this method is the document element VisitorSearch having the structure defined by the following table.
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 CustomerCode/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
|
Input (Literal)
The input of this method is the document element VisitorWatchedSince having the structure defined by the following table.
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
|
Input (Literal)
The input of this method is the document element WebcastCurrentViewersGet having the structure defined by the following table.
Name |
Type |
Required? |
Occurs |
Nillable? |
Description |
Username |
string |
No |
0..1 |
Yes |
|
Password |
string |
No |
0..1 |
Yes |
|
WebcastCode |
string |
No |
0..1 |
Yes |
|
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 CustomerCode/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
|
Input (Literal)
The input of this method is the document element WebcastGet having the structure defined by the following table.
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
|
Input (Literal)
The input of this method is the document element WebcastSearch having the structure defined by the following table.
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 CustomerCode/YYYYMMDD_serialnumber
|
WebcastSummary |
WebcastSummary |
Output |
A WebcastSummary, or null if not found
|
Input (Literal)
The input of this method is the document element WebcastSummaryGet having the structure defined by the following table.
Name |
Type |
Required? |
Occurs |
Nillable? |
Description |
Username |
string |
No |
0..1 |
Yes |
|
Password |
string |
No |
0..1 |
Yes |
|
WebcastCode |
string |
No |
0..1 |
Yes |
|
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
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
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
|
Element: Duration (type Activity)
Description
The total amount of time spent during this activity
Derived By
Type long
Referenced By
Definition
See Activity
Element: Total (type Activity)
Description
Counts the amount of times activity has been registered
Derived By
Type int
Referenced By
Definition
See Activity
Complex Type: Answer
Description
A form anwser from a web visitor
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Date |
dateTime |
0..1 |
Timestamp of the Value
|
Label |
string |
0..1 |
Unused
|
Value |
string |
0..1 |
The given value of the answer
|
VisitorId |
string |
0..1 |
Uniquely identifies a visitor
|
Element: Date (type Answer)
Description
Timestamp of the Value
Derived By
Type dateTime
Referenced By
Definition
See Answer
Element: Label (type Answer)
Description
Unused
Derived By
Type string
Referenced By
Definition
See Answer
Element: Value (type Answer)
Description
The given value of the answer
Derived By
Type string
Referenced By
Definition
See Answer
Element: VisitorId (type Answer)
Description
Uniquely identifies a visitor
Derived By
Type string
Referenced By
Definition
See Answer
Complex Type: Answers
Description
A collection of Answers
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Answer (type Answers)
Derived By
Type Answer
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Date |
dateTime |
0..1 |
Timestamp of the Value
|
Label |
string |
0..1 |
Unused
|
Value |
string |
0..1 |
The given value of the answer
|
VisitorId |
string |
0..1 |
Uniquely identifies a visitor
|
Referenced By
Definition
See Answers
Complex Type: ArrayOfdateTime
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
dateTime |
dateTime |
0..* |
|
Element: dateTime (type ArrayOfdateTime)
Derived By
Type dateTime
Referenced By
Definition
See ArrayOfdateTime
Complex Type: Chart
Description
Chart data class
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Items (type Chart)
Description
A collection of ChartItems
Derived By
Type ChartItems
Content Model
Contains elements as defined in the following table.
Referenced By
Name |
Type |
Chart |
Complex Type |
Definition
See Chart
Element: Type (type Chart)
Description
A chart's type
Derived By
Type string
Referenced By
Name |
Type |
Chart |
Complex Type |
Definition
See Chart
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
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Id |
string |
0..1 |
Uniquely identifies a chartitem
|
Title |
string |
0..1 |
a chartitem's title
|
Value |
long |
0..1 |
a chartitem's value
|
Element: Id (type ChartItem)
Description
Uniquely identifies a chartitem
Derived By
Type string
Referenced By
Definition
See ChartItem
Element: Title (type ChartItem)
Description
a chartitem's title
Derived By
Type string
Referenced By
Definition
See ChartItem
Element: Value (type ChartItem)
Description
a chartitem's value
Derived By
Type long
Referenced By
Definition
See ChartItem
Complex Type: ChartItems
Description
A collection of ChartItems
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: ChartItem (type ChartItems)
Derived By
Type ChartItem
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Id |
string |
0..1 |
Uniquely identifies a chartitem
|
Title |
string |
0..1 |
a chartitem's title
|
Value |
long |
0..1 |
a chartitem's value
|
Referenced By
Definition
See ChartItems
Complex Type: Charts
Description
A collection of Charts
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Chart |
Chart |
0..* |
|
Element: Chart (type Charts)
Derived By
Type Chart
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Charts
Complex Type: Customer
Description
Describes Customer usage statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Activity (type Customer)
Description
See Activity
Derived By
Type Activity
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
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
Element: DownloadsTotal (type Customer)
Description
The total amount of downloads
Derived By
Type int
Referenced By
Definition
See Customer
Element: Id (type Customer)
Description
Uniquely identifies a customer
Derived By
Type string
Referenced By
Definition
See Customer
Element: Title (type Customer)
Description
A customer's title
Derived By
Type string
Referenced By
Definition
See Customer
Element: Views (type Customer)
Description
See Views
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Duration |
long |
0..1 |
a view's duration
|
From |
dateTime |
0..1 |
a view's from measurement date and time
|
Span |
Span |
0..1 |
a collection of SpanParts
|
To |
dateTime |
0..1 |
a view's to measurement date and time
|
Total |
int |
0..1 |
a view's total
|
Viewers |
int |
0..1 |
a view's amount of viewers
|
Visitors |
int |
0..1 |
a view's amount of visitors
|
Referenced By
Definition
See Customer
Complex Type: Download
Description
Describes download statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Id |
string |
0..1 |
Uniquely identifies a download
|
Title |
string |
0..1 |
A download's title
|
Type |
string |
0..1 |
A download's type
|
Views |
Views |
0..1 |
See Views
|
Element: Id (type Download)
Description
Uniquely identifies a download
Derived By
Type string
Referenced By
Definition
See Download
Element: Title (type Download)
Description
A download's title
Derived By
Type string
Referenced By
Definition
See Download
Element: Type (type Download)
Description
A download's type
Derived By
Type string
Referenced By
Definition
See Download
Element: Views (type Download)
Description
See Views
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Duration |
long |
0..1 |
a view's duration
|
From |
dateTime |
0..1 |
a view's from measurement date and time
|
Span |
Span |
0..1 |
a collection of SpanParts
|
To |
dateTime |
0..1 |
a view's to measurement date and time
|
Total |
int |
0..1 |
a view's total
|
Viewers |
int |
0..1 |
a view's amount of viewers
|
Visitors |
int |
0..1 |
a view's amount of visitors
|
Referenced By
Definition
See Download
Complex Type: Downloads
Description
A collecion of Downloads
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Download (type Downloads)
Derived By
Type Download
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Id |
string |
0..1 |
Uniquely identifies a download
|
Title |
string |
0..1 |
A download's title
|
Type |
string |
0..1 |
A download's type
|
Views |
Views |
0..1 |
See Views
|
Referenced By
Definition
See Downloads
Complex Type: Form
Description
Contains a collection of Questions
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Id (type Form)
Description
Uniquely identifies a form
Derived By
Type guid
Referenced By
Name |
Type |
Form |
Complex Type |
Definition
See Form
Element: Questions (type Form)
Description
a collection of Questions
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: Title (type Form)
Description
a form's title
Derived By
Type string
Referenced By
Name |
Type |
Form |
Complex Type |
Definition
See Form
Element: Type (type Form)
Description
a form's type
Derived By
Type string
Referenced By
Name |
Type |
Form |
Complex Type |
Definition
See Form
Complex Type: Forms
Description
A Collection of Forms
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Form |
Form |
0..* |
|
Element: Form (type Forms)
Derived By
Type Form
Content Model
Contains elements as defined in the following table.
Referenced By
Name |
Type |
Forms |
Complex Type |
Definition
See Forms
Complex Type: MediaStream
Description
Describes MediaStream usage statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Activity (type MediaStream)
Description
see Activity
Derived By
Type Activity
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
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
Element: Id (type MediaStream)
Description
Uniquely identifies this mediastream
Derived By
Type string
Referenced By
Definition
See MediaStream
Element: Live (type MediaStream)
Description
Is this a live stream?
Derived By
Type boolean
Referenced By
Definition
See MediaStream
Element: Title (type MediaStream)
Description
a mediastream's title
Derived By
Type string
Referenced By
Definition
See MediaStream
Element: Views (type MediaStream)
Description
see Views
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Duration |
long |
0..1 |
a view's duration
|
From |
dateTime |
0..1 |
a view's from measurement date and time
|
Span |
Span |
0..1 |
a collection of SpanParts
|
To |
dateTime |
0..1 |
a view's to measurement date and time
|
Total |
int |
0..1 |
a view's total
|
Viewers |
int |
0..1 |
a view's amount of viewers
|
Visitors |
int |
0..1 |
a view's amount of visitors
|
Referenced By
Definition
See MediaStream
Complex Type: MediaStreams
Description
A collection of MediaStreams
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: MediaStream (type MediaStreams)
Derived By
Type MediaStream
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See MediaStreams
Complex Type: Name
Description
Describes a person's name
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
First |
string |
0..1 |
a person's first name
|
Last |
string |
0..1 |
a person's last name
|
Middle |
string |
0..1 |
a person's middle name
|
Title |
string |
0..1 |
a person's title
|
Element: First (type Name)
Description
a person's first name
Derived By
Type string
Referenced By
Name |
Type |
Name |
Complex Type |
Definition
See Name
Element: Last (type Name)
Description
a person's last name
Derived By
Type string
Referenced By
Name |
Type |
Name |
Complex Type |
Definition
See Name
Element: Middle (type Name)
Description
a person's middle name
Derived By
Type string
Referenced By
Name |
Type |
Name |
Complex Type |
Definition
See Name
Element: Title (type Name)
Description
a person's title
Derived By
Type string
Referenced By
Name |
Type |
Name |
Complex Type |
Definition
See Name
Complex Type: Option
Description
A form question Option
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Id |
guid |
0..1 |
Uniquely identifies this option
|
IsCorrect |
boolean |
0..1 |
Gets or sets if this option is the correct option
|
Text |
string |
0..1 |
an option's text
|
Total |
int |
0..1 |
?
|
Element: Id (type Option)
Description
Uniquely identifies this option
Derived By
Type guid
Referenced By
Definition
See Option
Element: IsCorrect (type Option)
Description
Gets or sets if this option is the correct option
Derived By
Type boolean
Referenced By
Definition
See Option
Element: Text (type Option)
Description
an option's text
Derived By
Type string
Referenced By
Definition
See Option
Element: Total (type Option)
Description
?
Derived By
Type int
Referenced By
Definition
See Option
Complex Type: Options
Description
A collection of Options
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Option (type Options)
Derived By
Type Option
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Id |
guid |
0..1 |
Uniquely identifies this option
|
IsCorrect |
boolean |
0..1 |
Gets or sets if this option is the correct option
|
Text |
string |
0..1 |
an option's text
|
Total |
int |
0..1 |
?
|
Referenced By
Definition
See Options
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
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Answers (type Question)
Description
a collection of Answers
Derived By
Type Answers
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Question
Element: Id (type Question)
Description
Uniquely identifies a question
Derived By
Type guid
Referenced By
Definition
See Question
Element: Mandatory (type Question)
Description
defines if this question is mandatory
Derived By
Type boolean
Referenced By
Definition
See Question
Element: Options (type Question)
Description
a collection of Options
Derived By
Type Options
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Question
Element: Text (type Question)
Description
a question's text
Derived By
Type string
Referenced By
Definition
See Question
Element: Type (type Question)
Description
a question's type
Derived By
Type string
Referenced By
Definition
See Question
Complex Type: Questions
Description
A collection of Questions
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Question (type Questions)
Derived By
Type Question
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Questions
Complex Type: Session
Description
Describes Web visitor session statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
City |
string |
0..1 |
a session's originating city
|
ContinentCode |
string |
0..1 |
a session's originating continent code
|
Country |
string |
0..1 |
a session's originating country
|
Domain |
string |
0..1 |
a session's domain
|
End |
dateTime |
0..1 |
the session's end date and time
|
Id |
string |
0..1 |
Uniquely identifies a session
|
IpAddress |
string |
0..1 |
a session's originating ip address
|
Latitude |
float |
0..1 |
a session's originating latitude
|
Longitude |
float |
0..1 |
a session's originating longtitude
|
PlayerUrl |
string |
0..1 |
the player url used by a session
|
Referer |
string |
0..1 |
the session's referer
|
Region |
string |
0..1 |
a session's originating region
|
Start |
dateTime |
0..1 |
the session's start date and time
|
UserAgentString |
string |
0..1 |
a session's originating browser user agent string
|
WatchedAt |
ArrayOfdateTime |
0..1 |
?
|
Element: City (type Session)
Description
a session's originating city
Derived By
Type string
Referenced By
Definition
See Session
Element: ContinentCode (type Session)
Description
a session's originating continent code
Derived By
Type string
Referenced By
Definition
See Session
Element: Country (type Session)
Description
a session's originating country
Derived By
Type string
Referenced By
Definition
See Session
Element: Domain (type Session)
Description
a session's domain
Derived By
Type string
Referenced By
Definition
See Session
Element: End (type Session)
Description
the session's end date and time
Derived By
Type dateTime
Referenced By
Definition
See Session
Element: Id (type Session)
Description
Uniquely identifies a session
Derived By
Type string
Referenced By
Definition
See Session
Element: IpAddress (type Session)
Description
a session's originating ip address
Derived By
Type string
Referenced By
Definition
See Session
Element: Latitude (type Session)
Description
a session's originating latitude
Derived By
Type float
Referenced By
Definition
See Session
Element: Longitude (type Session)
Description
a session's originating longtitude
Derived By
Type float
Referenced By
Definition
See Session
Element: PlayerUrl (type Session)
Description
the player url used by a session
Derived By
Type string
Referenced By
Definition
See Session
Element: Referer (type Session)
Description
the session's referer
Derived By
Type string
Referenced By
Definition
See Session
Element: Region (type Session)
Description
a session's originating region
Derived By
Type string
Referenced By
Definition
See Session
Element: Start (type Session)
Description
the session's start date and time
Derived By
Type dateTime
Referenced By
Definition
See Session
Element: UserAgentString (type Session)
Description
a session's originating browser user agent string
Derived By
Type string
Referenced By
Definition
See Session
Element: WatchedAt (type Session)
Description
?
Derived By
Type ArrayOfdateTime
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
dateTime |
dateTime |
0..* |
|
Referenced By
Definition
See Session
Complex Type: Sessions
Description
A collection of Sessions
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Session (type Sessions)
Derived By
Type Session
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
City |
string |
0..1 |
a session's originating city
|
ContinentCode |
string |
0..1 |
a session's originating continent code
|
Country |
string |
0..1 |
a session's originating country
|
Domain |
string |
0..1 |
a session's domain
|
End |
dateTime |
0..1 |
the session's end date and time
|
Id |
string |
0..1 |
Uniquely identifies a session
|
IpAddress |
string |
0..1 |
a session's originating ip address
|
Latitude |
float |
0..1 |
a session's originating latitude
|
Longitude |
float |
0..1 |
a session's originating longtitude
|
PlayerUrl |
string |
0..1 |
the player url used by a session
|
Referer |
string |
0..1 |
the session's referer
|
Region |
string |
0..1 |
a session's originating region
|
Start |
dateTime |
0..1 |
the session's start date and time
|
UserAgentString |
string |
0..1 |
a session's originating browser user agent string
|
WatchedAt |
ArrayOfdateTime |
0..1 |
?
|
Referenced By
Definition
See Sessions
Complex Type: SessionTotal
Description
Describes Web visitor session statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
City |
string |
0..1 |
a sessiontotal's city
|
ContinentCode |
string |
0..1 |
a sessiontotal's continent code
|
Country |
string |
0..1 |
a sessiontotal's country
|
Domain |
string |
0..1 |
a sessiontotal's domain
|
End |
dateTime |
0..1 |
a sessiontotal's end date and time
|
Id |
string |
0..1 |
Uniquely identifies a SessionTotal
|
IpAddress |
string |
0..1 |
a sessiontotal's ip address
|
Latitude |
float |
0..1 |
a sessiontotal's latitude
|
Longitude |
float |
0..1 |
a sessiontotal's longitude
|
PercentageWatched |
decimal |
0..1 |
a sessiontotal's percentage watched
|
PlayerUrl |
string |
0..1 |
a sessiontotal's player url
|
QuestionsIncorrect |
int |
0..1 |
a sessiontotal's amount of incorrect questions
|
Referer |
string |
0..1 |
a sessiontotal's referer
|
Region |
string |
0..1 |
a sessiontotal's region
|
Start |
dateTime |
0..1 |
a sessiontotal's start date and time
|
UserAgentString |
string |
0..1 |
a sessiontotal's user agent string
|
Element: City (type SessionTotal)
Description
a sessiontotal's city
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: ContinentCode (type SessionTotal)
Description
a sessiontotal's continent code
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: Country (type SessionTotal)
Description
a sessiontotal's country
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: Domain (type SessionTotal)
Description
a sessiontotal's domain
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: End (type SessionTotal)
Description
a sessiontotal's end date and time
Derived By
Type dateTime
Referenced By
Definition
See SessionTotal
Element: Id (type SessionTotal)
Description
Uniquely identifies a SessionTotal
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: IpAddress (type SessionTotal)
Description
a sessiontotal's ip address
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: Latitude (type SessionTotal)
Description
a sessiontotal's latitude
Derived By
Type float
Referenced By
Definition
See SessionTotal
Element: Longitude (type SessionTotal)
Description
a sessiontotal's longitude
Derived By
Type float
Referenced By
Definition
See SessionTotal
Element: PercentageWatched (type SessionTotal)
Description
a sessiontotal's percentage watched
Derived By
Type decimal
Referenced By
Definition
See SessionTotal
Element: PlayerUrl (type SessionTotal)
Description
a sessiontotal's player url
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: QuestionsIncorrect (type SessionTotal)
Description
a sessiontotal's amount of incorrect questions
Derived By
Type int
Referenced By
Definition
See SessionTotal
Element: Referer (type SessionTotal)
Description
a sessiontotal's referer
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: Region (type SessionTotal)
Description
a sessiontotal's region
Derived By
Type string
Referenced By
Definition
See SessionTotal
Element: Start (type SessionTotal)
Description
a sessiontotal's start date and time
Derived By
Type dateTime
Referenced By
Definition
See SessionTotal
Element: UserAgentString (type SessionTotal)
Description
a sessiontotal's user agent string
Derived By
Type string
Referenced By
Definition
See SessionTotal
Complex Type: Settings
Description
A collection of Strings used to store user settings
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
string |
string |
0..* |
|
Element: string (type Settings)
Derived By
Type string
Referenced By
Definition
See Settings
Complex Type: Span
Description
A collection of SpanParts
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: SpanPart (type Span)
Derived By
Type SpanPart
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Period |
Period |
0..1 |
see Period
|
Start |
dateTime |
0..1 |
a spanpart's start date and time
|
Value |
int |
0..1 |
a spanpart's value
|
Referenced By
Name |
Type |
Span |
Complex Type |
Definition
See Span
Complex Type: SpanPart
Description
Holds an amount over a span of time Used for generating graphs (that contains multiple SpanParts)
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Period |
Period |
0..1 |
see Period
|
Start |
dateTime |
0..1 |
a spanpart's start date and time
|
Value |
int |
0..1 |
a spanpart's value
|
Element: Period (type SpanPart)
Description
see 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
|
Referenced By
Definition
See SpanPart
Element: Start (type SpanPart)
Description
a spanpart's start date and time
Derived By
Type dateTime
Referenced By
Definition
See SpanPart
Element: Value (type SpanPart)
Description
a spanpart's value
Derived By
Type int
Referenced By
Definition
See SpanPart
Complex Type: TagList
Description
A collection of Strings used to classify a webcast
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
string |
string |
0..* |
|
Element: string (type TagList)
Derived By
Type string
Referenced By
Definition
See TagList
Complex Type: User
Description
Describes a user's usage statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: UserDetails (type User)
Description
see UserDetails
Derived By
Type UserDetails
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Email |
string |
0..1 |
a userdetails' email address
|
Name |
Name |
0..1 |
see Name
|
UserName |
string |
0..1 |
a userdetails' username
|
Referenced By
Name |
Type |
User |
Complex Type |
Definition
See User
Element: WebcastUserSummaries (type User)
Description
a collection of WebcastUserSummary
Derived By
Type WebcastUserSummaryList
Content Model
Contains elements as defined in the following table.
Referenced By
Name |
Type |
User |
Complex Type |
Definition
See User
Complex Type: UserDetails
Description
Describes a user's name, email and username
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Email |
string |
0..1 |
a userdetails' email address
|
Name |
Name |
0..1 |
see Name
|
UserName |
string |
0..1 |
a userdetails' username
|
Element: Email (type UserDetails)
Description
a userdetails' email address
Derived By
Type string
Referenced By
Definition
See UserDetails
Element: Name (type UserDetails)
Description
see Name
Derived By
Type Name
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
First |
string |
0..1 |
a person's first name
|
Last |
string |
0..1 |
a person's last name
|
Middle |
string |
0..1 |
a person's middle name
|
Title |
string |
0..1 |
a person's title
|
Referenced By
Definition
See UserDetails
Element: UserName (type UserDetails)
Description
a userdetails' username
Derived By
Type string
Referenced By
Definition
See UserDetails
Complex Type: UserSummary
Description
Describes a user
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Details (type UserSummary)
Description
see UserDetails
Derived By
Type UserDetails
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Email |
string |
0..1 |
a userdetails' email address
|
Name |
Name |
0..1 |
see Name
|
UserName |
string |
0..1 |
a userdetails' username
|
Referenced By
Definition
See UserSummary
Element: Subscribed (type UserSummary)
Description
a usersummary's amount of subscriptions
Derived By
Type int
Referenced By
Definition
See UserSummary
Element: Visited (type UserSummary)
Description
a usersummary's amount of visits
Derived By
Type int
Referenced By
Definition
See UserSummary
Complex Type: UserSummaryList
Description
A collection of UserSummarys
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: UserSummary (type UserSummaryList)
Derived By
Type UserSummary
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See UserSummaryList
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
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Duration |
long |
0..1 |
a view's duration
|
From |
dateTime |
0..1 |
a view's from measurement date and time
|
Span |
Span |
0..1 |
a collection of SpanParts
|
To |
dateTime |
0..1 |
a view's to measurement date and time
|
Total |
int |
0..1 |
a view's total
|
Viewers |
int |
0..1 |
a view's amount of viewers
|
Visitors |
int |
0..1 |
a view's amount of visitors
|
Element: Duration (type Views)
Description
a view's duration
Derived By
Type long
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Element: From (type Views)
Description
a view's from measurement date and time
Derived By
Type dateTime
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Element: Span (type Views)
Description
a collection of SpanParts
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: To (type Views)
Description
a view's to measurement date and time
Derived By
Type dateTime
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Element: Total (type Views)
Description
a view's total
Derived By
Type int
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Element: Viewers (type Views)
Description
a view's amount of viewers
Derived By
Type int
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Element: Visitors (type Views)
Description
a view's amount of visitors
Derived By
Type int
Referenced By
Name |
Type |
Views |
Complex Type |
Definition
See Views
Complex Type: Visitor
Description
Describes extended visitor usage statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Downloads (type Visitor)
Description
a collection of Downloads
Derived By
Type Downloads
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Visitor
Element: Email (type Visitor)
Description
a visitor's email address
Derived By
Type string
Referenced By
Definition
See Visitor
Element: Forms (type Visitor)
Description
a collection of Forms
Derived By
Type Forms
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Form |
Form |
0..* |
|
Referenced By
Definition
See Visitor
Element: Id (type Visitor)
Description
Uniquely identifies a visitor
Derived By
Type string
Referenced By
Definition
See Visitor
Element: Sessions (type Visitor)
Description
a collection of Sessions
Derived By
Type Sessions
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Visitor
Element: UserDetails (type Visitor)
Description
see UserDetails
Derived By
Type UserDetails
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Email |
string |
0..1 |
a userdetails' email address
|
Name |
Name |
0..1 |
see Name
|
UserName |
string |
0..1 |
a userdetails' username
|
Referenced By
Definition
See Visitor
Element: Views (type Visitor)
Description
see View
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Duration |
long |
0..1 |
a view's duration
|
From |
dateTime |
0..1 |
a view's from measurement date and time
|
Span |
Span |
0..1 |
a collection of SpanParts
|
To |
dateTime |
0..1 |
a view's to measurement date and time
|
Total |
int |
0..1 |
a view's total
|
Viewers |
int |
0..1 |
a view's amount of viewers
|
Visitors |
int |
0..1 |
a view's amount of visitors
|
Referenced By
Definition
See Visitor
Complex Type: VisitorOrderByList
Description
A collection of VisitorOrderBys
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: VisitorOrderBy (type VisitorOrderByList)
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
Complex Type: VisitorSummaries
Description
A collection of VisitorSummarys
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: VisitorSummary (type VisitorSummaries)
Derived By
Type VisitorSummary
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See VisitorSummaries
Complex Type: VisitorSummary
Description
Describes visitor usage statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: DownloadsTotal (type VisitorSummary)
Description
a visitorsummary's total amount of downloads
Derived By
Type int
Referenced By
Definition
See VisitorSummary
Element: Email (type VisitorSummary)
Description
a visitorsummary's emailaddress
Derived By
Type string
Referenced By
Definition
See VisitorSummary
Element: Id (type VisitorSummary)
Description
Uniquely identifies a visitorsummary
Derived By
Type string
Referenced By
Definition
See VisitorSummary
Element: Passed (type VisitorSummary)
Description
?
Derived By
Type boolean
Referenced By
Definition
See VisitorSummary
Element: Session (type VisitorSummary)
Description
see SessionTotal
Derived By
Type SessionTotal
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
City |
string |
0..1 |
a sessiontotal's city
|
ContinentCode |
string |
0..1 |
a sessiontotal's continent code
|
Country |
string |
0..1 |
a sessiontotal's country
|
Domain |
string |
0..1 |
a sessiontotal's domain
|
End |
dateTime |
0..1 |
a sessiontotal's end date and time
|
Id |
string |
0..1 |
Uniquely identifies a SessionTotal
|
IpAddress |
string |
0..1 |
a sessiontotal's ip address
|
Latitude |
float |
0..1 |
a sessiontotal's latitude
|
Longitude |
float |
0..1 |
a sessiontotal's longitude
|
PercentageWatched |
decimal |
0..1 |
a sessiontotal's percentage watched
|
PlayerUrl |
string |
0..1 |
a sessiontotal's player url
|
QuestionsIncorrect |
int |
0..1 |
a sessiontotal's amount of incorrect questions
|
Referer |
string |
0..1 |
a sessiontotal's referer
|
Region |
string |
0..1 |
a sessiontotal's region
|
Start |
dateTime |
0..1 |
a sessiontotal's start date and time
|
UserAgentString |
string |
0..1 |
a sessiontotal's user agent string
|
Referenced By
Definition
See VisitorSummary
Element: UserDetails (type VisitorSummary)
Description
see UserDetails
Derived By
Type UserDetails
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Email |
string |
0..1 |
a userdetails' email address
|
Name |
Name |
0..1 |
see Name
|
UserName |
string |
0..1 |
a userdetails' username
|
Referenced By
Definition
See VisitorSummary
Element: WatchedLive (type VisitorSummary)
Description
indicates if this visitorsummary watched a live webcast
Derived By
Type boolean
Referenced By
Definition
See VisitorSummary
Complex Type: Webcast
Description
Describes webcast usage statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Activity (type Webcast)
Description
see Activity
Derived By
Type Activity
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
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: ActualEnd (type Webcast)
Description
a webcast's nullable actual end date and time
Derived By
Type dateTime
Referenced By
Definition
See Webcast
Element: ActualStart (type Webcast)
Description
a webcast's nullable actual start date and time
Derived By
Type dateTime
Referenced By
Definition
See Webcast
Element: ChatQuestions (type Webcast)
Description
a webcast's amount of chatquestions
Derived By
Type int
Referenced By
Definition
See Webcast
Element: Code (type Webcast)
Description
a webcast's code
Derived By
Type string
Referenced By
Definition
See Webcast
Element: Id (type Webcast)
Description
Uniquely identifies a webcast
Derived By
Type string
Referenced By
Definition
See Webcast
Element: LogModifiedAt (type Webcast)
Description
?
Derived By
Type dateTime
Referenced By
Definition
See Webcast
Element: MediaStreams (type Webcast)
Description
a collection of MediaStreams
Derived By
Type MediaStreams
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See Webcast
Element: ModifiedAt (type Webcast)
Description
?
Derived By
Type dateTime
Referenced By
Definition
See Webcast
Element: Subscribed (type Webcast)
Description
a webcast's amount of subscribers
Derived By
Type int
Referenced By
Definition
See Webcast
Element: Title (type Webcast)
Description
a webcast's title
Derived By
Type string
Referenced By
Definition
See Webcast
Element: Views (type Webcast)
Description
see Views
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Duration |
long |
0..1 |
a view's duration
|
From |
dateTime |
0..1 |
a view's from measurement date and time
|
Span |
Span |
0..1 |
a collection of SpanParts
|
To |
dateTime |
0..1 |
a view's to measurement date and time
|
Total |
int |
0..1 |
a view's total
|
Viewers |
int |
0..1 |
a view's amount of viewers
|
Visitors |
int |
0..1 |
a view's amount of visitors
|
Referenced By
Definition
See Webcast
Complex Type: WebcastDetails
Description
Describes a webcast
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
ActualEnd |
dateTime |
0..1 |
a webcastdetail's nullable actual end date and time
|
ActualStart |
dateTime |
0..1 |
a webcastdetail's nullable actual start date and time
|
Code |
string |
0..1 |
a webcastdetail's code
|
Title |
string |
0..1 |
a webcastdetail's title
|
Element: ActualEnd (type WebcastDetails)
Description
a webcastdetail's nullable actual end date and time
Derived By
Type dateTime
Referenced By
Definition
See WebcastDetails
Element: ActualStart (type WebcastDetails)
Description
a webcastdetail's nullable actual start date and time
Derived By
Type dateTime
Referenced By
Definition
See WebcastDetails
Element: Code (type WebcastDetails)
Description
a webcastdetail's code
Derived By
Type string
Referenced By
Definition
See WebcastDetails
Element: Title (type WebcastDetails)
Description
a webcastdetail's title
Derived By
Type string
Referenced By
Definition
See WebcastDetails
Complex Type: WebcastSummary
Description
Describes concise webcast usage statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: Details (type WebcastSummary)
Description
see WebcastDetails
Derived By
Type WebcastDetails
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
ActualEnd |
dateTime |
0..1 |
a webcastdetail's nullable actual end date and time
|
ActualStart |
dateTime |
0..1 |
a webcastdetail's nullable actual start date and time
|
Code |
string |
0..1 |
a webcastdetail's code
|
Title |
string |
0..1 |
a webcastdetail's title
|
Referenced By
Definition
See WebcastSummary
Element: Sessions (type WebcastSummary)
Description
a webcastsummary's amount of sessions
Derived By
Type int
Referenced By
Definition
See WebcastSummary
Element: Subscribers (type WebcastSummary)
Description
a webcastsummary's amount of subscribers
Derived By
Type int
Referenced By
Definition
See WebcastSummary
Element: Tags (type WebcastSummary)
Description
see Tags
Derived By
Type TagList
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
string |
string |
0..* |
|
Referenced By
Definition
See WebcastSummary
Element: Viewers (type WebcastSummary)
Description
a webcastsummary's amount of viewers
Derived By
Type int
Referenced By
Definition
See WebcastSummary
Complex Type: WebcastSummaryList
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: WebcastSummary (type WebcastSummaryList)
Derived By
Type WebcastSummary
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastSummaryList
Complex Type: WebcastUserSummary
Description
Describes user webcast statistics
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: MinutesWatched (type WebcastUserSummary)
Description
a webcastsummary's amount of minutes watched
Derived By
Type int
Referenced By
Definition
See WebcastUserSummary
Element: Settings (type WebcastUserSummary)
Description
see SettingCollection
Derived By
Type Settings
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
string |
string |
0..* |
|
Referenced By
Definition
See WebcastUserSummary
Element: UniqueMinutesWatched (type WebcastUserSummary)
Description
a webcastsummary's unique amount of minutes watched
Derived By
Type int
Referenced By
Definition
See WebcastUserSummary
Element: VisitorId (type WebcastUserSummary)
Description
a webcastusersummary's visitorid
Derived By
Type string
Referenced By
Definition
See WebcastUserSummary
Element: Webcast (type WebcastUserSummary)
Description
see WebcastDetails
Derived By
Type WebcastDetails
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
ActualEnd |
dateTime |
0..1 |
a webcastdetail's nullable actual end date and time
|
ActualStart |
dateTime |
0..1 |
a webcastdetail's nullable actual start date and time
|
Code |
string |
0..1 |
a webcastdetail's code
|
Title |
string |
0..1 |
a webcastdetail's title
|
Referenced By
Definition
See WebcastUserSummary
Complex Type: WebcastUserSummaryList
Description
A collection of WebcastUserSummarys
Derived By
Restricting anyType
Referenced By
Content Model
Contains elements as defined in the following table.
Element: WebcastUserSummary (type WebcastUserSummaryList)
Derived By
Type WebcastUserSummary
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastUserSummaryList
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 |
sort by code, ascending
|
CodeDesc |
sort by code, descending
|
TitleAsc |
sort by title, ascending
|
TitleDesc |
sort by title, descending
|
SubscribersAsc |
sort by subscribers, ascending
|
SubscribersDesc |
sort by subscribers, descending
|
StartAsc |
sort by start, ascending
|
StartDesc |
sort by start, descending
|
ViewersAsc |
sort by viewers, ascending
|
ViewersDesc |
sort by viewers, descending
|
Referenced By
Elements: ReportService
Element: Activity
Derived By
Type Activity
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
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
|
Element: Answer
Derived By
Type Answer
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Date |
dateTime |
0..1 |
Timestamp of the Value
|
Label |
string |
0..1 |
Unused
|
Value |
string |
0..1 |
The given value of the answer
|
VisitorId |
string |
0..1 |
Uniquely identifies a visitor
|
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 |
dateTime |
dateTime |
0..* |
|
Element: base64Binary
Derived By
Type base64Binary
Element: boolean
Element: byte
Element: char
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: Username (element ChartGet)
Derived By
Type string
Referenced By
Definition
See ChartGet
Element: Password (element ChartGet)
Derived By
Type string
Referenced By
Definition
See ChartGet
Element: ObjectType (element ChartGet)
Derived By
Type string
Referenced By
Definition
See ChartGet
Element: ObjectIdentifier (element ChartGet)
Derived By
Type string
Referenced By
Definition
See ChartGet
Element: Start (element ChartGet)
Derived By
Type dateTime
Referenced By
Definition
See ChartGet
Element: Period (element 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 ChartGet
Element: ChartTypes (element ChartGet)
Derived By
Type string
Referenced By
Definition
See ChartGet
Element: PageSize (element ChartGet)
Derived By
Type int
Referenced By
Definition
See ChartGet
Element: PageNumber (element ChartGet)
Derived By
Type int
Referenced By
Definition
See ChartGet
Element: ChartGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: ChartGetResult (element ChartGetResponse)
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
Element: Charts (element ChartGetResponse)
Derived By
Type Charts
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Chart |
Chart |
0..* |
|
Referenced By
Definition
See ChartGetResponse
Element: ChartItem
Derived By
Type ChartItem
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Id |
string |
0..1 |
Uniquely identifies a chartitem
|
Title |
string |
0..1 |
a chartitem's title
|
Value |
long |
0..1 |
a chartitem's value
|
Element: ChartItems
Derived By
Type ChartItems
Content Model
Contains elements as defined in the following table.
Element: Charts
Derived By
Type Charts
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Chart |
Chart |
0..* |
|
Element: Customer
Derived By
Type Customer
Content Model
Contains elements as defined in the following table.
Element: CustomerGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: Username (element CustomerGet)
Derived By
Type string
Referenced By
Definition
See CustomerGet
Element: Password (element CustomerGet)
Derived By
Type string
Referenced By
Definition
See CustomerGet
Element: CustomerCode (element CustomerGet)
Derived By
Type string
Referenced By
Definition
See CustomerGet
Element: Start (element CustomerGet)
Derived By
Type dateTime
Referenced By
Definition
See CustomerGet
Element: Period (element 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 CustomerGet
Element: CustomerGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: CustomerGetResult (element CustomerGetResponse)
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
Element: Customer (element CustomerGetResponse)
Derived By
Type Customer
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See CustomerGetResponse
Element: dateTime
Element: decimal
Element: double
Element: Download
Derived By
Type Download
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Id |
string |
0..1 |
Uniquely identifies a download
|
Title |
string |
0..1 |
A download's title
|
Type |
string |
0..1 |
A download's type
|
Views |
Views |
0..1 |
See Views
|
Element: Downloads
Derived By
Type Downloads
Content Model
Contains elements as defined in the following table.
Element: duration
Element: ExcelSend
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: Username (element ExcelSend)
Derived By
Type string
Referenced By
Definition
See ExcelSend
Element: Password (element ExcelSend)
Derived By
Type string
Referenced By
Definition
See ExcelSend
Element: WebcastCode (element ExcelSend)
Derived By
Type string
Referenced By
Definition
See ExcelSend
Element: Email (element ExcelSend)
Derived By
Type string
Referenced By
Definition
See ExcelSend
Element: ExcelSendResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: ExcelSendResult (element ExcelSendResponse)
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
Element: float
Element: Form
Derived By
Type Form
Content Model
Contains elements as defined in the following table.
Element: Forms
Derived By
Type Forms
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Form |
Form |
0..* |
|
Element: FormsGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: UserName (element FormsGet)
Derived By
Type string
Referenced By
Definition
See FormsGet
Element: Password (element FormsGet)
Derived By
Type string
Referenced By
Definition
See FormsGet
Element: WebcastCode (element FormsGet)
Derived By
Type string
Referenced By
Definition
See FormsGet
Element: FormsGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: FormsGetResult (element FormsGetResponse)
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
Element: Forms (element FormsGetResponse)
Derived By
Type Forms
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Form |
Form |
0..* |
|
Referenced By
Definition
See FormsGetResponse
Element: guid
Element: int
Element: long
Element: MediaStream
Derived By
Type MediaStream
Content Model
Contains elements as defined in the following table.
Element: MediaStreams
Derived By
Type MediaStreams
Content Model
Contains elements as defined in the following table.
Element: Name
Derived By
Type Name
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
First |
string |
0..1 |
a person's first name
|
Last |
string |
0..1 |
a person's last name
|
Middle |
string |
0..1 |
a person's middle name
|
Title |
string |
0..1 |
a person's title
|
Element: Option
Derived By
Type Option
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Id |
guid |
0..1 |
Uniquely identifies this option
|
IsCorrect |
boolean |
0..1 |
Gets or sets if this option is the correct option
|
Text |
string |
0..1 |
an option's text
|
Total |
int |
0..1 |
?
|
Element: Options
Derived By
Type Options
Content Model
Contains elements as defined in the following table.
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
|
Element: QName
Element: Question
Derived By
Type Question
Content Model
Contains elements as defined in the following table.
Element: Questions
Derived By
Type Questions
Content Model
Contains elements as defined in the following table.
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
|
Element: Session
Derived By
Type Session
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
City |
string |
0..1 |
a session's originating city
|
ContinentCode |
string |
0..1 |
a session's originating continent code
|
Country |
string |
0..1 |
a session's originating country
|
Domain |
string |
0..1 |
a session's domain
|
End |
dateTime |
0..1 |
the session's end date and time
|
Id |
string |
0..1 |
Uniquely identifies a session
|
IpAddress |
string |
0..1 |
a session's originating ip address
|
Latitude |
float |
0..1 |
a session's originating latitude
|
Longitude |
float |
0..1 |
a session's originating longtitude
|
PlayerUrl |
string |
0..1 |
the player url used by a session
|
Referer |
string |
0..1 |
the session's referer
|
Region |
string |
0..1 |
a session's originating region
|
Start |
dateTime |
0..1 |
the session's start date and time
|
UserAgentString |
string |
0..1 |
a session's originating browser user agent string
|
WatchedAt |
ArrayOfdateTime |
0..1 |
?
|
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.
Component |
Type |
Occurs |
Description |
City |
string |
0..1 |
a sessiontotal's city
|
ContinentCode |
string |
0..1 |
a sessiontotal's continent code
|
Country |
string |
0..1 |
a sessiontotal's country
|
Domain |
string |
0..1 |
a sessiontotal's domain
|
End |
dateTime |
0..1 |
a sessiontotal's end date and time
|
Id |
string |
0..1 |
Uniquely identifies a SessionTotal
|
IpAddress |
string |
0..1 |
a sessiontotal's ip address
|
Latitude |
float |
0..1 |
a sessiontotal's latitude
|
Longitude |
float |
0..1 |
a sessiontotal's longitude
|
PercentageWatched |
decimal |
0..1 |
a sessiontotal's percentage watched
|
PlayerUrl |
string |
0..1 |
a sessiontotal's player url
|
QuestionsIncorrect |
int |
0..1 |
a sessiontotal's amount of incorrect questions
|
Referer |
string |
0..1 |
a sessiontotal's referer
|
Region |
string |
0..1 |
a sessiontotal's region
|
Start |
dateTime |
0..1 |
a sessiontotal's start date and time
|
UserAgentString |
string |
0..1 |
a sessiontotal's user agent string
|
Element: Settings
Derived By
Type Settings
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
string |
string |
0..* |
|
Element: short
Element: Span
Derived By
Type Span
Content Model
Contains elements as defined in the following table.
Element: SpanPart
Derived By
Type SpanPart
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Period |
Period |
0..1 |
see Period
|
Start |
dateTime |
0..1 |
a spanpart's start date and time
|
Value |
int |
0..1 |
a spanpart's value
|
Element: string
Element: TagList
Derived By
Type TagList
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
string |
string |
0..* |
|
Element: unsignedByte
Derived By
Type unsignedByte
Element: unsignedInt
Derived By
Type unsignedInt
Element: unsignedLong
Derived By
Type unsignedLong
Element: unsignedShort
Derived By
Type unsignedShort
Element: User
Derived By
Type User
Content Model
Contains elements as defined in the following table.
Element: UserDetails
Derived By
Type UserDetails
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Email |
string |
0..1 |
a userdetails' email address
|
Name |
Name |
0..1 |
see Name
|
UserName |
string |
0..1 |
a userdetails' username
|
Element: UserGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: Username (element UserGet)
Derived By
Type string
Referenced By
Definition
See UserGet
Element: Password (element UserGet)
Derived By
Type string
Referenced By
Definition
See UserGet
Element: CustomerUserName (element UserGet)
Derived By
Type string
Referenced By
Definition
See UserGet
Element: UserGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: UserGetResult (element UserGetResponse)
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
Element: User (element UserGetResponse)
Derived By
Type User
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See UserGetResponse
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: Username (element UserSearch)
Derived By
Type string
Referenced By
Definition
See UserSearch
Element: Password (element UserSearch)
Derived By
Type string
Referenced By
Definition
See UserSearch
Element: CustomerCode (element UserSearch)
Derived By
Type string
Referenced By
Definition
See UserSearch
Element: UserNameFilter (element UserSearch)
Derived By
Type string
Referenced By
Definition
See UserSearch
Element: UserUsernameFilter (element UserSearch)
Derived By
Type string
Referenced By
Definition
See UserSearch
Element: UserEmailFilter (element UserSearch)
Derived By
Type string
Referenced By
Definition
See UserSearch
Element: UserTagsFilter (element UserSearch)
Derived By
Type TagList
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
string |
string |
0..* |
|
Referenced By
Definition
See UserSearch
Element: PageSize (element UserSearch)
Derived By
Type int
Referenced By
Definition
See UserSearch
Element: PageNumber (element UserSearch)
Derived By
Type int
Referenced By
Definition
See UserSearch
Element: Order (element UserSearch)
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
Element: UserSearchResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: UserSearchResult (element UserSearchResponse)
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
Element: UserSummaries (element UserSearchResponse)
Derived By
Type UserSummaryList
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See UserSearchResponse
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.
Element: Views
Derived By
Type Views
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
Duration |
long |
0..1 |
a view's duration
|
From |
dateTime |
0..1 |
a view's from measurement date and time
|
Span |
Span |
0..1 |
a collection of SpanParts
|
To |
dateTime |
0..1 |
a view's to measurement date and time
|
Total |
int |
0..1 |
a view's total
|
Viewers |
int |
0..1 |
a view's amount of viewers
|
Visitors |
int |
0..1 |
a view's amount of visitors
|
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: Username (element VisitorCompletedForm)
Derived By
Type string
Referenced By
Definition
See VisitorCompletedForm
Element: Password (element VisitorCompletedForm)
Derived By
Type string
Referenced By
Definition
See VisitorCompletedForm
Element: WebcastCode (element VisitorCompletedForm)
Derived By
Type string
Referenced By
Definition
See VisitorCompletedForm
Element: VisitorId (element VisitorCompletedForm)
Derived By
Type string
Referenced By
Definition
See VisitorCompletedForm
Element: FormId (element VisitorCompletedForm)
Derived By
Type string
Referenced By
Definition
See VisitorCompletedForm
Element: VisitorCompletedFormResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: VisitorCompletedFormResult (element VisitorCompletedFormResponse)
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: Answered (element VisitorCompletedFormResponse)
Derived By
Type boolean
Referenced By
Definition
See VisitorCompletedFormResponse
Element: VisitorGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: Username (element VisitorGet)
Derived By
Type string
Referenced By
Definition
See VisitorGet
Element: Password (element VisitorGet)
Derived By
Type string
Referenced By
Definition
See VisitorGet
Element: WebcastCode (element VisitorGet)
Derived By
Type string
Referenced By
Definition
See VisitorGet
Element: VisitorId (element VisitorGet)
Derived By
Type string
Referenced By
Definition
See VisitorGet
Element: Start (element VisitorGet)
Derived By
Type dateTime
Referenced By
Definition
See VisitorGet
Element: Period (element 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 VisitorGet
Element: VisitorGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: VisitorGetResult (element VisitorGetResponse)
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
Element: Visitor (element VisitorGetResponse)
Derived By
Type Visitor
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See VisitorGetResponse
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.
Element: VisitorSearch
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: Username (element VisitorSearch)
Derived By
Type string
Referenced By
Definition
See VisitorSearch
Element: Password (element VisitorSearch)
Derived By
Type string
Referenced By
Definition
See VisitorSearch
Element: WebcastCode (element VisitorSearch)
Derived By
Type string
Referenced By
Definition
See VisitorSearch
Element: Email (element VisitorSearch)
Derived By
Type string
Referenced By
Definition
See VisitorSearch
Element: Start (element VisitorSearch)
Derived By
Type dateTime
Referenced By
Definition
See VisitorSearch
Element: Period (element 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 VisitorSearch
Element: PageSize (element VisitorSearch)
Derived By
Type int
Referenced By
Definition
See VisitorSearch
Element: PageNumber (element VisitorSearch)
Derived By
Type int
Referenced By
Definition
See VisitorSearch
Element: Ordering (element VisitorSearch)
Derived By
Type VisitorOrderByList
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See VisitorSearch
Element: VisitorSearchResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: VisitorSearchResult (element VisitorSearchResponse)
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
Element: VisitorSummaries (element 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.
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: Username (element VisitorWatchedSince)
Derived By
Type string
Referenced By
Definition
See VisitorWatchedSince
Element: Password (element VisitorWatchedSince)
Derived By
Type string
Referenced By
Definition
See VisitorWatchedSince
Element: WebcastCode (element VisitorWatchedSince)
Derived By
Type string
Referenced By
Definition
See VisitorWatchedSince
Element: VisitorId (element VisitorWatchedSince)
Derived By
Type string
Referenced By
Definition
See VisitorWatchedSince
Element: From (element VisitorWatchedSince)
Derived By
Type dateTime
Referenced By
Definition
See VisitorWatchedSince
Element: VisitorWatchedSinceResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: VisitorWatchedSinceResult (element VisitorWatchedSinceResponse)
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
Element: Watched (element VisitorWatchedSinceResponse)
Derived By
Type ArrayOfdateTime
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
dateTime |
dateTime |
0..* |
|
Referenced By
Definition
See VisitorWatchedSinceResponse
Element: Webcast
Derived By
Type Webcast
Content Model
Contains elements as defined in the following table.
Element: WebcastCurrentViewersGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: Username (element WebcastCurrentViewersGet)
Derived By
Type string
Referenced By
Definition
See WebcastCurrentViewersGet
Element: Password (element WebcastCurrentViewersGet)
Derived By
Type string
Referenced By
Definition
See WebcastCurrentViewersGet
Element: WebcastCode (element WebcastCurrentViewersGet)
Derived By
Type string
Referenced By
Definition
See WebcastCurrentViewersGet
Element: WebcastCurrentViewersGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: WebcastCurrentViewersGetResult (element WebcastCurrentViewersGetResponse)
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: ViewersCount (element WebcastCurrentViewersGetResponse)
Derived By
Type long
Referenced By
Definition
See WebcastCurrentViewersGetResponse
Element: WebcastDetails
Derived By
Type WebcastDetails
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
ActualEnd |
dateTime |
0..1 |
a webcastdetail's nullable actual end date and time
|
ActualStart |
dateTime |
0..1 |
a webcastdetail's nullable actual start date and time
|
Code |
string |
0..1 |
a webcastdetail's code
|
Title |
string |
0..1 |
a webcastdetail's title
|
Element: WebcastFilter
Derived By
Type WebcastFilter
Element: WebcastGet
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: Username (element WebcastGet)
Derived By
Type string
Referenced By
Definition
See WebcastGet
Element: Password (element WebcastGet)
Derived By
Type string
Referenced By
Definition
See WebcastGet
Element: WebcastCode (element WebcastGet)
Derived By
Type string
Referenced By
Definition
See WebcastGet
Element: Start (element WebcastGet)
Derived By
Type dateTime
Referenced By
Definition
See WebcastGet
Element: Period (element 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 WebcastGet
Element: Filter (element WebcastGet)
Derived By
Type WebcastFilter
Referenced By
Definition
See WebcastGet
Element: WebcastGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: WebcastGetResult (element WebcastGetResponse)
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: Webcast (element WebcastGetResponse)
Derived By
Type Webcast
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastGetResponse
Element: WebcastOrdering
Derived By
Type WebcastOrdering
Enumeration
Value |
Description |
CodeAsc |
sort by code, ascending
|
CodeDesc |
sort by code, descending
|
TitleAsc |
sort by title, ascending
|
TitleDesc |
sort by title, descending
|
SubscribersAsc |
sort by subscribers, ascending
|
SubscribersDesc |
sort by subscribers, descending
|
StartAsc |
sort by start, ascending
|
StartDesc |
sort by start, descending
|
ViewersAsc |
sort by viewers, ascending
|
ViewersDesc |
sort by viewers, descending
|
Element: WebcastSearch
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: Username (element WebcastSearch)
Derived By
Type string
Referenced By
Definition
See WebcastSearch
Element: Password (element WebcastSearch)
Derived By
Type string
Referenced By
Definition
See WebcastSearch
Element: CustomerCode (element WebcastSearch)
Derived By
Type string
Referenced By
Definition
See WebcastSearch
Element: Title (element WebcastSearch)
Derived By
Type string
Referenced By
Definition
See WebcastSearch
Element: Tags (element WebcastSearch)
Derived By
Type TagList
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
string |
string |
0..* |
|
Referenced By
Definition
See WebcastSearch
Element: PageSize (element WebcastSearch)
Derived By
Type int
Referenced By
Definition
See WebcastSearch
Element: PageNumber (element WebcastSearch)
Derived By
Type int
Referenced By
Definition
See WebcastSearch
Element: Order (element WebcastSearch)
Derived By
Type WebcastOrdering
Enumeration
Value |
Description |
CodeAsc |
sort by code, ascending
|
CodeDesc |
sort by code, descending
|
TitleAsc |
sort by title, ascending
|
TitleDesc |
sort by title, descending
|
SubscribersAsc |
sort by subscribers, ascending
|
SubscribersDesc |
sort by subscribers, descending
|
StartAsc |
sort by start, ascending
|
StartDesc |
sort by start, descending
|
ViewersAsc |
sort by viewers, ascending
|
ViewersDesc |
sort by viewers, descending
|
Referenced By
Definition
See WebcastSearch
Element: WebcastSearchResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: WebcastSearchResult (element WebcastSearchResponse)
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
Element: WebcastSummaries (element WebcastSearchResponse)
Derived By
Type WebcastSummaryList
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastSearchResponse
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: Username (element WebcastSummaryGet)
Derived By
Type string
Referenced By
Definition
See WebcastSummaryGet
Element: Password (element WebcastSummaryGet)
Derived By
Type string
Referenced By
Definition
See WebcastSummaryGet
Element: WebcastCode (element WebcastSummaryGet)
Derived By
Type string
Referenced By
Definition
See WebcastSummaryGet
Element: WebcastSummaryGetResponse
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Element: WebcastSummaryGetResult (element WebcastSummaryGetResponse)
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: WebcastSummary (element WebcastSummaryGetResponse)
Derived By
Type WebcastSummary
Content Model
Contains elements as defined in the following table.
Referenced By
Definition
See WebcastSummaryGetResponse
Element: WebcastSummaryList
Derived By
Type WebcastSummaryList
Content Model
Contains elements as defined in the following table.
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.