YM REST Services

<back to all web services

EventVirtualWebinars

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
PUT/Ams/{ClientID}/Event/{EventId}/VirtualWebinars/Update a given event's VirtualWebinar.
POST/Ams/{ClientID}/Event/{EventId}/VirtualWebinars/Create a new event VirtualWebinar.
GET/Ams/{ClientID}/Event/{EventId}/VirtualWebinars/{WebinarId}Return the details for a VirtualWebinar linked to an event.
DELETE/Ams/{ClientID}/Event/{EventId}/VirtualWebinars/{WebinarId}Delete a given event VirtualWebinar.
EventVirtualWebinars Parameters:
NameParameterData TypeRequiredDescription
WebinarIdpathlongNo
ZoomUserIdbodystringNo
EventIdpathintNo
Webinars Parameters:
NameParameterData TypeRequiredDescription
WebinarformWebinarNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
Webinar Parameters:
NameParameterData TypeRequiredDescription
UuidformstringNo
IdformlongNo
HostIdformstringNo
HostEmailformstringNo
TopicformstringNo
TypeformWebinarTypeNo
DurationformintNo
AgendaformstringNo
CreatedOnformDateTimeNo
StartTimeformstringNo
TimeZoneformstringNo
JoinUrlformstringNo
StartUrlformstringNo
TrackingFieldsformKeyValuePair<String,String>[]No
SettingsformWebinarSettingsNo
PasswordformstringNo
WebinarSettings Parameters:
NameParameterData TypeRequiredDescription
StartVideoWhenHostJoinsformbool?No
StartVideoWhenPanelistsJoinformbool?No
EnablePracticeSessionformbool?No
EnableHighDefinitionVideoformbool?No
ApprovalTypeformMeetingApprovalType?No
RegistrationTypeformMeetingRegistrationType?No
AudioformAudioType?No
AutoRecordingformRecordingTypeNo
EnforceLoginformbool?No
EnforceLoginDomainsformstringNo
AlternativeHostsformstringNo
CloseRegistrationformbool?No
ShowSocialShareButtonsformbool?No
AllowMultipleDevicesformbool?No
OnDemandformbool?No
GlobalDialInCountriesformstring[]No
ContactNameformstringNo
ContactEmailformstringNo
MaximumNumberOfRegistrantsformint?No
SurveyUrlformstringNo
SendRegistrationConfirmationEmailformbool?No
AuthenticatedUsersOnlyformbool?No
AuthenticationTypeIdformstringNo
QuestionAndAnswerformQuestionAndAnswerNo
QuestionAndAnswer Parameters:
NameParameterData TypeRequiredDescription
EnableformboolNo
EventVirtualWebinarsResponse Parameters:
NameParameterData TypeRequiredDescription
HostIDLabelformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/Event/{EventId}/VirtualWebinars/ HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"WebinarId":0,"ZoomUserId":"String","EventId":0,"Webinar":{"Uuid":"String","Id":0,"HostId":"String","HostEmail":"String","Topic":"String","Type":"Regular","Duration":0,"Agenda":"String","CreatedOn":"0001-01-01T00:00:00.0000000","StartTime":"String","TimeZone":"String","JoinUrl":"String","StartUrl":"String","TrackingFields":[{"Key":"String","Value":"String"}],"Settings":{"StartVideoWhenHostJoins":false,"StartVideoWhenPanelistsJoin":false,"EnablePracticeSession":false,"EnableHighDefinitionVideo":false,"ApprovalType":"Automatic","RegistrationType":"0","Audio":"Voip","AutoRecording":"OnLocal","EnforceLogin":false,"EnforceLoginDomains":"String","AlternativeHosts":"String","CloseRegistration":false,"ShowSocialShareButtons":false,"AllowMultipleDevices":false,"OnDemand":false,"GlobalDialInCountries":["String"],"ContactName":"String","ContactEmail":"String","MaximumNumberOfRegistrants":0,"SurveyUrl":"String","SendRegistrationConfirmationEmail":false,"AuthenticatedUsersOnly":false,"AuthenticationTypeId":"String","QuestionAndAnswer":{"Enable":false}},"Password":"String"},"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T02:21:08.5593938-04:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"HostIDLabel":"String","WebinarId":0,"ZoomUserId":"String","EventId":0,"Webinar":{"Uuid":"String","Id":0,"HostId":"String","HostEmail":"String","Topic":"String","Type":"Regular","Duration":0,"Agenda":"String","CreatedOn":"0001-01-01T00:00:00.0000000","StartTime":"String","TimeZone":"String","JoinUrl":"String","StartUrl":"String","TrackingFields":[{"Key":"String","Value":"String"}],"Settings":{"StartVideoWhenHostJoins":false,"StartVideoWhenPanelistsJoin":false,"EnablePracticeSession":false,"EnableHighDefinitionVideo":false,"ApprovalType":"Automatic","RegistrationType":"0","Audio":"Voip","AutoRecording":"OnLocal","EnforceLogin":false,"EnforceLoginDomains":"String","AlternativeHosts":"String","CloseRegistration":false,"ShowSocialShareButtons":false,"AllowMultipleDevices":false,"OnDemand":false,"GlobalDialInCountries":["String"],"ContactName":"String","ContactEmail":"String","MaximumNumberOfRegistrants":0,"SurveyUrl":"String","SendRegistrationConfirmationEmail":false,"AuthenticatedUsersOnly":false,"AuthenticationTypeId":"String","QuestionAndAnswer":{"Enable":false}},"Password":"String"},"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T02:21:08.5633969-04:00","Device":"Desktop"}