Requires any of the roles: | member, oauthmember, admin, oauthadmin |
GET | /Ams/{ClientID}/Member/{MemberID}/EventRegistrants | Return a list of event registrants for a given event. | |
---|---|---|---|
GET | /Ams/{ClientID}/Event/{EventID}/EventRegistrants | Return a list of registrations for a given event matching the search criteria. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EventID | path | int | No | |
Status | query | RegistrationStatus? | No | Allowable Values
|
FirstName | query | string | No | |
LastName | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MemberID | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientID | form | int | No | |
ResponseStatus | form | ResponseStatus | No | |
BypassCache | form | bool | No | |
DateCached | form | DateTime | No | |
Device | form | Device | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EventRegistrantsList | form | List<EventRegistrant> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
HeadShotImage | form | string | No | |
DisplayName | form | string | No | |
DateRegistered | form | DateTime | No | |
RegistrationID | form | string | No | |
IsPrimary | form | bool | No | |
BadgeNumber | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"EventRegistrantsList":[{"Id":0,"FirstName":"String","LastName":"String","HeadShotImage":"String","DisplayName":"String","DateRegistered":"0001-01-01T00:00:00.0000000","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":"2025-01-15T08:59:36.6342773-05:00","Device":"Desktop"}