YM REST Services

Events

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

The following routes are available for this service:
GET	/Ams/{ClientID}/Events	Return a list of events.
PUT	/Ams/{ClientID}/Events	Update a given event.
POST	/Ams/{ClientID}/Events	Create a new event.
GET	/Ams/{ClientID}/Events/{EventId}	Return the details for a given event.
PUT	/Ams/{ClientID}/Events/{EventId}	Update a given event.
DELETE	/Ams/{ClientID}/Events/{EventId}	Delete a given event.
GET	/Ams/{ClientID}/Member/{MemberID}/Events/{EventId}	Return the details for a given event.

**Events** Parameters:
Name	Parameter	Data Type	Required
EventId	path	int?	No
Active	body	bool?	No
ActivateOn	body	DateTime?	No
Name	body	string	No
StartDate	body	DateTime?	No
StartTime	body	string	No
EndDate	body	DateTime?	No
EndTime	body	string	No
DisplayDate	body	string	No
DisplayTime	body	string	No
DateTimeOffset	body	double	No
DateTimeOffsetDST	body	bool	No
Comments	body	string	No
Description	body	string	No
Logo	body	string	No
LogoName	body	string	No
LogoPath	body	string	No
LogoThumbPath	body	string	No
RemoveLogo	body	bool	No
Registration	body	EventRegistration	No
Recurrence	body	EventRecurrence	No
Location	body	EventLocation	No
Contact	body	EventContact	No
Visibility	body	EventVisibility	No
ParentEventId	body	int?	No
UpdateSeries	body	bool	No
Categories	body	int[]	No
Groups	body	int[]	No
AllowGroupAdminEdit	body	bool	No
IsLegacyEvent	body	bool	No
RelatedProducts	body	int[]	No
EventGuid	body	string	No
UseLegacyDetailsPage	body	bool	No
UseLegacyRegisterPage	body	bool	No
AllowInsuranceOffer	body	bool	No
OfferEventInsurance	body	bool	No
VirtualAddOnEnabled	body	bool	No
VirtualMeetingsConfigured	body	bool	No
IsVirtual	body	bool	No
VirtualMeetingType	body	VirtualMeetingTypes	No
VirtualMeetingId	body	long	No
VirtualUserId	body	string	No
CanUserChangeAtEventAllowed	body	bool	No
ZoomUserSettings	body	UserSettings	No
PageSize	body	int	No
PageNumber	body	int	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

**EventRegistration** Parameters:
Name	Parameter	Data Type	Required
Active	form	bool	No
Private	form	bool	No
MaxRegistrants	form	int?	No
RegisterBy	form	DateTime?	No
ReminderDays	form	int	No
MemberTypes	form	int[]	No
RsvpVisibility	form	int	No
PrimaryFormID	form	int?	No
AddlFormID	form	int?	No
AutoApprove	form	bool	No
MultipleRegistrations	form	bool	No
AllowIncompleteStatus	form	bool	No
ForceAllRequiredItems	form	bool	No
ShowCFOnAddlReg	form	bool	No
Instructions	form	string	No
ProcessorId	form	int?	No
EnableMultiProcessor	form	bool	No
RequireUniqueEmail	form	bool	No
UseDefaultThxPage	form	bool	No
ThxNote	form	string	No
AdminRecipients	form	string	No
AdminRecipient	form	List<string>	No
NotificationBody	form	string	No
Info	form	EventRegistrationInfo	No
AllowCEUs	form	bool?	No
OnlineCheckInEnable	form	bool	No
OnlineCheckInSecure	form	bool	No
OnlineRegistrationOpensEnable	form	bool	No
EnableWaitlist	form	bool	No
WaitlistMessage	form	string	No
WaitlistConfirmMessage	form	string	No
AutoLinkRegistrantToCdb	form	bool	No
OpenOnlineRegistrationDateTime	form	DateTime?	No

**EventRegistrationInfo** Parameters:
Name	Parameter	Data Type	Required	Description
NonCancelledCount	form	int	No
InProgressCount	form	int	No

**EventRecurrence** Parameters:
Name	Parameter	Data Type	Required
Active	form	bool	No
Cancel	form	bool?	No
EndsBy	form	DateTime?	No
Type	form	RecurrenceType?	No
Daily	form	DailyRecurrence	No
Weekly	form	WeeklyRecurrence	No
Monthly	form	MonthlyRecurrence	No

**DailyRecurrence** Parameters:
Name	Parameter	Data Type	Required	Description
Every	form	int	No

**WeeklyRecurrence** Parameters:
Name	Parameter	Data Type	Required	Description
Every	form	int	No
DayOfWeek	form	DayOfWeekVB[]	No

**MonthlyRecurrence** Parameters:
Name	Parameter	Data Type	Required
OnDay	form	bool?	No
Day	form	DaySpec	No
Week	form	WeekSpec	No

**DaySpec** Parameters:
Name	Parameter	Data Type	Required	Description
Months	form	int	No
DayOfMonth	form	int	No

**WeekSpec** Parameters:
Name	Parameter	Data Type	Required
Months	form	int	No
WeekOfMonth	form	Ordinal?	No
DayOfWeek	form	DayOfWeekVB	No

**EventLocation** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Presenter	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
Province	form	string	No
Country	form	Country	No
PostalCode	form	string	No
GoogleMaps	form	bool	No

**Country** Parameters:
Name	Parameter	Data Type	Required
countryId	form	string	No
countryCode	form	string	No
countryName	form	string	No
numberOfLocations	form	int	No
taxShipping	form	bool	No
taxDues	form	bool	No
locationLabel	form	string	No

**EventContact** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Email	form	string	No
Phone	form	string	No

**EventVisibility** Parameters:
Name	Parameter	Data Type	Required
CustomUrl	form	string	No
SignedInMembersOnly	form	bool	No
SiteWideCalendars	form	bool	No
CommunityCalendars	form	bool	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

**EventResponse** Parameters:
Name	Parameter	Data Type	Required	Description
EmailValid	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.

POST /Ams/{ClientID}/Events HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EventId: 0,
	Active: False,
	ActivateOn: 0001-01-01,
	Name: String,
	StartDate: 0001-01-01,
	StartTime: String,
	EndDate: 0001-01-01,
	EndTime: String,
	DisplayDate: String,
	DisplayTime: String,
	DateTimeOffset: 0,
	DateTimeOffsetDST: False,
	Comments: String,
	Description: String,
	Logo: String,
	LogoName: String,
	LogoPath: String,
	LogoThumbPath: String,
	RemoveLogo: False,
	Registration: 
	{
		Active: False,
		Private: False,
		MaxRegistrants: 0,
		RegisterBy: 0001-01-01,
		ReminderDays: 0,
		MemberTypes: 
		[
			0
		],
		RsvpVisibility: 0,
		PrimaryFormID: 0,
		AddlFormID: 0,
		AutoApprove: False,
		MultipleRegistrations: False,
		AllowIncompleteStatus: False,
		ForceAllRequiredItems: False,
		ShowCFOnAddlReg: False,
		Instructions: String,
		ProcessorId: 0,
		EnableMultiProcessor: False,
		RequireUniqueEmail: False,
		UseDefaultThxPage: False,
		ThxNote: String,
		AdminRecipients: String,
		AdminRecipient: 
		[
			String
		],
		NotificationBody: String,
		Info: 
		{
			NonCancelledCount: 0,
			InProgressCount: 0
		},
		AllowCEUs: False,
		OnlineCheckInEnable: False,
		OnlineCheckInSecure: False,
		OnlineRegistrationOpensEnable: False,
		EnableWaitlist: False,
		WaitlistMessage: String,
		WaitlistConfirmMessage: String,
		AutoLinkRegistrantToCdb: False,
		OpenOnlineRegistrationDateTime: 0001-01-01
	},
	Recurrence: 
	{
		Active: False,
		Cancel: False,
		EndsBy: 0001-01-01,
		Type: None,
		Daily: 
		{
			Every: 0
		},
		Weekly: 
		{
			Every: 0,
			DayOfWeek: 
			[
				Sunday
			]
		},
		Monthly: 
		{
			OnDay: False,
			Day: 
			{
				Months: 0,
				DayOfMonth: 0
			},
			Week: 
			{
				Months: 0,
				WeekOfMonth: 0,
				DayOfWeek: Sunday
			}
		}
	},
	Location: 
	{
		Name: String,
		Presenter: String,
		Address1: String,
		Address2: String,
		City: String,
		State: String,
		Province: String,
		Country: 
		{
			countryId: String,
			countryCode: String,
			countryName: String,
			numberOfLocations: 0,
			taxShipping: False,
			taxDues: False,
			locationLabel: String
		},
		PostalCode: String,
		GoogleMaps: False
	},
	Contact: 
	{
		Name: String,
		Email: String,
		Phone: String
	},
	Visibility: 
	{
		CustomUrl: String,
		SignedInMembersOnly: False,
		SiteWideCalendars: False,
		CommunityCalendars: False
	},
	ParentEventId: 0,
	UpdateSeries: False,
	Categories: 
	[
		0
	],
	Groups: 
	[
		0
	],
	AllowGroupAdminEdit: False,
	IsLegacyEvent: False,
	RelatedProducts: 
	[
		0
	],
	EventGuid: String,
	UseLegacyDetailsPage: False,
	UseLegacyRegisterPage: False,
	AllowInsuranceOffer: False,
	OfferEventInsurance: False,
	VirtualAddOnEnabled: False,
	VirtualMeetingsConfigured: False,
	IsVirtual: False,
	VirtualMeetingType: None,
	VirtualMeetingId: 0,
	VirtualUserId: String,
	CanUserChangeAtEventAllowed: False,
	ZoomUserSettings: 
	{
		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
		}
	},
	PageSize: 0,
	PageNumber: 0,
	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-03T10:11:22.6226841-04:00,
	Device: Desktop
}

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

{
	EmailValid: False,
	EventId: 0,
	Active: False,
	ActivateOn: 0001-01-01,
	Name: String,
	StartDate: 0001-01-01,
	StartTime: String,
	EndDate: 0001-01-01,
	EndTime: String,
	DisplayDate: String,
	DisplayTime: String,
	DateTimeOffset: 0,
	DateTimeOffsetDST: False,
	Comments: String,
	Description: String,
	Logo: String,
	LogoName: String,
	LogoPath: String,
	LogoThumbPath: String,
	RemoveLogo: False,
	Registration: 
	{
		Active: False,
		Private: False,
		MaxRegistrants: 0,
		RegisterBy: 0001-01-01,
		ReminderDays: 0,
		MemberTypes: 
		[
			0
		],
		RsvpVisibility: 0,
		PrimaryFormID: 0,
		AddlFormID: 0,
		AutoApprove: False,
		MultipleRegistrations: False,
		AllowIncompleteStatus: False,
		ForceAllRequiredItems: False,
		ShowCFOnAddlReg: False,
		Instructions: String,
		ProcessorId: 0,
		EnableMultiProcessor: False,
		RequireUniqueEmail: False,
		UseDefaultThxPage: False,
		ThxNote: String,
		AdminRecipients: String,
		AdminRecipient: 
		[
			String
		],
		NotificationBody: String,
		Info: 
		{
			NonCancelledCount: 0,
			InProgressCount: 0
		},
		AllowCEUs: False,
		OnlineCheckInEnable: False,
		OnlineCheckInSecure: False,
		OnlineRegistrationOpensEnable: False,
		EnableWaitlist: False,
		WaitlistMessage: String,
		WaitlistConfirmMessage: String,
		AutoLinkRegistrantToCdb: False,
		OpenOnlineRegistrationDateTime: 0001-01-01
	},
	Recurrence: 
	{
		Active: False,
		Cancel: False,
		EndsBy: 0001-01-01,
		Type: None,
		Daily: 
		{
			Every: 0
		},
		Weekly: 
		{
			Every: 0,
			DayOfWeek: 
			[
				Sunday
			]
		},
		Monthly: 
		{
			OnDay: False,
			Day: 
			{
				Months: 0,
				DayOfMonth: 0
			},
			Week: 
			{
				Months: 0,
				WeekOfMonth: 0,
				DayOfWeek: Sunday
			}
		}
	},
	Location: 
	{
		Name: String,
		Presenter: String,
		Address1: String,
		Address2: String,
		City: String,
		State: String,
		Province: String,
		Country: 
		{
			countryId: String,
			countryCode: String,
			countryName: String,
			numberOfLocations: 0,
			taxShipping: False,
			taxDues: False,
			locationLabel: String
		},
		PostalCode: String,
		GoogleMaps: False
	},
	Contact: 
	{
		Name: String,
		Email: String,
		Phone: String
	},
	Visibility: 
	{
		CustomUrl: String,
		SignedInMembersOnly: False,
		SiteWideCalendars: False,
		CommunityCalendars: False
	},
	ParentEventId: 0,
	UpdateSeries: False,
	Categories: 
	[
		0
	],
	Groups: 
	[
		0
	],
	AllowGroupAdminEdit: False,
	IsLegacyEvent: False,
	RelatedProducts: 
	[
		0
	],
	EventGuid: String,
	UseLegacyDetailsPage: False,
	UseLegacyRegisterPage: False,
	AllowInsuranceOffer: False,
	OfferEventInsurance: False,
	VirtualAddOnEnabled: False,
	VirtualMeetingsConfigured: False,
	IsVirtual: False,
	VirtualMeetingType: None,
	VirtualMeetingId: 0,
	VirtualUserId: String,
	CanUserChangeAtEventAllowed: False,
	ZoomUserSettings: 
	{
		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
		}
	},
	PageSize: 0,
	PageNumber: 0,
	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-03T10:11:22.6383145-04:00,
	Device: Desktop
}