GetEnrollmentInfo

Gets information about the pre-session form that attendees fill in
before they join a WebEx session. This API works for Event Center and
Support Center.

Note Attendee enrollment status, IP address, hostname for IP, and
registration submit time are only returned in EC sessions.

Request

The following schema diagram shows the structure of the elements in the
getEnrollmentInfo request message.

Figure 11-5 • Schema diagram for getEnrollmentInfo

Note One WebEx session may have multiple sub-sessions (different
confID) for the same session key.

The sample XML document gets enrollment information with a
specified conference ID.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>host</webExID>
            <password>123456</password>
            <siteName>testsite</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.attendee.GetEnrollmentInfo">
            <sessionKey>987566789</sessionKey>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the
header, see Global Request Elements in Security Context. For
descriptions of the non global elements, refer to “Elements in WebEx XML
Schema Definitions for the Meeting Attendee Service”.

Response

The following schema diagram shows the structure of the elements in the
getEnrollmentInfoResponse message.

Figure 11-6 • Schema diagram for getEnrollmentInfoResponse

Figure 11-7 • Schema diagram for getEnrollmentInfoResponse

The sample XML document shows an example of a possible response to the
preceding request document.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xmlns:com="http://www.webex.com/schemas/2002/06/common"
    xmlns:att="http://www.webex.com/schemas/2002/06/service/attendee">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="att:getEnrollmentInfoResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <att:session>
                <att:confID>62916711</att:confID>
                <att:attendee>
                    <att:attendeeID>1697762</att:attendeeID>
                        <att:enrollFields>
                            <att:defaultFields>
                                <att:firstName>test</att:firstName>
                                <att:lastName>test</att:lastName>
                                <att:email>test@webex.com</att:email>
                                <att:company>webex</att:company>
                                <att:phoneNum>1,,6565,,,</att:phoneNum>
                                <att:title>sales</att:title>
                                <att:numEmployees>1-99</att:numEmployees>
                                <att:receiveInfo>false</att:receiveInfo>
                                <att:address1>longshan load</att:address1>
                                <att:address2>district</att:address2>
                                <att:city>suzhou</att:city>
                                <att:state>Jiangsu</att:state>
                                <att:zipcode>215000</att:zipcode>
                                <att:country>United States of America</att:country>
                                <att:leadSourceID />
                                <att:leadScore>0.0</att:leadScore>
                            </att:defaultFields>
                            <att:customFields />
                        </att:enrollFields>
                        <att:domain>aggen.webex.com</att:domain>
                        <att:ipAddress>172.16.250.4</att:ipAddress>
                        <att:submitTime>10/10/2007 01:44:55</att:submitTime>
                        <att:status>APPROVED</att:status>
                    </att:attendee>
                    <att:attendee>
                        <att:attendeeID>63</att:attendeeID>
                        <att:enrollFields>
                            <att:defaultFields>
                                <att:firstName>fname</att:firstName>
                                <att:lastName>lname</att:lastName>
                                <att:email>honjozz@sz.webex.com</att:email>
                                <att:company>compay a</att:company>
                        </att:defaultFields>
                        <att:customFields>
                            <att:field>
                                <att:label>Phone2</att:label>
                                <att:value>12345678</att:value>
                            </att:field>
                            <att:field>
                                <att:label>JasonCheck</att:label>
                                <att:value/>
                            </att:field>
                            <att:field>
                                <att:label>JaSCDrop</att:label>
                                <att:value/>
                            </att:field>
                        </att:customFields>
                    </att:enrollFields>
                </att:attendee>
                <att:matchingRecords>
                    <serv:total>2</serv:total>
                    <serv:returned>2</serv:returned>
                    <serv:startFrom>1</serv:startFrom>
                </att:matchingRecords>
            </att:session>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The result and exceptionID global elements allow you to confirm that
an instantiation request was successful. These elements are described in
“Global Response Elements Showing Results and Errors”.