CurrentLogins

Top  Previous  Next

SOAP

CurrentLogins( aHandle, &aLoginListXML, &aErrorMsg );

 

REST

/CurrentLogins&Handle=<Value>

returns LoginListXML, ErrorMsg );

 

Description: CurrentLogins() Lists all currently logged in accounts in the system.  The logins are provided in an XML  format.  

 

aHandle The value created in the call to Login().

&aLoginList The resulting list of logins. The output XML will look like this:

<CurrentLogins>

  <Login SessionId="dkeis8d7d7s">

    <Name>Pete</Name>

    <UserGroupId>4</UserGroupId>

    <UserId>1</UserId>

    <MachineName>Wizard</MachineName>

  </Login>

  <Login SessionId="dkedd899d7x">

    <Name>Scott</Name>

    <UserGroupId>4</UserGroupId>

    <UserId>2</UserId>

    <MachineName>Wizard</MachineName>

  </Login>

</CurrentLogins>

&aErrorMsg is populated only if an error occurred that prevented the function from succeeding.  Otherwise, this parameter is empty.

 

Example: CurrentLogins( lHandle, lLogins, lErrorMsg );