Activity Completions Activity Completions
  1. Acorn Help Centre
  2. Developers
  3. REST-API

Activity Completions

Josh Lavulo-Hodges Josh Lavulo-Hodges

Activity Completions include all current and archived activity completions within the LMS. Each completion record includes details about the user, the completed activity, and the piece of content that contains the activity.

 

Get all activity completions:

Description
 Returns all activity completions within the tenancy.
Request Method GET
Request URL {{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/activitycompletions
Authorisation Header Bearer {api_key}

 

Query String Parameters:

Parameter Data Type Details
contentId integer Required if userId is not included, endpoint will only return results with the specified contentid.
userId integer Required if contentId is not included, endpoint will only return results with the specified userid.
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
activityId integer optional, if included the endpoint will only return results with the specified activityid.
contentType string

optional, filter the results by contenttype

Available Values:

  • course
  • live learning
  • resource
  • video
  • program
  • partnered content
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

 

Example Response without requestId included:

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

Example Response with requestId included:

If request is still processing:

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

If request is complete:


{
  "requestid": 161,
  "status": "Complete",
  "data": [
     {
          "userid": 3,
          "username": "hope.renner@example.com",
          "activityid": 292,
          "activityname": "Safety Principles",
          "activitytimecompleted": "2019-09-04T07:50:18+00:00",
          "activitycompletionstatus": "Completed",
          "contentid": 39,
          "contenttype": "Course",
          "contentname": "Safety Workshop"
      },
      {
          "userid": 22,
          "username": "toni54@example.com ",
          "activityid": 227,
          "activityname": "Introduction to Fraud
          "activitytimecompleted": "2019-06-04T09:24:16+00:00",
          "activitycompletionstatus": "Completed",
          "contentid": 22,
          "contenttype": "Live Learning",
          "contentname": "Fraud Awareness"
      }
  ]
}

Was this article helpful?

0 out of 0 found this helpful

Articles in this section

Add comment

Please sign in to leave a comment.