Versions Compared

Version Old Version 26 New Version 27
Changes made by

Seth Petry-Johnson

Seth Petry-Johnson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt
nameSummaryForParentPage

RESTful APIs for the “Event Store” functionality of the Learning Hub, where the hub acts as a centralized “clearinghouse” of accomplishments and activities.

These APIs are called by Publishers to put data into the Learning Hub.

Data model

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

EventId

PRG-UUID
(26+128 chars)

{ProgramId}-{UUID}

The {ProgramId} helps guarantee uniqueness but also to make the IDs more human readable.

Event Ids are assigned by the Learning Hub.

PublisherProgramId

string (25 char)

Descriptive name for the Program that published this event.

PublisherSystemId

string (25 char)

Identifier for the type of system that published this data.

Currently, only the value “LB” is supported, for LearningBuilder.

EventType

string (50 char)

The type of event as reported by the publisher.

This list of possible types will vary by PublisherSystemId. For LearningBuilder this will be one of:

As of 12.4, the only supported value is AI_COMP_SUCCESS

- Complete Activity WFsuccessful

  • LPI_STARTED -

    Status
    titleFUTURE USE

  • LPI_COMP_UNSUCCESS -

    Status
    titleFUTURE USE

  • LPI_COMP_SUCCESS -

    Status
    titleFUTURE USE

  • LPI_REOPENED -

    Status
    titleFUTURE USE

  • AI_STARTED -

    Status
    titleFUTURE USE

  • AI_COMP_UNSUCCESS -

    Status
    titleFUTURE USE

  • AI_REOPENED - Recalled from complete to incomplete -

    Status
    titleFUTURE USE

    • , indicating a successfully completed Activity in LearningBuilder.

    This will probably change over time as the Hub is extended to support edits and deletes.

    See also PublisherEventCategory, below.

    PublisherEventId

    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

    PublisherParticipantId

    string (200 char)

    The Program’s unique identifier for the person, organization, or entity that the event relates to.

    Info

    Each event contains the ID of the related party in the publisher’s system. It is up to subscribers and publishers to determine how those values should be mapped between their systems.

    PublisherEventCategory

    JSON object
    optional

    High level classification of this event, within the publisher’s system.

    Code Block
    languagejson
    {
  "value": "some constant value",
  "label": "some human readable value"
}

    The value property should be an ID or code that represents the event type to the publisher.

    The label property is a human readable explanation of that value, at the time of publishing.

    The label can change over time, but the value should stay constant.

    This data can be used by the subscriber to map different types of publisher data to different import templates. If omitted, subscribers will not be able to differentiate between different types of records coming from the publisher.

    See also:

    PublisherEventData

    JSON blob

    The Publisher’s representation of the event data.

    Info

    The schema of this JSON structure should be shared with the Subscriber(s), so that they know how to translate it into their own representation in their Event Subscriptions.

    EventStartUtc

    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).

    EventEndUtc

    UTC date/time

    Nullable date/time that the event ended.

    CreatedUtc

    UTC date/time

    UTC timestamp when this record was created.

    Event Type

    ...

    EventType vs PublisherEventCategory

    EventType is a system concept that indicates if data is being reported, updated, deleted, etc. These are fixed values that have specific meaning to the Hub.

    PublisherEventCategory is a publisher concept that differentiates different types of events in their system, and different types of events may be associated with different data fields. Additionally, subscribers may only care about certain types of events from a given publisher.In the initial launch of the Learning Hub, the only recognized value is AI_COMP_SUCCESS, representing a Completed Successfully event for a LearningBuilder Activity Instancesuch as “Course” or “Exam Result”. These are NOT fixed values and will vary by publisher. (For LearningBuilder publishers, this will usually be the Activity Type)

    Subscribers can subscribe to specific event categories for specific publishers, with separate mapping templates for each category.

    Calling the API

    API Hostnames

    ...