Event participants list

Get Event Participants List 

This API can be used to get list of event participants. The returned data contains full details including attendance status for each participantt. The API is a restrictive one and can be called by an admin of the site only. Any other user trying to invoke this API would result in an error being returned by the API.

API Details

Signature of API call

connection.invokeApi(String uri, String realUserName, Map<String, String> requestParameters);

See details about invoking API in general

 

Parameter 1 - URI

reportService.do

 

Parameter 2 - UserName

Username of any site administrator

 

Parameter 3 - Request Parameters

Name Value
dispatch

listEventParticipants

optional parameters
courseSessionId for a specific course session id
eventId for a specific event (scheduled exam)
userGroupId Group Id of the group for which to fetch the learners data
userSearchStr matching username, first/last name, email

fetchCustomProps

Boolean value to indicate if custom properties need to be fetched.
fromDate event start or end date from 
toDate event start or end date to
attended true | false - return only attended participants 
waitlisted true | false - return only waitlisted participants
search search for username, first name, last name or email of the learner
ownerId user id of the event owner (host / instructor)
ownerName search for username, first name, last name or email of the event owner
Paging parameters
currPage page number to fetch, must be specified for 2nd page onwards. Value of currPage starts with 0. So for page 2 specify currPage = 1
numItems total records in the list, must be specified for 2nd page onwards. You can get the count of records from response of first page. then pass it as-is in subsequent pages.
pageSize Number of items in a page

All date parameters are numbers, represented as epoch time in milliseconds - number of milliseconds that have elapsed since January 1, 1970 (midnight UTC/GMT),

Date filtering note - by default, date filters are converted to BOD and EOD (e.g. from date is converted to beginning of the day and to date is converted to end of day while applying the filtering criteria (similar to report screens in application). If you like to perform exact filtering on the passed date time, then set API_REPORT_USE_EXACT_TIME=true in Site Admin->Site Details->Customization. 

Response

1. Response on successfully getting results

HTTP Response Code = HttpServletResponse.SC_OK

Response XML

<response code="0">
    <msgs>
        <msg>
            <code>0</code>
            <value>
                <![CDATA[ Success ]]>
            </value>
        </msg>
    </msgs>
    <data>
        <eventSubscriptions numItems="70" currPage="0"
            pageSize="10">
            <eventSubscription
                id="7a4c358a-367b-11e9-ad7d-a226d5b92073" eventId="" eventItemId=""
                attended="false" waitlisted="false">
                <userId>43823a7e-304e-11e8-adcc-463742a6786a</userId>
                <firstName><![CDATA[ user1 ]]></firstName>
                <lastName><![CDATA[ Doe ]]></lastName>
                <userName><![CDATA[ k44a*user1 ]]></userName>
                <status>ACTIVE</status>
                <eventName><![CDATA[ My Meeting1 ]]></eventName>
                <startDate>1551387600000</startDate>
                <endDate>1551391200000</endDate>
                <joinedDate>1550823957000</joinedDate>
            </eventSubscription>
            <eventSubscription
                id="370ce0da-15d3-11e9-b206-bf9edb6d9295" eventId="" eventItemId=""
                attended="false" waitlisted="false">
                <userId>10be8cb4-7eaa-11e8-81ab-4891014e86b7</userId>
                <firstName><![CDATA[ c1admin ]]></firstName>
                <lastName><![CDATA[ c1admin ]]></lastName>
                <userName><![CDATA[ k44a*c1admin ]]></userName>
                <status>ACTIVE</status>
                <eventName><![CDATA[ future Event 4.1 ]]></eventName>
                <startDate>1547837940000</startDate>
                <endDate>1555610640000</endDate>
                <joinedDate>1547233251000</joinedDate>
            </eventSubscription>
            <eventSubscription
                id="3710c2d6-15d3-11e9-b206-bf9edb6d9295" eventId="" eventItemId=""
                attended="true" waitlisted="false">...</eventSubscription>
            <eventSubscription
                id="3712adda-15d3-11e9-b206-bf9edb6d9295" eventId="" eventItemId=""
                attended="false" waitlisted="false">...</eventSubscription>
            <eventSubscription
                id="3715de10-15d3-11e9-b206-bf9edb6d9295" eventId="" eventItemId=""
                attended="false" waitlisted="false">...</eventSubscription>
            <eventSubscription
                id="2dd09bce-15d3-11e9-b206-bf9edb6d9295" eventId="" eventItemId=""
                attended="true" waitlisted="false">...</eventSubscription>
            <eventSubscription
                id="2dd39f4a-15d3-11e9-b206-bf9edb6d9295" eventId="" eventItemId=""
                attended="true" waitlisted="false">...</eventSubscription>
            <eventSubscription
                id="42a6baae-b9d2-11e8-83d5-f13a4fde6b7d" eventId="" eventItemId=""
                attended="false" waitlisted="false">...</eventSubscription>
            <eventSubscription
                id="42a7cbe2-b9d2-11e8-83d5-f13a4fde6b7d" eventId="" eventItemId=""
                attended="false" waitlisted="false">...</eventSubscription>
            <eventSubscription
                id="42a90084-b9d2-11e8-83d5-f13a4fde6b7d" eventId="" eventItemId=""
                attended="false" waitlisted="false">...</eventSubscription>
        </eventSubscriptions>
    </data>
</response>

2. Response for unauthorized access

HTTP Response Code = HttpServletResponse.SC_UNAUTHORIZED

Response XML

<response code="-1">

    <msgs>

         <msg>

             <code>0005</code>

             <value><![CDATA[You are not allowed to perform this action.]]></value>

         </msg>

    </msgs>

</response>

 

Code Snippet

       /*  Check API Call for detail generic code */
    Map<String, String> parameters = new HashMap<String, String>();
    parameters.put("dispatch", "listEventParticipants");    
    String retStr = connection.invokeApi("reportService.do", "chenry", parameters);
    System.out.println(retStr);


Rating: