API: getLearnerCertificationPivotReport

Description

The getLearnerCertificationPivotReport returns the following for the specified certification:

• The users who are assigned the certification 
• The user's status for each course and action associated with the certification

The getLearnerCertificationPivotReport returns a maximum of 2000 users, 200 courses, and 200 actions. These limits are independent of one another.

Who Has Access

The following users have access to the getLearnerCredentialReport method:

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

API Call XML Package

<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>getLearnerCertificationPivotReport</Method>
   <Parameters>
      <Certification>
         <Page></Page>
         <PageSize></PageSize>
         <SortField></SortField>
         <SortOrder></SortOrder>

         <Filters>
            <Certifications>
               <Certification>
                  <ID></ID>
               </Certification>
            </Certifications>

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

            <UserCustomFields>
               <UserCustomField>
                  <CustomFieldName></CustomFieldName>
                  <CustomFieldValue></CustomFieldValue>
               </UserCustomField>
            </UserCustomFields>

            <UserHomeGroups>
               <UserHomeGroup>
                  <ID></ID>
               </UserHomeGroup>
            </UserHomeGroups>

            <Supervisors>
               <Supervisor>
                  <ID></ID>
                     - OR -
                  <Email></Email>
                     - OR - 
                  <EmployeeID></EmployeeID>
               </Supervisor>
            </Supervisors>

            <Credentials>
               <Credential>
                  <ID></ID>
               </Credential>
            </Credentials>

            <LearningModules>
               <LearningModule>
                  <ID></ID>
               </LearningModule>
            </LearningModules>

            <EnrollmentStates>
               <EnrollmentState></EnrollmentState>
            </EnrollmentStates>

            <CredentialStates>
               <CredentialState></CredentialState>
            </CredentialStates>
         </Filters>
      </Certification>
   </Parameters>
</SmarterU>

Certification Tag Group

The Certification tag group is a container for how the response is returned and the report filters.

<Certification>
   <Page></Page>
   <PageSize></PageSize>
   <SortField></SortField>
   <SortOrder></SortOrder>

   <Filters>
      <Certifications>
         <Certification>
            <ID></ID>
         </Certification>
      </Certifications>

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

      <UserCustomFields>
         <UserCustomField>
            <CustomFieldName></CustomFieldName>
            <CustomFieldValue></CustomFieldValue>
         </UserCustomField>
      </UserCustomFields>

      <UserHomeGroups>
         <UserHomeGroup>
            <ID></ID>
         </UserHomeGroup>
      </UserHomeGroups>

      <Supervisors>
         <Supervisor>
            <ID></ID>
               - OR -
            <Email></Email>
               - OR - 
            <EmployeeID></EmployeeID>
         </Supervisor>
      </Supervisors>

      <Credentials>
         <Credential>
            <ID></ID>
         </Credential>
      </Credentials>

      <LearningModules>
         <LearningModule>
            <ID></ID>
         </LearningModule>
      </LearningModules>

      <EnrollmentStates>
         <EnrollmentState></EnrollmentState>
      </EnrollmentStates>

      <CredentialStates>
         <CredentialState></CredentialState>
      </CredentialStates>
      
   </Filters>
</Certification>

The Certification tag may contain the following.

Page (optional)

The page number to return. The default is 1.

PageSize (optional)

The maximum number of records to return on the page. If the PageSize tag is not provided, up to 50 results are returned by default. The maximum allowed value is 100. 

SortField (optional)

The field used to sort the results:

• Name - The results will be sorted by user names.
• Employee_ID - The results will be sorted by employee IDs.

SortOrder (optional)

The directions the results will be sorted:

• Asc - The results will be sorted in ascending order.
• Desc - The results will be sorted in descending order.

Filters

The Filters tag group is a container for the report filters. Refer to Filters Tag Group.

Filters Tag Group

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

<Filters>
   <Certifications>
      <Certification>
         <ID></ID>
      </Certification>
   </Certifications>

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

   <UserCustomFields>
      <UserCustomField>
         <CustomFieldName></CustomFieldName>
         <CustomFieldValue></CustomFieldValue>
      </UserCustomField>
   </UserCustomFields>

   <UserHomeGroups>
      <UserHomeGroup>
         <ID></ID>
      </UserHomeGroup>
   </UserHomeGroups>

   <Supervisors>
      <Supervisor>
         <ID></ID>
            - OR -
         <Email></Email>
            - OR -
         <EmployeeID></EmployeeID>
      </Supervisor>
   </Supervisors>

   <Credentials>
      <Credential>
         <ID></ID>
      </Credential>
   </Credentials>

   <LearningModules>
      <LearningModule>
         <ID></ID>
      </LearningModule>
   </LearningModules>

   <EnrollmentStates>
      <EnrollmentState></EnrollmentState>
   </EnrollmentStates>

   <CredentialStates>
      <CredentialState></CredentialState>
   </CredentialStates>
      
</Filters>

The Filters tag may contain the following.

Certifications

The Certifications tag is a container for the certifications to include in the response. 

<Certifications>
   <Certification>
      <ID></ID>
   </Certification>
</Certifications>

Each certification is contained in a Certification tag and contains the following.

Users (optional)

The Users tag is a container for the users to include in the response. 

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

Each user is contained in a User tag and may contain the following.

UserCustomFields (optional)

The UserCustomFields tag is a container for the custom user field values to include in the response. 

<UserCustomFields>
   <UserCustomField>
      <CustomFieldName></CustomFieldName>
      <CustomFieldValue></CustomFieldValue>
   </UserCustomField>
</UserCustomFields>

Each custom user field filter is contained in a UserCustomField tag and contains the following.

UserHomeGroups (optional)

The UserHomeGroups tag group is a container for the home groups to include in the response.

<UserHomeGroups>
   <UserHomeGroup>
      <ID></ID>
   </UserHomeGroup>
</UserHomeGroups>

Each home group is contained in a UserHomeGroup tag and contains the following.

Supervisors (optional)

The Supervisors tag group is a container for the supervisors to include in the response.

<Supervisors>
   <Supervisor>
      <ID></ID>
         - OR -
      <Email></Email>
         - OR -
      <EmployeeID></EmployeeID>
   </Supervisor>
</Supervisors>

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

Credentials (optional)

The Credentials tag group is a container for the actions to include in the response.

<Credentials>
   <Credential>
      <ID></ID>
   </Credential>
</Credentials>

Each action is contained in a Credential tag and contains the following. 

LearningModules (optional)

The LearningModules tag group is a container for the courses to include in the response. 

<LearningModules>
   <LearningModule>
      <ID></ID>
   </LearningModule>
</LearningModules>

Each course is contained in a LearningModule tag and contains the following.

EnrollmentStates (optional)

The EnrollmentStates tag group is a container for the enrollment statuses to include in the response.

<EnrollmentStates>
   <EnrollmentState></EnrollmentState>
</EnrollmentStates>

Each enrollment status is contained in an EnrollmentState tag. Acceptable values are:

• Enrolled
• In Progress
• Complete
• Warning
• Overdue
• Not Enrolled

CredentialStates (optional)

The CredentialStates tag is a container for the action statuses to include in the response.

<CredentialStates>
   <CredentialState></CredentialState>
</CredentialStates>

Each action status is contained in a CredentialState tag. Acceptable values are:

• Accepted
• Pending
• Review
• Not Assigned

API Response XML Package

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

<SmarterU>
   <Result></Result>
   <Info>
      <Columns>
         <Column>
            <ReportName></ReportName>
            <DisplayName></DisplayName>
            <Type></Type>
         </Column>
      </Columns>

      <LearnerCertificationPivotReport rows=”” rowlimitreached=”” courselimitreached=”” credentiallimitreached=””>
         <Learner>
            <ID></ID>
            <LastName></LastName>
            <FirstName></FirstName>
            <EmployeeID></EmployeeID>
            <LearningModule_nnn></LearningModule_nnn>
            <Credential_nnn></Credential_nnn>
         </Learner>
      </LearnerCertificationPivotReport>
   </Info>
</SmarterU>

The response may also contain the following.

Columns

The Columns tag is a container for the response's column headers. 

<Columns>
   <Column>
      <ReportName></ReportName>
      <DisplayName></DisplayName>
      <Type></Type>
   </Column>
</Columns>

Each column is contained in a Column tag and may contain the following. 

LearnerCertificationPivotReport

The LearnerCertificationPivotReport is a container for the learners, and their status for the course or action. 

<LearnerCertificationPivotReport rows=”” rowlimitreached=”” courselimitreached=”” credentiallimitreached=””>
   <Learner>
      <ID></ID>
      <LastName></LastName>
      <FirstName></FirstName>
      <EmployeeID></EmployeeID>
      <LearningModule_200></LearningModule_200>
      <Credential_100></Credential_100>
   </Learner>
</LearnerCertificationPivotReport>

The following attributes are contained in the LearnerCertificationPivotReport tag and provide notification when a limit was reached.

• rows - The number of records that meet the specified filters. 
• rowlimitreached - Indicates whether the maximum number of learners that can be returned (i.e., 2000) for the certification was reached.
• courselimitreached - Indicates whether the maximum number of courses that can be returned (i.e., 200) for the certification was reached.
• credentiallimitreached - Indicates whether the maximum number of actions that can be returned (i.e., 200) for the certification was reached. 

Each learner is contained in a Learner tag and may contain the following.

Example API Response XML Package

<SmarterU>
	<Result></Result>
	<Info>
		<Columns>
			<Column>
				<ReportName>credential_100</ReportName>
				<DisplayName>Photo ID</DisplayName>
				<Type>Credential</Type>
			</Column>
			<Column>
				<ReportName>credential_200</ReportName>
				<DisplayName>Emergency Contact Form</DisplayName>
				<Type>Credential</Type>
			</Column>

			<Column>
				<ReportName>learningmodule_100</ReportName>
				<DisplayName>Customer Service: Retail</DisplayName>
				<Type>LearningModule</Type>
			</Column>
			<Column>
				<ReportName>learningmodule_200</ReportName>
				<DisplayName>Using the Point-of-Sales System</DisplayName>
				<Type>LearningModule</Type>
			</Column>

			<Column>
				<ReportName>learningmodule_300</ReportName>
				<DisplayName>Fitting Customers for Footwear</DisplayName>
				<Type>LearningModule</Type>
			</Column>
		</Columns>
		<LearnerCertificationPivotReport rows=”4” rowlimitreached=”false” courselimitreached=”false” credentiallimitreached=”false”>
			<Learner>
				<ID>1</ID>
				<LastName>Atkins</LastName>
				<FirstName>Robin</FirstName>
				<EmployeeID>1234</EmployeeID>
				<learningmodule_100>Overdue</learningmodule_100>
				<learningmodule_200>Warning</learningmodule_200>
				<learningmodule_300>Complete</learningmodule_200>
				<credential_100>Review</credential_100>
				<credential_200>Accepted</credential_200>
			</Learner>

			<Learner>
				<ID>2</ID>
				<LastName>Black</LastName>
				<FirstName>Kevin</FirstName>
				<EmployeeID>5678</EmployeeID>
				<learningmodule_100>Complete</learningmodule_100>
				<learningmodule_200>Warning</learningmodule_200>
				<learningmodule_300>Overdue</learningmodule_200>
				<credential_100>Pending</credential_100>
				<credential_200>Not Assigned</credential_200>
			</Learner>

			<Learner>
				<ID>3</ID>
				<LastName>Kravitz</LastName>
				<FirstName>Amber</FirstName>
				<EmployeeID>9876</EmployeeID>
				<learningmodule_100>Complete</learningmodule_100>
				<learningmodule_200>Complete</learningmodule_200>
				<learningmodule_300>Warning</learningmodule_200>
				<credential_100>Accepted</credential_100>
				<credential_200>Accepted</credential_200>
			</Learner>
		</LearnerCertificationPivotReport>
	</Info>
</SmarterU>

Error Codes