YM REST Services

<back to all web services

EventSessionGroups

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/Event/{EventId}/EventSessionGroupsReturn a list of session groups linked to an event.
PUT/Ams/{ClientID}/Event/{EventId}/EventSessionGroupsUpdate a given event session group.
POST/Ams/{ClientID}/Event/{EventId}/EventSessionGroupsCreate a new event session group.
GET/Ams/{ClientID}/Event/{EventId}/EventSessionGroups/{SessionGroupId}Return the details for a given event sessions group.
DELETE/Ams/{ClientID}/Event/{EventId}/EventSessionGroups/{SessionGroupId}Delete a given event session group.
EventSessionGroups Parameters:
NameParameterData TypeRequiredDescription
SessionGroupIdpathint?No
EventIdpathintNo
NamebodystringNo
SingleSelectbodyboolNo
ExpandOnRegistrationbodyboolNo
TypebodySessionGroupTypeNo
SessionsbodyList<EventSessions>No
OrdinalbodyintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventSessions Parameters:
NameParameterData TypeRequiredDescription
SessionIdformint?No
EventIdformintNo
DateCreatedformDateTimeNo
NameformstringNo
PresenterformstringNo
StartDateformDateTime?No
StartTimeformstringNo
EndDateformDateTime?No
EndTimeformstringNo
AllowOverlapformboolNo
MaxRegistrantsformint?No
DescriptionformstringNo
RegistrantCountformint?No
NonCanceledCountformint?No
AllowCEUsformbool?No
TicketsformList<int>No
ChargeForSessionformbool?No
SessionGroupIdformint?No
SortByNameformboolNo
EventSessionsResponse Parameters:
NameParameterData TypeRequiredDescription
SessionsformList<EventSessions>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}/EventSessionGroups HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EventSessionGroups 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>
  <EventId>0</EventId>
  <ExpandOnRegistration>false</ExpandOnRegistration>
  <Name>String</Name>
  <Ordinal>0</Ordinal>
  <SessionGroupId>0</SessionGroupId>
  <Sessions>
    <EventSessions>
      <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:d4p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <AllowCEUs>false</AllowCEUs>
      <AllowOverlap>false</AllowOverlap>
      <ChargeForSession>false</ChargeForSession>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <Description>String</Description>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <EndTime>String</EndTime>
      <EventId>0</EventId>
      <MaxRegistrants>0</MaxRegistrants>
      <Name>String</Name>
      <NonCanceledCount>0</NonCanceledCount>
      <Presenter>String</Presenter>
      <RegistrantCount>0</RegistrantCount>
      <SessionGroupId>0</SessionGroupId>
      <SessionId>0</SessionId>
      <SortByName>false</SortByName>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <StartTime>String</StartTime>
      <Tickets xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </Tickets>
    </EventSessions>
  </Sessions>
  <SingleSelect>false</SingleSelect>
  <Type>ByName</Type>
</EventSessionGroups>

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

<EventSessionsResponse 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>
  <AllowCEUs>false</AllowCEUs>
  <AllowOverlap>false</AllowOverlap>
  <ChargeForSession>false</ChargeForSession>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <Description>String</Description>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <EndTime>String</EndTime>
  <EventId>0</EventId>
  <MaxRegistrants>0</MaxRegistrants>
  <Name>String</Name>
  <NonCanceledCount>0</NonCanceledCount>
  <Presenter>String</Presenter>
  <RegistrantCount>0</RegistrantCount>
  <SessionGroupId>0</SessionGroupId>
  <SessionId>0</SessionId>
  <SortByName>false</SortByName>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <StartTime>String</StartTime>
  <Tickets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Tickets>
  <Sessions>
    <EventSessions>
      <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:d4p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <AllowCEUs>false</AllowCEUs>
      <AllowOverlap>false</AllowOverlap>
      <ChargeForSession>false</ChargeForSession>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <Description>String</Description>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <EndTime>String</EndTime>
      <EventId>0</EventId>
      <MaxRegistrants>0</MaxRegistrants>
      <Name>String</Name>
      <NonCanceledCount>0</NonCanceledCount>
      <Presenter>String</Presenter>
      <RegistrantCount>0</RegistrantCount>
      <SessionGroupId>0</SessionGroupId>
      <SessionId>0</SessionId>
      <SortByName>false</SortByName>
      <StartDate>0001-01-01T00:00:00</StartDate>
      <StartTime>String</StartTime>
      <Tickets xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </Tickets>
    </EventSessions>
  </Sessions>
</EventSessionsResponse>