EventSchedulingServiceSoap

Operations

Index Method Parameters Response Type Description
1 getWriterList
organizationToken
ArrayOfKeyValuePair Returns all staff members that are writers.
2 getCustomerList
organizationToken
ArrayOfKeyValuePair Returns all customers.
3 getStaffList
organizationToken
ArrayOfKeyValuePair Returns all staff members regardless of the writer flag
4 getParsingFormats
organizationToken
ArrayOfKeyValuePair Returns all system supported parsing formats.
5 getTimezones
organizationToken
ArrayOfKeyValuePair Returns all system supported time zones.
6 getLanguages
organizationToken
ArrayOfKeyValuePair Returns all system supported languages.
7 getEmailTemplates
organizationToken
ArrayOfKeyValuePair Returns all email templates defined for the organization.
8 getEvent
organizationToken
eventId
ScheduledEventInfo Returns the details of an event.
9 cancelEvent
organizationToken
eventId
ScheduledEventInfo Cancels a scheduled event.
10 startEvent
organizationToken
eventId
Immediately starts a scheduled event.
11 stopEvent
organizationToken
eventId
Stops a live event.
12 changeWriter
organizationToken
eventId
newWriterId
newParsingFormatId
Changes the writer on a live event.
15 getEventAccess
organizationToken
eventNameOrId
EventAccessInfo Get the access token for an event that is protected with a password or login requirements.
16 getScheduledAndLiveEvents
userToken
ArrayOfScheduledEventInfo Get scheduled or live events.
17 scheduleEvent
organizationToken
info
ScheduledEventInfo Schedule an event.

getWriterList

Parameters

Name Type Required Description
organizationToken
String
 Y

Response

Name Type Required Description
GetWriterListResult
ArrayOfKeyValuePair
Property Type Required Description
KeyValuePair[] KeyValuePair[] N
KeyValuePair[].Key String N
KeyValuePair[].Value String N
Y

getCustomerList

Parameters

Name Type Required Description
organizationToken
String
 Y

Response

Name Type Required Description
GetCustomerListResult
ArrayOfKeyValuePair
Property Type Required Description
KeyValuePair[] KeyValuePair[] N
KeyValuePair[].Key String N
KeyValuePair[].Value String N
Y

getStaffList

Parameters

Name Type Required Description
organizationToken
String
 Y

Response

Name Type Required Description
GetStaffListResult
ArrayOfKeyValuePair
Property Type Required Description
KeyValuePair[] KeyValuePair[] N
KeyValuePair[].Key String N
KeyValuePair[].Value String N
Y

getParsingFormats

Parameters

Name Type Required Description
organizationToken
String
 Y

Response

Name Type Required Description
GetParsingFormatsResult
ArrayOfKeyValuePair
Property Type Required Description
KeyValuePair[] KeyValuePair[] N
KeyValuePair[].Key String N
KeyValuePair[].Value String N
Y

getTimezones

Parameters

Name Type Required Description
organizationToken
String
 Y

Response

Name Type Required Description
GetTimezonesResult
ArrayOfKeyValuePair
Property Type Required Description
KeyValuePair[] KeyValuePair[] N
KeyValuePair[].Key String N
KeyValuePair[].Value String N
Y

getLanguages

Parameters

Name Type Required Description
organizationToken
String
 Y

Response

Name Type Required Description
GetLanguagesResult
ArrayOfKeyValuePair
Property Type Required Description
KeyValuePair[] KeyValuePair[] N
KeyValuePair[].Key String N
KeyValuePair[].Value String N
Y

getEmailTemplates

Parameters

Name Type Required Description
organizationToken
String
 Y

Response

Name Type Required Description
GetEmailTemplatesResult
ArrayOfKeyValuePair
Property Type Required Description
KeyValuePair[] KeyValuePair[] N
KeyValuePair[].Key String N
KeyValuePair[].Value String N
Y

getEvent

Parameters

Name Type Required Description
organizationToken
String
 Y
eventId
String
 Y

Response

Name Type Required Description
GetEventResult
ScheduledEventInfo
Property Type Required Description
ActualDatetime String N
ActualUtcDatetime String N
ActualDuration String N
BytesReceived String N
CharactersReceived String N
ConnectDatetime String N
ConnectDuration String N
RequirePasswordFlag String N
RequireLoginFlag String N
WebPlayerFlag String N
LegalPodFlag String N
RetainTranscriptFlag String N
SingleUserFlag String N
CaptionPodFlag String N
GenericCaptionPodFlag String N
StreamToYouTubeLive String N
YouTubeLiveCaptionUrl String N
YouTubeLiveDelay String N
StreamToZoom String N
ZoomCaptionUrl String N
ZoomSendOnTimer String N
ZoomSendOnLineFeed String N
ZoomSendOnSentenceEnd String N
ZoomLineCount String N
ZoomCorrectionBuffer String N
IncludeLanguageTranslation String N
SourceLanguage String N
Password String N
Id String N
IncludeChatFlag String N
IntegratedAudio String N
AllowPhoneDialOut String N
AllowSipConnections String N
SipConferenceAddress String N
Name String N
Delay String N
ParsingFormat KeyValuePair N
ParsingFormat.Key String N
ParsingFormat.Value String N
ScheduledDatetime String N
ScheduledUtcDatetime String N
ScheduledDuration String N
Status String N
TimeZone KeyValuePair N
TimeZone.Key String N
TimeZone.Value String N
Writer KeyValuePair N
Writer.Key String N
Writer.Value String N
ViewTranscriptFlag String N
Viewers ArrayOfKeyValuePair N
Viewers.KeyValuePair[] KeyValuePair[] N
Viewers.KeyValuePair[].Key String N
Viewers.KeyValuePair[].Value String N
AdditionalWriters ArrayOfKeyValuePair N
AdditionalWriters.KeyValuePair[] KeyValuePair[] N
AdditionalWriters.KeyValuePair[].Key String N
AdditionalWriters.KeyValuePair[].Value String N
Languages ArrayOfKeyValuePair N
Languages.KeyValuePair[] KeyValuePair[] N
Languages.KeyValuePair[].Key String N
Languages.KeyValuePair[].Value String N
WriterNotification KeyValuePair N
WriterNotification.Key String N
WriterNotification.Value String N
ViewerNotification KeyValuePair N
ViewerNotification.Key String N
ViewerNotification.Value String N
Errors String N
Y

cancelEvent

Parameters

Name Type Required Description
organizationToken
String
 Y
eventId
String
 Y

Response

Name Type Required Description
CancelEventResult
ScheduledEventInfo
Property Type Required Description
ActualDatetime String N
ActualUtcDatetime String N
ActualDuration String N
BytesReceived String N
CharactersReceived String N
ConnectDatetime String N
ConnectDuration String N
RequirePasswordFlag String N
RequireLoginFlag String N
WebPlayerFlag String N
LegalPodFlag String N
RetainTranscriptFlag String N
SingleUserFlag String N
CaptionPodFlag String N
GenericCaptionPodFlag String N
StreamToYouTubeLive String N
YouTubeLiveCaptionUrl String N
YouTubeLiveDelay String N
StreamToZoom String N
ZoomCaptionUrl String N
ZoomSendOnTimer String N
ZoomSendOnLineFeed String N
ZoomSendOnSentenceEnd String N
ZoomLineCount String N
ZoomCorrectionBuffer String N
IncludeLanguageTranslation String N
SourceLanguage String N
Password String N
Id String N
IncludeChatFlag String N
IntegratedAudio String N
AllowPhoneDialOut String N
AllowSipConnections String N
SipConferenceAddress String N
Name String N
Delay String N
ParsingFormat KeyValuePair N
ParsingFormat.Key String N
ParsingFormat.Value String N
ScheduledDatetime String N
ScheduledUtcDatetime String N
ScheduledDuration String N
Status String N
TimeZone KeyValuePair N
TimeZone.Key String N
TimeZone.Value String N
Writer KeyValuePair N
Writer.Key String N
Writer.Value String N
ViewTranscriptFlag String N
Viewers ArrayOfKeyValuePair N
Viewers.KeyValuePair[] KeyValuePair[] N
Viewers.KeyValuePair[].Key String N
Viewers.KeyValuePair[].Value String N
AdditionalWriters ArrayOfKeyValuePair N
AdditionalWriters.KeyValuePair[] KeyValuePair[] N
AdditionalWriters.KeyValuePair[].Key String N
AdditionalWriters.KeyValuePair[].Value String N
Languages ArrayOfKeyValuePair N
Languages.KeyValuePair[] KeyValuePair[] N
Languages.KeyValuePair[].Key String N
Languages.KeyValuePair[].Value String N
WriterNotification KeyValuePair N
WriterNotification.Key String N
WriterNotification.Value String N
ViewerNotification KeyValuePair N
ViewerNotification.Key String N
ViewerNotification.Value String N
Errors String N
Y

startEvent

Parameters

Name Type Required Description
organizationToken
String
 Y
eventId
String
 Y

Response

No Response

stopEvent

Parameters

Name Type Required Description
organizationToken
String
 Y
eventId
String
 Y

Response

No Response

changeWriter

Parameters

Name Type Required Description
organizationToken
String
 Y
eventId
String
 Y
newWriterId
String
 Y
newParsingFormatId
String
 Y

Response

No Response

getEventAccess

Parameters

Name Type Required Description
organizationToken
String
 Y
eventNameOrId
String
 Y

Response

Name Type Required Description
GetEventAccessResult
EventAccessInfo
Property Type Required Description
Name String N
AccessToken String N
Y

getScheduledAndLiveEvents

Parameters

Name Type Required Description
userToken
String
 Y

Response

Name Type Required Description
GetScheduledAndLiveEventsResult
ArrayOfScheduledEventInfo
Property Type Required Description
ScheduledEventInfo[] ScheduledEventInfo[] N
ScheduledEventInfo[].ActualDatetime String N
ScheduledEventInfo[].ActualUtcDatetime String N
ScheduledEventInfo[].ActualDuration String N
ScheduledEventInfo[].BytesReceived String N
ScheduledEventInfo[].CharactersReceived String N
ScheduledEventInfo[].ConnectDatetime String N
ScheduledEventInfo[].ConnectDuration String N
ScheduledEventInfo[].RequirePasswordFlag String N
ScheduledEventInfo[].RequireLoginFlag String N
ScheduledEventInfo[].WebPlayerFlag String N
ScheduledEventInfo[].LegalPodFlag String N
ScheduledEventInfo[].RetainTranscriptFlag String N
ScheduledEventInfo[].SingleUserFlag String N
ScheduledEventInfo[].CaptionPodFlag String N
ScheduledEventInfo[].GenericCaptionPodFlag String N
ScheduledEventInfo[].StreamToYouTubeLive String N
ScheduledEventInfo[].YouTubeLiveCaptionUrl String N
ScheduledEventInfo[].YouTubeLiveDelay String N
ScheduledEventInfo[].StreamToZoom String N
ScheduledEventInfo[].ZoomCaptionUrl String N
ScheduledEventInfo[].ZoomSendOnTimer String N
ScheduledEventInfo[].ZoomSendOnLineFeed String N
ScheduledEventInfo[].ZoomSendOnSentenceEnd String N
ScheduledEventInfo[].ZoomLineCount String N
ScheduledEventInfo[].ZoomCorrectionBuffer String N
ScheduledEventInfo[].IncludeLanguageTranslation String N
ScheduledEventInfo[].SourceLanguage String N
ScheduledEventInfo[].Password String N
ScheduledEventInfo[].Id String N
ScheduledEventInfo[].IncludeChatFlag String N
ScheduledEventInfo[].IntegratedAudio String N
ScheduledEventInfo[].AllowPhoneDialOut String N
ScheduledEventInfo[].AllowSipConnections String N
ScheduledEventInfo[].SipConferenceAddress String N
ScheduledEventInfo[].Name String N
ScheduledEventInfo[].Delay String N
ScheduledEventInfo[].ParsingFormat KeyValuePair N
ScheduledEventInfo[].ParsingFormat.Key String N
ScheduledEventInfo[].ParsingFormat.Value String N
ScheduledEventInfo[].ScheduledDatetime String N
ScheduledEventInfo[].ScheduledUtcDatetime String N
ScheduledEventInfo[].ScheduledDuration String N
ScheduledEventInfo[].Status String N
ScheduledEventInfo[].TimeZone KeyValuePair N
ScheduledEventInfo[].TimeZone.Key String N
ScheduledEventInfo[].TimeZone.Value String N
ScheduledEventInfo[].Writer KeyValuePair N
ScheduledEventInfo[].Writer.Key String N
ScheduledEventInfo[].Writer.Value String N
ScheduledEventInfo[].ViewTranscriptFlag String N
ScheduledEventInfo[].Viewers ArrayOfKeyValuePair N
ScheduledEventInfo[].Viewers.KeyValuePair[] KeyValuePair[] N
ScheduledEventInfo[].Viewers.KeyValuePair[].Key String N
ScheduledEventInfo[].Viewers.KeyValuePair[].Value String N
ScheduledEventInfo[].AdditionalWriters ArrayOfKeyValuePair N
ScheduledEventInfo[].AdditionalWriters.KeyValuePair[] KeyValuePair[] N
ScheduledEventInfo[].AdditionalWriters.KeyValuePair[].Key String N
ScheduledEventInfo[].AdditionalWriters.KeyValuePair[].Value String N
ScheduledEventInfo[].Languages ArrayOfKeyValuePair N
ScheduledEventInfo[].Languages.KeyValuePair[] KeyValuePair[] N
ScheduledEventInfo[].Languages.KeyValuePair[].Key String N
ScheduledEventInfo[].Languages.KeyValuePair[].Value String N
ScheduledEventInfo[].WriterNotification KeyValuePair N
ScheduledEventInfo[].WriterNotification.Key String N
ScheduledEventInfo[].WriterNotification.Value String N
ScheduledEventInfo[].ViewerNotification KeyValuePair N
ScheduledEventInfo[].ViewerNotification.Key String N
ScheduledEventInfo[].ViewerNotification.Value String N
ScheduledEventInfo[].Errors String N
Y

scheduleEvent

Parameters

Name Type Required Description
organizationToken
String
 Y
info
ScheduledEventInfo
Property Type Required Description
ActualDatetime String N
ActualUtcDatetime String N
ActualDuration String N
BytesReceived String N
CharactersReceived String N
ConnectDatetime String N
ConnectDuration String N
RequirePasswordFlag String N
RequireLoginFlag String N
WebPlayerFlag String N
LegalPodFlag String N
RetainTranscriptFlag String N
SingleUserFlag String N
CaptionPodFlag String N
GenericCaptionPodFlag String N
StreamToYouTubeLive String N
YouTubeLiveCaptionUrl String N
YouTubeLiveDelay String N
StreamToZoom String N
ZoomCaptionUrl String N
ZoomSendOnTimer String N
ZoomSendOnLineFeed String N
ZoomSendOnSentenceEnd String N
ZoomLineCount String N
ZoomCorrectionBuffer String N
IncludeLanguageTranslation String N
SourceLanguage String N
Password String N
Id String N
IncludeChatFlag String N
IntegratedAudio String N
AllowPhoneDialOut String N
AllowSipConnections String N
SipConferenceAddress String N
Name String N
Delay String N
ParsingFormat KeyValuePair N
ParsingFormat.Key String N
ParsingFormat.Value String N
ScheduledDatetime String N
ScheduledUtcDatetime String N
ScheduledDuration String N
Status String N
TimeZone KeyValuePair N
TimeZone.Key String N
TimeZone.Value String N
Writer KeyValuePair N
Writer.Key String N
Writer.Value String N
ViewTranscriptFlag String N
Viewers ArrayOfKeyValuePair N
Viewers.KeyValuePair[] KeyValuePair[] N
Viewers.KeyValuePair[].Key String N
Viewers.KeyValuePair[].Value String N
AdditionalWriters ArrayOfKeyValuePair N
AdditionalWriters.KeyValuePair[] KeyValuePair[] N
AdditionalWriters.KeyValuePair[].Key String N
AdditionalWriters.KeyValuePair[].Value String N
Languages ArrayOfKeyValuePair N
Languages.KeyValuePair[] KeyValuePair[] N
Languages.KeyValuePair[].Key String N
Languages.KeyValuePair[].Value String N
WriterNotification KeyValuePair N
WriterNotification.Key String N
WriterNotification.Value String N
ViewerNotification KeyValuePair N
ViewerNotification.Key String N
ViewerNotification.Value String N
Errors String N
Y

Response

Name Type Required Description
ScheduleEventResult
ScheduledEventInfo
Property Type Required Description
ActualDatetime String N
ActualUtcDatetime String N
ActualDuration String N
BytesReceived String N
CharactersReceived String N
ConnectDatetime String N
ConnectDuration String N
RequirePasswordFlag String N
RequireLoginFlag String N
WebPlayerFlag String N
LegalPodFlag String N
RetainTranscriptFlag String N
SingleUserFlag String N
CaptionPodFlag String N
GenericCaptionPodFlag String N
StreamToYouTubeLive String N
YouTubeLiveCaptionUrl String N
YouTubeLiveDelay String N
StreamToZoom String N
ZoomCaptionUrl String N
ZoomSendOnTimer String N
ZoomSendOnLineFeed String N
ZoomSendOnSentenceEnd String N
ZoomLineCount String N
ZoomCorrectionBuffer String N
IncludeLanguageTranslation String N
SourceLanguage String N
Password String N
Id String N
IncludeChatFlag String N
IntegratedAudio String N
AllowPhoneDialOut String N
AllowSipConnections String N
SipConferenceAddress String N
Name String N
Delay String N
ParsingFormat KeyValuePair N
ParsingFormat.Key String N
ParsingFormat.Value String N
ScheduledDatetime String N
ScheduledUtcDatetime String N
ScheduledDuration String N
Status String N
TimeZone KeyValuePair N
TimeZone.Key String N
TimeZone.Value String N
Writer KeyValuePair N
Writer.Key String N
Writer.Value String N
ViewTranscriptFlag String N
Viewers ArrayOfKeyValuePair N
Viewers.KeyValuePair[] KeyValuePair[] N
Viewers.KeyValuePair[].Key String N
Viewers.KeyValuePair[].Value String N
AdditionalWriters ArrayOfKeyValuePair N
AdditionalWriters.KeyValuePair[] KeyValuePair[] N
AdditionalWriters.KeyValuePair[].Key String N
AdditionalWriters.KeyValuePair[].Value String N
Languages ArrayOfKeyValuePair N
Languages.KeyValuePair[] KeyValuePair[] N
Languages.KeyValuePair[].Key String N
Languages.KeyValuePair[].Value String N
WriterNotification KeyValuePair N
WriterNotification.Key String N
WriterNotification.Value String N
ViewerNotification KeyValuePair N
ViewerNotification.Key String N
ViewerNotification.Value String N
Errors String N
Y