---
title: "API: getUserWithRoleDetail"
slug: "api-getuserwithroledetail"
tags: ["home groups"]
updated: 2022-09-20T19:34:07Z
published: 2022-09-20T19:34:07Z
canonical: "support.smarteru.com/api-getuserwithroledetail"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.smarteru.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API: getUserWithRoleDetail

- SmarterU requires all API calls to POST to HTTPS. Any POST to HTTP will result in the SU:01 error (i.e., No POST data detected.).
- If you are viewing the help in a language other than English, please change your language to English before copying and pasting any code. All API attributes and functions are in English.
- Tags are required unless specified.

## Description

The getUserWithRoleDetail method retrieves a [user's learning plans](/v1/docs/user-learning-plans-and-certifications).

[Learning Plans](https://support.smarteru.com/docs/learning-plans) were previously referred to as *roles*. 

## Who Has Access

The following users have access to the getUserWithRoleDetail method:

- Users with the [Group Managers](/v1/docs/group-permission-group-manager-gm), [Manage Group Users](/v1/docs/group-permission-manage-group-users-mgu), or [Manage Users](/v1/docs/group-permission-manage-users-mu) group permission.
- [Administrators and owners](/v1/docs/user-profile-information#access-level).

## API Call XML Package

```markup
<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>getUserWithRoleDetail</Method>
   <Parameters>
      <User>
         <AccountUserRelID><![CDATA[]]></AccountUserRelID>
            - OR -
         <Email><![CDATA[]]></Email>
            - OR -
         <EmployeeID><![CDATA[]]></EmployeeID>
      </User>
   </Parameters>
</SmarterU>
```

## **User Tag Group**

The User tag group is a container for the user filters.

```markup
<User>
   <AccountUserRelID><![CDATA[]]></AccountUserRelID>
      - OR -
   <Email><![CDATA[]]></Email>
      - OR -
   <EmployeeID><![CDATA[]]></EmployeeID>
</User>
```

The User tag contains one of the following.

### AccountUserRelID

The user's system-generated identifier. This tag is mutually exclusive with the [Email](/v1/docs/api-getuserwithroledetail#email) and [](https://help.smarteru.com/api-getuserwithroledetail$user_EmployeeId)[EmployeeID](/v1/docs/api-getuserwithroledetail#employeeid) tags. This is the ID returned by the [getUser](/v1/docs/api-getuser) and [listUsers](/v1/docs/api-listusers) methods.

### Email

The [user's email address](/v1/docs/user-login-information#primary-email-required-if-employee-id-not-specified). This tag is mutually exclusive with the [AccountUserRelID](/v1/docs/api-getuserwithroledetail#accountuserrelid) and [EmployeeID](/v1/docs/api-getuserwithroledetail#employeeid) tags. This is the Email returned by the [getUser](/v1/docs/api-getuser) and [listUsers](/v1/docs/api-listusers) methods.

### EmployeeID

The [user's employee ID](/v1/docs/user-login-information#employee-id-required-if-primary-email-not-specified). This tag is mutually exclusive with the [AccountUserRelID](/v1/docs/api-getuserwithroledetail#accountuserrelid) and [Email](/v1/docs/api-getuserwithroledetail#email) tags. This is the EmployeeID returned by the [getUser](/v1/docs/api-getuser) and [listUsers](/v1/docs/api-listusers) methods.

## API Response XML Package

The [API response XML package](/v1/docs/api-response-xml-package) will always include a Result, Info, and [Errors](/v1/docs/api-getuserwithroledetail#error-codes) tag.

```markup
<SmarterU>
   <Result></Result>
   <Info>
      <User>
         <ID><![CDATA[]]></ID>
         <Email><![CDATA[]]></Email>
         <EmployeeID><![CDATA[]]></EmployeeID>
         <CreatedDate><![CDATA[]]></CreatedDate>
         <ModifiedDate><![CDATA[]]></ModifiedDate>
         <GivenName><![CDATA[]]></GivenName>
         <Surname><![CDATA[]]></Surname>
         <Language><![CDATA[]]></Language>
         <AllowFeedback><![CDATA[]]></AllowFeedback>
         <Status><![CDATA[]]></Status>
         <AuthenticationType><![CDATA[]]></AuthenticationType>
         <Timezone><![CDATA[]]></Timezone>
         <AlternateEmail><![CDATA[]]></AlternateEmail>
         <HomeGroup><![CDATA[]]></HomeGroup>
         <Organization><![CDATA[]]></Organization>
         <Title><![CDATA[]]></Title>
         <Division><![CDATA[]]></Division>

         <Supervisors>
            <Supervisor><![CDATA[]]></Supervisor>
         </Supervisors>

         <PhonePrimary><![CDATA[]]></PhonePrimary>
         <PhoneAlternate><![CDATA[]]></PhoneAlternate>
         <PhoneMobile><![CDATA[]]></PhoneMobile>
         <SendMailTo><![CDATA[]]></SendMailTo>
         <SendEmailTo><![CDATA[]]></SendEmailTo>
         <Fax><![CDATA[]]></Fax>
         <Address1><![CDATA[]]></Address1>
         <Address2><![CDATA[]]></Address2>
         <City><![CDATA[]]></City>
         <PostalCode><![CDATA[]]></PostalCode>
         <Province><![CDATA[]]</Province>
         <Country><![CDATA[]]></Country>
         <SendWeeklyTaskReminder><![CDATA[]]></SendWeeklyTaskReminder>
         <SendWeeklyProgressSummary><![CDATA[]]></SendWeeklyProgressSummary>

         <Teams>
            <Team><![CDATA[]]></Team>
         </Teams>

         <Roles>
            <Role>
               <Name><![CDATA[]]></Name>
               <RoleID><![CDATA[]]><RoleID/>
            </Role>
         </Roles>

         <CustomFields>
            <CustomField type="">
               <Name><![CDATA[]]></Name>
               <Value><![CDATA[]]></Value>
            </CustomField>
         </CustomFields>

         <Venues>
            <Venue>
               <Name><![CDATA[]]</Name>
               <Visibility><![CDATA[]]</Visibility>
               <AutoWaitingList><![CDATA[]]</AutoWaitingList>
            </Venue>
         </Venues>

         <Wages>
         </Wages>

         <ReceiveNotifications><![CDATA[]]</ReceiveNotifications>
      </User>
   </Info>

   <Errors>
      <Error>
         <ErrorID></ErrorID>
         <ErrorMessage></ErrorMessage>
      </Error>
   </Errors>
</SmarterU>
```

The User tag is a container for the user's learning plans returned by the getUserWithRoleDetail method and may contain the following.

### ID

The user's system-generated identifier.

### Email

The [user's email address](/v1/docs/user-login-information#primary-email-required-if-employee-id-not-specified).

### EmployeeID

The [user's employee ID](/v1/docs/user-login-information#employee-id-required-if-primary-email-not-specified).

### CreatedDate

The date the user was [created](/v1/docs/adding-a-user-manually).

### ModifiedDate

The date the user was last [edited](/v1/docs/editing-a-user-manually).

### **GivenName**

The [user's first name](/v1/docs/user-login-information#given-names-required).

### **Surname**

The [user's last name](/v1/docs/user-login-information#surname-required).

### **Language**

The [language](/v1/docs/user-login-information#language) used for the user's account.

### **AllowFeedback**

Indicates whether the user can [provide feedback on online course tasks](https://support.smarteru.com/v1/docs/user-login-information#allow-feedback):

- *1* - The user can provide feedback on online course tasks.
- *0* - The user cannot provide feedback on online course tasks.

### Status

The [user's status](/v1/docs/user-login-information#status):

- *Active* - The user account may be used to access SmarterU.
- *Inactive -* The user account may not be used to access SmarterU.

### AuthenticationType

Indicates [how you would like the user to authenticate](https://support.smarteru.com/v1/docs/user-login-information#user-default-login):

- *SmarterU* - The user will log into SmarterU via the SmarterU interface.
- *External* - The user will log into SmarterU via an external system using [single-sign on](https://support.smarteru.com/v1/docs/external-authorization-sso).
- *Both* - The user will log into SmarterU via the SmarterU interface or an external system.

### TimeZone

The user's primary [time zone](https://support.smarteru.com/v1/docs/user-login-information#timezone-required).

### AlternateEmail

The [user's alternate email address](https://support.smarteru.com/docs/user-login-information#send-email-to).

### HomeGroup

The name of the user's [home group](/v1/docs/home-groups).

### Organization

The [name of the user's organization](/v1/docs/user-profile-information#organization).

### Title

The [user's title](/v1/docs/user-profile-information#title).

### Division

The [user's division](https://support.smarteru.com/v1/docs/user-profile-information#division).

### Supervisors

A container for [the user's supervisors](/v1/docs/user-profile-information#supervisors) [](https://help.smarteru.com/user-profile-information$setting_supervisor).

```markup
<Supervisors>
   <Supervisor><![CDATA[]]></Supervisor>
</Supervisors>
```

Each supervisor is contained in a Supervisor tag and contains the following.

| Tag | Description |
| --- | --- |
| **Supervisor** | The supervisor's email address. |

### PhonePrimary

The [user's primary phone number](/v1/docs/user-contact-information#phone-primary).

### PhoneAlternate

The [user's alternate phone number](/v1/docs/user-contact-information#phone-alternate).

### PhoneMobile

The [user's mobile phone number](/v1/docs/user-contact-information#phone-mobile).

### SendMailTo

Indicates [where the user's physical mail should be sent](/v1/docs/user-contact-information#send-physical-mail-to):

- *Personal -* The user's physical mail should be sent to their [personal address](https://support.smarteru.com/v1/docs/user-contact-information#address-line-1).
- *Organization -* The user's physical mail should be sent to their [organization's address](https://support.smarteru.com/docs/organization-contact-information#address-line-1).

### SendEmailTo

Indicates [where the user's emails should be sent](https://support.smarteru.com/v1/docs/user-login-information#send-email-to):

- *Supervisor* -  Emails to the user will be sent to the supervisors' email addresses. If the user has multiple supervisors, emails will be sent to all of the user's supervisors. A [supervisor](https://support.smarteru.com/v1/docs/user-profile-information#supervisors) must have a primary email address specified for this option to be allowed.
- *Self*  - Emails to the user are sent to the user's primary email address. An [email address](https://support.smarteru.com/v1/docs/api-updateuser#email-optional) must be provided for this option to be allowed.
- *Alternate* - Emails to the user will be sent to the email address specified in the AlternateEmail tag. For this option to be allowed, a valid email address must be provided in the AlternateEmail tag.

### Fax

The [user's fax number](/v1/docs/user-contact-information#fax).

### Address1

The [first line of the user's address](/v1/docs/user-contact-information#address-line-1).

### Address2

The [second line of the user's address](/v1/docs/user-contact-information#address-line-2).

### City

The [city of the user's address](/v1/docs/user-contact-information#city).

### PostalCode

The [postal code of the user's address](/v1/docs/user-contact-information#postalzip-code).

### Province

The [province or state of the user's address](/v1/docs/user-contact-information#region). This is the [full name of the province or state](/v1/docs/api-call-province-and-state-names-1).

### Country

The [country of the user's address:](/v1/docs/user-contact-information#country)

- *Canada*
- *United States*
- *International*

### SendWeeklyTaskReminder

Indicates [whether the user should receive weekly reminders](https://support.smarteru.com/v1/docs/user-contact-information#send-weekly-task-reminder) of their pending or outstanding courses in SmarterU:

- *1* - The user will receive weekly reminders.
- *0* - The user will not receive weekly reminders.

### SendWeeklyProgressSummary

Indicates [whether the user should receive weekly reports on the status of their supervisees](https://support.smarteru.com/v1/docs/user-contact-information#send-weekly-progress-summary):

- *1* - The user will receive weekly reports on their supervisees.
- *0* - The user will not receive weekly reports on their supervisees.

### Teams

A container for the [user's teams](/v1/docs/user-team-information). Each team name is contained in a Team tag.

### Roles

A container for the [user's learning plans](/v1/docs/user-learning-plans-and-certifications). Each learning plan is contained in a Role tag and contains the following.

| Tag | Description |
| --- | --- |
| **Name** | The [learning plan's name](https://support.smarteru.com/v1/docs/learning-plan-main#name). |
| **RoleID** | The [learning plan's user-specified identifier](https://support.smarteru.com/v1/docs/learning-plan-main#learning-plan-id). |

### CustomFields

A container for the [custom user fields](/v1/docs/account-custom-user-fields). Each custom user field is contained in a CustomField tag and contains the following.

| Tag | Description |
| --- | --- |
| **Name** | The [custom user field's name](https://support.smarteru.com/v1/docs/account-custom-user-fields#name). |
| **Value** | The custom user field's value. |

### Venues

A container for the [user's venues](/v1/docs/user-venues). Each venue is contained in a Venue tag and contains the following.

| Tag | Description |
| --- | --- |
| **Name** | The [venue's name](https://support.smarteru.com/docs/venue-main#name-required). |
| **Visibility** | Indicates whether the [venue is visible to the user by default](https://support.smarteru.com/v1/docs/user-venues): - *1* - The venue is visible to the user by default. - *0* - The venue is not visible to the user by default. |
| **AutoWaitingList** | Not yet implemented. |

### Wages

A container for the [user's wage information](/v1/docs/user-wage-information). Each wage is contained in a Wage tag and contains the following.

| Tag | Description |
| --- | --- |
| **WageID** | The system-generated internal identifier for the user's wage. |
| **EffectiveDate** | The [wage's effective date](/v1/docs/user-wage-information#effective-date). |
| HourlyWage | The [hourly wage](/v1/docs/user-wage-information#hourly-wage). |

### ReceiveNotifications

Indicates whether the user will [receive email notifications](/v1/docs/user-login-information#enable-email-notifications):

- *True* - The user will receive email notifications.
- *False -* The user will not receive email notifications.

### Example API Response XML Package

Below is an example of an API response XML package.

```markup
<SmarterU>
   <Result>Success</Result>
   <Info>
      <User>
         <ID><![CDATA[25365]]></ID>
         <Email><![CDATA[dana.brown@finashoes.com]]></Email>
         <EmployeeID><![CDATA[294]]></EmployeeID>
         <CreatedDate><![CDATA[2013-05-29 20:01:53.663]]></CreatedDate>
         <ModifiedDate><![CDATA[2018-03-09 16:03:45.487]]></ModifiedDate>
         <GivenName><![CDATA[Dana]]></GivenName>
         <Surname><![CDATA[Brown]]></Surname>
         <Language><![CDATA[English]]></Language>
         <AllowFeedback><![CDATA[0]]></AllowFeedback>
         <Status><![CDATA[Active]]></Status>
         <AuthenticationType><![CDATA[SmarterU]]></AuthenticationType>
         <Timezone><![CDATA[(GMT-6:00) - US/Central]]></Timezone>
         <AlternateEmail><![CDATA[cherry@intindi.com]]></AlternateEmail>
         <HomeGroup><![CDATA[Retail]]></HomeGroup>
         <Organization/>
         <Title><![CDATA[Store Manager]]></Title>
         <Division><![CDATA[Retail]]></Division>
 
         <Supervisors>
            <Supervisor><![CDATA[Vasquez, Maria]]></Supervisor>
         </Supervisors>

         <PhonePrimary><![CDATA[(855) 830-4800]]></PhonePrimary>
         <PhoneAlternate><![CDATA[(855) 133-3300]]></PhoneAlternate>
         <PhoneMobile><![CDATA[(855) 303-4011]]></PhoneMobile>
         <SendMailTo><![CDATA[Personal]]></SendMailTo>
         <SendEmailTo><![CDATA[Alternate]]></SendEmailTo>
         <Fax><![CDATA[(855) 830-4801]]></Fax>
         <Address1><![CDATA[449 Provencher Blvd]]></Address1>
         <Address2/>
         <City><![CDATA[Winnipeg]]></City>
         <PostalCode><![CDATA[MB R2J 0B8]]></PostalCode>
         <Province/>
         <Country><![CDATA[United States]]></Country>
         <SendWeeklyTaskReminder><![CDATA[1]]></SendWeeklyTaskReminder>
         <SendWeeklyProgressSummary><![CDATA[1]]></SendWeeklyProgressSummary>

         <Teams>
            <Team><![CDATA[Leadership]]></Team>
         </Teams>

         <Roles>
            <Role>
               <Name><![CDATA[Sales Associate]]></Name>
               <RoleID/>
            </Role>
            <Role>
               <Name><![CDATA[Employee]]></Name>
               <RoleID/>
            </Role>
            <Role>
               <Name><![CDATA[Store Manager]]></Name>
               <RoleID><![CDATA[LP-1020]]></RoleID>
            </Role>
         </Roles>

         <CustomFields>
            <CustomField type="Date">
               <Name><![CDATA[Community Service Date]]></Name>
               <Value><![CDATA[28-Jun-2013]]></Value>
            </CustomField>
            <CustomField type="String">
               <Name><![CDATA[Comm. Service Beneficiary]]></Name>
               <Value><![CDATA[Aspen Lake Animal Shelter]]></Value>
            </CustomField>
            <CustomField type="Date">
               <Name><![CDATA[Annual Review Date]]></Name>
               <Value><![CDATA[30-Sep-2013]]></Value>
            </CustomField>
            <CustomField type="Hierarchy">
               <Name><![CDATA[Location]]></Name>
               <Value><![CDATA[United States]]></Value>
            </CustomField>
         </CustomFields>

         <Venues>
            <Venue>
               <Name>Education Center - HQ</Name>
               <Visibility>0</Visibility>
               <AutoWaitingList>0</AutoWaitingList>
            </Venue>
            <Venue>
               <Name>Retail Location - Chicago</Name>
               <Visibility>0</Visibility>
               <AutoWaitingList>0</AutoWaitingList>
            </Venue>
            <Venue>
               <Name>Main Office</Name>
               <Visibility>1</Visibility>
               <AutoWaitingList>0</AutoWaitingList>
            </Venue>
         </Venues>

         <Wages>
         </Wages>

         <ReceiveNotifications>1</ReceiveNotifications>
      </User>
   </Info>
 
   <Errors>
   </Errors>
</SmarterU>
```

## **Error Codes**

| Error Code | Message |
| --- | --- |
| GU:01 | The email address provided is not valid. |
| GU:02 | The required permissions are not met to call the getUser method. |
| GU:03 | The user requested does not exist. |
| GU:04 | The requested user cannot be retrieved via the API. |
| GU:05 | The account user rel id provided is not valid. |
| GU:07 | The user requested does not have a Home Group. Home Group must be updated before additional information can be retrieved for this user. |

## Related

- [API: createUser](/api-createuser.md)
- [API: getRole](/api-getrole.md)
- [API: getUser](/api-getuser.md)
- [API: getUserGroups](/api-getusergroups.md)
- [API: getUserSubscriptions](/api-getusersubscriptions.md)
- [API: listUsers](/api-listusers.md)
- [API: updateUser](/api-updateuser.md)
- [Users ](/users.md)