API Methods: events.getList



Description

Returns a list of events


Required parameters

  • None

Optional parameters

  • event_id :
    the id number of the event
  • event_name :
    the name of the event
  • address_1 :
    the first address line of the event location
  • address_2 :
    the second address line of the event location
  • city :
    the city of the event location
  • state :
    the state of the event location
  • country :
    the country of the event location
  • zip_code_5 :
    the five digit zip code of the event location
  • zip_code_4 :
    the plus four zip code of the event location
  • venue :
    the name of the venue for the event
  • start_date :
    the start date and time of the event formatted according to RFC 822 standard
  • end_date :
    the end date and time of the event formatted according to RFC 822 standard. If this is omitted, the event will be an all day event.
  • user_id :
    the id of the user to whom this event belongs. The list of user ids is available from the users.getList call.
  • group_id :
    the id of the group to which this event belongs. The list of group ids is available from the groups.getList call.
  • invite_message :
    the default invitation message for this event
  • ask_rsvp :
    a boolean value (0=false, 1=true) which determines if the invitees are asked to rsvp for the event
  • show_guests :
    a boolean value which determines if the list of invitees is shown to all the other invitees
  • description :
    a brief description of the event
  • event_type :
    the type of event. This has three possible values:
    • 0 : Private
    • 1 : Group
    • 2 : Public
  • ss_key : the key of the community associated with the event. The list of communities is available from the communities.getList call.
  • interest_key : the key of a site interest associated with the event. The list of interests is available from the siteinterests.getList call.
  • subinterest_key : the key of a site sub-interest associated with the event. The list of interests is available from the siteinterests.getList call.

Example response

<?xml version="1.0"?>
<response status="ok" time="Mon, 28 Apr 2008 17:01:29 -0500">
    <events count="2" total="6">

        <event>
            <event_id>2</event_id>
            <event_name>
                <![CDATA[Site Launch]]>
            </event_name>

            <start_date>
                <![CDATA[Thu, 01 Nov 2007 18:00:01 -0500]]>
            </start_date>
            <end_date>
                <![CDATA[Thu, 01 Nov 2007 20:00:01 -0500]]>
            </end_date>

            <address_1>
                <![CDATA[3303 Northland Drive]]>
            </address_1>
            <address_2/>
            <city>
                <![CDATA[Austin]]>

            </city>
            <state>
                <![CDATA[TX]]>
            </state>
            <zip_code_5>78731</zip_code_5>

            <zip_code_4>0</zip_code_4>
            <venue>
                <![CDATA[The Casa]]>
            </venue>
            <country>

                <![CDATA[USA]]>
            </country>
            <description/>
            <user_id>1</user_id>
            <group_id>0</group_id>

            <show_guests>1</show_guests>
            <ask_rsvp>1</ask_rsvp>
            <invite_message/>
            <event_type label="Public">2</event_type>

            <invitees>
                <user_id>1</user_id>
            </invitees>
        </event>
        <event>

            <event_id>4</event_id>
            <event_name>
                <![CDATA[Public Event]]>
            </event_name>
            <start_date>

                <![CDATA[Wed, 31 Oct 2007 06:00:01 -0500]]>
            </start_date>
            <end_date/>
            <address_1>
                <![CDATA[1302 norwalk lane]]>
            </address_1>

            <address_2/>
            <city>
                <![CDATA[Austin]]>
            </city>
            <state>
                <![CDATA[TX]]>

            </state>
            <zip_code_5>78703</zip_code_5>
            <zip_code_4>0</zip_code_4>
            <venue>
                <![CDATA[x]]>

            </venue>
            <country>
                <![CDATA[USA]]>
            </country>
            <description/>
            <user_id>8</user_id>

            <group_id>0</group_id>
            <show_guests>1</show_guests>
            <ask_rsvp>1</ask_rsvp>
            <invite_message>

                <![CDATA[x]]>
            </invite_message>
            <event_type label="Public">2</event_type>
            <invitees>
                <user_id>8</user_id>

            </invitees>
        </event>
    </events>
</response>