YM REST Services

<back to all web services

EventAttendeeTypes

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/Event/{EventId}/AttendeeTypesReturn a list of attendee types for a given event.
POST/Ams/{ClientID}/Event/{EventId}/AttendeeTypesCreate new attendee types for a given event.
PUT/Ams/{ClientID}/Event/{EventId}/AttendeeTypesUpdate existing attendee types for a given event.
GET/Ams/{ClientID}/Event/{EventId}/AttendeeTypes/{Id}Return a list of selections for an attendee type of a given event.
DELETE/Ams/{ClientID}/Event/{EventId}/AttendeeTypes/{Id}Delete an existing attendee type for a given event.
EventAttendeeTypes Parameters:
NameParameterData TypeRequiredDescription
EventIdpathintNo
IdpathintNo
NamebodystringNo
DescriptionbodystringNo
ActivebodyboolNo
EventRestrictedToSignedInMembersbodyboolNo
RestrictedToSignedInMembersbodyboolNo
RestrictedToNonMembersbodyboolNo
RestrictedMemberTypesbodyList<MemberTypeInfo>No
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MemberTypeInfo Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
IsSelectedformboolNo
EventAttendeeTypesResponse Parameters:
NameParameterData TypeRequiredDescription
RowsDeletedformintNo
EventAttendeeTypeListformList<EventAttendeeType>No
EventAttendeeType Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
ActiveformboolNo
RestrictedToSignedInMembersformboolNo
RestrictedToNonMembersformboolNo
RestrictedMemberTypesformList<MemberTypeInfo>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.

POST /Ams/{ClientID}/Event/{EventId}/AttendeeTypes HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EventAttendeeTypes 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>
  <Active>false</Active>
  <Description>String</Description>
  <EventId>0</EventId>
  <EventRestrictedToSignedInMembers>false</EventRestrictedToSignedInMembers>
  <Id>0</Id>
  <Name>String</Name>
  <RestrictedMemberTypes>
    <MemberTypeInfo>
      <Id>0</Id>
      <IsSelected>false</IsSelected>
      <Name>String</Name>
    </MemberTypeInfo>
  </RestrictedMemberTypes>
  <RestrictedToNonMembers>false</RestrictedToNonMembers>
  <RestrictedToSignedInMembers>false</RestrictedToSignedInMembers>
</EventAttendeeTypes>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EventAttendeeTypesResponse 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>
  <Active>false</Active>
  <Description>String</Description>
  <EventId>0</EventId>
  <EventRestrictedToSignedInMembers>false</EventRestrictedToSignedInMembers>
  <Id>0</Id>
  <Name>String</Name>
  <RestrictedMemberTypes>
    <MemberTypeInfo>
      <Id>0</Id>
      <IsSelected>false</IsSelected>
      <Name>String</Name>
    </MemberTypeInfo>
  </RestrictedMemberTypes>
  <RestrictedToNonMembers>false</RestrictedToNonMembers>
  <RestrictedToSignedInMembers>false</RestrictedToSignedInMembers>
  <EventAttendeeTypeList>
    <EventAttendeeType>
      <Active>false</Active>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
      <RestrictedMemberTypes>
        <MemberTypeInfo>
          <Id>0</Id>
          <IsSelected>false</IsSelected>
          <Name>String</Name>
        </MemberTypeInfo>
      </RestrictedMemberTypes>
      <RestrictedToNonMembers>false</RestrictedToNonMembers>
      <RestrictedToSignedInMembers>false</RestrictedToSignedInMembers>
    </EventAttendeeType>
  </EventAttendeeTypeList>
  <RowsDeleted>0</RowsDeleted>
</EventAttendeeTypesResponse>