YM REST Services

EventVirtualUsers

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

The following routes are available for this service:
GET	/Ams/{ClientID}/Event/{EventId}/VirtualUsers/{UserEmail}	Return the details for a virtual user.

**EventVirtualUsers** Parameters:
Name	Parameter	Data Type	Required	Description
EventId	path	int	No
UserEmail	path	string	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	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

**EventVirtualUsersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
User	form	User	No
UserSettings	form	UserSettings	No

**User** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
FirstName	form	string	No
LastName	form	string	No
Email	form	string	No
Type	form	UserPlanType	No
Pmi	form	long	No
TimeZone	form	string	No
Verified	form	int	No
Department	form	string	No
CreatedAt	form	DateTime	No
LastLoginTime	form	DateTime	No
PictureURL	form	string	No
AccountID	form	string	No
AccountNumber	form	long	No
Status	form	UserStatus	No

**UserSettings** Parameters:
Name	Parameter	Data Type	Required	Description
ScheduleMeeting	form	UserSettingsScheduleMeeting	No
Feature	form	UserSettingsFeature	No

**UserSettingsScheduleMeeting** Parameters:
Name	Parameter	Data Type	Required
HostVideo	form	bool	No
ParticipantsVideo	form	bool	No
AudioType	form	MeetingAudioType	No
JoinBeforeHost	form	bool	No
ForcePersonalMeetingIDJoinBeforeHostPassword	form	bool	No
GenerateRequirePasscodeForParticipantsByPhone	form	bool	No
UsePersonalMeetingIDWhenSchedulingMeeting	form	bool	No
UsePersonalMeetingIDWhenStartingInstantMeeting	form	bool	No
RequirePasscodeForSchedulingNewMeetings	form	bool	No
RequirePasswordForScheduledMeetings	form	bool	No
DefaultPasswordForScheduledMeetings	form	string	No
RequirePasswordForInstantMeetings	form	bool	No
RequirePasswordForPersonalMeetingIDMeetings	form	RequirePasswordForPMIMeetingsType	No
PersonalMeetingIDPassword	form	string	No
EmbedPasswordInJoinLink	form	bool	No
PersonalMeeting	form	bool	No

**UserSettingsFeature** Parameters:
Name	Parameter	Data Type	Required
MeetingCapacity	form	int	No
LargeMeeting	form	bool	No
large_meeting_capacity	form	int	No
Webinar	form	bool	No
WebinarCapacity	form	int	No
ChinaMeeting	form	bool	No
IndiaMeeting	form	bool	No
ZoomPhone	form	bool	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.

GET /Ams/{ClientID}/Event/{EventId}/VirtualUsers/{UserEmail} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	User: 
	{
		Id: String,
		FirstName: String,
		LastName: String,
		Email: String,
		Type: Basic,
		Pmi: 0,
		TimeZone: String,
		Verified: 0,
		Department: String,
		CreatedAt: 0001-01-01,
		LastLoginTime: 0001-01-01,
		PictureURL: String,
		AccountID: String,
		AccountNumber: 0,
		Status: Active
	},
	UserSettings: 
	{
		ScheduleMeeting: 
		{
			HostVideo: False,
			ParticipantsVideo: False,
			AudioType: TelephonyAndVoIP,
			JoinBeforeHost: False,
			ForcePersonalMeetingIDJoinBeforeHostPassword: False,
			GenerateRequirePasscodeForParticipantsByPhone: False,
			UsePersonalMeetingIDWhenSchedulingMeeting: False,
			UsePersonalMeetingIDWhenStartingInstantMeeting: False,
			RequirePasscodeForSchedulingNewMeetings: False,
			RequirePasswordForScheduledMeetings: False,
			DefaultPasswordForScheduledMeetings: String,
			RequirePasswordForInstantMeetings: False,
			RequirePasswordForPersonalMeetingIDMeetings: OnlyMeetingsWithJoinBeforeHostEnabled,
			PersonalMeetingIDPassword: String,
			EmbedPasswordInJoinLink: False,
			PersonalMeeting: False
		},
		Feature: 
		{
			MeetingCapacity: 0,
			LargeMeeting: False,
			large_meeting_capacity: 0,
			Webinar: False,
			WebinarCapacity: 0,
			ChinaMeeting: False,
			IndiaMeeting: False,
			ZoomPhone: False
		}
	},
	EventId: 0,
	UserEmail: String,
	MemberID: 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-03T08:04:34.4341579-04:00,
	Device: Desktop
}