The AI_InitiateFullCourseListingReport service returns all entitled and installed content for either a specific user, or the entire site. This report is available in both summary and detail modes.
When scoped to a specific user, the summary report contains one unique row for each active, non-hidden, course either directly assigned to the user, or contained within a folder (or one of its subfolders) assigned to the user.
The detailed report contains:
One row for each active, non-hidden, visible course directly assigned to the user
One row for each active, non-hidden, visible course contained within each folder (and each of its subfolders) assigned to the user
Unscoped reports return all hierarchies containing active content, but will not return empty folders.
Note: Only course assets are returned in this service.
The user running this report must have Admin, Company Admin, or Super Admin privileges.
Inputs
URL Parameter
Required
Description
customerID
x
Enter your company sname.
mode
x
Enter summary or detail.
userName
Enter the login name of one, and only one, user.
If this field is left blank, the report returns all courses that are active, non-hidden and installed for the entire site.
reportFormat
x
Specify the report format:
1 = CSV
2 = CSV16
3 = XML
The following formats are available for the Detailed report only:
6 = XMLx
Success Responses
A successful response returns a report ID. Use the UTIL_PollForReport service to retrieve the report results.
Report Output
The report output is formatted in either CSV, CSV16, XML, or XMLx, based on the value entered in the reportFormat field.
CSV Output - Summary
The CSV and CSV16 output for a summary report includes the following columns:
Course Number - the course ID
Course Title - the course title
Custom - Y if the course is a custom course, otherwise blank
# of appearances in Curriculum - the total number of times the content item is directly catalog-assigned to the user and included in a folder (or one of its subfolders) entitled to the user
Mobile Status - the mobile status of the course. Valid values are blank, Phone, or Tablet.
CSV Output - Detailed
The CSV and CSV16 output for a detailed report includes the following columns:
Course Number - the course ID
Course Title - title for the course
Duration - course duration in hours and minutes (xx:xx), or N/A
Curriculum - location in the catalog hierarchy where the asset resides. For reports scoped to a specific user:
if the course is directly assigned to the user, this column is blank
if the course is not assigned to the user, the column contains the path from the folder directly entitled to the user down/through to the folder containing the content item
Mobile Status - the mobile status of the course. Valid values are blank, Phone, or Tablet.
XML Output - Summary
When a course is either directly assigned to the user, or assigned via a folder assignment, a unique row for each course includes the following elements:
asset
id - course ID
title - title for the course
custom - Y if the course is a custom course, otherwise blank
#appearances - the total number of times the course is directly assigned to the user and included in a folder or subfolder entitled to the user
duration - course duration in hours and minutes (xx:xx), or N/A
mobile - the mobile status of the course. Valid values are blank, Phone, or Tablet.
XML Output - Detailed
When a course is directly assigned to the user, no information is included for the folder hierarchy, but the following elements are included for each course:
asset
id - course ID
title - title for the course
duration - course duration in hours and minutes (xx:xx), or N/A
mobile - the mobile status of the course. Valid values are blank, Phone, or Tablet.
When a folder is assigned to the user, the report will traverse the hierarchy from the assigned folder down to the course, and the following elements are included:
group - refers to the folder
id - the code ID for the folder
title - the title of the folder
asset
id - course ID
title - title for the course
duration - course duration in hours and minutes (xx:xx), or N/A
mobile - the mobile status of the course. Valid values are blank, Phone, or Tablet.
Example XML Detailed Report Results