API: listCredentialCounts

Description

The listCredentialCounts method retrieves the count of users who are assigned the action, and the count of users who are assigned the action by status.

Who Has Access

The following users have access to the listCredentialCounts 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>
      <Credential>
         <Filters>
            <Credentials>
               <CredentialIdentifier>
                  <Name></Name>
                     - OR -
                  <ID></ID>
               </CredentialIdentifier>
            </Credentials>
         </Filters>
      </Credential>
   </Parameters>
</SmarterU>

Credential Tag Group

The Credential tag group is a container for the action filters. 

<Credential>
   <Filters>
      <Credentials>
         <CredentialIdentifier>
            <Name></Name>
               - OR -
            <ID></ID>
         </CredentialIdentifier>
      </Credentials>
   </Filters>
</Credential>      

The Credential tag includes the following.

Filters

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

Filters Tag Group

The Filters tag group is a container for the action filters.

<Filters>
   <Credentials>
      <CredentialIdentifier>
         <Name></Name>
            - OR -
         <ID></ID>
      </CredentialIdentifier>
   </Credentials>
</Filters>

The Filters tag contains the following.

Credentials

A container for the actions to include. Each action is contained in a CredentialIdentifier tag and contains the following. 

API Response XML Package

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

<SmarterU>
   <Result>Success</Result>
   <Info>
      <Credentials>
         <Credential>
            <Name><![CDATA[]]></Name>
            <CredentialID></CredentialID>
            <Actions>
               <Learners></Learners>
               <Accepted></Accepted>
               <Review></Review>
               <Pending></Pending>
            </Actions>
         </Credential>
      </Credentials>
   </Info>

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

The Credentials tag is a container for the actions returned by the listCredentialCounts method. Each action is contained in a Credential tag and may contain the following.

Name

The action's name.

CredentialID

The action's system-generated identifier.

Actions

A container for the action's counts. The tag contains the following.

Example API Response XML Package

Below is an example of an API response XML package.

<SmarterU>
   <Result>Success</Result>
   <Info>
      <Credentials>
         <Credential>
            <Name><![CDATA[Driver's license]]></Name>
            <CredentialID>6682</CredentialID>
            <Actions>
               <Learners>36</Learners>
               <Accepted>20</Accepted>
               <Review>10</Review>
               <Pending>6</Pending>
            </Actions>
         </Credential>
      </Credentials>
   </Info>

   <Errors>
   </Errors>
</SmarterU> 

Error Codes