YM REST Services

<back to all web services

EventRegistrants

Requires Authentication
Requires any of the roles:member, oauthmember, admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/EventRegistrantsReturn a list of event registrants for a given event.
GET/Ams/{ClientID}/Event/{EventID}/EventRegistrantsReturn a list of registrations for a given event matching the search criteria.
EventRegistrants Parameters:
NameParameterData TypeRequiredDescription
EventIDpathintNo
StatusqueryRegistrationStatus?No

Allowable Values

  • InComplete
  • Open
  • Approved
  • Cancelled
FirstNamequerystringNo
LastNamequerystringNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventRegistrantsResponse Parameters:
NameParameterData TypeRequiredDescription
EventRegistrantsListformList<EventRegistrant>No
EventRegistrant Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FirstNameformstringNo
LastNameformstringNo
HeadShotImageformstringNo
DisplayNameformstringNo
DateRegisteredformDateTimeNo
RegistrationIDformstringNo
IsPrimaryformboolNo
BadgeNumberformintNo

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

{
	EventRegistrantsList: 
	[
		{
			Id: 0,
			FirstName: String,
			LastName: String,
			HeadShotImage: String,
			DisplayName: String,
			DateRegistered: 0001-01-01,
			RegistrationID: String,
			IsPrimary: False,
			BadgeNumber: 0
		}
	],
	EventID: 0,
	Status: InComplete,
	FirstName: String,
	LastName: 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-03T06:30:45.6020229-04:00,
	Device: Desktop
}