Attendance Attendance
  1. Acorn Help Centre
  2. Developers
  3. REST-API

Attendance

Josh Lavulo-Hodges Josh Lavulo-Hodges

Attendance includes all current attendance records within the LMS. The current attendance status is included in each attendance record along with details about the user, the relevant session, and the piece of content that contains the session.

The possible Attendance Statuses include:

  • registered
  • requested
  • withdrawn
  • sessionCancelled
  • didNotAttend
  • partiallyAttended
  • attended

 

Get all attendance completions:

Description
 Returns all attendance records within the tenancy.
Request Method GET
Request URL {{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/attendance
Authorisation Header Bearer {api_key}

 

Query String Parameters:

Parameter Data Type Details
requestId integer optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned
contentId integer optional, if included the endpoint will only return results with the specified contentid
showSuspended boolean optional, if true the completions of suspended users will be included
userFields boolean optional, if true activity completion records will include all custom user fields
contentFields boolean optional, if true attendance records will include all custom content fields
sessionFields boolean optional, if true attendance records will include all custom session fields

 

Example Response without requestId included:

{ 
  "requestid": 161, 
  "status": "Processing" 
}

Example Response with requestId included:

{ 
  "requestid": 161, 
  "status": "Processing" 
}
{
  "requestid": 161,
  "status": "Complete",
  "data": [
     {
           "userid": 747,
           "username": "hope.renner@example.com",
           "contentid": 18,
           "sessionid": 19,
           "contenttype": "Live Learning",
           "contentname": "Big Morning Tea",
           "eventname": "Big Morning Tea",
           "sessiontype": "Face to Face",
           "sessionstarttime": "2020-03-23T04:00:00+00:00",
           "sessionendtime": "2020-03-23T05:00:00+00:00",
           "attendancestatus": "Registered",
           "note": ""
      },
      {
           "userid": 749,
           "username": "toni54@example.com ",
           "contentid": 81,
           "sessionid": 21,
           "contenttype": "Live Learning",
           "contentname": "Safety Workshop",
           "eventname": "Day 1",
           "sessiontype": "Face to Screen",
           "sessionstarttime": "2020-03-13T04:00:00+00:00",
           "sessionendtime": "2020-03-13T09:00:00+00:00",
           "attendancestatus": "Attended",
           "note": "Approved"
      }
  ]
}

Was this article helpful?

0 out of 0 found this helpful

Articles in this section

Add comment

Please sign in to leave a comment.