YM REST 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:
Name	Parameter	Data Type	Required
WebinarId	path	long	No
ZoomUserId	body	string	No
EventId	path	int	No

**Webinars** Parameters:
Name	Parameter	Data Type	Required	Description
Webinar	form	Webinar	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**Webinar** Parameters:
Name	Parameter	Data Type	Required
Uuid	form	string	No
Id	form	long	No
HostId	form	string	No
HostEmail	form	string	No
Topic	form	string	No
Type	form	WebinarType	No
Duration	form	int	No
Agenda	form	string	No
CreatedOn	form	DateTime	No
StartTime	form	string	No
TimeZone	form	string	No
JoinUrl	form	string	No
StartUrl	form	string	No
TrackingFields	form	KeyValuePair<String,String>[]	No
Settings	form	WebinarSettings	No
Password	form	string	No

**WebinarSettings** Parameters:
Name	Parameter	Data Type	Required
StartVideoWhenHostJoins	form	bool?	No
StartVideoWhenPanelistsJoin	form	bool?	No
EnablePracticeSession	form	bool?	No
EnableHighDefinitionVideo	form	bool?	No
ApprovalType	form	MeetingApprovalType?	No
RegistrationType	form	MeetingRegistrationType?	No
Audio	form	AudioType?	No
AutoRecording	form	RecordingType	No
EnforceLogin	form	bool?	No
EnforceLoginDomains	form	string	No
AlternativeHosts	form	string	No
CloseRegistration	form	bool?	No
ShowSocialShareButtons	form	bool?	No
AllowMultipleDevices	form	bool?	No
OnDemand	form	bool?	No
GlobalDialInCountries	form	string[]	No
ContactName	form	string	No
ContactEmail	form	string	No
MaximumNumberOfRegistrants	form	int?	No
SurveyUrl	form	string	No
SendRegistrationConfirmationEmail	form	bool?	No
AuthenticatedUsersOnly	form	bool?	No
AuthenticationTypeId	form	string	No
QuestionAndAnswer	form	QuestionAndAnswer	No

**QuestionAndAnswer** Parameters:
Name	Parameter	Data Type	Required	Description
Enable	form	bool	No

**EventVirtualWebinarsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
HostIDLabel	form	string	No

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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-01,
		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-03T05:11:46.6280371-04:00,
	Device: Desktop
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
		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-03T05:11:46.6280371-04:00,
	Device: Desktop
}