GetloginTicket

Returns a host authentication ticket, which is a temporary identifier
string associated with a host.

The ticket is typically used with the URL API login command for user
authentication: an integration first calls GetLoginTicket to obtain the
ticket string, and then calls the URL API p.php?AT=LI with TK=
to authenticate the host.

Note This XML API will generate and return a new ticket for a host
if there is no ticket available or that the last ticket has been used up
by the host. This XML API is also allowed to be called by attendeeonly
accounts that do not have session hosting privileges.

Request

The sample XML document shows an example request for a login ticket.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>hostname@acme.com</webExID>
          <password>P@ssword123</password>  
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.user.GetLoginTicket">
        </bodyContent>
    </body>
</serv:message>

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

Collapse Figure 3-10 • Schema diagram of `getloginTicket`
Drilldown into bodyContentTypeXSD Diagram of getLoginTicket

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, see Elements in WebEx XML Schema Definitions for the User 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:use="http://www.webex.com/schemas/2002/06/service/user">
        <serv:header>
            <serv:response>
                <serv:result>SUCCESS</serv:result>
                <serv:gsbStatus>BACKUP</serv:gsbStatus>
            </serv:response>
        </serv:header>
        <serv:body>
            <serv:bodyContent xsi:type="use:getLoginTicketResponse"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <use:ticket>5e9733eb9efeb02d80aa0551ef7e9ccd</use:ticket>
                <use:apiVersion>WebEx XML API V8.0.0</use:apiVersion>
            </serv:bodyContent>
        </serv:body>
</serv:message>

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

Collapse XSD Schema Diagram of `getloginTicketResponse`
Drilldown into apiVersion Drilldown into ticket Drilldown into bodyContentTypeXSD Diagram of getLoginTicketResponse

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”.