TrackRecordPro API Documentation TrackRecordPro

loginUser()

Summary

Method Name

LoginUser

Minimum Supported API Version3.0

loginUser

$result = loginUser($username, $password)

Details

If you are using impersonation for authentication, this allows you to obtain a session ID for a user given their username and password. If successful, the method sets the current user's session token which can be obtained from the getSessionID() method. You should re-use this session token on further calls, rather than logging in for each call. The returned session token is valid for 24 hours after its last use.

Parameters

$usernameThe user name to authenticate with
$passwordThe password associated with the user

Return value

There is no return value, but a failed login attempt will throw a LoginException.