YM REST Services

<back to all web services

EventAttendees

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/Event/{EventID}/EventAttendeesReturn a list of all Attendees for the specified event including both Registrations and RSVPs.If the Event Registration contains a related Custom Form, the form data will be included in the element as it is stored in our database. Records for authenticated members also include the element to cross reference the Member's data.
EventAttendees Parameters:
NameParameterData TypeRequiredDescription
EventIDpathintNo
PageSizequeryintNo
PageNumberqueryintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventsAttendeesResponse Parameters:
NameParameterData TypeRequiredDescription
AttendeesformList<Attendee>No
Attendee Parameters:
NameParameterData TypeRequiredDescription
RegisterIDformintNo
RsvpIDformintNo
DateRegisterformDateTimeNo
LastNameformstringNo
FirstNameformstringNo
ProfileIDformintNo
IDformGuidNo
RsvpResponseformstringNo
DataSetformDictionary<string, 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.

GET /Ams/{ClientID}/Member/{MemberID}/Event/{EventID}/EventAttendees HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Attendees: 
	[
		{
			RegisterID: 0,
			RsvpID: 0,
			DateRegister: 0001-01-01,
			LastName: String,
			FirstName: String,
			ProfileID: 0,
			ID: 00000000000000000000000000000000,
			RsvpResponse: String,
			DataSet: 
			{
				String: String
			}
		}
	],
	EventID: 0,
	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-03T07:05:23.4001863-04:00,
	Device: Desktop
}