YM REST Services

<back to all web services

EventRegistrations

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/Event/{EventID}/EventRegistrationsReturn Event Registration details for the provided Event and Event Registration ID.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.
POST/Ams/{ClientID}/Event/{EventID}/EventRegistrationsCreate an Event Registration for the Event.
PUT/Ams/{ClientID}/Event/{EventID}/EventRegistrationsUpdate the Event Registration for the Event.
DELETE/Ams/{ClientID}/Event/{EventID}/EventRegistrationsDelete the Event Registration for the Event.
EventRegistrations Parameters:
NameParameterData TypeRequiredDescription
EventIDpathintNo
RegistrationIDbodystringNo
BadgeNumberbodyint?No
RegistrantbodyEventRegistrationRegistrantNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventRegistrationRegistrant Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo
EventNameformstringNo
FirstNameformstringNo
LastNameformstringNo
BadgeNumberformint?No
RegistrationIDformstringNo
DateRegisteredformDateTime?No
AttendedformstringNo
OrderIDformint?No
ProfileIDformint?No
InvoiceIDformstringNo
IsPrimaryRegistrantformboolNo
PrimaryRegistrantRegistrationIDformstringNo
PrimaryRegistrantProfileIDformint?No
AttendeeTypeformstringNo
CustomFormDataSetformList<CustomFormDataSetItem>No
CustomFormDataSetAttachmentsformList<Dictionary<String,String>>No
SessionsformList<Dictionary<String,String>>No
IsAttendedformbool?No
CustomFormDataSetItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValuesformList<string>No
EventRegistrationResponse Parameters:
NameParameterData TypeRequiredDescription
EventRegistrationRegistrantformEventRegistrationRegistrantNo

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}/Event/{EventID}/EventRegistrations HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EventID: 0,
	RegistrationID: String,
	BadgeNumber: 0,
	Registrant: 
	{
		Status: String,
		EventName: String,
		FirstName: String,
		LastName: String,
		BadgeNumber: 0,
		RegistrationID: String,
		DateRegistered: 0001-01-01,
		Attended: String,
		OrderID: 0,
		ProfileID: 0,
		InvoiceID: String,
		IsPrimaryRegistrant: False,
		PrimaryRegistrantRegistrationID: String,
		PrimaryRegistrantProfileID: 0,
		AttendeeType: String,
		CustomFormDataSet: 
		[
			{
				Name: String,
				Values: 
				[
					String
				]
			}
		],
		CustomFormDataSetAttachments: 
		[
			{
				String: String
			}
		],
		Sessions: 
		[
			{
				String: String
			}
		]
	},
	UsingRedis: True,
	AppInitTime: 2024-05-03T03:25:08.2888604-04:00,
	ServerID: WS-4-69-031,
	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-03T04:10:16.8227012-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	EventRegistrationRegistrant: 
	{
		Status: String,
		EventName: String,
		FirstName: String,
		LastName: String,
		BadgeNumber: 0,
		RegistrationID: String,
		DateRegistered: 0001-01-01,
		Attended: String,
		OrderID: 0,
		ProfileID: 0,
		InvoiceID: String,
		IsPrimaryRegistrant: False,
		PrimaryRegistrantRegistrationID: String,
		PrimaryRegistrantProfileID: 0,
		AttendeeType: String,
		CustomFormDataSet: 
		[
			{
				Name: String,
				Values: 
				[
					String
				]
			}
		],
		CustomFormDataSetAttachments: 
		[
			{
				String: String
			}
		],
		Sessions: 
		[
			{
				String: String
			}
		]
	},
	EventID: 0,
	RegistrationID: String,
	BadgeNumber: 0,
	Registrant: 
	{
		Status: String,
		EventName: String,
		FirstName: String,
		LastName: String,
		BadgeNumber: 0,
		RegistrationID: String,
		DateRegistered: 0001-01-01,
		Attended: String,
		OrderID: 0,
		ProfileID: 0,
		InvoiceID: String,
		IsPrimaryRegistrant: False,
		PrimaryRegistrantRegistrationID: String,
		PrimaryRegistrantProfileID: 0,
		AttendeeType: String,
		CustomFormDataSet: 
		[
			{
				Name: String,
				Values: 
				[
					String
				]
			}
		],
		CustomFormDataSetAttachments: 
		[
			{
				String: String
			}
		],
		Sessions: 
		[
			{
				String: String
			}
		]
	},
	UsingRedis: True,
	AppInitTime: 2024-05-03T03:25:08.2888604-04:00,
	ServerID: WS-4-69-031,
	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-03T04:10:16.8267014-04:00,
	Device: Desktop
}