YM REST 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}/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.

**EventRegistrants** Parameters:
Name	Parameter	Data Type	Required	Description
EventID	path	int	No
Status	query	RegistrationStatus?	No	Allowable Values InComplete Open Approved Cancelled
FirstName	query	string	No
LastName	query	string	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**EventRegistrantsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
EventRegistrantsList	form	List<EventRegistrant>	No

**EventRegistrant** Parameters:
Name	Parameter	Data Type	Required
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EventRegistrantsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <EventID>0</EventID>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <Status>InComplete</Status>
  <EventRegistrantsList>
    <EventRegistrant>
      <BadgeNumber>0</BadgeNumber>
      <DateRegistered>0001-01-01T00:00:00</DateRegistered>
      <DisplayName>String</DisplayName>
      <FirstName>String</FirstName>
      <HeadShotImage>String</HeadShotImage>
      <Id>0</Id>
      <IsPrimary>false</IsPrimary>
      <LastName>String</LastName>
      <RegistrationID>String</RegistrationID>
    </EventRegistrant>
  </EventRegistrantsList>
</EventRegistrantsResponse>

YM REST Services

EventRegistrants

Allowable Values

HTTP + XML