LogoffUser()

Abstract

The LogoffUser() API function is an XmlHttp function to end a user’s session.  This will clear the security token from the user’s database record forcing them to logon again in order to regain access to the data.

API Address

https://api.tracker-rms.com/WebAPI/XmlHttpLogoffUser.aspx

Request Format

The input format XML for this function is as follows:

<?xml version="1.0"?>
<TrackerRMS>
    <WebAPI>
        <LogoffUser>
            <UserCredentials>
                <SecurityToken></SecurityToken>
                <Username></Username>
                <Password></Password>
            </UserCredentials>
        </LogoffUser>
    </WebAPI>
</TrackerRMS>
Parameter Notes
<SecurityToken> This will be the 40 character security token obtained from the LogonUser() function
<Username> The username is typically the email address for the user in the format name@domain.com
<Password> The password will be the same as their web based password and can contain a combination of upper case, lower case and alpha-numeric characters

Response Format

The function will return the standard RequestStatus section (see RequestStatus section) depending on the success of the API call with 0 (zero) signifying a successful logoff.

<?xml version="1.0"?>
<TrackerRMS>
    <WebAPI>
        <RequestStatus>
            <ReturnCode></ReturnCode>
            <ReturnDescription></ReturnDescription>
            <ReturnRecordCount></ReturnRecordCount>
        </RequestStatus>
    </WebAPI>
</TrackerRMS>

Leave A Comment?