webservices

Events Collection and Resource

by Administrator on ‎03-25-2011 10:02 AM

The events collection represents all events that a user has created in the Event Marketing product.

 

Request Format

 

 

GET https://api.constantcontact.com/ws/customers/{user-name}/events

Required Headers

        accept: application/atom+xml
   content-type: application/atom+xml

 

 

For more information about listing events, refer to Managing Events.

 

Response Format

 

Each <atom:entry> element represents an event.  Each folder in the list should have a set of summary information that may be useful, but will not have all of the detail information.

 

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<atom:feed xmlns:atom="http://www.w3.org/2005/Atom">
<atom:title>Events</atom:title>
<atom:updated>2010-08-17T16:28:10.385-04:00</atom:updated>
<atom:id>tag:api.constantcontact.com,2010:/ws/customers/joesflowers/events</atom:id>
<atom:entry>
<atom:title>Spring Orientation</atom:title>
<atom:link rel="edit" href="/ws/customers/joesflowers/events/a07e1hoasmu0e644426"/>
<atom:updated>2010-08-10T15:30:16.050-04:00</atom:updated>
<atom:id>tag:api.constantcontact.com,2010:/ws/customers/joesflowers/events/a07e1hoasmu0e644426</atom:id>
<atom:content>
<Event>
<Name>Spring Oriengation</Name>
<Description></Description>
<Title>Joes Flowers Sprint Orientation</Title>
<Registered>1</Registered>
<CreatedDate>2010-08-10T15:30:16.050-04:00</CreatedDate>
<Status>ACTIVE</Status>
<EventType></EventType>
<EventLocation>
<Location>Boston Marriott</Location>
<Address1></Address1>
<Address2></Address2>
<Address3></Address3>
<City>Chelsea</City>
<State>Massachusetts</State>
<Country></Country>
<PostalCode></PostalCode>
</EventLocation>
<RegistrationURL></RegistrationURL>
<StartDate>2010-08-11T18:00:00-04:00</StartDate>
<EndDate>2010-10-11T18:00:00-04:00</EndDate>
<PublishDate>2010-08-10T15:32:38.653-04:00</PublishDate>
<AttendedCount>0</AttendedCount>
<CancelledCount>0</CancelledCount>
</Event>
</atom:content>
</atom:entry>
<atom:entry>
<atom:title>Summer Orientation</atom:title>
<atom:link rel="edit" href="/ws/customers/joesflowers/events/a07e1hoasmzc36cecc8"/>
<atom:updated>2010-08-10T15:34:17.513-04:00</atom:updated>
<atom:id>tag:api.constantcontact.com,2010:/ws/customers/joesflowers/events/a07e1hoasmzc36cecc8</atom:id>
<atom:content>
<Event>
<Name>Summer Orientation</Name>
<Description></Description>
<Title>Summer Orientation</Title>
<Registered>5</Registered>
<CreatedDate>2010-08-10T15:34:17.513-04:00</CreatedDate>
<Status>ACTIVE</Status>
<EventType></EventType>
<EventLocation>
<Location>Boca Raton Beach</Location>
<Address1></Address1>
<Address2></Address2>
<Address3></Address3>
<City>Burlington</City>
<State>Massachusetts</State>
<Country></Country>
<PostalCode></PostalCode>
</EventLocation>
<RegistrationURL></RegistrationURL>
<StartDate>2010-08-11T18:00:00-04:00</StartDate>
<EndDate>2010-10-11T18:00:00-04:00</EndDate>
<PublishDate>2010-08-10T15:35:30.647-04:00</PublishDate>
<WebPage></WebPage>
<AttendedCount>0</AttendedCount>
<CancelledCount>0</CancelledCount>
</Event>
</atom:content>
</atom:entry>
</atom:feed>

Event Resource

 

The event resource represents individual events that exist in the user account.

 

The event resource is represented by the following URI:

 

 

https://api.constantcontact.com/ws/customers/{user-name}/events/{event-id}

 

Required Headers

        accept: application/atom+xml
   content-type: application/atom+xml

 

 

For more information about obtaining event details, refer to Managing Events.

 

Response Format

 

For more detailed descriptions of the XML elements, refer to the Event XML Data Elements section.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom">
<atom:title>Summer Orientation</atom:title>
<atom:link rel="edit" href="/ws/customers/joesflowers/events/a07e1hoasn2a917e97c"/>
<atom:updated>2010-08-10T15:37:49.686-04:00</atom:updated>
<atom:id>tag:api.constantcontact.com,2010:/ws/customers/joesflowers/events/a07e1hoasn2a917e97c</atom:id>
<atom:content>
<Event>
<Name>Summer Orientation</Name>
<Description></Description>
<Title>Summer Orientation</Title>
<Registered>20</Registered>
<CreatedDate>2010-08-10T15:37:49.686-04:00</CreatedDate>
<Status>ACTIVE</Status>
<EventType></EventType>
<EventLocation>
<Location>Hotel California</Location>
<Address1>1 Evm Place</Address1>
<Address2></Address2>
<Address3></Address3>
<City>Burlington</City>
<State>Massachusetts</State>
<Country>United States</Country>
<PostalCode>01950</PostalCode>
</EventLocation>
<RegistrationURL></RegistrationURL>
<StartDate>2010-08-11T18:00:00-04:00</StartDate>
<EndDate>2010-10-11T18:00:00-04:00</EndDate>
<PublishDate>2010-08-10T15:38:41.646-04:00</PublishDate>
<WebPage></WebPage>
<AttendedCount>0</AttendedCount>
<CancelledCount>0</CancelledCount>
<EventFeeRequired>TRUE</EventFeeRequired>
<CurrencyType>JPY</CurrencyType>
<PaymentOptions>
<PaymentOption>
<Type>PAYPAL</Type>
<PayPalAccountEmail>paypalexample@example.com</PayPalAccountEmail>
</PaymentOption>
<PaymentOption>
<Type>CHECK</Type>
<PaymentAddress>
<Address1>123 wsw st</Address1>
<Address2></Address2>
<Address3></Address3>
<City>Ashland</City>
<State>Massachusetts</State>
<Country>United States</Country>
<PostalCode>32423</PostalCode>
</PaymentAddress>
</PaymentOption>
<PaymentOption>
<Type>DOOR</Type>
</PaymentOption>
</PaymentOptions>
<RegistrationTypes>
<RegistrationType>
<Name>Attendee</Name>
<RegistrationLimitCount>25</RegistrationLimitCount>
<RegistrationClosedManually>FALSE</RegistrationClosedManually>
<GuestLimit>5</GuestLimit>
<Ticketing>TRUE</Ticketing>
<EventFees>
<EventFee>
<Label>Main Hall Entry Fee</Label>
<Fee>1.0</Fee>
<EarlyFee>0.0</EarlyFee>
<LateFee>0.0</LateFee>
<FeeScope>BOTH</FeeScope>
</EventFee>
<EventFee>
<Label>Additional Sessions</Label>
<Fee>2.0</Fee>
<EarlyFee>0.0</EarlyFee>
<LateFee>0.0</LateFee>
<FeeScope>REGISTRANTS</FeeScope>
</EventFee>
<EventFee>
<Label>Main Hall for Guests</Label>
<Fee>3.0</Fee>
<EarlyFee>0.0</EarlyFee>
<LateFee>0.0</LateFee>
<FeeScope>GUESTS</FeeScope>
</EventFee>
</EventFees>
</RegistrationType>
</RegistrationTypes>
</Event>
</atom:content>
</atom:entry>

 

URI Format


URI ComponentDescription
user-name

The account owner's Constant Contact user name.
Value must be in lower case.

events

Represent a collection of events.

URL parameters:

sortColumn: Specifies data by which the list should be sorted (Default: Name)

Name, Title, Location, StartDate, EndDate, Registered, City, State, CreatedDate, PublishDate

sortOrder: Specifies whether the list should be sorted in ascending or descending order (Default: ASC)

ASC, DESC

pageSize: Specifies how many events should be listed in each page (Default: 50)

pageNumber: Used for paging for internal purposes only.  You should not modify this value.

Example:

To get a list of events sorted by the event start date with most recent event first, 5 events per page:

https://api.constantcontact.com/ws/customers/joesflowers/events?sortColumn=StartDate&sortOrder=ASC&p...

event-id

Represents an individual event. 

The ID of an event is the last component of the URI included in "href" attribute of <atom:link> element.  It is not the value of <atom:id> element.

 

 

Event Data XML Elements Specifications


Element NameAllowed ValuesEditable?Required on POSTRequired on PUTNotes
Name   Not Supported Not Supported Not Supported Internal name for the event you can use to identify it
Title   Not Supported Not Supported Not Supported Title of the event that is displayed publicly
Registered   Not Supported Not Supported Not Supported Number of registrants
CreatedDate   Not Supported Not Supported Not Supported Date and time when the event was created in UTC
Status

DRAFT
ACTIVE
COMPLETE
CANCELLED
DELETED

Not Supported Not Supported Not Supported DRAFT - the event is still in draft mode
ACTIVE - the event has been published
COMPLETE - the event has occurred
CANCELLED - the event has been cancelled
EventType

BIRTHDAY
BUSINESS_FINANCE_SALES
CLASSES_WORKSHOPS
COMPETITION_SPORTS
CONFERENCES_SEMINARS_FORUM
CONVENTIONS_TRADESHOWS_EXPOS
FESTIVALS_FAIRS
FOOD_WINE
FUNDRAISERS_CHARITIES
HOLIDAY
INCENTIVE_REWARD_RECOGNITION
MOVIES_FILM
MUSIC_CONCERTS
NETWORKING_CLUBS
PERFORMING_ARTS
OUTDOORS_RECREATION
RELIGION_SPIRITUALITY
SCHOOLS_REUNIONS_ALUMNI
PARTIES_SOCIAL_EVENTS_MIXERS
TRAVEL
WEDDINGS
OTHER

Not Supported Not Supported Not Supported Type of the event
(This is currently not working and will be fixed soon.)
EventLocation   Not Supported Not Supported Not Supported A container for event location data
RegistrationURL   Not Supported Not Supported Not Supported URL for the event home page.  If the event home page does not exist, it directs to the registration page.
StartDate   Not Supported Not Supported Not Supported Date and time at which the event is scheduled to start (in UTC)
EndDate   Not Supported Not Supported Not Supported Date and time at which the event is scheduled to end (in UTC)
PublishDate   Not Supported Not Supported Not Supported Date and time at which the event was published (in UTC)
AttendedCount   Not Supported Not Supported Not Supported The number of registrants who attended the event
CancelledCount   Not Supported Not Supported Not Supported The number of people who canceled the registration
EventFeeRequired TRUE
FALSE
Not Supported Not Supported Not Supported Whether the event fee is required
CurrencyType   Not Supported Not Supported Not Supported Currency in which the event fee has been specified
PaymentOptions One or more <PaymentOption> elements Not Supported Not Supported Not Supported Specifies all payment options available for the event
RegistrationTypes One or more <RegistrationType> elements Not Supported Not Supported Not Supported Specifies different classes of registrations that are available.  The Event Marketing product only supports "Attendee" class of registrations right now.

 

 

EventLocation XML Elements Specification

 

Element NameAllowed ValuesEditable?Required on POST?Required on PUT?Notes
Location   Not Supported Not Supported Not Supported A nominal name for the event location
Address1   Not Supported Not Supported Not Supported First line of location address
Address2   Not Supported Not Supported Not Supported Second line of location address
Address3   Not Supported Not Supported Not Supported Third line of location address
City   Not Supported Not Supported Not Supported Location city
State   Not Supported Not Supported Not Supported Name of the state.  This element will be changed to <StateName> soon.  We will also add <StateCode> element to give the valid state codes.
Country   Not Supported Not Supported Not Supported Name of the country.  This element will be changed to <CountryName> soon.  We will also add <CountryCode> element to give the valid country codes.
PostalCode   Not Supported Not Supported Not Supported Postal (Zip) code for the event location

 

PaymentOption XML Element Specification

 

Element NameAllowed ValuesEditable?Required on POST?Required on PUT?Notes
Type PAYPAL
CHECK
DOOR
Not Supported Not Supported Not Supported Payment type
PayPalAccountEmail   Not Supported Not Supported Not Supported PayPal account email address to which the payment should be sent.  This element only appears if <Type> element's value is PAYPAL.
PaymentAddress Contains elements for payment address.  See below. Not Supported Not Supported Not Supported Address to which the payment check should be sent.  This element only appears if <Type> element's value is CHECK.

 

PaymentAddress XML Element Specification

 

Element NameAllowed ValuesEditable?Required on POST?Required on PUT?Notes
Address1   Not Supported Not Supported Not Supported First line of payment address
Address2   Not Supported Not Supported Not Supported Second line of payment address
Address3   Not Supported Not Supported Not Supported Third line of payment address
City   Not Supported Not Supported Not Supported Payment address city
State   Not Supported Not Supported Not Supported State name for the payment address.  This element will be changed to <StateName> and <StateCode> element will be added later to contain the valid state codes.
Country   Not Supported Not Supported Not Supported Country name for the payment address.  This element will be changed to <CountryName> and <CountryCode> element will be added later to contain the valid country codes.
PostalCode   Not Supported Not Supported Not Supported Postal (Zip) code for the payment address

 

RegistrationType XML Element Specification

 

Element NameAllowed ValuesEditable?Required on POST?Required on PUT?Notes
Name   Not Supported Not Supported Not Supported Name of the registration type.  The Event Marketing product only supports "Attendee" class and therefore the value for this element will always be "Attendee".
RegistrationLimitCount   Not Supported Not Supported Not Supported Limit for the number of registrants at which the registration will close automatically
RegistrationLimitDate   Not Supported Not Supported Not Supported Date and time at which the registration will close automatically (in UTC)
RegistrationClosedManually TRUE
FALSE
 
Not Supported Not Supported Not Supported Whether the registration was closed manually or not
GuestLimit   Not Supported Not Supported Not Supported Limit on the number of guests that each registrant can bring
Ticketing TRUE
FALSE
Not Supported Not Supported Not Supported Whether ticketing has been enabled
EventFees One or more <EventFee> element. See Below. Not Supported Not Supported Not Supported  

 

EventFee XML Element Specification

 

Element NameAllowed ValuesEditable?Required on POST?Required on PUT?Notes
Label   Not Supported Not Supported Not Supported Label for the fee type
Fee   Not Supported Not Supported Not Supported Amount for the fee
EarlyFee   Not Supported Not Supported Not Supported Early fee amount, if exists
LateFee   Not Supported Not Supported Not Supported Late fee amount, if exists
FeeScope

REGISTRANTS
GUESTS
BOTH

Not Supported Not Supported Not Supported To which attendees the fee applies

 

 

Time Zone ID Specification

This field is used when creating an event (via a POST to the events collection). It is not returned on GET operations when obtaining information about existing events.

 

Possible Choices for Time Zone Id

Time Zone Id Offset from GMT
US/Eastern GMT-0500
US/Central GMT-0600
US/Mountain GMT-0700
US/Pacific GMT-0800
Etc/GMT+12 GMT-1200
Pacific/Samoa GMT-1100
US/Hawaii GMT-1000
Pacific/Tahiti GMT-1000
US/Alaska GMT-0900
Mexico/BajaNorte GMT-0800
US/Arizona GMT-0700
America/Chihuahua GMT-0700
CST GMT-0600
America/Mexico_City GMT-0600
Canada/Saskatchewan GMT-0600
America/Bogota GMT-0500
US/East-Indiana GMT-0500
America/Lima GMT-0500
America/Guayaquil GMT-0500
America/Caracas GMT-0430
America/Puerto_Rico GMT-0400
America/Asuncion GMT-0400
Canada/Atlantic GMT-0400
America/Cuiaba GMT-0400
America/Guyana GMT-0400
America/La_Paz GMT-0400
America/Manaus GMT-0400
America/Santiago GMT-0400
Canada/Newfoundland GMT-0330
Brazil/East GMT-0300
America/Buenos_Aires GMT-0300
America/Cayenne GMT-0300
America/Fortaleza GMT-0300
America/Godthab GMT-0300
America/Montevideo GMT-0300
America/Paramaribo GMT-0300
Atlantic/South_Georgia GMT-0200
Atlantic/Azores GMT-0100
Atlantic/Cape_Verde GMT-0100
Africa/Accra GMT 0000
Africa/Casablanca GMT 0000
Europe/London GMT 0000
Etc/Universal GMT 0000
Europe/Lisbon GMT 0000
Africa/Monrovia GMT 0000
Europe/Amsterdam GMT+0100
Europe/Belgrade GMT+0100
Europe/Brussels GMT+0100
Europe/Sarajevo GMT+0100
Africa/Lagos GMT+0100
Africa/Windhoek GMT+0100
Asia/Amman GMT+0200
Europe/Athens GMT+0200
Asia/Beirut GMT+0200
Africa/Harare GMT+0200
Europe/Helsinki GMT+0200
Asia/Jerusalem GMT+0200
Africa/Johannesburg GMT+0200
Europe/Minsk GMT+0200
Asia/Baghdad GMT+0300
Asia/Kuwait GMT+0300
Europe/Moscow GMT+0300
Africa/Nairobi GMT+0300
Europe/Volgograd GMT+0300
Asia/Tehran GMT+0330
Asia/Dubai GMT+0400
Asia/Baku GMT+0400
Indian/Mahe GMT+0400
Indian/Mauritius GMT+0400
Indian/Reunion GMT+0400
Asia/Tbilisi GMT+0400
Asia/Yerevan GMT+0400
Asia/Kabul GMT+0430
Asia/Aqtobe GMT+0500
Asia/Ashgabat GMT+0500
Asia/Dushanbe GMT+0500
Asia/Karachi GMT+0500
Indian/Maldives GMT+0500
Asia/Oral GMT+0500
Asia/Tashkent GMT+0500
Asia/Yekaterinburg GMT+0500
Asia/Kolkata GMT+0530
Asia/Kathmandu GMT+0545
Asia/Almaty GMT+0600
Asia/Bishkek GMT+0600
Asia/Dhaka GMT+0600
Asia/Omsk GMT+0600
Asia/Qyzylorda GMT+0600
Asia/Novosibirsk GMT+0600
Asia/Thimbu GMT+0600
Asia/Rangoon GMT+0630
Asia/Bangkok GMT+0700
Asia/Jakarta GMT+0700
Asia/Krasnoyarsk GMT+0700
Asia/Chongqing GMT+0800
Asia/Brunei GMT+0800
Asia/Hong_Kong GMT+0800
Asia/Irkutsk GMT+0800
Asia/Kuala_Lumpur GMT+0800
Asia/Makassar GMT+0800
Asia/Manila GMT+0800
Australia/Perth GMT+0800
Asia/Singapore GMT+0800
Asia/Taipei GMT+0800
Asia/Ulaanbaatar GMT+0800
Asia/Tokyo GMT+0900
Asia/Dili GMT+0900
Asia/Jayapura GMT+0900
Asia/Seoul GMT+0900
Asia/Yakutsk GMT+0900
Australia/Adelaide GMT+0930
Australia/Darwin GMT+0930
Australia/Brisbane GMT+1000
Australia/Canberra GMT+1000
Pacific/Port_Moresby GMT+1000
Pacific/Guam GMT+1000
Australia/Hobart GMT+1000
Asia/Vladivostok GMT+1000
Pacific/Noumea GMT+1100
Asia/Magadan GMT+1100
Pacific/Guadalcanal GMT+1100
Pacific/Efate GMT+1100
Pacific/Auckland GMT+1200
Pacific/Fiji GMT+1200
Asia/Kamchatka GMT+1200
Pacific/Tongatapu GMT+1300