YM REST Services

<back to all web services

Events

Requires Authentication
Requires any of the roles:admin, oauthadmin, member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/EventsReturn a list of events.
PUT/Ams/{ClientID}/EventsUpdate a given event.
POST/Ams/{ClientID}/EventsCreate 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:
NameParameterData TypeRequiredDescription
EventIdpathint?No
Activebodybool?No
ActivateOnbodyDateTime?No
NamebodystringNo
StartDatebodyDateTime?No
StartTimebodystringNo
EndDatebodyDateTime?No
EndTimebodystringNo
DisplayDatebodystringNo
DisplayTimebodystringNo
DateTimeOffsetbodydoubleNo
DateTimeOffsetDSTbodyboolNo
CommentsbodystringNo
DescriptionbodystringNo
LogobodystringNo
LogoNamebodystringNo
LogoPathbodystringNo
LogoThumbPathbodystringNo
RemoveLogobodyboolNo
RegistrationbodyEventRegistrationNo
RecurrencebodyEventRecurrenceNo
LocationbodyEventLocationNo
ContactbodyEventContactNo
VisibilitybodyEventVisibilityNo
ParentEventIdbodyint?No
UpdateSeriesbodyboolNo
Categoriesbodyint[]No
Groupsbodyint[]No
AllowGroupAdminEditbodyboolNo
IsLegacyEventbodyboolNo
RelatedProductsbodyint[]No
EventGuidbodystringNo
UseLegacyDetailsPagebodyboolNo
UseLegacyRegisterPagebodyboolNo
AllowInsuranceOfferbodyboolNo
OfferEventInsurancebodyboolNo
VirtualAddOnEnabledbodyboolNo
VirtualMeetingsConfiguredbodyboolNo
IsVirtualbodyboolNo
VirtualMeetingTypebodyVirtualMeetingTypesNo
VirtualMeetingIdbodylongNo
VirtualUserIdbodystringNo
CanUserChangeAtEventAllowedbodyboolNo
ZoomUserSettingsbodyUserSettingsNo
PageSizebodyintNo
PageNumberbodyintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventRegistration Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNo
PrivateformboolNo
MaxRegistrantsformint?No
RegisterByformDateTime?No
ReminderDaysformintNo
MemberTypesformint[]No
RsvpVisibilityformintNo
PrimaryFormIDformint?No
AddlFormIDformint?No
AutoApproveformboolNo
MultipleRegistrationsformboolNo
AllowIncompleteStatusformboolNo
ForceAllRequiredItemsformboolNo
ShowCFOnAddlRegformboolNo
InstructionsformstringNo
ProcessorIdformint?No
EnableMultiProcessorformboolNo
RequireUniqueEmailformboolNo
UseDefaultThxPageformboolNo
ThxNoteformstringNo
AdminRecipientsformstringNo
AdminRecipientformList<string>No
NotificationBodyformstringNo
InfoformEventRegistrationInfoNo
AllowCEUsformbool?No
OnlineCheckInEnableformboolNo
OnlineCheckInSecureformboolNo
OnlineRegistrationOpensEnableformboolNo
EnableWaitlistformboolNo
WaitlistMessageformstringNo
WaitlistConfirmMessageformstringNo
AutoLinkRegistrantToCdbformboolNo
OpenOnlineRegistrationDateTimeformDateTime?No
EventRegistrationInfo Parameters:
NameParameterData TypeRequiredDescription
NonCancelledCountformintNo
InProgressCountformintNo
EventRecurrence Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNo
Cancelformbool?No
EndsByformDateTime?No
TypeformRecurrenceType?No
DailyformDailyRecurrenceNo
WeeklyformWeeklyRecurrenceNo
MonthlyformMonthlyRecurrenceNo
DailyRecurrence Parameters:
NameParameterData TypeRequiredDescription
EveryformintNo
WeeklyRecurrence Parameters:
NameParameterData TypeRequiredDescription
EveryformintNo
DayOfWeekformDayOfWeekVB[]No
MonthlyRecurrence Parameters:
NameParameterData TypeRequiredDescription
OnDayformbool?No
DayformDaySpecNo
WeekformWeekSpecNo
DaySpec Parameters:
NameParameterData TypeRequiredDescription
MonthsformintNo
DayOfMonthformintNo
WeekSpec Parameters:
NameParameterData TypeRequiredDescription
MonthsformintNo
WeekOfMonthformOrdinal?No
DayOfWeekformDayOfWeekVBNo
EventLocation Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PresenterformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ProvinceformstringNo
CountryformCountryNo
PostalCodeformstringNo
GoogleMapsformboolNo
Country Parameters:
NameParameterData TypeRequiredDescription
countryIdformstringNo
countryCodeformstringNo
countryNameformstringNo
numberOfLocationsformintNo
taxShippingformboolNo
taxDuesformboolNo
locationLabelformstringNo
EventContact Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EmailformstringNo
PhoneformstringNo
EventVisibility Parameters:
NameParameterData TypeRequiredDescription
CustomUrlformstringNo
SignedInMembersOnlyformboolNo
SiteWideCalendarsformboolNo
CommunityCalendarsformboolNo
UserSettings Parameters:
NameParameterData TypeRequiredDescription
ScheduleMeetingformUserSettingsScheduleMeetingNo
FeatureformUserSettingsFeatureNo
UserSettingsScheduleMeeting Parameters:
NameParameterData TypeRequiredDescription
HostVideoformboolNo
ParticipantsVideoformboolNo
AudioTypeformMeetingAudioTypeNo
JoinBeforeHostformboolNo
ForcePersonalMeetingIDJoinBeforeHostPasswordformboolNo
GenerateRequirePasscodeForParticipantsByPhoneformboolNo
UsePersonalMeetingIDWhenSchedulingMeetingformboolNo
UsePersonalMeetingIDWhenStartingInstantMeetingformboolNo
RequirePasscodeForSchedulingNewMeetingsformboolNo
RequirePasswordForScheduledMeetingsformboolNo
DefaultPasswordForScheduledMeetingsformstringNo
RequirePasswordForInstantMeetingsformboolNo
RequirePasswordForPersonalMeetingIDMeetingsformRequirePasswordForPMIMeetingsTypeNo
PersonalMeetingIDPasswordformstringNo
EmbedPasswordInJoinLinkformboolNo
PersonalMeetingformboolNo
UserSettingsFeature Parameters:
NameParameterData TypeRequiredDescription
MeetingCapacityformintNo
LargeMeetingformboolNo
large_meeting_capacityformintNo
WebinarformboolNo
WebinarCapacityformintNo
ChinaMeetingformboolNo
IndiaMeetingformboolNo
ZoomPhoneformboolNo
EventResponse Parameters:
NameParameterData TypeRequiredDescription
EmailValidformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"EventId":0,"Active":false,"ActivateOn":"0001-01-01T00:00:00.0000000","Name":"String","StartDate":"0001-01-01T00:00:00.0000000","StartTime":"String","EndDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000"},"Recurrence":{"Active":false,"Cancel":false,"EndsBy":"0001-01-01T00:00:00.0000000","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-03T01:21:31.2259590-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"EmailValid":false,"EventId":0,"Active":false,"ActivateOn":"0001-01-01T00:00:00.0000000","Name":"String","StartDate":"0001-01-01T00:00:00.0000000","StartTime":"String","EndDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000"},"Recurrence":{"Active":false,"Cancel":false,"EndsBy":"0001-01-01T00:00:00.0000000","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-03T01:21:31.2269641-04:00","Device":"Desktop"}