This is a proposed model and is not yet available in production.
An Activity is essentially an analytics event that has occurred in your platform. Activities are comprised of five parts, three of which are required:
All activities have the following key concepts:
| Property | Description |
|---|---|
Actor | This is the person or system that performed the action. At the moment, the actor must be a natural person (i.e. not a "school"), but different types may be supported in the future. |
Action | This is the type of activity that was performed by the actor and will always be a past-tense verb such as completed or graded. |
Target | The target is the person or object that was acted upon. |
Context | This is an optional property that describes the context in which the action took place. For example, if a student submitted an assignment, the context may be a class. |
Result | This is an optional property that may be passed to Edlink if the action produced an outcome. For example, if Lindsay grades Michael's submission, the result would be a grade / outcome. |
Activities are quite complex compound objects. Unfortunately, this isn't really avoidable as they are designed to distill and capture the nearly infinite number of human actions that can occur.
Activities are create-only, but occasionally, you may wish to amend or delete an activity. Instead of calling PUT, PATCH, or DELETE like in other parts of our API, you should instead initiate a new activity that voids a previous one. Please note, voiding activities is not a function that is universally supported by school data systems.
A situation in which you would want to void an activity:
An activity was created by mistake (either user or system error).
A situation in which you would not want to void an activity:
A teacher regrades a student submission and this results in a new score, your application should send a new scored activity. It is not necessary to void the old score.
To send Edlink a void statement send a new activity with the following properties:
- The action should be
voided. - The
actorshould be the user who is voiding the previous activity (e.g. a school admin). - The
targetshould be the ID of the activity you wish to void.