YM REST Services

EventVirtualMeetings

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
PUT	/Ams/{ClientID}/Event/{EventId}/VirtualMeetings/	Update a given event's VirtualMeeting.
POST	/Ams/{ClientID}/Event/{EventId}/VirtualMeetings/	Create a new event VirtualMeeting.
GET	/Ams/{ClientID}/Event/{EventId}/VirtualMeetings/{MeetingId}	Return the details for a VirtualMeeting linked to an event.
DELETE	/Ams/{ClientID}/Event/{EventId}/VirtualMeetings/{MeetingId}	Delete a given event VirtualMeeting.

**EventVirtualMeetings** Parameters:
Name	Parameter	Data Type	Required
MeetingId	path	long	No
ZoomUserId	body	string	No
EventId	path	int	No

**Meetings** Parameters:
Name	Parameter	Data Type	Required	Description
Meeting	form	Meeting	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

**Meeting** Parameters:
Name	Parameter	Data Type	Required
Uuid	form	string	No
Id	form	long	No
HostId	form	string	No
Topic	form	string	No
Type	form	MeetingType	No
Status	form	MeetingStatus	No
Agenda	form	string	No
CreatedOn	form	DateTime	No
StartTime	form	string	No
TimeZone	form	string	No
StartUrl	form	string	No
JoinUrl	form	string	No
Password	form	string	No
H323Password	form	string	No
PstnPassword	form	string	No
PMI	form	long	No
Settings	form	MeetingSettings	No
Duration	form	int	No

**MeetingSettings** Parameters:
Name	Parameter	Data Type	Required
StartVideoWhenHostJoins	form	bool?	No
StartVideoWhenParticipantsJoin	form	bool?	No
HostInChina	form	bool?	No
HostInIndia	form	bool?	No
JoinBeforeHost	form	bool?	No
MuteUponEntry	form	bool?	No
Watermark	form	bool?	No
UsePmi	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
SendRegistrationConfirmationEmail	form	bool?	No
EnableMeetingAuthentication	form	bool?	No
WaitingRoom	form	bool?	No
GlobalDialInCountries	form	string[]	No
ContactName	form	string	No
ContactEmail	form	string	No

**EventVirtualMeetingsResponse** 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}/VirtualMeetings/ HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MeetingId: 0,
	ZoomUserId: String,
	EventId: 0,
	Meeting: 
	{
		Uuid: String,
		Id: 0,
		HostId: String,
		Topic: String,
		Type: Instant,
		Status: Waiting,
		Agenda: String,
		CreatedOn: 0001-01-01,
		StartTime: String,
		TimeZone: String,
		StartUrl: String,
		JoinUrl: String,
		Password: String,
		H323Password: String,
		PstnPassword: String,
		PMI: 0,
		Settings: 
		{
			StartVideoWhenHostJoins: False,
			StartVideoWhenParticipantsJoin: False,
			HostInChina: False,
			HostInIndia: False,
			JoinBeforeHost: False,
			MuteUponEntry: False,
			Watermark: False,
			UsePmi: False,
			ApprovalType: Automatic,
			RegistrationType: 0,
			Audio: Voip,
			AutoRecording: OnLocal,
			EnforceLogin: False,
			EnforceLoginDomains: String,
			AlternativeHosts: String,
			CloseRegistration: False,
			SendRegistrationConfirmationEmail: False,
			EnableMeetingAuthentication: False,
			WaitingRoom: False,
			GlobalDialInCountries: 
			[
				String
			],
			ContactName: String,
			ContactEmail: String
		},
		Duration: 0
	},
	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-03T03:03:14.9902197-04:00,
	Device: Desktop
}

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

{
	HostIDLabel: String,
	MeetingId: 0,
	ZoomUserId: String,
	EventId: 0,
	Meeting: 
	{
		Uuid: String,
		Id: 0,
		HostId: String,
		Topic: String,
		Type: Instant,
		Status: Waiting,
		Agenda: String,
		CreatedOn: 0001-01-01,
		StartTime: String,
		TimeZone: String,
		StartUrl: String,
		JoinUrl: String,
		Password: String,
		H323Password: String,
		PstnPassword: String,
		PMI: 0,
		Settings: 
		{
			StartVideoWhenHostJoins: False,
			StartVideoWhenParticipantsJoin: False,
			HostInChina: False,
			HostInIndia: False,
			JoinBeforeHost: False,
			MuteUponEntry: False,
			Watermark: False,
			UsePmi: False,
			ApprovalType: Automatic,
			RegistrationType: 0,
			Audio: Voip,
			AutoRecording: OnLocal,
			EnforceLogin: False,
			EnforceLoginDomains: String,
			AlternativeHosts: String,
			CloseRegistration: False,
			SendRegistrationConfirmationEmail: False,
			EnableMeetingAuthentication: False,
			WaitingRoom: False,
			GlobalDialInCountries: 
			[
				String
			],
			ContactName: String,
			ContactEmail: String
		},
		Duration: 0
	},
	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-03T03:03:14.9923877-04:00,
	Device: Desktop
}