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 .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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-01T00:00:00.0000000","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":"2025-01-15T08:46:14.8092102-05:00","ServerID":"WS-4-27-804","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":"2025-01-15T08:48:48.8578724-05:00","Device":"Desktop"}

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

{"EventRegistrationRegistrant":{"Status":"String","EventName":"String","FirstName":"String","LastName":"String","BadgeNumber":0,"RegistrationID":"String","DateRegistered":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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":"2025-01-15T08:46:14.8092102-05:00","ServerID":"WS-4-27-804","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":"2025-01-15T08:48:48.8578724-05:00","Device":"Desktop"}