GetLabInfo

Allows you to get the general information of a Hands-on Lab, so that you
can reserve an appropriate number of lab computers for your training sessions. If labName is
unspecified, the request returns information for all labs configured on the site.

Request

The sample XML document retrieves the information of a Hands-on Lab named “Jill's lab for xml”. Be sure to provide a valid value for the Hands-on Lab of your website.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>
            <siteID>0000</siteID>
            <partnerID>9999</partnerID>
            <email>johnsmith@xyz.com</email>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.training.GetLabInfo">
            <labName>Jill's lab for xml</labName>
        </bodyContent>
    </body>
</serv:message>

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

Collapse Figure 6-22 • Schema diagram for `getLabInfo`
Drilldown into labNameDrilldown into labIDDrilldown into bodyContentTypeXSD Diagram of getLabInfo

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

Response

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:sess="http://www.webex.com/schemas/2002/06/service/session"
    xmlns:train="http://www.webex.com/schemas/2002/06/service/trainingsession"
    xmlns:qti="http://www.webex.com/schemas/2002/06/service/trainingsessionqti"
    xmlns:qtiasi=
    "http://www.webex.com/schemas/2002/06/service/trainingsessionqtiasi">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="train:getLabInfoResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:labInfo>
                <train:labName>Jill's lab for xml</train:labName>
                <train:description>Test Lab description.</train:description>
                <train:totalComputers>1</train:totalComputers>
                <train:computersInSession>0</train:computersInSession>
            </train:labInfo>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The following schema diagram shows the structure of the elements in a getLabInfoResponse response message.

Collapse Figure 6-23 • Schema diagram for `getLabInfoResponse`
Drilldown into labInfo Drilldown into bodyContentTypeXSD Diagram of getLabInfoResponse

The result and exceptionID global elements allow you to confirm that an instantiation request was successful.
See Global Response Elements Showing Results and Errors.