Versions Compared

Version Old Version 6 New Version 7
Changes made by

Seth Petry-Johnson

Seth Petry-Johnson

Saved on

Key

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

...

Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
separatorbrackets
printablefalse

Overview

TODO

Excerpt
nameSummaryForParentPage

RESTful APIs for the “Event Store” feature, in which the registry functionality of the Learning Hub, where the hub acts as a centralized “clearinghouse” of accomplishments and activities to support system integrations.

Calling the API

Insert excerpt
Learning Hub
Learning Hub
nameCertRegistryApiHostnames
nopaneltrue

...

Method

Explanation

Handy status macro
set36399
isLabeledfalse
historySnapshotIdac74f399-bd5a-4c94-85f2-fa2f46fde05c
status185953
historyChainId06a50fca-cffb-4e87-a2d5-1da3fcb525a0

These endpoints require an API Key, assigned by the system administrators.

These should be

Credentials assigned to a specific user or client.

userId and apiKey should passed using Basic Authentication

If the endpoint requires a {PROGRAM_ID}, then this key must either be a SYSTEM key or have access to the specified Program.

Publishing events into the Registry

...

Event Type

Info

TODO

Publishing Events into the Registry

Info

“Events” are records of activity or accomplishment. These are published by a Program and other Programs can consume them.

PUT /events/{eventId}
Handy status macro
set36399
isLabeledfalse
historySnapshotId7cfb151d-d309-448c-9e11-ef4dcd1953cc
status185953
historyChainId995d84a4-485f-470b-9882-e5f4d573912a

Info

Creates or updates an Event.

{eventId} must be prefixed with the ProgramId and a hyphen, e.g. “FOO-ABC123”.

The API Key used for authentication must have rights to modify data for ProgramId.

JSON Payload

Code Block
{
    "ProgramId": "ProgramId",
    "ProgramMemberId": "joebob@example.com",
    "EventType": "Event Type indicator",
    "EventStartUTC": "UTC date/time",
    "EventEndUTC": "UTC date/time",
    "EventData": { JSON },
    "ReferenceEventId": "optional reference to another EventId"
}

Parameter

Description

{eventId}

The ID of the Event to create or update.

Must be prefixed with {ProgramId}- to ensure uniqueness.

ProgramId

The Program that owns the Event.

The API Key must have access to this Program.

ProgramMemberId

Email address or some other piece of information that uniquely identifiers the primary participant within the Program’s system.

EventType

The type of Event this record represents.

See the “Event Types” section, above.

EventStartUTC

The UTC date/time when this Event occurred, or the time that the Event started.

EventEndUTC

The UTC date/time when this Event ended. For Events with only a single timestamp, rather than a range, set this equal to EventStartUTC.

EventData

JSON object representing the Event in the source Program’s system.

ReferenceEventId

Optional; used to reference another Event, if relevant.

Response

Response Code

200 OK

Headers

Location: /events/{eventId}

Body

Empty

...

Pulling events from the Registry

...