getUser_v3

Retrieves information about the specified user. You can see this information in the Rescue Administration Center by selecting a user in the organization tree.

Changes in Version 3 of getUser

The following has been introduced in the getUser_v3 method:

email has been added as new input parameter.

Input Parameters

Element	Description
`node`	The ID of the user whose details you want to retrieve. Required. Important: You must use either the `node` or the `email` parameter to retrieve user information.
`email`	The email address of the user whose details you want to retrieve. Required. Important: You must use either the `node` or the `email` parameter to retrieve user information.
`authcode`	The secret authentication code that is used to authenticate the user without logging in to Rescue. Optional.

Output

OK NODEID: 337366 NAME: John Doe NICK: EMAIL: jdoe@company.com SSOID: DESCRIPTION: 
TYPE: Technician HASMOBILEADDON: False HASRPATADDON: True ISACCOUNTHOLDER: True STATUS: Online

NODEID: ID of the user whose information you want to retrieve
NAME: Username
NICK: Nickname of the user
EMAIL: User's email
SSOID: Single Sign On ID of the user
DESCRIPTION: User's description
TYPE: Type of the user, which is either Technician, Administrator, or MasterAdministrator
HASMOBILEADDON: Displays whether the user has mobile addon
HASRPATADDON: Displays whether the user has RPAT addon
ISACCOUNTHOLDER: Displays whether the user is an account holder
STATUS: Status of the user

Return Values

Displayed Return Value	Description
`ERROR`	An unspecified error occurred, such as timeout.
`OK`	Retrieving information about a user succeeded.
`NOTLOGGEDIN`	Retrieving information about a user failed because the current user is no longer logged in.
`INVALIDPARAM_NODE`	The specified ID is not the ID of an existing user.
`INVALID_SECRETAUTHCODE`	The secret authentication code for the user is invalid.
`USER_DELETED_OR_DISABLED`	The user is deleted or disabled.

Sample Code

The following are examples for using the getUser_v3 method that you can call in your environment.

HTTP GET

https://secure.logmeinrescue.com/API/getUser_v3.aspx?email=jdoe@company.com
&authcode=4ahx...80u0

HTTP POST

<form method="post" action="https://secure.logmeinrescue.com/API/getUser_v3.aspx">
        <input name="email" value="jdoe@company.com">
        <input name="authcode" value="4ahx...80u0">
</form>

C# with SOAP

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using apiSamples.WebServiceClients;

namespace apiSamples
{
    public partial class SOAP : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            try
            {
                //Set up proxy
                WebServiceClients.API proxy = new WebServiceClients.API();
                proxy.CookieContainer = new CookieContainer();

                string sEmail = "some@email.com";
                string sPwd = "secretPassword";
                string sAuthCode = "4ahx...80u0";

                //Login
                WebServiceClients.loginRet loginResult = proxy.login(sEmail, sPwd);
                Response.Write(loginResult + "<br />");

                int iNodeID = [ID of node in which information is being retrieved];
                User_V2 oUserV2 = new User_V2();

                //Get user data
                WebServiceClients.getUserRet_v2 createResult = proxy.getUser_v3(iNodeID, sAuthCode, out oUserV2);
                Response.Write(createResult + oUserV2.sName + oUserV2.sEmail [etc...]);
            }
            catch (Exception ex)
            {
                lblError.Text = ex.Message;
            }
        }

    }

}