API: getSessionAttendanceReport

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 getSessionAttendanceReport method returns the details of an instructor-led session and the attendance of each user enrolled in the session. The results can be filtered by attendance status.

Who Has Access

The following users have access to the getSessionAttendanceReport method:

Users with the Group Manager, View Learner Results, or Instructor-Led Training Instructor group permission.
Administrators and owners.

API Call XML Package

<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>getSessionAttendanceReport</Method>
   <Parameters>
      <Report>
         <CourseSessionID><![CDATA[]]></CourseSessionID>
         <Filters>
            <AttendanceStatus><![CDATA[]]></AttendanceStatus>
         </Filters>
      </Report>
   </Parameters>
</SmarterU>

The Report tag group is a container for the session you want to report on and the filters to apply to the report.

<Report>
   <CourseSessionID><![CDATA[]]></CourseSessionID>
   <Filters>
      <AttendanceStatus><![CDATA[]]></AttendanceStatus>
   </Filters>
</Report>

The Report tag may contain the following.

CourseSessionID

The session's system-generated identifier. This is the CourseSessionID returned by the listSessions method.

Filters (optional)

A container for filtering the report's results. Refer to Filters Tag Group.

Filters Tag Group

The Filters tag group is a container for the filters applied to the report. If no filters are provided, all users enrolled in the session will be returned.

The Filters tag may contain the following.

AttendanceStatus (optional)

The attendance status of the users to return. Acceptable values are:

Unconfirmed - Returns users whose attendance hasn't been confirmed.
Attended - Returns users who attended the session.
NotAttended - Returns users who did not attend the session.

API Response XML Package

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

<SmarterU>
   <Result></Result>
   <Info>
      <Report>
         <SessionDetails>
            <Session>
               <CourseSessionID><![CDATA[]]></CourseSessionID>
               <StartDate><![CDATA[]]></StartDate>
               <EndDate><![CDATA[]]></EndDate>
               <Type><![CDATA[]]></Type>
               <Capacity><![CDATA[]]></Capacity>
            </Session>
         </SessionDetails>
         
         <SessionAttendance>
            <User>
               <EnrollmentID><![CDATA[]]></EnrollmentID>
               <FirstName><![CDATA[]]></FirstName>
               <LastName><![CDATA[]]></LastName>
               <Email><![CDATA[]]></Email>
               <EmployeeID><![CDATA[]]></EmployeeID>
               <AttendanceStatus><![CDATA[]]></AttendanceStatus>
            </User>
         </SessionAttendance>
      </Report>
   </Info>

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

The Report tag is a container for the session attendance report and may contain the following.

SessionDetails

A container for the session's details. Each session is contained in a Session tag and contains the following.

Tag	Description
CourseSessionID	The session's system-generated identifier. This returns the same value that was provided in the Report tag group.
StartDate	The date and time the session starts.
EndDate	The date and time the session ends.
Type	The session's type (e.g., Venue).
Capacity	The maximum number of users that can be enrolled in the session.

SessionAttendance

A container for the users enrolled in the session. Each user is contained in a User tag and contains the following.

Tag	Description
EnrollmentID	The enrollment's system-generated identifier.
FirstName	The user's first name.
LastName	The user's last name.
Email	The user's email address.
EmployeeID	The user's employee ID.
AttendanceStatus	The user's attendance status for the session (e.g., Unconfirmed).

Example API Response XML Package

<SmarterU>
   <Result>Success</Result>
   <Info>
      <Report>
         <SessionDetails>
            <Session>
               <CourseSessionID><![CDATA[126115]]></CourseSessionID>
               <StartDate><![CDATA[2022-08-17 15:00:00.0]]></StartDate>
               <EndDate><![CDATA[2022-08-17 18:00:00.0]]></EndDate>
               <Type><![CDATA[Venue]]></Type>
               <Capacity><![CDATA[6]]></Capacity>
            </Session>
         </SessionDetails>

         <SessionAttendance>
            <User>
               <EnrollmentID><![CDATA[52524480]]></EnrollmentID>
               <FirstName><![CDATA[Yianni]]></FirstName>
               <LastName><![CDATA[Argyris]]></LastName>
               <Email><![CDATA[Argyris.Yianni@cleardaywindows.com]]></Email>
               <EmployeeID><![CDATA[74385]]></EmployeeID>
               <AttendanceStatus><![CDATA[Unconfirmed]]></AttendanceStatus>
            </User>

            <User>
               <EnrollmentID><![CDATA[52524482]]></EnrollmentID>
               <FirstName><![CDATA[Saeed]]></FirstName>
               <LastName><![CDATA[El-Ghazzawy]]></LastName>
               <Email><![CDATA[El-Ghazzawy.Saeed@cleardaywindows.com]]></Email>
               <EmployeeID><![CDATA[92856]]></EmployeeID>
               <AttendanceStatus><![CDATA[Unconfirmed]]></AttendanceStatus>
            </User>

         </SessionAttendance>
      </Report>
   </Info>

   <Errors>
   </Errors>
</SmarterU>

Error Codes

Error Code	Message
GSA:01	Permission denied — caller is not an Admin.
GSA:02	CourseSessionID is invalid — no session details found for the given ID + account.
GSA:03	Invalid AttendanceStatus filter — value must be UNCONFIRMED, ATTENDING, NOTATTENDING, ATTENDED, DIDNOTATTEND, or ALL.