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 .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}/EventRegistrations HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EventRegistrations 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>
  <BadgeNumber>0</BadgeNumber>
  <EventID>0</EventID>
  <Registrant xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.SaaS.Events">
    <d2p1:Attended>String</d2p1:Attended>
    <d2p1:AttendeeType>String</d2p1:AttendeeType>
    <d2p1:BadgeNumber>0</d2p1:BadgeNumber>
    <d2p1:CustomFormDataSet xmlns:d3p1="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.CustomForms">
      <d3p1:CustomFormDataSetItem>
        <d3p1:_x003C_Name_x003E_k__BackingField>String</d3p1:_x003C_Name_x003E_k__BackingField>
        <d3p1:_x003C_Values_x003E_k__BackingField xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d3p1:_x003C_Values_x003E_k__BackingField>
      </d3p1:CustomFormDataSetItem>
    </d2p1:CustomFormDataSet>
    <d2p1:CustomFormDataSetAttachments xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfKeyValueOfstringstring>
        <d3p1:KeyValueOfstringstring>
          <d3p1:Key>String</d3p1:Key>
          <d3p1:Value>String</d3p1:Value>
        </d3p1:KeyValueOfstringstring>
      </d3p1:ArrayOfKeyValueOfstringstring>
    </d2p1:CustomFormDataSetAttachments>
    <d2p1:DataSetID>0</d2p1:DataSetID>
    <d2p1:DateRegistered>0001-01-01T00:00:00</d2p1:DateRegistered>
    <d2p1:EventName>String</d2p1:EventName>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:InvoiceID>String</d2p1:InvoiceID>
    <d2p1:IsPrimaryRegistrant>false</d2p1:IsPrimaryRegistrant>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:OrderID>0</d2p1:OrderID>
    <d2p1:PrimaryRegistrantProfileID>0</d2p1:PrimaryRegistrantProfileID>
    <d2p1:PrimaryRegistrantRegistrationID>String</d2p1:PrimaryRegistrantRegistrationID>
    <d2p1:ProfileID>0</d2p1:ProfileID>
    <d2p1:RegistrationID>String</d2p1:RegistrationID>
    <d2p1:SessionIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <d2p1:Sessions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfKeyValueOfstringstring>
        <d3p1:KeyValueOfstringstring>
          <d3p1:Key>String</d3p1:Key>
          <d3p1:Value>String</d3p1:Value>
        </d3p1:KeyValueOfstringstring>
      </d3p1:ArrayOfKeyValueOfstringstring>
    </d2p1:Sessions>
    <d2p1:Status>String</d2p1:Status>
  </Registrant>
  <RegistrationID>String</RegistrationID>
</EventRegistrations>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EventRegistrationResponse 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>
  <BadgeNumber>0</BadgeNumber>
  <EventID>0</EventID>
  <Registrant xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.SaaS.Events">
    <d2p1:Attended>String</d2p1:Attended>
    <d2p1:AttendeeType>String</d2p1:AttendeeType>
    <d2p1:BadgeNumber>0</d2p1:BadgeNumber>
    <d2p1:CustomFormDataSet xmlns:d3p1="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.CustomForms">
      <d3p1:CustomFormDataSetItem>
        <d3p1:_x003C_Name_x003E_k__BackingField>String</d3p1:_x003C_Name_x003E_k__BackingField>
        <d3p1:_x003C_Values_x003E_k__BackingField xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d3p1:_x003C_Values_x003E_k__BackingField>
      </d3p1:CustomFormDataSetItem>
    </d2p1:CustomFormDataSet>
    <d2p1:CustomFormDataSetAttachments xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfKeyValueOfstringstring>
        <d3p1:KeyValueOfstringstring>
          <d3p1:Key>String</d3p1:Key>
          <d3p1:Value>String</d3p1:Value>
        </d3p1:KeyValueOfstringstring>
      </d3p1:ArrayOfKeyValueOfstringstring>
    </d2p1:CustomFormDataSetAttachments>
    <d2p1:DataSetID>0</d2p1:DataSetID>
    <d2p1:DateRegistered>0001-01-01T00:00:00</d2p1:DateRegistered>
    <d2p1:EventName>String</d2p1:EventName>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:InvoiceID>String</d2p1:InvoiceID>
    <d2p1:IsPrimaryRegistrant>false</d2p1:IsPrimaryRegistrant>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:OrderID>0</d2p1:OrderID>
    <d2p1:PrimaryRegistrantProfileID>0</d2p1:PrimaryRegistrantProfileID>
    <d2p1:PrimaryRegistrantRegistrationID>String</d2p1:PrimaryRegistrantRegistrationID>
    <d2p1:ProfileID>0</d2p1:ProfileID>
    <d2p1:RegistrationID>String</d2p1:RegistrationID>
    <d2p1:SessionIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <d2p1:Sessions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfKeyValueOfstringstring>
        <d3p1:KeyValueOfstringstring>
          <d3p1:Key>String</d3p1:Key>
          <d3p1:Value>String</d3p1:Value>
        </d3p1:KeyValueOfstringstring>
      </d3p1:ArrayOfKeyValueOfstringstring>
    </d2p1:Sessions>
    <d2p1:Status>String</d2p1:Status>
  </Registrant>
  <RegistrationID>String</RegistrationID>
  <EventRegistrationRegistrant xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.SaaS.Events">
    <d2p1:Attended>String</d2p1:Attended>
    <d2p1:AttendeeType>String</d2p1:AttendeeType>
    <d2p1:BadgeNumber>0</d2p1:BadgeNumber>
    <d2p1:CustomFormDataSet xmlns:d3p1="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.CustomForms">
      <d3p1:CustomFormDataSetItem>
        <d3p1:_x003C_Name_x003E_k__BackingField>String</d3p1:_x003C_Name_x003E_k__BackingField>
        <d3p1:_x003C_Values_x003E_k__BackingField xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d3p1:_x003C_Values_x003E_k__BackingField>
      </d3p1:CustomFormDataSetItem>
    </d2p1:CustomFormDataSet>
    <d2p1:CustomFormDataSetAttachments xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfKeyValueOfstringstring>
        <d3p1:KeyValueOfstringstring>
          <d3p1:Key>String</d3p1:Key>
          <d3p1:Value>String</d3p1:Value>
        </d3p1:KeyValueOfstringstring>
      </d3p1:ArrayOfKeyValueOfstringstring>
    </d2p1:CustomFormDataSetAttachments>
    <d2p1:DataSetID>0</d2p1:DataSetID>
    <d2p1:DateRegistered>0001-01-01T00:00:00</d2p1:DateRegistered>
    <d2p1:EventName>String</d2p1:EventName>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:InvoiceID>String</d2p1:InvoiceID>
    <d2p1:IsPrimaryRegistrant>false</d2p1:IsPrimaryRegistrant>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:OrderID>0</d2p1:OrderID>
    <d2p1:PrimaryRegistrantProfileID>0</d2p1:PrimaryRegistrantProfileID>
    <d2p1:PrimaryRegistrantRegistrationID>String</d2p1:PrimaryRegistrantRegistrationID>
    <d2p1:ProfileID>0</d2p1:ProfileID>
    <d2p1:RegistrationID>String</d2p1:RegistrationID>
    <d2p1:SessionIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <d2p1:Sessions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:ArrayOfKeyValueOfstringstring>
        <d3p1:KeyValueOfstringstring>
          <d3p1:Key>String</d3p1:Key>
          <d3p1:Value>String</d3p1:Value>
        </d3p1:KeyValueOfstringstring>
      </d3p1:ArrayOfKeyValueOfstringstring>
    </d2p1:Sessions>
    <d2p1:Status>String</d2p1:Status>
  </EventRegistrationRegistrant>
</EventRegistrationResponse>