Freigeben über


Badgr (Unabhängiger Herausgeber)

Organisationen auf der ganzen Welt verwenden Badgr, um Marken-Lernökosysteme zu erstellen, die ihre Communitys mit fähigkeitenbasierten digitalen Anmeldeinformationen, stapelbaren Lernpfaden und tragbaren Lernpfaden unterstützen.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connectormetadaten
Herausgeber Troy Taylor, Hitachi Solutions
Webseite https://badgr.com
Datenschutzrichtlinie https://info.badgr.com/privacy-policy.html
Kategorien Personalabteilung

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen der Assertionen von BadgeClass

Dient zum Abrufen einer Liste von Assertionen für eine einzelne BadgeClass.

Abrufen der BadgeClasses des Ausstellers

Dient zum Abrufen einer Liste von BadgeClasses für einen einzelnen Aussteller. Der authentifizierte Benutzer muss über den Besitzer-, Editor- oder Mitarbeiterstatus des Ausstellers verfügen.

Abrufen der BadgeClasses des Benutzers

Dient zum Abrufen einer Liste der BadgeClasses für authentifizierte Benutzer.

Abrufen der Zugriffstoken des Benutzers

Dient zum Abrufen einer Liste von Zugriffstoken für authentifizierte Benutzer.

Abrufen des BadgeUser-Profils

Rufen Sie ein einzelnes BadgeUser-Profil ab. Verwenden Sie die entityId "self", um das Profil des authentifizierten Benutzers abzurufen.

Abrufen einer BadgeClass

Rufen Sie eine einzelne BadgeClass ab.

Abrufen einer einzelnen Assertion

Abrufen einer Assertion

Abrufen einer Sammlung

Rufen Sie eine einzelne Sammlung ab.

Abrufen eines AccessTokens

Rufen Sie ein einzelnes AccessToken ab.

Abrufen eines Ausstellers

Rufen Sie einen einzelnen Aussteller ab.

Abrufen von Assertionen

Dient zum Abrufen einer Liste von Assertionen für einen einzelnen Aussteller.

Abrufen von Assertionen im Rucksack eines Benutzers

Rufen Sie eine Liste der Assertionen im Rucksack des authentifizierten Benutzers ab.

Abrufen von Ausstellertoken

Abrufen von Ausstellertoken.

Abrufen von Backpack Assertion Details

Rufen Sie Details zu einer Assertion im Rucksack eines Benutzers ab.

Aktualisieren einer Assertion

Aktualisieren einer Assertion.

Aktualisieren einer BadgeClass

Aktualisieren einer vorhandenen BadgeClass. Zuvor ausgestellte BadgeInstances werden nicht aktualisiert.

Aktualisieren einer Sammlung

Aktualisieren Sie eine Sammlung in einem Rucksack.

Aktualisieren eines Ausstellers

Aktualisieren eines einzelnen Ausstellers.

Aktualisieren eines BadgeUser

Aktualisieren Sie das Konto eines BadgeUser. Verwenden der EntityId "self" zum Aktualisieren des Profils des authentifizierten Benutzers

Anfordern einer Kontowiederherstellungs-E-Mail

Fordern Sie eine E-Mail zur Kontowiederherstellung für einen Benutzer an.

Assertionsakzeptanz im Backpack aktualisieren

Aktualisieren Sie die Akzeptanz einer Assertion im Backpack eines Benutzers.

Ausgeben einer Assertion

Ausgeben einer neuen Assertion an einen Empfänger.

Ausgeben einer Assertion

Ausgeben einer Assertion an einen einzelnen Empfänger.

Ausstellen mehrerer BadgeClass

Ausgeben mehrerer Kopien derselben BadgeClass an mehrere Empfänger.

Aussteller abrufen

Dient zum Abrufen einer Liste der Aussteller für authentifizierte Benutzer.

Eine Sammlung erstellen

Erstellen Sie eine neue Sammlung.

Entfernen einer Assertion aus dem Rucksack

Entfernen Sie eine Assertion aus dem Rucksack eines Benutzers.

Erstellen der BadgeClass eines Ausstellers

Erstellen Sie eine neue BadgeClass, die einem Aussteller zugeordnet ist. Der authentifizierte Benutzer muss über den Besitzer-, Editor- oder Mitarbeiterstatus des Ausstellers verfügen.

Erstellen einer BadgeClass

Erstellen Sie eine neue BadgeClass.

Erstellen eines Ausstellers

Erstellen Sie einen neuen Aussteller.

Erstellen eines BadgeUser-Kontos

Erstellen Sie ein BadgeUser-Konto und -Profil.

Hochladen einer Assertion in den Rucksack

Laden Sie eine neue Assertion in den Rucksack eines Benutzers hoch.

Importieren einer Assertion in Den Rucksack

Importieren Sie eine neue Assertion in den Rucksack eines Benutzers.

Löschen einer Auflistung

Löschen Sie eine Sammlung aus einem Rucksack.

Löschen einer BadgeClass

Löschen sie eine BadgeClass. Beschränkt auf Besitzer oder Redakteure (nicht Mitarbeiter) des entsprechenden Ausstellers.

Löschen eines Ausstellers

Löschen eines einzelnen Ausstellers.

Sammlungen abrufen

Dient zum Abrufen einer Liste von Sammlungen.

Widerrufen einer Assertion

Widerrufen einer Assertion.

Widerrufen eines AccessTokens

Widerrufen des AccessTokens eines Benutzers.

Widerrufen mehrerer Assertionen

Widerrufen mehrerer Assertionen für mehrere Empfänger.

Wiederherstellen eines Kontos

Stellen Sie ein Konto wieder her, und legen Sie ein neues Kennwort fest.

Abrufen der Assertionen von BadgeClass

Dient zum Abrufen einer Liste von Assertionen für eine einzelne BadgeClass.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Recipient
recipient string

Ein Empfängerbezeichner zum Filtern nach

Number
num string

Anfordern der Paginierung von Ergebnissen

Abgelaufen einschließen
include_expired boolean

Einschließen abgelaufener Assertionen

Gesperrt einschließen
include_revoked boolean

Gesperrte Assertionen einschließen

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.recipient.type string

Der Typ.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Erweiterungen
result.extensions string

Die Erweiterungen.

BadgeClass-Name
result.badgeclassName string

Der Name der BadgeClass.

Abrufen der BadgeClasses des Ausstellers

Dient zum Abrufen einer Liste von BadgeClasses für einen einzelnen Aussteller. Der authentifizierte Benutzer muss über den Besitzer-, Editor- oder Mitarbeiterstatus des Ausstellers verfügen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Number
num string

Anfordern der Paginierung von Ergebnissen

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Name
result.name string

Der Name.

Bild
result.image string

Das Bild.

Description
result.description string

Die Beschreibung.

Leistungstyp
result.achievementType string

Die Art der Leistung.

Kriterien-URL
result.criteriaUrl string

Die URL-Adresse der Kriterien.

Kriterienerzählen
result.criteriaNarrative string

Die Erzählung der Kriterien.

Ausrichtungen
result.alignments array of object
Zielname
result.alignments.targetName string

Der Name des Ziels.

Ziel-URL
result.alignments.targetUrl string

Die URL-Adresse des Ziels.

Zielbeschreibung
result.alignments.targetDescription string

Die Beschreibung des Ziels.

Zielframework
result.alignments.targetFramework string

Das Framework des Ziels.

Zielcode
result.alignments.targetCode string

Der Code des Ziels.

Stichwörter
result.tags array of string
Betrag
result.expires.amount string

Der Betrag.

Dauer
result.expires.duration string

Die Dauer.

Erweiterungen
result.extensions string

Die Erweiterungen.

Abrufen der BadgeClasses des Benutzers

Dient zum Abrufen einer Liste der BadgeClasses für authentifizierte Benutzer.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Name
result.name string

Der Name.

Bild
result.image string

Das Bild.

Description
result.description string

Die Beschreibung.

Leistungstyp
result.achievementType string

Die Art der Leistung.

Kriterien-URL
result.criteriaUrl string

Die URL-Adresse der Kriterien.

Kriterienerzählen
result.criteriaNarrative string

Die Erzählung der Kriterien.

Ausrichtungen
result.alignments array of object
Zielname
result.alignments.targetName string

Der Name des Ziels.

Ziel-URL
result.alignments.targetUrl string

Die URL-Adresse des Ziels.

Zielbeschreibung
result.alignments.targetDescription string

Die Beschreibung des Ziels.

Zielframework
result.alignments.targetFramework string

Das Framework des Ziels.

Zielcode
result.alignments.targetCode string

Der Code des Ziels.

Stichwörter
result.tags array of string
Betrag
result.expires.amount string

Der Betrag.

Dauer
result.expires.duration string

Die Dauer.

Erweiterungen
result.extensions string

Die Erweiterungen.

Abrufen der Zugriffstoken des Benutzers

Dient zum Abrufen einer Liste von Zugriffstoken für authentifizierte Benutzer.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of AccessToken

Abrufen des BadgeUser-Profils

Rufen Sie ein einzelnes BadgeUser-Profil ab. Verwenden Sie die entityId "self", um das Profil des authentifizierten Benutzers abzurufen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Vorname
result.firstName string

Der Vorname.

Nachname
result.lastName string

Der Nachname.

E-Mails
result.emails array of object
Entitätstyp
result.emails.entityType string

Der Typ der Entität.

Entitäts-ID
result.emails.entityId string

Der Bezeichner der Entität.

Email
result.emails.email string

Die E-Mail-Adresse.

Überprüft
result.emails.verified boolean

Ob überprüft.

Primary
result.emails.primary boolean

Gibt an, ob primär.

Case Variants
result.emails.caseVariants string

Die Groß-/Kleinschreibungsvarianten.

URL
result.url string

Die URL-Adresse.

Telefon
result.telephone string

Die Telefonnummer.

Vereinbarte Version der Bedingungen
result.agreedTermsVersion string

Die Fassung der Begriffe aggreed.

Hat die neueste Version der Geschäftsbedingungen vereinbart
result.hasAgreedToLatestTermsVersion string

Die Version der späteren Begriffe aggree.

Marketing-Opt-In
result.marketingOptIn string

Vereinbarte Marketing-Opt-In.

Badgr Domain
result.badgrDomain string

Die Domäne von Badgr.

Hat Kennwortsatz
result.hasPasswordSet string

Wenn das Kennwort festgelegt ist.

Recipient
result.recipient string

Der Empfänger.

Abrufen einer BadgeClass

Rufen Sie eine einzelne BadgeClass ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Name
result.name string

Der Name.

Bild
result.image string

Das Bild.

Description
result.description string

Die Beschreibung.

Leistungstyp
result.achievementType string

Die Art der Leistung.

Kriterien-URL
result.criteriaUrl string

Die URL-Adresse der Kriterien.

Kriterienerzählen
result.criteriaNarrative string

Die Erzählung der Kriterien.

Ausrichtungen
result.alignments array of object
Zielname
result.alignments.targetName string

Der Name des Ziels.

Ziel-URL
result.alignments.targetUrl string

Die URL-Adresse des Ziels.

Zielbeschreibung
result.alignments.targetDescription string

Die Beschreibung des Ziels.

Zielframework
result.alignments.targetFramework string

Das Framework des Ziels.

Zielcode
result.alignments.targetCode string

Der Code des Ziels.

Stichwörter
result.tags array of string
Betrag
result.expires.amount string

Der Betrag.

Dauer
result.expires.duration string

Die Dauer.

Erweiterungen
result.extensions string

Die Erweiterungen.

Abrufen einer einzelnen Assertion

Abrufen einer Assertion

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.recipient.type string

Der Typ.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Erweiterungen
result.extensions string

Die Erweiterungen.

BadgeClass-Name
result.badgeclassName string

Der Name der BadgeClass.

Abrufen einer Sammlung

Rufen Sie eine einzelne Sammlung ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Name
result.name string

Der Name.

Description
result.description string

Die Beschreibung.

Besitzer
result.owner string

Der Besitzer.

Freigabe-URL
result.share_url string

Die URL-Adresse der Freigabe.

Freigabehash
result.shareHash string

Der Hash der Freigabe.

Veröffentlicht
result.published boolean

Gibt an, ob veröffentlicht.

Assertions
result.assertions array of object
Entitätstyp
result.assertions.entityType string

Der Typ der Entität.

Entitäts-ID
result.assertions.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.assertions.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.assertions.createdAt string

Beim Erstellen bei.

Erstellt von
result.assertions.createdBy string

Erstellt von.

BadgeClass
result.assertions.badgeclass string

Die BadgeClass.

BadgeClass Open Badge ID
result.assertions.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.assertions.issuer string

Der Aussteller.

Aussteller: Offene Badge-ID
result.assertions.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.assertions.image string

Das Bild.

Identität
result.assertions.recipient.identity string

Die Identität.

Zerlegt
result.assertions.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.assertions.recipient.type string

Der Typ.

Nur-Text-Identität
result.assertions.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.assertions.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.assertions.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.assertions.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.assertions.evidence array of object
URL
result.assertions.evidence.url string

Die URL-Adresse.

Erzählung
result.assertions.evidence.narrative string

Die Erzählung.

Widerrufen
result.assertions.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.assertions.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.assertions.acceptance string

Die Annahme.

Läuft ab
result.assertions.expires string

Wann läuft ab.

Erweiterungen
result.assertions.extensions string

Die Erweiterungen.

BadgeClass-Name
result.assertions.badgeclassName string

Der Name der BadgeClass.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Abrufen eines AccessTokens

Rufen Sie ein einzelnes AccessToken ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result AccessToken

Abrufen eines Ausstellers

Rufen Sie einen einzelnen Aussteller ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Name
result.name string

Der Name.

Bild
result.image string

Das Bild.

Email
result.email string

Die E-Mail-Adresse.

Description
result.description string

Die Beschreibung.

URL
result.url string

Die URL-Adresse.

Personal
result.staff array of object
Entitätstyp
result.staff.entityType string

Der Typ der Entität.

Entitäts-ID
result.staff.entityId string

Der Bezeichner der Entität.

Benutzerprofil
result.staff.userProfile string

Das Profil des Benutzers.

Benutzer
result.staff.user string

Der Benutzer.

Rolle
result.staff.role string

Die Rolle.

Erweiterungen
result.extensions string

Die Erweiterungen.

Badgr Domain
result.badgrDomain string

Die Domäne von Badgr.

Abrufen von Assertionen

Dient zum Abrufen einer Liste von Assertionen für einen einzelnen Aussteller.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Recipient
recipient string

Ein Empfängerbezeichner zum Filtern nach

Number
num string

Anfordern der Paginierung von Ergebnissen

Abgelaufen einschließen
include_expired boolean

Einschließen abgelaufener Assertionen

Gesperrt einschließen
include_revoked boolean

Gesperrte Assertionen einschließen

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.recipient.type string

Der Typ.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Erweiterungen
result.extensions string

Die Erweiterungen.

BadgeClass-Name
result.badgeclassName string

Der Name der BadgeClass.

Abrufen von Assertionen im Rucksack eines Benutzers

Rufen Sie eine Liste der Assertionen im Rucksack des authentifizierten Benutzers ab.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.recipient.type string

Der Typ.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Erweiterungen
result.extensions string

Die Erweiterungen.

BadgeClass-Name
result.badgeclassName string

Der Name der BadgeClass.

Abrufen von Ausstellertoken

Abrufen von Ausstellertoken.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
body
body True

Gibt zurück

response
AccessToken

Abrufen von Backpack Assertion Details

Rufen Sie Details zu einer Assertion im Rucksack eines Benutzers ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Typ
result.recipient.type string

Der Typ.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Ausstehend
result.pending string

Anhängig.

Aktualisieren einer Assertion

Aktualisieren einer Assertion.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

BadgeClass
badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus. .

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Identität
identity string

Die Identität.

Zerlegt
hashed boolean

Gibt an, ob hashed.

Typ
type string

Der Typ.

Nur-Text-Identität
plaintextIdentity string

Die Identität im Klartext.

Salt
salt string

Wenn hashed, das Salz.

Ausgestellt am
issuedOn string

Wenn sie ausgestellt wird.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

URL
url string

Die URL-Adresse.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

Läuft ab
expires string

Wann läuft ab.

Erweiterungen
extensions string

Die Erweiterungen.

BadgeClass-Name
badgeclassName string

Der Name der BadgeClass.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.recipient.type string

Der Typ.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Erweiterungen
result.extensions string

Die Erweiterungen.

BadgeClass-Name
result.badgeclassName string

Der Name der BadgeClass.

Aktualisieren einer BadgeClass

Aktualisieren einer vorhandenen BadgeClass. Zuvor ausgestellte BadgeInstances werden nicht aktualisiert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus. .

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Name
name string

Der Name.

Bild
image string

Das Bild.

Description
description string

Die Beschreibung.

Leistungstyp
achievementType string

Die Art der Leistung.

Kriterien-URL
criteriaUrl string

Die URL der Kriterien.

Kriterienerzählen
criteriaNarrative string

Die Erzählung der Kriterien.

Zielname
targetName string

Der Name des Ziels.

Ziel-URL
targetUrl string

Die URL des Ziels.

Zielbeschreibung
targetDescription string

Die Beschreibung des Ziels.

Zielframework
targetFramework string

Das Framework des Ziels.

Zielcode
targetCode string

Der Code des Ziels.

Stichwörter
tags array of string
Betrag
amount string

Der Betrag.

Dauer
duration string

Die Dauer.

Erweiterungen
extensions string

Die Erweiterungen.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Name
result.name string

Der Name.

Bild
result.image string

Das Bild.

Description
result.description string

Die Beschreibung.

Leistungstyp
result.achievementType string

Die Art der Leistung.

Kriterien-URL
result.criteriaUrl string

Die URL-Adresse der Kriterien.

Kriterienerzählen
result.criteriaNarrative string

Die Erzählung der Kriterien.

Ausrichtungen
result.alignments array of object
Zielname
result.alignments.targetName string

Der Name des Ziels.

Ziel-URL
result.alignments.targetUrl string

Die URL-Adresse des Ziels.

Zielbeschreibung
result.alignments.targetDescription string

Die Beschreibung des Ziels.

Zielframework
result.alignments.targetFramework string

Das Framework des Ziels.

Zielcode
result.alignments.targetCode string

Der Code des Ziels.

Stichwörter
result.tags array of string
Betrag
result.expires.amount string

Der Betrag.

Dauer
result.expires.duration string

Die Dauer.

Erweiterungen
result.extensions string

Die Erweiterungen.

Aktualisieren einer Sammlung

Aktualisieren Sie eine Sammlung in einem Rucksack.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

Entitätstyp
entityType string

Der Typ der Entität.

Entitäts-ID
entityId string

Der Bezeichner der Entität.

Name
name string

Der Name.

Description
description string

Die Beschreibung.

Besitzer
owner string

Der Besitzer.

Freigabe-URL
share_url string

Die URL-Adresse der Freigabe.

Freigabehash
shareHash string

Der Hash der Freigabe.

Veröffentlicht
published boolean

Gibt an, ob veröffentlicht.

BadgeClass
badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Identität
identity string

Die Identität.

Zerlegt
hashed boolean

Gibt an, ob hashed.

Typ
type string

Der Typ.

Nur-Text-Identität
plaintextIdentity string

Die Identität im Klartext.

Salt
salt string

Wenn hashed, das Salz.

Ausgestellt am
issuedOn string

Wenn sie ausgestellt wird.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

URL
url string

Die URL-Adresse.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

Läuft ab
expires string

Wenn das Signal abläuft.

Erweiterungen
extensions string

Die Erweiterungen.

BadgeClass-Name
badgeclassName string

Der Name der BadgeClass.

Erstellt unter
createdAt string

Erstellt bei.

Erstellt von
createdBy string

Von wem erstellt wurde.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Name
result.name string

Der Name.

Description
result.description string

Die Beschreibung.

Besitzer
result.owner string

Der Besitzer.

Freigabe-URL
result.share_url string

Die URL-Adresse der Freigabe.

Freigabehash
result.shareHash string

Der Hash der Freigabe.

Veröffentlicht
result.published boolean

Gibt an, ob veröffentlicht.

Assertions
result.assertions array of object
Entitätstyp
result.assertions.entityType string

Der Typ der Entität.

Entitäts-ID
result.assertions.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.assertions.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.assertions.createdAt string

Beim Erstellen bei.

Erstellt von
result.assertions.createdBy string

Erstellt von.

BadgeClass
result.assertions.badgeclass string

Die BadgeClass.

BadgeClass Open Badge ID
result.assertions.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.assertions.issuer string

Der Aussteller.

Aussteller: Offene Badge-ID
result.assertions.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.assertions.image string

Das Bild.

Identität
result.assertions.recipient.identity string

Die Identität.

Zerlegt
result.assertions.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.assertions.recipient.type string

Der Typ.

Nur-Text-Identität
result.assertions.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.assertions.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.assertions.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.assertions.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.assertions.evidence array of object
URL
result.assertions.evidence.url string

Die URL-Adresse.

Erzählung
result.assertions.evidence.narrative string

Die Erzählung.

Widerrufen
result.assertions.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.assertions.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.assertions.acceptance string

Die Annahme.

Läuft ab
result.assertions.expires string

Wann läuft ab.

Erweiterungen
result.assertions.extensions string

Die Erweiterungen.

BadgeClass-Name
result.assertions.badgeclassName string

Der Name der BadgeClass.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Aktualisieren eines Ausstellers

Aktualisieren eines einzelnen Ausstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

Erstellt von
createdBy string

Von wem erstellt wurde.

Name
name string

Der Name.

Bild
image string

Das Bild.

Email
email string

Die E-Mail-Adresse.

Description
description string

Die Beschreibung.

URL
url string

Die URL-Adresse.

Entitätstyp
entityType string

Der Typ der Entität.

Entitäts-ID
entityId string

Der Bezeichner der Entität.

Benutzerprofil
userProfile string

Das Profil des Benutzers.

Benutzer
user string

Der Benutzer.

Rolle
role string

Die Rolle.

Erweiterungen
extensions string

Die Erweiterungen.

Badgr Domain
badgrDomain string

Die Domäne von Badgr.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Name
result.name string

Der Name.

Bild
result.image string

Das Bild.

Email
result.email string

Die E-Mail-Adresse.

Description
result.description string

Die Beschreibung.

URL
result.url string

Die URL-Adresse.

Personal
result.staff array of object
Entitätstyp
result.staff.entityType string

Der Typ der Entität.

Entitäts-ID
result.staff.entityId string

Der Bezeichner der Entität.

Benutzerprofil
result.staff.userProfile string

Das Profil des Benutzers.

Benutzer
result.staff.user string

Der Benutzer.

Rolle
result.staff.role string

Die Rolle.

Erweiterungen
result.extensions string

Die Erweiterungen.

Badgr Domain
result.badgrDomain string

Die Domäne von Badgr.

Aktualisieren eines BadgeUser

Aktualisieren Sie das Konto eines BadgeUser. Verwenden der EntityId "self" zum Aktualisieren des Profils des authentifizierten Benutzers

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

Entitätstyp
entityType string

Der Typ der Entität.

Entitäts-ID
entityId string

Der Bezeichner der Entität.

Vorname
firstName string

Der Vorname.

Nachname
lastName string

Der Nachname.

Entitätstyp
entityType string

Der Typ der Entität.

Entitäts-ID
entityId string

Der Bezeichner der Entität.

Email
email string

Die E-Mail-Adresse.

Überprüft
verified boolean

Ob überprüft.

Primary
primary boolean

Gibt an, ob primär.

Case Variants
caseVariants string

Die Groß-/Kleinschreibungsvarianten.

URL
url string

Die URL-Adresse.

Telefon
telephone string

Die Telefonnummer.

Vereinbarte Version der Bedingungen
agreedTermsVersion string

Die Fassung der vereinbarten Bedingungen.

Hat die neueste Version der Geschäftsbedingungen vereinbart
hasAgreedToLatestTermsVersion string

Die Version der neuesten Vereinbarten Bedingungen.

Marketing-Opt-In
marketingOptIn string

Hat sich für marketing entschieden.

Badgr Domain
badgrDomain string

Die Domäne von Badgr.

Hat Kennwortsatz
hasPasswordSet string

Verfügt über einen Kennwortsatz.

Recipient
recipient string

Der Empfänger.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Vorname
result.firstName string

Der Vorname.

Nachname
result.lastName string

Der Nachname.

E-Mails
result.emails array of object
Entitätstyp
result.emails.entityType string

Der Typ der Entität.

Entitäts-ID
result.emails.entityId string

Der Bezeichner der Entität.

Email
result.emails.email string

Die E-Mail-Adresse.

Überprüft
result.emails.verified boolean

Ob überprüft.

Primary
result.emails.primary boolean

Gibt an, ob primär.

Case Variants
result.emails.caseVariants string

Die Groß-/Kleinschreibungsvarianten.

URL
result.url string

Die URL-Adresse.

Telefon
result.telephone string

Die Telefonnummer.

Vereinbarte Version der Bedingungen
result.agreedTermsVersion string

Die Fassung der Begriffe aggreed.

Hat die neueste Version der Geschäftsbedingungen vereinbart
result.hasAgreedToLatestTermsVersion string

Die Version der späteren Begriffe aggree.

Marketing-Opt-In
result.marketingOptIn string

Vereinbarte Marketing-Opt-In.

Badgr Domain
result.badgrDomain string

Die Domäne von Badgr.

Hat Kennwortsatz
result.hasPasswordSet string

Wenn das Kennwort festgelegt ist.

Recipient
result.recipient string

Der Empfänger.

Anfordern einer Kontowiederherstellungs-E-Mail

Fordern Sie eine E-Mail zur Kontowiederherstellung für einen Benutzer an.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Email
email string

Die E-Mail-Adresse in der Datei, an die Wiederherstellungs-E-Mails gesendet werden sollen.

Assertionsakzeptanz im Backpack aktualisieren

Aktualisieren Sie die Akzeptanz einer Assertion im Backpack eines Benutzers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

Akzeptanz
acceptance string

Die Annahme.

BadgeClass
badgeclass string

Die Definition eines ertragsfähigen Badges.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus. .

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Identität
identity string

Die Identität.

Typ
type string

Der Typ.

Zerlegt
hashed boolean

Gibt an, ob hashed.

Nur-Text-Identität
plaintextIdentity string

Die Identität im Klartext.

Ausgestellt am
issuedOn string

Wenn sie ausgestellt wird.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

URL
url string

Die URL-Adresse.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

Läuft ab
expires string

Wann läuft ab.

Ausstehend
pending string

Anhängig.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Typ
result.recipient.type string

Der Typ.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Ausstehend
result.pending string

Anhängig.

Ausgeben einer Assertion

Ausgeben einer neuen Assertion an einen Empfänger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

BadgeClass
badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus. .

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Identität
identity string

Die Identität.

Zerlegt
hashed boolean

Gibt an, ob hashed.

Typ
type string

Der Typ.

Nur-Text-Identität
plaintextIdentity string

Die Identität im Klartext.

Salt
salt string

Wenn hashed, das Salz.

Ausgestellt am
issuedOn string

Wenn sie ausgestellt wird.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

URL
url string

Die URL-Adresse.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

Läuft ab
expires string

Wann läuft ab.

Erweiterungen
extensions string

Die Erweiterungen.

BadgeClass-Name
badgeclassName string

Der Name der BadgeClass.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.recipient.type string

Der Typ.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Erweiterungen
result.extensions string

Die Erweiterungen.

BadgeClass-Name
result.badgeclassName string

Der Name der BadgeClass.

Ausgeben einer Assertion

Ausgeben einer Assertion an einen einzelnen Empfänger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

BadgeClass
badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus. .

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Identität
identity string

Die Identität.

Zerlegt
hashed boolean

Gibt an, ob hashed.

Typ
type string

Der Typ.

Nur-Text-Identität
plaintextIdentity string

Die Identität im Klartext.

Salt
salt string

Wenn hashed, das Salz.

Ausgestellt am
issuedOn string

Wenn sie ausgestellt wird.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

URL
url string

Die URL-Adresse.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

Läuft ab
expires string

Wann läuft ab.

Erweiterungen
extensions string

Die Erweiterungen.

BadgeClass-Name
badgeclassName string

Der Name der BadgeClass.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.recipient.type string

Der Typ.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Erweiterungen
result.extensions string

Die Erweiterungen.

BadgeClass-Name
result.badgeclassName string

Der Name der BadgeClass.

Ausstellen mehrerer BadgeClass

Ausgeben mehrerer Kopien derselben BadgeClass an mehrere Empfänger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

BadgeClass
badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus. .

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Identität
identity string

Die Identität.

Zerlegt
hashed boolean

Gibt an, ob hashed.

Typ
type string

Der Typ.

Nur-Text-Identität
plaintextIdentity string

Die Identität im Klartext.

Salt
salt string

Wenn hashed, das Salz.

Ausgestellt am
issuedOn string

Wenn sie ausgestellt wird.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

URL
url string

Die URL-Adresse.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

Läuft ab
expires string

Wann läuft ab.

Erweiterungen
extensions string

Die Erweiterungen.

BadgeClass-Name
badgeclassName string

Der Name der BadgeClass.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.recipient.type string

Der Typ.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Erweiterungen
result.extensions string

Die Erweiterungen.

BadgeClass-Name
result.badgeclassName string

Der Name der BadgeClass.

Aussteller abrufen

Dient zum Abrufen einer Liste der Aussteller für authentifizierte Benutzer.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Name
result.name string

Der Name.

Bild
result.image string

Das Bild.

Email
result.email string

Die E-Mail-Adresse.

Description
result.description string

Die Beschreibung.

URL
result.url string

Die URL-Adresse.

Personal
result.staff array of object
Entitätstyp
result.staff.entityType string

Der Typ der Entität.

Entitäts-ID
result.staff.entityId string

Der Bezeichner der Entität.

Entitätstyp
result.staff.userProfile.entityType string

Der Entitätstyp.

Entitäts-ID
result.staff.userProfile.entityId string

Der Entitätsbezeichner.

Vorname
result.staff.userProfile.firstName string

Der Vorname.

Nachname
result.staff.userProfile.lastName string

Der Nachname.

E-Mails
result.staff.userProfile.emails array of object
Email
result.staff.userProfile.emails.email string

Die E-Mail-Adresse.

Überprüft
result.staff.userProfile.emails.verified boolean

Ob überprüft.

Primary
result.staff.userProfile.emails.primary boolean

Gibt an, ob primär.

Case Variants
result.staff.userProfile.emails.caseVariants array of string

Die Groß-/Kleinschreibungsvarianten.

URLs
result.staff.userProfile.url array of string

Die URL-Adressen.

Telefonnummern
result.staff.userProfile.telephone array of string

Die Telefonnummern.

Badgr Domain
result.staff.userProfile.badgrDomain string

Die Badgr-Domäne.

Benutzer
result.staff.user string

Der Benutzer.

Rolle
result.staff.role string

Die Rolle.

Erweiterungen
result.extensions string

Die Erweiterungen.

Badgr Domain
result.badgrDomain string

Die Domäne von Badgr.

Eine Sammlung erstellen

Erstellen Sie eine neue Sammlung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitätstyp
entityType string

Der Typ der Entität.

Entitäts-ID
entityId string

Der Bezeichner der Entität.

Name
name string

Der Name.

Description
description string

Die Beschreibung.

Besitzer
owner string

Der Besitzer.

Freigabe-URL
share_url string

Die URL-Adresse der Freigabe.

Freigabehash
shareHash string

Der Hash der Freigabe.

Veröffentlicht
published boolean

Gibt an, ob veröffentlicht.

BadgeClass
badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Identität
identity string

Die Identität.

Zerlegt
hashed boolean

Gibt an, ob hashed.

Typ
type string

Der Typ.

Nur-Text-Identität
plaintextIdentity string

Die Identität im Klartext.

Salt
salt string

Wenn hashed, das Salz.

Ausgestellt am
issuedOn string

Wenn sie ausgestellt wird.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

URL
url string

Die URL-Adresse.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

Läuft ab
expires string

Wenn das Signal abläuft.

Erweiterungen
extensions string

Die Erweiterungen.

BadgeClass-Name
badgeclassName string

Der Name der BadgeClass.

Erstellt unter
createdAt string

Erstellt bei.

Erstellt von
createdBy string

Von wem erstellt wurde.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Name
result.name string

Der Name.

Description
result.description string

Die Beschreibung.

Besitzer
result.owner string

Der Besitzer.

Freigabe-URL
result.share_url string

Die URL-Adresse der Freigabe.

Freigabehash
result.shareHash string

Der Hash der Freigabe.

Veröffentlicht
result.published boolean

Gibt an, ob veröffentlicht.

Assertions
result.assertions array of object
Entitätstyp
result.assertions.entityType string

Der Typ der Entität.

Entitäts-ID
result.assertions.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.assertions.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.assertions.createdAt string

Beim Erstellen bei.

Erstellt von
result.assertions.createdBy string

Erstellt von.

BadgeClass
result.assertions.badgeclass string

Die BadgeClass.

BadgeClass Open Badge ID
result.assertions.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.assertions.issuer string

Der Aussteller.

Aussteller: Offene Badge-ID
result.assertions.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.assertions.image string

Das Bild.

Identität
result.assertions.recipient.identity string

Die Identität.

Zerlegt
result.assertions.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.assertions.recipient.type string

Der Typ.

Nur-Text-Identität
result.assertions.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.assertions.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.assertions.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.assertions.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.assertions.evidence array of object
URL
result.assertions.evidence.url string

Die URL-Adresse.

Erzählung
result.assertions.evidence.narrative string

Die Erzählung.

Widerrufen
result.assertions.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.assertions.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.assertions.acceptance string

Die Annahme.

Läuft ab
result.assertions.expires string

Wann läuft ab.

Erweiterungen
result.assertions.extensions string

Die Erweiterungen.

BadgeClass-Name
result.assertions.badgeclassName string

Der Name der BadgeClass.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Entfernen einer Assertion aus dem Rucksack

Entfernen Sie eine Assertion aus dem Rucksack eines Benutzers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Erstellen der BadgeClass eines Ausstellers

Erstellen Sie eine neue BadgeClass, die einem Aussteller zugeordnet ist. Der authentifizierte Benutzer muss über den Besitzer-, Editor- oder Mitarbeiterstatus des Ausstellers verfügen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus. .

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Name
name string

Der Name.

Bild
image string

Das Bild.

Description
description string

Die Beschreibung.

Leistungstyp
achievementType string

Die Art der Leistung.

Kriterien-URL
criteriaUrl string

Die URL der Kriterien.

Kriterienerzählen
criteriaNarrative string

Die Erzählung der Kriterien.

Zielname
targetName string

Der Name des Ziels.

Ziel-URL
targetUrl string

Die URL des Ziels.

Zielbeschreibung
targetDescription string

Die Beschreibung des Ziels.

Zielframework
targetFramework string

Das Framework des Ziels.

Zielcode
targetCode string

Der Code des Ziels.

Stichwörter
tags array of string
Betrag
amount string

Der Betrag.

Dauer
duration string

Die Dauer.

Erweiterungen
extensions string

Die Erweiterungen.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Name
result.name string

Der Name.

Bild
result.image string

Das Bild.

Description
result.description string

Die Beschreibung.

Leistungstyp
result.achievementType string

Die Art der Leistung.

Kriterien-URL
result.criteriaUrl string

Die URL-Adresse der Kriterien.

Kriterienerzählen
result.criteriaNarrative string

Die Erzählung der Kriterien.

Ausrichtungen
result.alignments array of object
Zielname
result.alignments.targetName string

Der Name des Ziels.

Ziel-URL
result.alignments.targetUrl string

Die URL-Adresse des Ziels.

Zielbeschreibung
result.alignments.targetDescription string

Die Beschreibung des Ziels.

Zielframework
result.alignments.targetFramework string

Das Framework des Ziels.

Zielcode
result.alignments.targetCode string

Der Code des Ziels.

Stichwörter
result.tags array of string
Betrag
result.expires.amount string

Der Betrag.

Dauer
result.expires.duration string

Die Dauer.

Erweiterungen
result.extensions string

Die Erweiterungen.

Erstellen einer BadgeClass

Erstellen Sie eine neue BadgeClass.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Number
num integer

Anfordern der Paginierung von Ergebnissen

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus. .

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Name
name string

Der Name.

Bild
image string

Das Bild.

Description
description string

Die Beschreibung.

Leistungstyp
achievementType string

Die Art der Leistung.

Kriterien-URL
criteriaUrl string

Die URL der Kriterien.

Kriterienerzählen
criteriaNarrative string

Die Erzählung der Kriterien.

Zielname
targetName string

Der Name des Ziels.

Ziel-URL
targetUrl string

Die URL des Ziels.

Zielbeschreibung
targetDescription string

Die Beschreibung des Ziels.

Zielframework
targetFramework string

Das Framework des Ziels.

Zielcode
targetCode string

Der Code des Ziels.

Stichwörter
tags array of string
Betrag
amount string

Der Betrag.

Dauer
duration string

Die Dauer.

Erweiterungen
extensions string

Die Erweiterungen.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Name
result.name string

Der Name.

Bild
result.image string

Das Bild.

Description
result.description string

Die Beschreibung.

Leistungstyp
result.achievementType string

Die Art der Leistung.

Kriterien-URL
result.criteriaUrl string

Die URL-Adresse der Kriterien.

Kriterienerzählen
result.criteriaNarrative string

Die Erzählung der Kriterien.

Ausrichtungen
result.alignments array of object
Zielname
result.alignments.targetName string

Der Name des Ziels.

Ziel-URL
result.alignments.targetUrl string

Die URL-Adresse des Ziels.

Zielbeschreibung
result.alignments.targetDescription string

Die Beschreibung des Ziels.

Zielframework
result.alignments.targetFramework string

Das Framework des Ziels.

Zielcode
result.alignments.targetCode string

Der Code des Ziels.

Stichwörter
result.tags array of string
Betrag
result.expires.amount string

Der Betrag.

Dauer
result.expires.duration string

Die Dauer.

Erweiterungen
result.extensions string

Die Erweiterungen.

Erstellen eines Ausstellers

Erstellen Sie einen neuen Aussteller.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Erstellt von
createdBy string

Von wem erstellt wurde.

Name
name string

Der Name.

Bild
image string

Das Bild.

Email
email string

Die E-Mail-Adresse.

Description
description string

Die Beschreibung.

URL
url string

Die URL-Adresse.

Entitätstyp
entityType string

Der Typ der Entität.

Entitäts-ID
entityId string

Der Bezeichner der Entität.

Benutzerprofil
userProfile string

Das Profil des Benutzers.

Benutzer
user string

Der Benutzer.

Rolle
role string

Die Rolle.

Erweiterungen
extensions string

Die Erweiterungen.

Badgr Domain
badgrDomain string

Die Domäne von Badgr.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Name
result.name string

Der Name.

Bild
result.image string

Das Bild.

Email
result.email string

Die E-Mail-Adresse.

Description
result.description string

Die Beschreibung.

URL
result.url string

Die URL-Adresse.

Personal
result.staff array of object
Entitätstyp
result.staff.entityType string

Der Typ der Entität.

Entitäts-ID
result.staff.entityId string

Der Bezeichner der Entität.

Benutzerprofil
result.staff.userProfile string

Das Profil des Benutzers.

Benutzer
result.staff.user string

Der Benutzer.

Rolle
result.staff.role string

Die Rolle.

Erweiterungen
result.extensions string

Die Erweiterungen.

Badgr Domain
result.badgrDomain string

Die Domäne von Badgr.

Erstellen eines BadgeUser-Kontos

Erstellen Sie ein BadgeUser-Konto und -Profil.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Der Bezeichner der Entität.

Entitätstyp
entityType string

Der Typ der Entität.

Entitäts-ID
entityId string

Der Bezeichner der Entität.

Vorname
firstName string

Der Vorname.

Nachname
lastName string

Der Nachname.

Entitätstyp
entityType string

Der Typ der Entität.

Entitäts-ID
entityId string

Der Bezeichner der Entität.

Email
email string

Die E-Mail-Adresse.

Überprüft
verified boolean

Ob überprüft.

Primary
primary boolean

Gibt an, ob primär.

Case Variants
caseVariants string

Die Groß-/Kleinschreibungsvarianten.

URL
url string

Die URL-Adresse.

Telefon
telephone string

Die Telefonnummer.

Vereinbarte Version der Bedingungen
agreedTermsVersion string

Die Fassung der vereinbarten Bedingungen.

Hat die neueste Version der Geschäftsbedingungen vereinbart
hasAgreedToLatestTermsVersion string

Die Version der neuesten Vereinbarten Bedingungen.

Marketing-Opt-In
marketingOptIn string

Hat sich für marketing entschieden.

Badgr Domain
badgrDomain string

Die Domäne von Badgr.

Hat Kennwortsatz
hasPasswordSet string

Verfügt über einen Kennwortsatz.

Recipient
recipient string

Der Empfänger.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Vorname
result.firstName string

Der Vorname.

Nachname
result.lastName string

Der Nachname.

E-Mails
result.emails array of object
Entitätstyp
result.emails.entityType string

Der Typ der Entität.

Entitäts-ID
result.emails.entityId string

Der Bezeichner der Entität.

Email
result.emails.email string

Die E-Mail-Adresse.

Überprüft
result.emails.verified boolean

Ob überprüft.

Primary
result.emails.primary boolean

Gibt an, ob primär.

Case Variants
result.emails.caseVariants string

Die Groß-/Kleinschreibungsvarianten.

URL
result.url string

Die URL-Adresse.

Telefon
result.telephone string

Die Telefonnummer.

Vereinbarte Version der Bedingungen
result.agreedTermsVersion string

Die Fassung der Begriffe aggreed.

Hat die neueste Version der Geschäftsbedingungen vereinbart
result.hasAgreedToLatestTermsVersion string

Die Version der späteren Begriffe aggree.

Marketing-Opt-In
result.marketingOptIn string

Vereinbarte Marketing-Opt-In.

Badgr Domain
result.badgrDomain string

Die Domäne von Badgr.

Hat Kennwortsatz
result.hasPasswordSet string

Wenn das Kennwort festgelegt ist.

Recipient
result.recipient string

Der Empfänger.

Hochladen einer Assertion in den Rucksack

Laden Sie eine neue Assertion in den Rucksack eines Benutzers hoch.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
BadgeClass
badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus. .

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Identität
identity string

Die Identität.

Zerlegt
hashed boolean

Gibt an, ob hashed.

Typ
type string

Der Typ.

Nur-Text-Identität
plaintextIdentity string

Die Identität im Klartext.

Salt
salt string

Wenn hashed, das Salz.

Ausgestellt am
issuedOn string

Wenn sie ausgestellt wird.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

URL
url string

Die URL-Adresse.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

Läuft ab
expires string

Wann läuft ab.

Erweiterungen
extensions string

Die Erweiterungen.

BadgeClass-Name
badgeclassName string

Der Name der BadgeClass.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.recipient.type string

Der Typ.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Erweiterungen
result.extensions string

Die Erweiterungen.

BadgeClass-Name
result.badgeclassName string

Der Name der BadgeClass.

Importieren einer Assertion in Den Rucksack

Importieren Sie eine neue Assertion in den Rucksack eines Benutzers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
URL
url string

URL zu einem OpenBadge-kompatiblen Signal.

Bild
image string

Base64-codiertes OpenBadge-Bild.

Behauptung
assertion object

OpenBadge-kompatibler JSON-Code.

Löschen einer Auflistung

Löschen Sie eine Sammlung aus einem Rucksack.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Löschen einer BadgeClass

Löschen sie eine BadgeClass. Beschränkt auf Besitzer oder Redakteure (nicht Mitarbeiter) des entsprechenden Ausstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Löschen eines Ausstellers

Löschen eines einzelnen Ausstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Sammlungen abrufen

Dient zum Abrufen einer Liste von Sammlungen.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnisse
result array of object

Das Array der Ergebnisse.

Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Name
result.name string

Der Name.

Description
result.description string

Die Beschreibung.

Besitzer
result.owner string

Der Besitzer.

Freigabe-URL
result.share_url string

Die URL-Adresse der Freigabe.

Freigabehash
result.shareHash string

Der Hash der Freigabe.

Veröffentlicht
result.published boolean

Gibt an, ob veröffentlicht.

Assertions
result.assertions array of object
Entitätstyp
result.assertions.entityType string

Der Typ der Entität.

Entitäts-ID
result.assertions.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.assertions.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.assertions.createdAt string

Beim Erstellen bei.

Erstellt von
result.assertions.createdBy string

Erstellt von.

BadgeClass
result.assertions.badgeclass string

Die BadgeClass.

BadgeClass Open Badge ID
result.assertions.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.assertions.issuer string

Der Aussteller.

Aussteller: Offene Badge-ID
result.assertions.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.assertions.image string

Das Bild.

Identität
result.assertions.recipient.identity string

Die Identität.

Zerlegt
result.assertions.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.assertions.recipient.type string

Der Typ.

Nur-Text-Identität
result.assertions.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.assertions.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.assertions.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.assertions.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.assertions.evidence array of object
URL
result.assertions.evidence.url string

Die URL-Adresse.

Erzählung
result.assertions.evidence.narrative string

Die Erzählung.

Widerrufen
result.assertions.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.assertions.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.assertions.acceptance string

Die Annahme.

Läuft ab
result.assertions.expires string

Wann läuft ab.

Erweiterungen
result.assertions.extensions string

Die Erweiterungen.

BadgeClass-Name
result.assertions.badgeclassName string

Der Name der BadgeClass.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

Widerrufen einer Assertion

Widerrufen einer Assertion.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Widerrufsgrund
revocation_reason string

Der Grund für die Widerrufung dieser Behauptung

Widerrufen eines AccessTokens

Widerrufen des AccessTokens eines Benutzers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Entitäts-ID
entity_id True string

Die Kennung der Entität

Widerrufen mehrerer Assertionen

Widerrufen mehrerer Assertionen für mehrere Empfänger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
BadgeClass
badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus. .

Aussteller: Offene Badge-ID
issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Identität
identity string

Die Identität.

Zerlegt
hashed boolean

Gibt an, ob hashed.

Typ
type string

Der Typ.

Nur-Text-Identität
plaintextIdentity string

Die Identität im Klartext.

Salt
salt string

Wenn hashed, das Salz.

Ausgestellt am
issuedOn string

Wenn sie ausgestellt wird.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

URL
url string

Die URL-Adresse.

Erzählung
narrative string

Die Erzählung für das ausgegebene Signal.

Läuft ab
expires string

Wann läuft ab.

Erweiterungen
extensions string

Die Erweiterungen.

BadgeClass-Name
badgeclassName string

Der Name der BadgeClass.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result array of object
Entitätstyp
result.entityType string

Der Typ der Entität.

Entitäts-ID
result.entityId string

Der Bezeichner der Entität.

Signal-ID öffnen
result.openBadgeId string

Der Bezeichner des offenen Badges.

Erstellt unter
result.createdAt string

Beim Erstellen bei.

Erstellt von
result.createdBy string

Von wem erstellt wurde.

BadgeClass
result.badgeclass string

Die Definition eines ertragsfähigen Badges.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

The identifier of the BadgeClass's Open Badge.

Emittent
result.issuer string

Die Person oder Organisation, die Badges erstellt/ anbietet, und gibt sie den Ertragsern aus.

Aussteller: Offene Badge-ID
result.issuerOpenBadgeId string

Der Bezeichner des offenen Badges des Ausstellers.

Bild
result.image string

Das Bild.

Identität
result.recipient.identity string

Die Identität.

Zerlegt
result.recipient.hashed boolean

Gibt an, ob hashed.

Typ
result.recipient.type string

Der Typ.

Nur-Text-Identität
result.recipient.plaintextIdentity string

Die Identität im Klartext.

Salt
result.recipient.salt string

Wenn hashed, das Salz.

Ausgestellt am
result.issuedOn string

Wenn sie ausgestellt wird.

Erzählung
result.narrative string

Die Erzählung für das ausgegebene Signal.

Evidence
result.evidence array of object
URL
result.evidence.url string

Die URL-Adresse.

Erzählung
result.evidence.narrative string

Die Erzählung für das ausgegebene Signal.

Widerrufen
result.revoked boolean

Gibt an, ob dies widerrufen wurde.

Widerrufsgrund
result.revocationReason string

Der Grund für den Widerruf.

Akzeptanz
result.acceptance string

Wann das Signal angenommen wurde.

Läuft ab
result.expires string

Wenn das Signal abläuft.

Erweiterungen
result.extensions string

Die Erweiterungen.

BadgeClass-Name
result.badgeclassName string

Der Name der BadgeClass.

Wiederherstellen eines Kontos

Stellen Sie ein Konto wieder her, und legen Sie ein neues Kennwort fest.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
token string

Das Token, das in der Wiederherstellungs-E-Mail empfangen wurde.

Kennwort
password string

Das zu verwendende neue Kennwort.

Gibt zurück

Name Pfad Typ Beschreibung
Description
status.description string

Die Beschreibung.

Success
status.success boolean

Ob ein Erfolg.

Ergebnis
result

Definitionen

AccessToken