GetEvents v1.1

Description

The GetEvents API method returns a list of events accessible to the current user. There are optional parameters to allow for filtering and sorting of the results.

URL

https://www.regonline.com/api/v1.1/default.asmx/GetEvents

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 is an optional parameter that 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 GetEvents(), then all events in the user’s account are returned. Or, filters such as the following can be used:

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

orderBy
This is also an optional parameter that defines the sort order of the results returned. Valid expression syntax is similar to a SQL ORDER BY clause. Taking the example of GetEvents() 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

   <GetEventsResponse xmlns="https://www.regonline.com/api/v1.1">
      <GetEventsResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <Data>
          <APIEventV1_1>
            <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>
            <Latitude>decimal</Latitude>
            <Longitude>decimal</Longitude>
            <TotalRevenue>decimal</TotalRevenue>
            <TotalRegistrations>int</TotalRegistrations>
            <TotalCancels>int</TotalCancels>
            <TotalSubstitutions>int</TotalSubstitutions>
            <TargetAttendance>int</TargetAttendance>
            <TotalIncompletes>int</TotalIncompletes>
            <ContactEmailAddress>string</ContactEmailAddress>
            <EventDescription>string</EventDescription>
            <EventFee>decimal</EventFee>
            <RegistrationFormURL>string</RegistrationFormURL>
            <RegistrantTypes>
                <RegistrantType>
                    <NameOnForm>Member</NameOnForm>
                    <Limit>int</Limit>
                    <MinGroupSize>int</MinGroupSize>
                    <MaxGroupSize>int</MaxGroupSize>
                    <EventFee>decimal</EventFee>
                </RegistrantType>
                <RegistrantType>
                    ...
                </RegistrantType>
            <RegistrantTypes/>
          </APIEventV1_1>
          <APIEventV1_1>
            ...
          </APIEventV1_1>
        </Data>
      </GetEventsResult>
    </GetEventsResponse>

Authentication

See Login documentation

Posted: January 26th, 2016

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