Login

Top  Previous  Next

SOAP

Login( aUserGroupName, aUserLogin, aPassword, 

           &aHandle, &aErrorMsg );

 

REST

/Login?UserGroup=<Value>&UserLogin=<Value>&Password=<Value>

Returns: Handle,ErrorMsg

 

Description: Login() Creates an entry in the login table indicating that this user is accessing the system.  No other systems may access this login until Logout() is called.

 

aUserGroupName The name of the group that the specified Login is a member of.

aUserLogin The account to login as.

aPassword Password for the specified login, in the specified group.  The password field may be encrypted based on the encryption defined for the specified user group.

&aHandle is populated when this function returns successfully.  It contains an encrypted token that identifies this login.  Keep this token for all future calls, and for logging out.

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