| Oracle® Real-Time Collaboration Application Developer's Guide 10g Release 1 (10.1.2) Part Number B25461-01 |
|
|
View PDF |
| Oracle® Real-Time Collaboration Application Developer's Guide 10g Release 1 (10.1.2) Part Number B25461-01 |
|
|
View PDF |
This chapter describes the available Oracle Real-Time Integration Services methods, the parameters for each of these methods, and the data types used in the requests and responses.
The following services are available:
For an online demonstration of the operations included in each of these services, as well as the services' Java proxy, refer to the Service URL of the service. For a formal definition of the service, refer to the Service Definition URL.
Authentication Services provides a secure authentication and authorization mechanism for users and sites to access Oracle Real-Time Collaboration Integration Services. The authentication mechanism involves the issuing and validation of Authentication Services tokens.
A site or a user that wishes to access Oracle Real-Time Collaboration Integration Services would first obtain an Authentication Services token by providing site or user credentials. From there on, until the time that the token expires, the site or user will not be required to provide the password or authentication token for further Oracle Real-Time Collaboration Integration Services requests. The token obtained may then be used for further Oracle Real-Time Collaboration Integration Services requests.
Authentication Services exposes the following Web services:
Service URL
http://<hostname:portnum>/imtapp/ws/AuthenticationService
Service Definition
http://<hostname:portnum>/imtapp/ws/AuthenticationService?WSDL
Returns an Authentication Services session token (a TokenObject) when provided with an authentic username and password or SiteID and AuthToken as input. An additional parameter that defines the type of client requesting the token is required. This is set to "USER" or "SITE".
Session tokens may be used to generate more tokens. Session tokens currently only have a time-based expiration policy; this policy can be configured at install time.
Request Parameters of createSession
The following are the request parameters for the createSession service:
Table 3-1 Parameters of createSession
| Parameter | Description |
|---|---|
|
param0 |
String containing username or site ID |
|
param1 |
String containing password or an authentication token |
|
param2 |
String containing either "USER" or "SITE". This defines the type of client requesting the token. |
TokenObject
Represents an Authentication Services token.
Table 3-2 Parameters of TokenObject
| Parameter | Description |
|---|---|
|
token |
String representing the token |
|
tokenAttributes |
Array of type AdhocAttribute. This array contains two elements:
|
|
tokenIndex |
String |
AdhocAttribute
Represents an attribute (a name-value pair).
Table 3-3 Parameters of AdhocAttribute
| Parameter | Description |
|---|---|
|
name |
String containing name of the attribute |
|
value |
String containing value of the attribute |
Returns a TokenObject when executed successfully. It takes the user ID or Site ID, session token, TokenProperties (properties of the token being requested) and a PolicyObject as input.
Request Parameters of requestToken
The following are the request parameters for the requestToken service:
Table 3-4 Parameters of requestToken
| Parameter | Description |
|---|---|
|
param0 |
String containing username or site ID |
|
param1 |
String containing password, or session token |
|
param2 |
|
|
param3 |
|
TokenProperties
Encapsulates the properties of the token being requested. Typically, the purpose (policy) for which the requested token will be used is contained in this object.
Table 3-5 Parameters of TokenProperties
| Parameter | Description |
|---|---|
|
tokenPolicy |
String, the token policy, such as "SESSION::PRESENCE" This string may be a combination of the following strings separated by a double colon (::):
|
|
tokenAttributes |
AdhocAttribute. If you have requested a token with a proxied policy (for example, if the requested token has a policy of "PROXY::GUESTCHAT"), you must specify the following attribute:
|
PolicyObject
Encapsulates additional information required by Authentication Services in order to authorize the requestToken request specific to the policy of the token requested. Information provided in this object would typically depend on the tokenPolicy set in the TokenProperties object of the request.
Returns an array of TokenObject when executed successfully. It takes the user ID or Site ID, session token, TokenProperties (properties of the tokens being requested) and an array of PolicyObjects as input.
Request Parameters of requestMultipleTokens
The following are the request parameters for the requestMultipleTokens service:
Table 3-7 Parameters of requestMultipleTokens
| Parameter | Description |
|---|---|
|
param0 |
String containing user name or site ID |
|
param1 |
String containing user password or the site authentication token |
|
param2 |
TokenProperties object that encapsulates the properties of the token being requested |
|
param3 |
Array of PolicyObject that describes the types of tokens being requested |
Returns a TokenObject when executed successfully. It takes a CredentialObject, TokenProperties (properties of the token being requested), and a PolicyObject (specifies any parameters that are specific to the implementation of the policy scheme that governs the generation of the token being requested) as input.
Request Parameters of requestTokenForCredentials
The following are the request parameters for the requestTokenForCredentials service:
CredentialObject
Represents information required by the Request Token for Credential service.
Table 3-9 Parameters of CredentialObject
| Parameter | Description |
|---|---|
|
credentialType |
String containing type of credential being used:
|
|
entityType |
String containing type of entity (ÒSITEÓ or ÒUSERÓ) |
|
entityCredential |
String containing password or SiteAuthKey or session token |
|
entityID |
String containing site ID or user ID |
This service invalidates a token and returns the invalidated TokenObject when provided with an authentic username and token or siteID and the token to be invalidated as input. The End Session operation determines if the token requested to be invalidated was issued to the user or site passed in the request. If this condition is satisfied, the token and all its child tokens are invalidated.
Request Parameters of endSession
The following are the request parameters for the endSession service:
Table 3-10 Parameters of endSession
| Parameter | Description |
|---|---|
|
param0 |
String representing user name or site ID |
|
param1 |
String representing token of user or site |
This service returns the status of a token encapsulated in a TokenObject object when provided with an authentic username and token or siteID and the token as input.
Request Parameters of getTokenStatus
The following are the request parameters for the getTokenStatus service:
Implemented as a SOAP RPC-style Web service and provides the ability for clients to query and update configuration information from an Oracle Real-Time Collaboration deployment.
The following are some examples of its functionality:
Obtain and modify Oracle Real-Time Collaboration configuration settings. The following are some examples of settings:
Whether it is mandatory to set a conference key for conferences scheduled by a given site
The value of the "early join time" for a conference
Obtain Oracle Real-Time Collaboration Integration Services catalog information (for example, supported versions of an Oracle Real-Time Collaboration Web service available from the deployment)
Since Configuration Services provide information about other Oracle Real-Time Collaboration Web services, the signatures of the operations that it exposes will not change. New operations may be added in future releases, but what is released will not change. The following are the only features that will change in a new release:
The list of configuration information available (new entries may be added)
New operations that provide new functionality
Configuration Services exposes the following Web service:
Service URL
http://<hostname:portnum>/imtapp/ws/ConfigurationService
Service Definition
http://<hostname:portnum>/imtapp/ws/ConfigurationService?WSDL
Configuration Entries
Configuration entries form the basis for accessing the functionality offered by Configuration Services. Any configuration information that is exposed through Configuration Services has an entry in the Configuration Services directory. Each entry in the Configuration Services directory is identified by a name is used to access it. The entries in the Configuration Services directory is structured in a tree as follows:
rtc
+--servicecatalog
| +--authenticationservice
| | +--versions
| | +--url
| | +--endpoint
| | +--wsdl
| +--preconferenceservice
| +--versions
| +--url
| +--endpoint
| +--wsdl
+--application
| +--conferencekeyrequired
| +--presenceenabled
| +--schedulingenabled
|
+--clients
+--win32
| +--addin
| | +--version
| | +--url
| +--messenger
+--addin
| +--win32
+--messenger
+--win32
Fullname
The fullname of a configuration entry is the handle to the configuration in the Configuration Services directory. It is a string that references the configuration entry and is composed as a period (.) delimited path to the configuration entry.
The following are examples of fullnames:
The fullname for the property that determines if a conference key is mandatory for conferences scheduled by a given site is rtc.application.conferencekeyrequired
The fullname for the Authentication Services versions supported is rtc.servicecatalog.authenticationservice.versions
The table at the end of this section lists all the entries in the Configuration Services directory along with the fullnames required to reference them.
Namespace and Property Name
Every entry in the Configuration Services directory can also be referenced by its property name along with its namespace. A namespace represents a grouping of Configuration Services entries and the property name is the name of a specific entry under a given namespace.
For example, the entry for Authentication Services versions supported can be referenced with namespace rtc.servicecatalog.authenticationservice and property name "versions". It may alternatively also be referenced with namespace rtc.servicecatalog and property name authenticationservice.versions.
Configuration Service Directory
The following table lists the fullnames of available configuration entries:
Table 3-12 Configuration Entries
| Configuration Entry Fullname | Description | Public? |
|---|---|---|
|
rtc.application |
Has no value by itself. It is the top-level namespace for Oracle Real-Time Collaboration configuration properties. |
Yes |
|
rtc.application.admin_email |
Represents the Oracle Real-Time Collaboration administrator email address. |
Yes |
|
rtc.application.auth_chat_enabled |
Determines if a site or a user is authorized to obtain chat tokens. |
No |
|
rtc.application.auth_presence_enabled |
Determines if a site or a user is authorized to obtain presence tokens. |
No |
|
rtc.application.auth_proxy_enabled |
Determines if a site or a user is authorized to obtain proxy tokens. |
No |
|
rtc.application.auth_session_enabled |
Determines if a site or a user is authorized to obtain session tokens. |
No |
|
rtc.application.conference_key_required |
Determines if the conferences scheduled by a site or a user are required to have a conference key. |
No |
|
rtc.application.current_server_time |
Represents the current time on the server. |
Yes |
|
rtc.application.early_join_minutes |
Represents the early join minutes for conferences created. |
Yes |
|
rtc.application.guest_user_access_enabled |
Determines if guest user access is enabled. |
No |
|
rtc.application.im_nickname |
To be documented |
No |
|
rtc.application.im_suffix |
To be documented |
No |
|
rtc.application.max_request_size |
Determines the maximum size of the Oracle Real-Time Collaboration Web services requests. |
Yes |
|
rtc.application.max_response_size |
Determines the maximum size of Oracle Real-Time Collaboration Web services responses. |
Yes |
|
rtc.application.scheduling_access_enabled |
Determines if a site or user is authorized for scheduling. |
No |
|
rtc.application.token_life |
Determines the life of Authentication Services tokens in seconds. |
Yes |
|
rtc.application.version_identifier |
Represents the version of the Oracle Real-Time Collaboration application. |
No |
|
rtc.application.im_domain |
Represents the Oracle Messenger domain of the Oracle Messenger server |
|
|
rtc.servicecatalog |
Has no value by itself. It is the top-level namespace for all service catalog entries. |
Yes |
|
rtc.servicecatalog.service_home |
Represents Oracle Real-Time Collaboration Web services home (no-ssl home if enabled. If SSL is required, the SSL home is returned.) |
Yes |
|
rtc.servicecatalog.service_ssl_home |
Represents Oracle Real-Time Collaboration Web services SSL home. |
Yes |
|
rtc.servicecatalog.authenticationservice |
Has no value by itself. It is the top-level namespace for Authentication Services. |
Yes |
|
rtc.servicecatalog.authenticationservice.versions |
Lists all supported versions of Authentication Services in the form of a comma-delimited string. |
Yes |
|
rtc.servicecatalog.authenticationservice.url |
Has no value. |
Yes |
|
rtc.servicecatalog.authenticationservice.url.endpoint |
Represents Authentication Services endpoint URL relative to the Web services home. |
Yes |
|
rtc.servicecatalog.authenticationservice.url.wsdl |
Represents Authentication Services WSDL URL relative to the Web services home. |
Yes |
|
rtc.servicecatalog.preconferenceservice |
Has no value by itself. It is the top-level namespace for Pre-Conference Management Services. |
Yes |
|
rtc.servicecatalog.preconferenceservice.versions |
Lists all supported versions of Pre-Conference Management Services in the form of a comma-delimited string. |
Yes |
|
rtc.servicecatalog.preconferenceservice.url |
Has no value. |
Yes |
|
rtc.servicecatalog.preconferenceservice.url.endpoint |
Represents Pre-Conference Management Services endpoint URL relative to the Web services home. |
Yes |
|
rtc.servicecatalog.preconferenceservice.url.wsdl |
Represents Pre-Conference Management Services WSDL URL relative to the Web services home. |
Yes |
|
rtc.servicecatalog.presenceservice |
Has no value by itself. It is the top-level namespace for Presence Services. |
Yes |
|
rtc.servicecatalog.presenceservice.versions |
Lists all supported versions of Presence Services in the form of a comma-delimited string. |
Yes |
|
rtc.servicecatalog.presenceservice.url |
Has no value. |
Yes |
|
rtc.servicecatalog.presenceservice.url.endpoint |
Represents Presence Services endpoint URL relative to the Web services home. |
Yes |
|
rtc.servicecatalog.presenceservice.url.wsdl |
Represents Presence Services WSDL URL relative to Web services home. |
Yes |
|
rtc.servicecatalog.postconferenceservice |
Has no value by itself. It is the top-level namespace for Post-Conference Services. |
Yes |
|
rtc.servicecatalog.postconferenceservice.versions |
Lists all supported versions of Post-Conference Services in the form of a comma-delimited string. |
Yes |
|
rtc.servicecatalog.postconferenceservice.url |
Has no value. |
Yes |
|
rtc.servicecatalog.postconferenceservice.url.endpoint |
Represents Post-Conference Services endpoint URL relative to the Web services home. |
Yes |
|
rtc.servicecatalog.postconferenceservice.url.wsdl |
Represents Post-Conference Services WSDL URL relative to the Web services home. |
Yes |
|
rtc.clients |
Has no value. It is the top-level namespace for Oracle Real-Time Collaboration clients. |
Yes |
|
rtc.clients.addin |
Has no value |
Yes |
|
rtc.clients.addin.win32 |
Has no value |
Yes |
|
rtc.clients.addin.win32.version |
Returns the currently supported addin version |
Yes |
|
rtc.clients.addin.win32.url |
Returns the download URL for the addin client |
Yes |
|
rtc.clients.messenger |
Has no value |
Yes |
|
rtc.clients.messenger.win32 |
Has no value |
Yes |
|
rtc.clients.messenger.win32.version |
Returns the currently supported Oracle Messenger client version |
Yes |
|
rtc.clients.messenger.win32.url |
Returns the download URL for the Oracle Messenger client |
Yes |
|
rtc.clients.win32 |
Has no value |
Yes |
|
rtc.clients.win32.addin |
Has no value |
Yes |
|
rtc.clients.win32.addin.version |
Returns the currently supported addin version |
Yes |
|
rtc.clients.win32.addin.url |
Returns the download url for the addin client |
Yes |
|
rtc.clients.win32.messenger |
Has no value |
Yes |
|
rtc.clients.win32. messenger.version |
Returns the currently supported Oracle Messenger client version |
Yes |
|
rtc.clients.win32. messenger.url |
Returns the download URL for the Oracle Messenger client |
Yes |
Obtains Oracle Real-Time Collaboration configuration information; returns a GetConfigurationResponse.
Request Parameters of getConfiguration
The following are the request parameters for the getConfiguration service:
Table 3-13 Parameters of getConfiguration
| Parameter | Description |
|---|---|
|
param0 |
GetConfigurationRequest object |
GetConfigurationRequest
Represents information required by the Get Configuration service.
Table 3-14 Parameters of GetConfigurationRequest
| Parameter | Description |
|---|---|
|
entityID |
String containing site ID or user ID of the entity making the Web service call. |
|
entityToken |
String containing authentication token for this entity. The token can be obtained using Authentication Services. |
|
namespace |
The optional namespace of the properties being requested. |
|
properties |
An array of property name strings for which values are requested. These property strings, when concatenated to the end of the namespace with a period (".") should form a valid configuration service entry. |
|
adhocAttribute |
Optional array of AdhocAttribute, name-value pair attributes that can be used to provide additional type-specific data. |
GetConfigurationResponse
Represents information returned by the Get Configuration service.
Table 3-15 Parameters of GetConfigurationResponse
| Parameter | Description |
|---|---|
|
statusCode |
Integer status code for the Web service call |
|
statusMessage |
Character string, authentication token for this entity. The token can be obtained using Authentication Services. |
|
statusDetails |
The optional namespace of the properties being requested |
|
namespace |
String containing additional information regarding the status of the Web service call |
|
properties |
An AdhocAttribute array that contain property names and values for all the configuration entries in the query. If there was an issue obtaining the value of a specific configuration entry, its value is set to null. |
|
adhocAttributes |
Array of AdhocAttribute, name-value pair attributes that can be used to specify additional output elements from the Web service |
The following table describes the status codes of GetConfigurationResponse:
Table 3-16 Status Codes of GetConfigurationResponse
| Status | Status Code | Description |
|---|---|---|
|
NO_ERROR |
0 |
Web service call completed successfully |
|
INVALID_SITE_ID |
4 |
The site ID provided was invalid |
|
NOT_AUTHORIZED |
1032 |
The entity is not authorized to make the request |
|
UNEXPECTED_ERROR |
1090 |
An unexpected error occurred and the operation cannot be completed successfully |
Schedules, updates, deletes, and lists conferences; supports the following services:
Service URL
http://<hostname:portnum>/imtapp/ws/PreConference Service
Service Definition
http://<hostname:portnum>/imtapp/ws/PreConferenceService?WSDL
This URL service allows an integrating application to create an instant conference on the Oracle Real-Time Collaboration system. Once the instant conference has been successfully created, the system returns a join URL to the host. The host can then use the join URL to launch the Oracle Real-Time Collaboration console. The difference between this service and the Schedule Conference service is that this service schedules and starts a conference instantly.
Service URL
http://<hostname:portnum>/imtapp/app/OracleRTCService?operation=instantMeeting&xmlin=<xml-document>
Input Parameters
The parameter "xmlin" is the XML document that contains all the input parameters for the service. This document should be based on the following XML schema:
http://<hostname:portnum>/imtapp/app/instantMtgReq.xsd
The following table describes each of the elements in the XML schema.
Table 3-17 Input Parameters of Instant Conference
| XML Schema Element | Required? | Data Type | Valid Values | Description |
|---|---|---|---|---|
|
meetingType |
No |
String |
REGULAR, PUBLIC, RESTRICTED, and REGISTERED |
Meeting type |
|
siteid |
Yes |
String |
|
Site ID of the integrating application |
|
password |
No |
String |
|
Conference password, if any |
|
meetingTitle |
No |
String |
|
Name of the conference being scheduled |
|
hostExitURL |
No |
URL |
Valid URL |
URL of the page that pops-up on the host side after a conference has ended. This feature can be used to collect feedback/exit surveys related to the conference. |
|
attendeeExitURL |
No |
URI |
Valid URL |
URL of the page that pops-up on the attendee side after a conference has ended. This feature can be used to collect feedback/exit surveys related to the conference. |
|
attendeeStartURL |
No |
URI |
Valid URL |
URL of the page that pop-up on the attendee side when the attendee joins a conference. This feature can be used to lead the attendee to some informational page about the conference. Example, sales related page in a sales conference. |
|
returnType |
No |
String |
XML, text |
When return type is set to XML, an XML document is returned. When return type is set to text, then the return type is a URL redirect. |
Return Parameters
The format of the return document depends on the returnType parameter.
If the returnType parameter is XML, then upon successful execution, the response is an XML document whose schema is defined by meetingResp.xsd:
http://<hostname:portnum>/imtapp/app/meetingResp.xsd
Table 3-18 Return Parameters of Instant Conference
| XML Schema Element | Required? | Data Type | Description |
|---|---|---|---|
|
responseCode |
Yes |
Integer |
Return code is always 0 on successful execution |
|
mtgId |
Yes |
String |
ID of the scheduled conference |
|
playbackURL |
Yes |
Any URL |
URL to be used for playing back the conference |
If the returnType is text, then the join conference URL is returned with the redirect header. This is useful when the Instant Conference service is called from a browser window. In this case, the browser window is automatically redirected to the URL location, which automatically launches Oracle Web Conferencing to start the Web conference.
Error Handling
The format of the error document depends on the returnType parameter.
If the returnType is text, then the appropriate error message is returned as a text/HTML page.
If the returnType is XML, if there is any error (response code is non-zero), the response to the call is an XML document based on errorMsg.xsd.
http://<hostname:portnum>/imtapp/app/errorMsg.xsd
Table 3-19 Error Handling Parameters of Instant Conference
| XML Schema Element | Required? | Data Type | Description |
|---|---|---|---|
|
responseCode |
Yes |
Integer |
Return code is always 0 on successful execution |
|
message |
Yes |
String |
A short description of the error |
Allows an integrating site or end user application to schedule a conference; returns a ScheduleResponse object.
Request Parameters of scheduleConference
The following are the request parameters for the scheduleConference service:
ScheduleRequest
Represents information required by the scheduleConference and updateConference services.
Table 3-21 Parameters of ScheduleRequest
| Parameter | Description |
|---|---|
|
entityID |
Character string representing the site ID or user ID of the entity making the Web service call. |
|
entityToken |
Character string representing the authentication token for this entity. The token can be obtained from Authentication Services. |
|
scheduleOptions |
ScheduleOptions object representing various scheduling parameters |
|
adhocAttributes |
Optional array of AdhocAttribute objects containing name-value pair attributes that can be used to specify additional inputs to the Web service. |
ScheduleOptions
Specifies various scheduling parameters.
Table 3-22 Parameters of ScheduleOptions
| Parameter | Description |
|---|---|
|
attendees |
Array of ParticipantData objects for the conference attendees |
|
conferenceId |
String representing the conference ID |
|
description |
String representing description for the conference |
|
registeredUserOnly |
Boolean flag indicating whether only registered users may attend the Web conference. If set to null, a default value of true is used. |
|
publiclyListed |
Boolean flag indicating whether this Web conference can be publicly listed. If set to null, a default value of false is used. |
|
hostInvitedOnly |
Boolean flag indicating whether only registered users invited by the host can attend the Web conference. If set to true, only registered users will be allowed to attend the conference and the registeredUserOnly flag must be set to true. If set to null, a default value of true is used. |
|
enrollmentRequired |
Boolean flag indicating whether the attendees for this conference need to go through an enrollment process in order to join the conference. If set to true, only registered users will be allowed for the conference and the registeredUserOnly flag must be set to true. In addition, a conference key must be provided. If enrollmentRequired is set to null, a default value of false is used. |
|
dialinInfo |
String |
|
startDate |
Date object, conference start time |
|
endDate |
Date object, conference end time |
|
organizer |
ParticipantData object, conference organizer |
|
conferenceKey |
String, conference key |
|
publishAttendees |
Boolean flag indicating whether the conference's list of attendees should be included in your e-mail invitation to each attendee. If set to null, a default value of false is used. |
|
sendEmailNotification |
Boolean value indicating whether e-mail invitations should be sent for the conference. |
|
siteId |
String, site ID |
|
title |
String, conference title |
|
adhocAttributes |
Array of AdhocAttribute objects containing name-value pair attributes that can be used to specify additional scheduling options. |
ParticipantData
Represents a conference attendee or organizer.
Table 3-23 Parameters of ParticipantData
| Parameter | Description |
|---|---|
|
firstName |
String, participant's first name |
|
lastName |
String, participant's last name |
|
emailAddr |
String, e-mail address of participant |
|
userguid |
String, user's GUID if the participant is a registered user |
|
userid |
String, user's ID if the participant is a registered user |
|
adhocAttributes |
Array of AdhocAttribute objects containing name-value pair attributes that can be used to specify additional scheduling options. |
ScheduleResponse
Represents information returned from the Schedule Conference and Update Conference services.
Table 3-24 Parameters of ScheduleResponse
| Parameter | Description |
|---|---|
|
statusCode |
Integer, status code for the Web service call |
|
statusMessage |
Character string, authentication token for this entity. The token can be obtained using Authentication Services. |
|
statusDetails |
The optional namespace of the properties being requested |
|
scheduleResult |
ScheduleResult object encapsulating the result of the scheduling operation; includes the conference ID along with the attendee and host URLs used to join the conference. |
|
adhocAttributes |
Array of AdhocAttribute, name-value pair attributes that can be used to specify additional output elements from the Web service |
The following table describes the status codes of scheduleConference and updateConference services:
Table 3-25 Status Codes of scheduleConference and updateConference Services
| Status | Status Code | Description |
|---|---|---|
|
NO_ERROR |
0 |
Web service call completed successfully |
|
INVALID_SITE_ID |
4 |
The site ID provided was invalid |
|
INVALID_USER_ID |
5 |
The attendee list could not be retrieved for this conference. |
|
INVALID_USER_GUID |
6 |
The entity is not authorized to make the request |
|
MEETING_START_TIME_IS_NULL |
351 |
A null conference start time was provided. |
|
MEETING_END_TIME_IS_NULL |
352 |
A null conference end time was provided. |
|
MEETING_START_TIME_ERR |
356 |
There was a problem with the conference start time. |
|
MEETING_END_TIME_ERR |
357 |
There was a problem with the conference end time. |
|
MEETING_MTGNOTCREATED_ERR |
358 |
The conference could not be created. |
|
MEETING_PUBLIC_MTGTYPE_ERR |
362 |
The current site does not allow public conferences to be scheduled. |
|
MEETING_INVALID_PASSWORD |
367 |
An invalid conference key was provided. |
|
PROCESSED_WITH_NON_FATAL_ERRORS |
1013 |
A non-critical error occurred while processing some of the conference attendees. |
|
NOT_AUTHORIZED |
1032 |
The entity is not authorized to make the request |
|
ORGANIZER_ID_MISSING |
1061 |
The host information is missing for this conference. |
|
USER_CANNOT_SCHEDULE_FOR_ORGANIZER |
1062 |
The user who submitted the schedule request was different from the conference host. |
|
ERROR_PROCESSING_PARTICIPANT |
1064 |
An error occurred while processing conference participants. |
|
ERROR_SENDING_EMAIL_INVITES |
1065 |
An error occurred while attempting to send email invites to conference participants. |
|
UNEXPECTED_ERROR |
1090 |
An unexpected error occurred and the operation cannot be completed successfully |
ScheduleResult
Represents information returned from the Schedule Conference and Update Conference services.
Table 3-26 Parameters of ScheduleResult
| Parameter | Description |
|---|---|
|
attendeeURL |
String, URL where attendees can join the conference |
|
hostURL |
String, URL where the host can join the conference |
|
conferenceID |
String, conference ID |
|
adhocAttributes |
Optional array of AdhocAttribute containing name-value pair attributes that can be used to specify additional output elements from the Web service |
Allows an integrating site or end user application to update a previously scheduled conference. This function returns a ScheduleResponse object.
Request Parameters of updateConference
The following are the request parameters for the updateConference service:
Allows an integrating site or end user application to delete a previously scheduled conference.
Returns a StatusResponse object.
Request Parameters of deleteConference
The following are the request parameters for the deleteConference service:
Table 3-28 Parameters of deleteConference
| Parameter | Description |
|---|---|
|
param0 |
DeleteConferenceRequest object |
DeleteConferenceRequest
Represents information required by the deleteConference service.
Table 3-29 Parameters of DeleteConferenceRequest
| Parameter | Description |
|---|---|
|
entityID |
Character string representing the site ID or user ID of the entity making the Web service call. |
|
entityToken |
Character string representing the authentication token for this entity. The token can be obtained from Authentication Services. |
|
conferenceID |
String containing the conference ID of the conference to be deleted. |
|
adhocAttributes |
Optional array of AdhocAttribute objects containing name-value pair attributes that can be used to specify additional inputs to the Web service. |
StatusResponse
Represents information returned from the deleteConference service.
Table 3-30 Parameters of StatusResponse
| Parameter | Description |
|---|---|
|
statusCode |
Integer, status code for the Web service call |
|
statusMessage |
Character string, authentication token for this entity. The token can be obtained using Authentication Services. |
|
statusDetails |
The optional namespace of the properties being requested |
|
adhocAttributes |
Array of AdhocAttribute, name-value pair attributes that can be used to specify additional output elements from the Web service |
The following table describes the status codes of the deleteConference service:
Table 3-31 Status Codes of deleteConference Service
| Status | Status Code | Description |
|---|---|---|
|
NO_ERROR |
0 |
Web service call completed successfully |
|
INVALID_MEETING_ID |
3 |
An invalid conference ID was provided |
|
INVALID_SITE_ID |
4 |
The site ID provided was invalid |
|
MEETING_CANNOT_BE_UPDATED_NOW |
354 |
The meeting could not be modified at the current time |
|
NOT_AUTHORIZED |
1032 |
The entity is not authorized to make the request |
|
UNEXPECTED_ERROR |
1090 |
An unexpected error occurred and the operation cannot be completed successfully |
Allows an integrating site to retrieve the list of upcoming conferences for a site, with options to filter based on conferenceType, userID (for a site), start date and end date.
Returns an UpcomingConferencesResponse object that contains a list of upcoming conferences for a site or user.
Request Parameters of listUpcomingConferences
The following are the request parameters for the listUpcomingConferences service:
Table 3-32 Parameters of listUpcomingConferences
| Parameter | Description |
|---|---|
|
param0 |
UpcomingConferencesRequest object |
UpcomingConferencesRequest
Represents information required by the listUpcomingConferences service.
Table 3-33 Parameters of UpcomingConferencesRequest
| Parameter | Description |
|---|---|
|
entityId |
String, site ID or user ID of the entity making the Web service call |
|
entityToken |
String representing the authentication token for this entity. Obtain this token by using Authentication services. |
|
userID |
String containing the user ID used to filter upcoming conferences. Conferences where this user participates as either host or attendee will be returned. If a null user ID is provided, the upcoming conferences will not be filtered based on host or attendee user IDs. |
|
registeredUserOny |
If Boolean flag is non-null, upcoming conferences having a registeredUserOnly flag equal to the filter value will be retrieved. Otherwise, upcoming conferences retrieved will not be filtered based on the value of this flag. |
|
publiclyListed |
If Boolean flag is non-null, upcoming conferences having a publiclyListed flag equal to the filter value will be retrieved. Otherwise, upcoming conferences retrieved will not be filtered based on the value of this flag. |
|
hostInvitedOnly |
If Boolean flag is non-null, upcoming conferences having a hostInvitedOnly flag equal to the filter value will be retrieved. Otherwise, upcoming conferences retrieved will not be filtered based on the value of this flag. |
|
fromStartDate |
Optional Date object for filtering the list by earliest start date |
|
toStartDate |
Optional Date object for filtering the list by latest start date |
|
adhocAttrributes |
Optional array of AdhocAttribute objects containing name-value pair attributes that can be used to specify additional inputs to the Web service. |
UpcomingConferencesResponse
Represents information returned from the listUpcomingConferences service.
Table 3-34 Parameters of UpcomingConferencesResponse
| Parameter | Description |
|---|---|
|
statusCode |
Integer, status code for the Web service call |
|
statusMessage |
Character string, authentication token for this entity. The token can be obtained using Authentication Services. |
|
statusDetails |
The optional namespace of the properties being requested |
|
conferenceDetails |
UpcomingConferenceDetails object including conference ID and title, name of host, conference start and end times, and conference URL |
|
adhocAttributes |
Array of AdhocAttribute, name-value pair attributes that can be used to specify additional output elements from the Web service |
The following table describes the status codes of the listUpcomingConferences service:
Table 3-35 Status Codes of deleteConference Service
| Status | Status Code | Description |
|---|---|---|
|
NO_ERROR |
0 |
Web service call completed successfully |
|
INVALID_USER_ID |
5 |
An invalid user ID was provided |
|
ERROR_RETRIEVING_CONFERENCE_LIST |
376 |
An error occurred while retrieving conference list |
|
NOT_AUTHORIZED |
1032 |
The entity is not authorized to make the request |
|
UNEXPECTED_ERROR |
1090 |
An unexpected error occurred and the operation cannot be completed successfully |
UpcomingConferenceDetails
Represents information returned by the listUpcomingConferences service:
Table 3-36 Parameters of UpcomingConferenceDetails
| Parameter | Description |
|---|---|
|
attributes |
Array of AdhocAttribute objects for the conference. |
|
conferenceID |
String, site ID or user ID of the entity making the Web service call |
|
conferenceStatus |
String containing the conference status. Can have a value of "Not Started", "In progress", or "Waiting for Host". |
|
conferenceTitle |
String containing the conference title |
|
registeredUserOnly |
Boolean flag indicating whether only registered users may be allowed to attend the Web conference |
|
publiclyListed |
Boolean flag indicating whether this web conference can be publicly listed |
|
hostInvitedOnly |
Boolean flag indicating whether only registered users invited by the host can attend the Web conference |
|
conferenceURL |
String representing the URL where this conference can be joined |
|
hostGUID |
String representation of the host's GUID. |
|
hostName |
String containing the name of the host |
|
scheduledEndTime |
Date object for the conference end time |
|
scheduledStartTime |
Date object for the conference start time |
|
statusDetail |
String containing detailed status information for the conference |
|
adhocAttrributes |
Optional array of AdhocAttribute objects containing name-value pair attributes that can be used to specify additional inputs to the Web service. |
Retrieves playback-related information for a conference.
Supports the following services:
Service URL
http://<hostname:portnum>/imtapp/ws/PostConferenceService
Service Definition
http://<hostname:portnum>/imtapp/ws/PostConferenceService?WSDL
Obtains playback-related information for a conference. In particular, it returns the URL (in a PlaybackURLResponse object) where the conference playback can be retrieved, as well as flags indicating whether the conference was finished, published, or recorded.
Request Parameters of getPlaybackURL
The following are the request parameters for the getPlaybackURL service:
PlaybackURLRequest
Represents information required by the getPlaybackURL service.
Table 3-38 Parameters of PlaybackURLRequest
| Parameter | Description |
|---|---|
|
entityID |
Character string representing the site ID or user ID of the entity making the Web service call. |
|
entityToken |
Character string representing the authentication token for this entity. The token can be obtained from Authentication Services. |
|
conferenceID |
The conference ID for the conference whose playback details are to be retrieved |
|
includeConferenceKey |
Optional boolean flag indicating whether the conference key should be included (in encrypted form) as part of the playback URL. If set to null, the conference key will not be included. |
|
adhocAttributes |
Optional array of AdhocAttribute containing name-value pair attributes that can be used to specify additional inputs to the Web service. |
PlaybackURLResponse
Represents information returned by the Get Playback URL service:
Table 3-39 Parameters of PlaybackURLResponse
| Parameter | Description |
|---|---|
|
statusCode |
Integer status code for the Web service call. |
|
statusMessage |
Descriptive string for the status of the Web service call. |
|
statusDetails |
String containing additional information regarding the status of the Web service call |
|
playbackURLDetail |
PlaybackURLDetails object, encapsulates the URL where the conference playback can be retrieved, as well as flags indicating whether the conference was finished, published, or recorded |
|
adhocAttributes |
Array of AdhocAttribute containing name-value pair attributes that can be used to specify additional output elements from the web service. |
The following table describes the status codes of the getPlaybackURL service:
Table 3-40 Status Codes of getPlaybackURL Service
| Status | Status Code | Description |
|---|---|---|
|
NO_ERROR |
0 |
Web service call completed successfully |
|
MEETING_ID_IS_NULL |
2 |
The conference ID provided was set to null |
|
INVALID_MEETING_ID |
3 |
An invalid conference ID was provided |
|
NOT_AUTHORIZED |
1032 |
The entity is not authorized to make the request |
PlaybackURLDetails
Represents information related to the playback URL of a conference.
Table 3-41 Parameters of PlaybackURLDetails
| Parameter | Description |
|---|---|
|
playbackURL |
String containing the URL for the conference playback |
|
finishedFlag |
Boolean indicating whether the conference has been finished |
|
recordedFlag |
Boolean indicating whether the conference has been recorded |
|
publishedFlag |
Boolean indicating whether the conference has been published |
|
adhocAttributes |
Optional array of AdhocAttribute containing name-value pair attributes that can be used to specify additional information relating to the playback details |
Provides the following SOAP-based and servlet-based services that facilitate clients to obtain the presence of an entity; supports the following services
Used when the integrating application or web site does not need to directly process the presence information but instead wants to display the presence information in a web page served to end users.
The Get Presence URL service is available in the following forms:
Image URL service
JavaScript/Text URL service
Service URL
http://<hostname:portnum>/imtapp/Presence?MODE=mode&OP=op&RES=resource&TID=tokenID&UID=userID&K1=hashKey
Input Parameters
The Presence URL service takes the following inputs as parameters in the URL:
Table 3-42 Parameters of getPresence
| Parameter | Description |
|---|---|
|
R_MODE |
Optional parameter to specific Image ("IMG") or JavaScript ("JS") mode. Default is "JS". |
|
R_OP |
Optional parameter specific to the request mode. For example, this parameter can be used to request alternate images when using the "IMG" mode by setting its value between 1 and 5. |
|
R_RES |
Optional parameter to explicitly retrieve presence of specific resource |
|
TID |
Required parameter. TokenID for a token authorized for the Presence Service. Obtain this parameter with Authentication Services by setting "PRESENCE" in the policy option |
|
R_UID |
Required parameter. User ID (or JID) of the target presentity. |
|
K1 |
SHA1 hash key used to secure the request. Further details about generating this key are given below. |
The value of the K1 parameter is computed using the SHA1 Digest algorithm on a customized message. This added security is needed because the presence request would be coming from the end-user browser and not a site. Hence, it is necessary to ensure that only presence requests authorized by a site are served. The input message to the SHA1 hash algorithm is a String obtained from the URL parameters using the following logic:
The URL parameters should be arranged in alphabetical order.
If a parameter does not have a value assigned, it should be ignored.
For parameters with an assigned value (other than K1), the following string should be added to the message, excluding the quotes: "<param_name><param_value>".
After all parameters have been added, the following string should be added to the message, excluding the quotes: "<token><token_value>".
The Secure Hash Algorithm (SHA1) is a standard message digest algorithm, with libraries available in most programming languages. In Java, the java.security.MessageDigest class can be used for this purpose.
Response (Success)
If presence information for the JID is available and if the hash key (K1) is validated correctly, the service generates the following response:
If the OPT parameter is set to "IMG": the service returns an image representing the presence status.
If the OPT parameter is set to "JS": the service returns text with the Presence Status and Presence Show attributes. The show attribute represents states such as "Available", "Away", "Offline", or "DnD" ("DnD" represents the "Do Not Disturb" state). The Status attribute represents any custom display text that the Presentity may have set for that connection (for example, "Call me on my Cell").
Response (Error)
If an invalid JID is specified, or if the hash key (K1)is not validated, the service generates the following response:
If the OPT parameter is set to "IMG": The Service returns an image representing the Error status. Deployments can customize this image to be the same as an "Offline" image, or may have a specific image to represent an "Error" status.
If the OPT parameter is set to "JS": The Service returns text with the Presence Status and Presence Show values set to "Offline".
The SOAP service is used when an integrating application needs to obtain presence information for internal processing. This service returns detailed presence information about a target presentity (representing a user, application, or service, for example).
The service returns a PresentityStatus object, which is an aggregation of the online resources for that JID. Based on the input parameters, the returned information has the following variations:
If a resource is specified: Returns the status of the particular resource. If the specified resource is not one of the online resources, the PresentityStatus object will not contain any resource objects.
If no resource is specified and showAllResourcesFlag is set to true: The services returns a list of all the resource objects for that JID.
Service URL
http://<hostname:portnum>/imtapp/ws/PresenceService
Service Definition
http://<hostname:portnum>/imtapp/ws/PresenceService?WSDL
Request Parameters of getPresence
The following are the request parameters for the getPresence service:
Table 3-43 Parameters of getPresence
| Parameter | Description |
|---|---|
|
param0 |
String representing the siteID or userID of the entity making the Web service call |
|
param1 |
String representing the authentication token for this entity. Obtain this token by using Authentication services. |
|
param2 |
String representing the JID of the presentity whose presence is to be retrieved |
|
param3 |
Optional string representing the resource of the presentity whose presence is to be retrieved. If this parameter is not set, the default resource is retrieved |
|
param4 |
Optional boolean flag to indicate if all the resources should be retrieved. This is effective only if param3 is not set. |
PresentityStatus
Specifies the target presentity for Get Presence SOAP Service.
Table 3-44 Parameters of PresentityStatus
| Parameter | Description |
|---|---|
|
allResources |
Array of PresentityResource containing each of the presentity's available online resources. |
|
userJID |
String, JID for the user |
PresentityResource
Specifies the resource for presentities.
Table 3-45 Parameters of PresentityResource
| Parameter | Description |
|---|---|
|
lastModifiedDate |
Date object for the time when this resource was last modified |
|
priority |
Long indicating the priority of this resource |
|
resourceName |
String containing the resource name |
|
show |
String indicating whether the presentity should be shown as either online or offline on the current resource |
|
status |
String representing the presentity's detailed online status on the current resource |
Used by integrating applications to obtain presence information for a list of presentities in bulk through a single Web service call. The SOAP service is an RPC-style service that returns list of detailed presence information for each of the target presentities.
Used to obtain a list of detailed presence information for each of the target presentities (such as a user, application, or service). Returns an object of type BulkPresenceResponse.
Request Parameters of getBulkPresence
The following are the request parameters for the getBulkPresence operation:
BulkPresenceRequest
Represents information required for the getBulkPresence service.
Table 3-47 Parameters of BulkPresenceRequest
| Parameter | Description |
|---|---|
|
entityID |
Character string representing the site ID or user ID of the entity making the Web service call. |
|
entityToken |
Character string representing the authentication token for this entity. The token can be obtained from Authentication Services. |
|
entityJIDs |
Array of character strings representing the JIDs of the presentities whose presence is to be retrieved |
|
resources |
Optional array of character strings representing the resource to be retrieved for each of the specified presentities. If an individual resource name is set to null, the default resource for the corresponding presentity will be retrieved. If the array itself is set to null, the default resource will be retrieved for all presentities. |
|
allResources |
Optional boolean flag indicating whether all the resources for a presentity should be retrieved. This flag will be ignored for those presentities for which a specific resource name is requested from the resources array. If set to null, only the default resource will be retrieved for all presentities for which a resource name was not provided. |
|
adhocAttributes |
Optional array of AdhocAttribute, name-value pair attributes that can be used to specify additional inputs to the Web service. |
BulkPresenceResponse
Represents information returned from the getBulkPresence service.
Table 3-48 Parameters of BulkPresenceResponse
| Parameter | Description |
|---|---|
|
statusCode |
Integer status code for the Web service call. |
|
statusMessage |
Descriptive string for the status of the Web service call. |
|
statusDetails |
String containing additional information regarding the status of the Web service call. |
|
presentityStatusList |
Array of detailed presence information for the target presentities, encapsulated in an array of PresentityStatus objects. |
|
adhocAttributes |
Array of AdhocAttribute, name-value pair attributes that can be used to specify additional output elements from the Web service. |
The following table describes the status codes of the getBulkPresence service:
Table 3-49 Status Codes of getBulkPresence Service
| Status | Status Code | Description |
|---|---|---|
|
NO_ERROR |
0 |
Web service call completed successfully |
|
SERVICE_INPUT_ERROR |
1010 |
Invalid input was provided to the Web service |
|
REQUEST_SIZE_EXCEEDED |
1011 |
The request exceeded the maximum number of allowed request elements. No data is returned. It is the responsibility of clients invoking this service to limit the size of their requests. |
|
ADDITIONAL_DATA_AVAILABLE |
1012 |
The request was only partially processed since the response reached the maximum allowed response size. Elements of the response are processed in the same order as they are found in the request until the maximum response size is exceeded. Any subsequent request elements will be ignored and the corresponding response elements will not included as part of the overall response. It is therefore the responsibility of clients invoking this service to provide the logic to handle any such dropped request elements. |
|
NOT_AUTHORIZED |
1032 |
The entity is not authorized to make the request |
Provides a mechanism for clients to generate reports based on finished conferences. It allows clients to retrieve conference attendees, lists of finished conferences based on their date and conference ID, as well as more specific conference details.
Reporting Services exposes the following Web services:
Service URL
http://<hostname:portnum>/imtapp/ws/ReportingService
Service Definition
http://<hostname:portnum>/imtapp/ws/ReportingService?WSDL
Used by integrating applications to obtain attendee-related information for a particular conference. The SOAP service is an RPC-style service that returns a list of attendees.
This service returns an object of type AttendeeListResponse.
Request Parameters of reportAttendeeList
The following are the request parameters for the reportAttendeeList operation:
AttendeeListRequest
Represents information for a particular conference whose attendees are to be retrieved.
Table 3-51 Parameters of AttendeeListRequest
| Parameter | Description |
|---|---|
|
entityID |
Character string representing the site ID or user ID of the entity making the Web service call. |
|
entityToken |
Character string representing the authentication token for this entity. The token can be obtained from Authentication Services. |
|
conferenceID |
String containing the ID of the conference whose attendees are to be retrieved |
|
adhocAttributes |
Optional array of AdhocAttribute objects containing name-value pair attributes that can be used to specify additional inputs to the Web service.. |
AttendeeListResponse
Represents attendee-related information of a particular conference.
Table 3-52 Parameters of AttendeeListResponse
| Parameter | Description |
|---|---|
|
statusCode |
Integer status code for the Web service call. |
|
statusMessage |
Descriptive string for the status of the Web service call. |
|
statusDetails |
String containing additional information regarding the status of the Web service call. |
|
attendees |
Array of Attendee for this conference. |
|
adhocAttributes |
Optional array of AdhocAttribute objects containing name-value pair attributes that can be used to specify additional inputs to the Web service.. |
The following table describes the status codes of the reportAttendeeList service:
Table 3-53 Status Codes of reportAttendeeList Service
| Status | Status Code | Description |
|---|---|---|
|
NO_ERROR |
0 |
Web service call completed successfully |
|
INVALID_SITE_ID |
4 |
The site ID provided was invalid |
|
ERROR_RETRIEVING_ATTENDEE_LIST |
377 |
The attendee list could not be retrieved for this conference |
|
ERROR_RETRIEVING_CONFERENCE_DETAILS |
379 |
The conference details could not be retrieved for this conference. |
|
NOT_AUTHORIZED |
1032 |
The entity is not authorized to make the request |
|
UNEXPECTED_ERROR |
1090 |
An unexpected error occurred and the operation cannot be completed successfully |
Attendee
Represents an attendee of a conference.
Table 3-54 Parameters of Attendee
| Parameter | Description |
|---|---|
|
name |
String containing the attendee's name. |
|
emailAddress |
String containing the attendee's email address |
|
timeEntered |
Long value representing time attendee entered conference |
|
timeExited |
Long value representing time attendee exited conference |
|
userID |
String containing the attendee's user ID |
|
guest |
Boolean flag indicating whether the attendee was a guest of the conference |
|
adhocAttributes |
Optional array of AdhocAttribute containing name-value pair attributes that can be used to provide additional type-specific data. |
Used by integrating applications to obtain detailed information for a particular finished conference. The SOAP service is an RPC-style service that returns the conference details for the requested conference. It obtains detailed information for a finished conference. In particular, it returns the requested conference's details including information such as title, host name, start and end times, duration, number of attendees, and status details, and can optionally include attendee and playback URL information for the conference.
This service returns an object of type FinishedConferenceDetailsResponse.
Request Parameters of reportFinishedConferenceDetails
The following are the request parameters for the reportFinishedConferenceDetails operation:
FinishedConferenceDetailsRequest
Represents information required by the Report Finished Conference Details service.
Table 3-56 Parameters of FinishedConferenceDetailsRequest
| Parameter | Description |
|---|---|
|
entityID |
Character string representing the site ID or user ID of the entity making the Web service call. |
|
entityToken |
Character string representing the authentication token for this entity. The token can be obtained from Authentication Services. |
|
conferenceID |
String containing the ID of the finished conference whose details are to be retrieved. |
|
includeAttendees |
Optional boolean flag indicating whether the conference attendees should be included with the conference details. If set to null, the conference attendees will not be included with the conference details. |
|
includePlaybackURLDetails |
Optional boolean indicating whether the conference playback URL details should be included with the conference details. If set to null, the conference's playback URL details will not be included with the conference details. |
|
adhocAttributes |
Optional array of AdhocAttribute, name-value pair attributes that can be used to specify additional inputs to the Web service. |
FinishedConferenceDetailsResponse
Represents information returned by the returnedFinishedConferenceDetails service.
Table 3-57 Parameters of FinishedConferenceDetailsResponse
| Parameter | Description |
|---|---|
|
statusCode |
Integer status code for the Web service call. |
|
statusMessage |
Descriptive string for the status of the Web service call. |
|
statusDetails |
String containing additional information regarding the status of the Web service call. |
|
conferenceDetails |
The finished conference details; object of type FinishedConferenceDetails. |
|
adhocAttributes |
Array of AdhocAttribute containing name-value pair attributes that can be used to specify additional output elements from the Web service. |
The following table describes the status codes of the reportFinishedConferenceDetails service:
Table 3-58 Status Codes of reportFinishedConferenceDetails Service
| Status | Status Code | Description |
|---|---|---|
|
NO_ERROR |
0 |
Web service call completed successfully |
|
MEETING_ID_IS_NULL |
2 |
The conference ID provided was set to null |
|
INVALID_MEETING_ID |
3 |
The conference ID provided was invalid |
|
INVALID_SITE_ID |
4 |
The site ID provided was invalid |
|
ERROR_RETRIEVING_ATTENDEE_LIST |
377 |
The attendee list could not be retrieved for this conference. |
|
ERROR_RETRIEVING_CONFERENCE_DETAILS |
379 |
The conference details could not be retrieved for this conference |
|
NOT_AUTHORIZED |
1032 |
The entity is not authorized to make the request |
|
UNEXPECTED_ERROR |
1090 |
An unexpected error occurred and the operation cannot be completed successfully |
FinishedConferenceDetails
Represents a finished conference.
Table 3-59 Parameters of FinishedConferenceDetails
| Parameter | Description |
|---|---|
|
conferenceID |
String containing the conference ID |
|
title |
String containing the conference title |
|
hostName |
String containing the name of the conference host |
|
startTime |
Date object for the time at which the conference started |
|
endTime |
Date object for the time at which the conference ended |
|
duration |
Integer equal to the duration of conference in minutes |
|
numAttendees |
Integer containing the number of attendees |
|
rating |
A string rating for the conference |
|
comments |
String containing comments relating to the conference |
|
statusDetails |
String containing status details for the conference. The following are the possible options:
|
|
attendees |
Array of Attendee objects with attendee-related information for the conference |
|
playbackURLDetails |
PlaybackURLDetails object containing playback URL details for the conference |
|
adhocAttributes |
Optional array of AdhocAttribute containing name-value pair attributes that can be used to provide additional type-specific data. |
Used by integrating applications to retrieve conference details for a number of conferences filtered by date. The SOAP service is an RPC-style service that returns a list of conference details for the matching conferences. It obtains conference details for all conferences that occurred between the specified start and end dates. In particular, it returns a list of conference details including information such as title, host name, start and end times, duration, number of attendees, and status details, and can optionally include attendee and playback URL information for each of the matching conferences.
This service returns an object of type BulkFinishedConferenceDetailsResponse.
Request Parameters of reportFinishedConferencesByDate
The following are the request parameters for the reportFinishedConferencesByDate operation:
FinishedConferencesByDateRequest
Represents information required by the Report Finished Conferences By Date service.
Table 3-61 Parameters of FinishedConferencesByDateRequest
| Parameter | Description |
|---|---|
|
entityID |
Character string representing the site ID or user ID of the entity making the Web service call. |
|
entityToken |
Character string representing the authentication token for this entity. The token can be obtained from Authentication Services. |
|
fromEndDate |
The lower-bound end date for which matching conferences should be retrieved. If set to null, the standard base time of January 1, 1970, 00:00:00 GMT will be used by default. |
|
toEndDate |
The upper-bound end date for which matching conferences should be retrieved. If set to null, the current date at the server will be used by default. |
|
includeAttendees |
Optional boolean flag indicating whether the conference attendees should be included with the conference details. If set to null, the conference attendees will not be included with the conference details. |
|
includePlaybackURLDetails |
Optional boolean indicating whether the conference playback URL details should be included with the conference details. If set to null, the conference's Playback URL details will not be included with the conference details. |
|
adhocAttributes |
Optional array of AdhocAttribute containing name-value pair attributes that can be used to specify additional inputs to the Web service. |
BulkFinishedConferenceDetailsResponse
Represents details of finished conferences.
Table 3-62 Parameters of BulkFinishedConferenceDetailsResponse
| Parameter | Description |
|---|---|
|
statusCode |
Integer status code for the Web service call. |
|
statusMessage |
Descriptive string for the status of the Web service call. |
|
statusDetails |
String containing additional information regarding the status of the Web service call. |
|
conferenceDetailsList |
Array of FinishedConferenceDetails, finished conference details matching the request. |
|
adhocAttributes |
Array of AdhocAttribute containing name-value pair attributes that can be used to specify additional output elements from the Web service. |
The following are the status codes of the bulkFinishedConferencesByDate service:
Table 3-63 Status Codes of bulkFinishedConferencesByDate Service
| Status | Status Code | Description |
|---|---|---|
|
NO_ERROR |
0 |
Web service call completed successfully |
|
INVALID_SITE_ID |
4 |
The site ID provided was invalid |
|
ERROR_RETRIEVING_CONFERENCE_LIST |
376 |
The list of conferences could not be retrieved for this request |
|
ERROR_RETRIEVING_ATTENDEE_LIST |
377 |
The attendee list could not be retrieved for this conference. |
|
ERROR_RETRIEVING_CONFERENCE_DETAILS |
379 |
The conference details could not be retrieved for this conference |
|
NOT_AUTHORIZED |
1032 |
The entity is not authorized to make the request |
|
UNEXPECTED_ERROR |
1090 |
An unexpected error occurred and the operation cannot be completed successfully |
Used by integrating applications wishing to retrieve conference details for a batch of conferences whose conference IDs are known. The SOAP service is an RPC-style service that returns a list of conference details for the matching conferences. It obtains conference details for those conferences specified in the list of conference IDs. In particular, it returns a list of conference details including information such as title, host name, start and end times, duration, number of attendees, and status details, and can optionally include attendee and playback URL information for each of the matching conferences.
This service returns an object of type BulkFinishedConferenceDetailsResponse.
Request Parameters of reportFinishedConferencesByID
The following are the request parameters for the reportFinishedConferencesByID operation:
FinishedConferencesByIDRequest
Represents information required by the Report Finished Conferences By ID service.
Table 3-65 Parameters of FinishedConferencesByIDRequest
| Parameter | Description |
|---|---|
|
entityID |
Character string representing the site ID or user ID of the entity making the Web service call. |
|
entityToken |
Character string representing the authentication token for this entity. The token can be obtained from Authentication Services. |
|
conferenceIDs |
String array containing the list of conference IDs for those conferences whose details should be retrieved. |
|
includeAttendees |
Optional boolean flag indicating whether the conference attendees should be included with the conference details. If set to null, the conference attendees will not be included with the conference details. |
|
includePlaybackURLDetails |
Optional boolean indicating whether the conference playback URL details should be included with the conference details. If set to null, the conference's Playback URL details will not be included with the conference details. |
|
adhocAttributes |
Optional array of AdhocAttribute containing name-value pair attributes that can be used to specify additional inputs to the Web service. |
The following are the status codes of the reportFinishedConferencesByID service:
Table 3-66 Status Codes of reportFinishedConferencesByID Service
| Status | Status Code | Description |
|---|---|---|
|
NO_ERROR |
0 |
Web service call completed successfully |
|
INVALID_SITE_ID |
4 |
The site ID provided was invalid |
|
ERROR_RETRIEVING_ATTENDEE_LIST |
377 |
The attendee list could not be retrieved for this conference. |
|
ERROR_RETRIEVING_CONFERENCE_DETAILS |
379 |
The conference details could not be retrieved for this conference |
|
NOT_AUTHORIZED |
1032 |
The entity is not authorized to make the request |
|
UNEXPECTED_ERROR |
1090 |
An unexpected error occurred and the operation cannot be completed successfully |
