Registrants Collection and Resource

webservices · ‎03-25-2011

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/{event-id}/registrants

Required Headers

accept: application/atom+xml

For more information about listing registrants for an event, refer to Managing Events.

Response Format

Each <atom:entry> element represents a registrant, and each registrant summary information contains a set of data fields that may be useful at the summary level. In order to get more detailed information about each registrant, you need to call the GET method on the URI from href attribute of <atom:link> element inside each entry.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<atom:feed xmlns:atom="http://www.w3.org/2005/Atom">
    <atom:title>Registrants</atom:title>
    <atom:updated>2010-08-18T15:30:04.220-04:00</atom:updated>
    <atom:id>tag:api.constantcontact.com,2010:/ws/customers/joesflowers/events/a07e1hoasn2a917e97c/registrants</atom:id>
    <atom:link rel="current" href="/ws/customers/joesflowers/events/a07e1hoasn2a917e97c/registrants"/>
    <atom:link rel="first" href="/ws/customers/joesflowers/events/a07e1hoasn2a917e97c/registrants"/>
    <atom:link rel="next" href="/ws/customers/joesflowers/events/a07e1hoasn2a917e97c/registrants?pageNumber=1"/>
    <atom:entry>
        <atom:title>Test User 1</atom:title>
        <atom:link rel="edit"
        href="/ws/customers/joesflowers/events/a07e1hoasn2a917e97c/registrants/001xn3Y4OR91FzwO30b8qN3LWcOS1FX1xC4V67bXB7
        q_g5pDr_tBvaQX89QvmkTNnVy"/>
        <atom:updated>2010-08-10T15:51:11-04:00</atom:updated>
        <atom:id>tag:api.constantcontact.com,2010:
        /ws/customers/joesflowers/events/a07e1hoasn2a917e97c/registrants/001xn3Y4OR91FzwO30b8qN3LWcOS1FX1xC4V67bXB7q_g5pD
        r_tBvaQX89QvmkTNnVy</atom:id>
        <atom:content>
            <Registrant>
                <LastName>Test</LastName>
                <FirstName>User</FirstName>
                <EmailAddress>testuser@example.com</EmailAddress>
                <RegistrationStatus>REGISTERED</RegistrationStatus>
                <RegistrationDate>2010-08-10T15:51:11-04:00</RegistrationDate>
                <AttendanceStatus>
                  <Status>ATTENDED</Status>
                  <Type>GROUP</Type>
                </AttendanceStatus>
                <GuestCount>1</GuestCount>
                <PaymentStatus>PAID</PaymentStatus>
            </Registrant>
        </atom:content>
    </atom:entry>
    <atom:entry>
        <atom:title>Test User 2</atom:title>
        <atom:link rel="edit"
        href="/ws/customers/joesflowers/events/a07e1hoasn2a917e97c/registrants/001xn3Y4OR91FzwO30b8qN3LRqXHXzmiajtzgpvwDG
        wrczLoArmTbnuphikObyHdLJd"/>
        <atom:updated>2010-08-10T15:51:44-04:00</atom:updated>
        <atom:id>tag:api.constantcontact.com,2010:
        /ws/customers/joesflowers/events/a07e1hoasn2a917e97c/registrants/001xn3Y4OR91FzwO30b8qN3LRqXHXzmiajtzgpvwDGwrczLo
        ArmTbnuphikObyHdLJd</atom:id>
        <atom:content>
            <Registrant>
                <LastName>Test</LastName>
                <FirstName>User 2</FirstName>
                <EmailAddress>testuser2@example.com</EmailAddress>
                <RegistrationStatus>REGISTERED</RegistrationStatus>
                <RegistrationDate>2010-08-10T15:51:44-04:00</RegistrationDate>
                <GuestCount>2</GuestCount>
                <PaymentStatus>INCOMPLETE</PaymentStatus>
            </Registrant>
        </atom:content>
    </atom:entry>
</atom:feed>

Registrant Resource

The registrant resource represents individual registrants that exist in the user account.

The registrant resource is represented by the following URI:

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

Required Headers

accept: application/atom+xml

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

Response Format

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom">
    <atom:title>Tanmand Evm1</atom:title>
    <atom:link rel="edit"
    href="/ws/customers/joesflowers/events/a07e1hoasn2a917e97c/registrants/001xn3Y4OR91FzwO30b8qN3LStB0UpRcvutof486SE6nOx
    kJfpX0y7-ugr6yQGBX-ke"/>
    <atom:updated>2010-08-10T15:53:11.804-04:00</atom:updated>
    <atom:id>tag:api.constantcontact.com,2010:
    /ws/customers/joesflowers/events/a07e1hoasn2a917e97c/registrants/001xn3Y4OR91FzwO30b8qN3LStB0UpRcvutof486SE6nOxkJfpX0
    y7-ugr6yQGBX-ke</atom:id>
    <atom:content>
        <Registrant>
            <LastName>Test</LastName>
            <FirstName>User</FirstName>
            <EmailAddress>testuser@example.com</EmailAddress>
            <PersonalInformation>
                <Label>Personal Information</Label>
                <Address1></Address1>
                <Address2></Address2>
                <Address3></Address3>
                <City></City>
                <State></State>
                <PostalCode></PostalCode>
                <Province></Province>
                <Country></Country>
                <Phone></Phone>
                <CellPhone></CellPhone>
            </PersonalInformation>
            <BusinessInformation>
                <Label>Business Information</Label>
                <Company></Company>
                <JobTitle></JobTitle>
                <Department></Department>
                <Address1></Address1>
                <Address2></Address2>
                <Address3></Address3>
                <City></City>
                <State></State>
                <PostalCode></PostalCode>
                <Province></Province>
                <Country></Country>
                <Phone></Phone>
                <Fax></Fax>
                <Website></Website>
                <Blog></Blog>
            </BusinessInformation>
            <CustomInformation1>
                <CustomField>
                    <Question>Would you like chicken or beef?</Question>
                    <Answers>
                        <Answer>Beef</Answer>
                    </Answers>
                </CustomField>
                <CustomField>
                    <Question>When are you arriving?</Question>
                    <Answers>
                        <Answer>2010-08-20T04:00:00+00:00</Answer>
                    </Answers>
                </CustomField>
            </CustomInformation1>
            <CustomInformation2/>
            <RegistrationStatus>REGISTERED</RegistrationStatus>
            <RegistrationDate>2010-08-10T15:53:11.804-04:00</RegistrationDate>
            <AttendanceStatus>
              <Status>ATTENDED</Status>
              <Type>GROUP</Type>
            </AttendanceStatus>
            <GuestCount>4</GuestCount>
            <PaymentStatus>PENDING</PaymentStatus>
            <OrderAmount>10.0</OrderAmount>
            <CurrencyType>JPY</CurrencyType>
            <PaymentType>DOOR</PaymentType>
            <Costs>
                <Cost>
                    <Count>2</Count>
                    <FeeType>Event fee</FeeType>
                    <Rate>1.0</Rate>
                    <Total>2.0</Total>
                </Cost>
                <Cost>
                    <Count>1</Count>
                    <FeeType>Bus fee</FeeType>
                    <Rate>2.0</Rate>
                    <Total>2.0</Total>
                </Cost>
                <Cost>
                    <Count>2</Count>
                    <FeeType>Hotel fee</FeeType>
                    <Rate>3.0</Rate>
                    <Total>6.0</Total>
                </Cost>
            </Costs>
        </Registrant>
    </atom:content>
</atom:entry>

URI Format

URI Component	Description
user-name	The account owner's Constant Contact user name. *Value must be in lower case.*
events	Represent a collection of events.
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.
registrants	Represent a collection of registrants. URL parameters: sortColumn: Specifies data by which the list should be sorted (Default: Name) FirstName, LastName, RegistrationStatus, GuestCount, EmailAddress, PaymentStatus, CreatedDate sortOrder: Specifies whether the list should be sorted in ascending or descending order (Default: ASC) ASC, DESC pageSize: Specifies how many registrants 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 registrants sorted by their last names in alphabetical order, 10 contacts per page: https://api.constantcontact.com/ws/customers/joesflowers/events/2938kdhf2983/registrants?sortColumn=...
registrant-id	Represents an individual registrant. The ID of a registrant is the last component of the URI included in "href" attribute of <atom:link> element. It is not the value of <atom:id> element.

Registrant Data XML Elements Specifications

Element Name	Allowed Values	Editable?	Required on POST	Required on PUT	Notes
LastName		Not Supported	Not Supported	Not Supported	Last name of the registrant
FirstName		Not Supported	Not Supported	Not Supported	First name of the registrant
EmailAddress		Not Supported	Not Supported	Not Supported	Email address of the registrant
RegistrationStatus	ABANDONED ATTENDED CANCELLED NOT_ATTENDED REGISTERED	Not Supported	Not Supported	Not Supported	Registrant's registration status ABANDONED - The registrant did not complete the payment process ATTENDED - The registrant attended the event CANCELLED - The registrant cancelled the registration NOT_ATTENDED - The registrant did not attend the event REGISTERED - The registrant registered for the event
RegistrationDate		Not Supported	Not Supported	Not Supported	Registration date (in UTC)
GuestCount		Not Supported	Not Supported	Not Supported	Number of guests the registrant is bringing
AttendanceStatus	ATTENDED NOT_ATTENDED	Yes	Not Supported	Yes	This field is a composite. The XML looks like: <AttendanceStatus> <Status>ATTENDED</Status> <Type>GROUP</Type> </AttendanceStatus>
PaymentStatus	BALANCE_DUE REFUND_DUE INCOMPLETE NA PAID PENDING	Not Supported	Not Supported	Not Supported	BALANCE_DUE - The registrant has been issued a refund. REFUND_DUE - The registrant needs to be issued a refund. INCOMPLETE - The registrant did not complete the payment process. NA - There is no payment required for the event. PAID - The registrant paid for the event. PENDING - The registrant is paying by check or at the door and has not paid yet.
PersonalInformation	All elements that belong to the Personal Information section of the registration form	Not Supported	Not Supported	Not Supported
BusinessInformation	All elements that belong to the Business Information section of the registration form	Not Supported	Not Supported	Not Supported
CustomInformation1	One or more <CustomField> elements
OrderAmount		Not Supported	Not Supported	Not Supported	Total order amount paid by the registrant
CurrencyType		Not Supported	Not Supported	Not Supported	Currency code for the event fees
PaymentType	PAYPAL CHECK DOOR	Not Supported	Not Supported	Not Supported	Payment type used by the registrant
Costs	One or more <Cost> elements	Not Supported	Not Supported	Not Supported	Cost breakdown of the order amount

PersonalInformation XML Elements Specification

Element Name	Editable?	Required on POST?	Required on PUT?	Notes
Label	Not Supported	Not Supported	Not Supported	Custom label for the Personal Information section
Address1	Not Supported	Not Supported	Not Supported
Address2	Not Supported	Not Supported	Not Supported
Address3	Not Supported	Not Supported	Not Supported
City	Not Supported	Not Supported	Not Supported
State	Not Supported	Not Supported	Not Supported	State name. This element will be changed to <StateName>, and <StateCode> element will be added to indicate the state code.
PostalCode	Not Supported	Not Supported	Not Supported
Province	Not Supported	Not Supported	Not Supported
Country	Not Supported	Not Supported	Not Supported	Country name for address. This element will be changed to <CountryName> and <CountryCode> will be added to indicate the country code.
Phone	Not Supported	Not Supported	Not Supported
CellPhone	Not Supported	Not Supported	Not Supported

BusinessInformation XML Elements Specification

Element Name	Editable?	Required on POST?	Required on PUT?	Notes
Label	Not Supported	Not Supported	Not Supported	Custom label for the Business information section
Company	Not Supported	Not Supported	Not Supported
JobTitle	Not Supported	Not Supported	Not Supported
Department	Not Supported	Not Supported	Not Supported
Address1	Not Supported	Not Supported	Not Supported
Address2	Not Supported	Not Supported	Not Supported
Address3	Not Supported	Not Supported	Not Supported
City	Not Supported	Not Supported	Not Supported
State	Not Supported	Not Supported	Not Supported	State name. This element will be changed to <StateName>, and <StateCode> element will be added to indicate the state code.
PostalCode	Not Supported	Not Supported	Not Supported
Province	Not Supported	Not Supported	Not Supported
Country	Not Supported	Not Supported	Not Supported	Country name for address. This element will be changed to <CountryName> and <CountryCode> will be added to indicate the country code.
Phone	Not Supported	Not Supported	Not Supported
Fax	Not Supported	Not Supported	Not Supported
Website	Not Supported	Not Supported	Not Supported
Blog	Not Supported	Not Supported	Not Supported

CustomField XML Elements Specification

Element Name	Allowed Values	Editable?	Required on POST?	Required on PUT?	Notes
Question		Not Supported	Not Supported	Not Supported	The question text as defined in the registration form
Answer		Not Supported	Not Supported	Not Supported	Answer to the question as given by the registrant. There will be more than one <Answer> element if the question was a multi-choice. If the question was a date question, the value will be in the Atom time format in UTC.

Cost XML Elements Specification

Element Name	Editable?	Required on POST?	Required on PUT?	Notes
Count	Not Supported	Not Supported	Not Supported	Number of registrants/guests who paid this particular fee type
FeeType	Not Supported	Not Supported	Not Supported	Type of the fee as defined on the registration form
Rate	Not Supported	Not Supported	Not Supported	Fee per person
Total	Not Supported	Not Supported	Not Supported	Total amount for this particular fee type

Registrants Collection and Resource

Request Format

Required Headers

Response Format

Registrant Resource

Required Headers

Response Format

URI Format

Registrant Data XML Elements Specifications

PersonalInformation XML Elements Specification

BusinessInformation XML Elements Specification

CustomField XML Elements Specification

Cost XML Elements Specification

Learning & Resources

Social Media

Call-To-Action Links

Welcome Your Audience