YM REST Services

<back to all web services

EventRegistrationIDs

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/Event/{EventID}/EventRegistrationIDsReturn a list of all Registration IDs for the specified Event ID.
EventRegistrationIDs Parameters:
NameParameterData TypeRequiredDescription
EventIDpathintNo
StatusqueryRegistrationStatus?No

Allowable Values

  • InComplete
  • Open
  • Approved
  • Cancelled
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventRegistrationIDsResponse Parameters:
NameParameterData TypeRequiredDescription
EventRegistrationsIDformList<EventRegistrationID>No
EventRegistrationID Parameters:
NameParameterData TypeRequiredDescription
IsPrimaryformboolNo
RegistrantIDformstringNo

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.

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

{"EventRegistrationsID":[{"IsPrimary":false,"RegistrantID":"String"}],"EventID":0,"Status":"InComplete","UsingRedis":true,"AppInitTime":"2024-05-02T23:57:28.8020412-04:00","ServerID":"WS-5-59-079","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-03T00:33:43.8257411-04:00","Device":"Desktop"}