Get event participants
Added by IBM contributorIBM | Edited by IBM contributorAnna G O'Neal on May 23, 2012
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Get and post details about the people who are registered for the event, including names, email addresses, registration status, and more.



Get and post details about the people who are registered for the event, including names, email addresses, registration status, and more.

Table 1. API details
MethodResource addressOutput representation
GET or POSTFor JavaScript™ Object Notation (JSON) output, use https://apps.lotuslive.com/meetings/api/getEventParticipants

For Atom (XML) output, use https://apps.lotuslive.com/meetings/api/xml/getEventParticipants
JSON or Atom (XML) format


Use the following input parameters:

Table 2. Input parameters
ParameterDescription
returnTypeSet the value to xml to change the default response type from a JSON string to an Atom feed in XML format. Example URL: https://apps.lotuslive.com/meetings/api/getEventParticipants?event=eventID&status=status&returnType=xml.
eventSet the value to the unique ID for the event. Example URL: https://apps.lotuslive.com/meetings/api/getMeetingSummary?event={uniqueID].
statusSet the value to the registration status of the user. Possible values include all, approved, denied, participated, and undefined. Example URL: https://apps.lotuslive.com/meetings/api/getMeetingSummary?status=approved.


Inputs

None.

Outputs

Details about the meeting are returned in JSON or Atom format.

Response codes

200
The response is successful.
Examples

The JSON response successfully returned details about event:

{ "status": "ok",
  "results": {
     "registrations":  [{
         "isparticipated":false,
         "isapproved":true,
         "registrationfields":  [{
              "value":"Another one",
              "label":"",
              "type":"text",
              "id":"name",
              "order":1
         },
         {
              "value":"test@gmail.com",
              "label":"", 
              "type":"email",
              "id":"email",
              "order":2}],
         "registrationid":"43e4f821a251dc0c8dac743024ad4f4b07e442f5",
         "isconfirmed":true,
         "isdenied":false,
         "confirmationstatus":false,
         "eventhash":"be490b9ea8",
         "isbrowserchecked":false}]
}


The JSON response did not return any details about the event:

{
    "status":"error", 
    "details": "NO DATA RETURNED FROM DATABASE"
}


The Atom feed response successfully returned details about the event:

<?xml version='1.0' encoding='UTF-8'?>
<feed xmlns="http://www.w3.org/2005/Atom">
 <id>Event_Participant_ID</id>
 <title type="text">Event Participant Details</title>
 <updated>2011-09-28T11:13:44.711Z</updated>
 <author>
 <name>LotusLive</name>
 </author>
 
 <entry>
 <id>EventParticipant_Entry_eventID</id>
 <title type="text">eventID</title>
 <content type="text">be490b9ea8</content>
 </entry>
 <entry>
 <id>EventParticipant_Entry_participants</id>
 
 <title type="text">participants</title>
 <content type="xhtml">
 <div xmlns="http://www.w3.org/1999/xhtml">
 <RESULTS>
 
 <REGISTERATIONS>
 
 <REGISTRATION confirmationstatus="false" eventhash="be490b9ea8" isapproved="true" isbrowserchecked="false" isconfirmed="true" isdenied="false" isparticipated="false" registrationid="43e4f821a251dc0c8dac743024ad4f4b07e442f5">
 
 <REGISTRATIONFIELDS>
 
 <REGISTRATIONFIELD id="name" label="" order="1" type="text" value="Another one" />
 
 <REGISTRATIONFIELD id="email" label="" order="2" type="email" value="test@gmail.com" />
 
 <REGISTRATIONFIELD id="position" label="" order="3" type="text" value="" />
 
 <REGISTRATIONFIELD id="company" label="" order="4" type="text" value="" />
 
 <REGISTRATIONFIELD id="address" label="" order="5" type="text" value="" />
 
 <REGISTRATIONFIELD id="city" label="" order="6" type="text" value="" />
 
 <REGISTRATIONFIELD id="state" label="" order="7" type="text" value="" />
 
 <REGISTRATIONFIELD id="zip" label="" order="8" type="text" value="" />
 
 <REGISTRATIONFIELD id="country" label="" order="9" type="text" value="" />
 
 <REGISTRATIONFIELD id="phone" label="" order="10" type="tel" value="" />
 
 <REGISTRATIONFIELD id="fax" label="" order="11" type="tel" value="" />
</REGISTRATIONFIELDS>
</REGISTRATION>
</REGISTERATIONS>
</RESULTS>
 </div>
 </content>
 </entry>
</feed>


The Atom feed response did not return any details about the event:

<?xml version='1.0' encoding='UTF-8'?>
<id>Event_Participant_ID</id>
 <title type="text">Event Participant Details</title>
 <updated>2011-09-28T11:20:19.423Z</updated>
 <author>
 <name>LotusLive</name>
 </author>
 
 <entry>
 <id>EventParticipant_Entry_eventID</id>
 <title type="text">eventID</title>
 <content type="text">be490b9ea80</content>
 </entry>
 <entry>
 <id>EventParticipant_Entry_error</id>
 
 <title type="text">error</title>
 <content type="xhtml">
 <div xmlns="http://www.w3.org/1999/xhtml">
 <ERROR description="NO DATA RETURNED FROM DATABASE" number="0" />
 </div>
 </content>
 </entry>
</feed>


Parent topic: Meetings APIs