API: listUsersCounts

Starting June 1, 2022, SmarterU will require 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 listUsersCounts method retrieves the count of actions by status for a user.

Who Has Access

The following users have access to the listUsersCounts method:

Users with the Group Manager, or View Learner Results group permission.
Supervisors, if the account's Supervisor Access setting'sReport on Supervisees option is checked.
Administrators and owners.

API Call XML Package

<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>createUser</Method>
   <Parameters>
      <User>
         <Filters>
            <Users>
               <UserIdentifier>
                  <ID></ID>
                     - OR -
                  <Email></Email>
                     - OR -
                  <EmployeeID></EmployeeID>
               </UserIdentifier>
            </Users>
         </Filters>
      </User>
   </Parameters>
</SmarterU>

User Tag Group

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

<User>
   <Filters>
      <Users>
         <UserIdentifier>
            <ID></ID>
               - OR -
            <Email></Email>
               - OR -
            <EmployeeID></EmployeeID>
         </UserIdentifier>
      </Users>
   </Filters>
</User>

The User tag includes the following.

Filters

A container for the filters. Refer to Filters Tag Group.

Filters Tag Group

A container for the filters you want to apply.

<Filters>
   <Users>
      <UserIdentifier>
         <ID></ID>
         <Email></Email>
         <EmployeeID></EmployeeID>
      </UserIdentifier>
   </Users>
</Filters>

The Filters tag must contain the following.

Users

A container for user filters. Each user is contained in a UserIdentifier tag and contains the following.

Tag	Description
ID	The user's system-generated identifier. This tag is mutually exclusive with the Email and EmployeeID tags. This is the ID returned by the getUser and listUsers methods.
Email	The user's email address. This tag is mutually exclusive with the ID and EmployeeID tags. This is the Email returned by the getUser and listUsers methods.
EmployeeID	The user's employee ID. This tag is mutually exclusive with the ID and Email tags. This is the EmployeeID returned by the getUser and listUsers methods.

API Response XML Package

The API response XML package will always include a Result, Info, and Errors tag.

<SmarterU>
   <Result></Result>
   <Info>
      <Users>
         <User>
            <ID><![CDATA[]]></ID>
            <Email><![CDATA[]]></Email>
            <EmployeeID><![CDATA[]]><EmployeeID/>
            <Actions>
               <Total></Total>
               <Accepted></Accepted>
               <Review></Review>
               <Pending></Pending>
            </Actions>
         </User>
      </Users>
   </Info>

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

The response may contain the following.

Users

The Users tag is a container for the users returned by the listUsersCounts method. Each user is contained in a User tag and may contain the following.

Tag	Description
ID	The user's system-generated identifier.
Email	The user's email address.
EmployeeID	The user's employee ID.
Actions	A container for the count of actions for the user. The tag contains the following: Total - The total number of actions assigned to the user. Accepted - The number of actions assigned to the user that have been confirmed. Review - The number of actions assigned to the user that are awaiting for activity from someone else. Pending - The number of actions assigned to the user that are awaiting activity from the user.

Example API Response XML Package

Below is an example of an API response XML package.

<SmarterU>
   <Result>Success</Result>
   <Info>
      <Users>
         <User>
            <ID><![CDATA[922822]]></ID>
            <Email><![CDATA[anna.cruz@finashoes.com]]></Email>                        
            <EmployeeID><![CDATA[10012]]></EmployeeID>
            <Actions>
              <Total>2</Total>
              <Accepted>1</Accepted>
              <Review>1</Review>
              <Pending>0</Pending>
           </Actions>
         </User>

         <User>
            <ID><![CDATA[923053]]></ID>
            <Email><![CDATA[dana.brown@finashoes.com]]></Email> 
            <EmployeeID><![CDATA[193847]]></EmployeeID>
            <Actions>
               <Total>3</Total>
               <Accepted>0</Accepted>
               <Review>0</Review>
               <Pending>3</Pending>
            </Actions>
         </User>
      </Users>
   </Info>

   <Errors>
   </Errors>
</SmarterU>

Error Codes

Error Code	Message
LUC:01	The filters provided is invalid.
LUC:02	The users provided is invalid.
LUC:03	The ID provided is invalid.
LUC:04	The email provided is invalid.
LUC:05	The employee ID provided is invalid.
LUC:06	The required permissions are not met to call the listUsersCounts method.