...
EVENT | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
An Event is the thing being recorded in the hub: user completed a course, earned a credential, etc. This design is influenced by the idea of a Learning Record Store in xAPI, but with less complexity. | ||||||||||||||||||||||||||||||||||||
Field | Type | Notes | ||||||||||||||||||||||||||||||||||
| PRG-UUID |
The Event Ids are assigned by the Learning Hub. | ||||||||||||||||||||||||||||||||||
| string (25 char) | Descriptive name for the Program that published this event. | ||||||||||||||||||||||||||||||||||
| string (25 char) | Identifier for the type of system that published this data. Currently, only the value “LB” is supported, for LearningBuilder. | ||||||||||||||||||||||||||||||||||
| string (50 char) | The type of event as reported by the publisher. This list of possible types will vary by
| ||||||||||||||||||||||||||||||||||
| string (25 char) | Descriptive name for the Program that published this event. | ||||||||||||||||||||||||||||||||||
| string (200 char) | The Program’s unique identifier for the source event. For LearningBuilder this will be something like “AI:1234”, which would be the Activity Instance WFI #1234 | ||||||||||||||||||||||||||||||||||
| string (200 char) | The Program’s unique identifier for the person, organization, or entity that the event relates to.
| ||||||||||||||||||||||||||||||||||
| JSON blob | The Program’s representation of the event data | ||||||||||||||||||||||||||||||||||
| UTC date/time | Non-null date/time the event started. (If only a single date/time is associated with the event, it is stored here) | ||||||||||||||||||||||||||||||||||
| UTC date/time | Nullable date/time that the event ended. | ||||||||||||||||||||||||||||||||||
| UTC date/time | UTC timestamp when this record was created. | ||||||||||||||||||||||||||||||||||
...
| Code Block |
|---|
{
"PublisherProgramId": "ProgramId",
"PublisherSystemId": "LB",
"PublisherEventId": "some_key_id",
"EventType": "Event Type indicator",
"PublisherParticipantId": "joebob@example.com",
"PublisherEventData": { JSON },
"EventStartUtc": "UTC date/time",
"EventEndUtc": "UTC date/time"
} |
Parameter | Description | ||
|---|---|---|---|
| The Program that owns the Event. The API Key must have access to this Program. | ||
| The type of system that published the event. For now, only “LB” is supported. | ||
| The type of Event this record represents. See the “Event Types” section, above. | ||
| A value that uniquely identifies this event in the publisher’s system. For LearningBuilder publishers, this will be an “entity-scoped identifier” such as |
| The type of Event this record represents. See the “Event Types” section, above. |
| Email address or some other piece of information that uniquely identifiers the primary participant within the Program’s system. | ||
| JSON object representing the Event in the source Program’s system. | ||
| The UTC date/time when this Event occurred, or the time that the Event started. | ||
| The UTC date/time when this Event ended. For Events with only a single timestamp, rather than a range, set this equal to |
...
Response Code | Headers and Body | |||||
|---|---|---|---|---|---|---|
200 (Ok) |
|
...