GetPublicEvents

Description

The GetPublicEvents API method returns a list of events across all customers that meet the following criteria:

  • The event is active
  • The start date of the event is in the next 90 days
  • The event was promoted to social outlets by the event organizer

URL

https://www.regonline.com/api/default.asmx/GetPublicEvents

Parameters

Note: Although not all parameters are required, if you do not want to use a particular parameter, an empty value must still be passed with the request.

filter
This parameter can be used to restrict the results returned from the methods.  Valid filter expressions are basically C# syntax and can contain some .NET framework method calls.  So, for example, if no filter is passed to GetEventsPublic(), then public events are returned.  Or, filters such as the following can be used:

   IsActive && Title.Contains("Test")
 
   EndDate >= DateTime(2010, 1, 1)
 
   ActiveDate.HasValue

orderBy
This parameter defines the sort order of the results returned.  Valid expression syntax is similar to a SQL ORDER BY clause.  Taking the example of GetPublicEvents() again, if no orderBy is given, then the sort order is undefined.  Or, expressions such as the following can be used:

   AddBy, AddDate DESC
 
   Title ASC

Maximum Results

This method will return a maximum of 1000 results.

Returns

   <GetPublicEventsResponse xmlns="http://www.regonline.com/api">
      <GetPublicEventsResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <Data>
          <APIEvent>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <Status>string</Status>
            <Title>string</Title>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <ActiveDate>dateTime</ActiveDate>
            <ClientEventID>string</ClientEventID>
            <TypeID>int</TypeID>
            <Type>string</Type>
            <City>string</City>
            <State>string</State>
            <Country>string</Country>
            <PostalCode>string</PostalCode>
            <LocationName>string</LocationName>
            <LocationRoom>string</LocationRoom>
            <LocationPhone>string</LocationPhone>
            <LocationBuilding>string</LocationBuilding>
            <LocationAddress1>string</LocationAddress1>
            <LocationAddress2>string</LocationAddress2>
            <TimeZone>string</TimeZone>
            <Capacity>int</Capacity>
            <CurrencyCode>string</CurrencyCode>
            <Keywords>string</Keywords>
            <AddDate>dateTime</AddDate>
            <AddBy>string</AddBy>
            <ModDate>dateTime</ModDate>
            <ModBy>string</ModBy>
            <Channel>string</Channel>
            <IsWaitlisted>boolean</IsWaitlisted>
            <Culture>string</Culture>
            <MediaType>string</MediaType>
            <IsActive>boolean</IsActive>
            <IsOnSite>boolean</IsOnSite>
            <TotalRevenue>decimal</TotalRevenue>
            <TotalRegistrations>int</TotalRegistrations>
            <TotalCancels>int</TotalCancels>
            <TotalSubstitutions>int</TotalSubstitutions>
            <TargetAttendance>int</TargetAttendance>
            <TotalIncompletes>int</TotalIncompletes>
          </APIEvent>
          <APIEvent>
             ...
          </APIEvent>
          <APIEvent>
             ...
          </APIEvent>
        </Data>
      </GetPublicEventsResult>
    </GetPublicEventsResponse>

Authentication

See Login documentation

Posted: June 28th, 2011

RegOnline by Lanyon is the easy-to-use, affordable online registration and event management software. Turn your next conference, meeting, trade show into a huge success. Event management solutions include online registration forms, event websites, badges, event marketing, credit card processing and so much more. Sign up today for a free trial.

TRUSTe online privacy certification Lanyon Solutions, Inc.
717 North Harwood
Dallas, Texas 75201
email: info@lanyon.com | Toll Free: 1-888-351-9948

 

© Copyright 2017 | RegOnline by Lanyon | All Rights Reserved