Udostępnij przez


Badgr (niezależny wydawca)

Organizacje na całym świecie używają Badgr do tworzenia markowych ekosystemów uczenia, które wspierają swoje społeczności przy użyciu poświadczeń cyfrowych opartych na umiejętnościach, ścieżki szkoleniowe z możliwością stosu i przenośnych rekordów uczniów.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Troy Taylor
adres URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadane łącznika
Publisher Troy Taylor, Firma Solutions
Witryna internetowa https://badgr.com
Zasady ochrony prywatności https://info.badgr.com/privacy-policy.html
Kategorie Zasoby ludzkie

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Akceptacja potwierdzenia aktualizacji w plecaku

Aktualizowanie akceptacji potwierdzenia w plecaku użytkownika.

Aktualizowanie asercji

Aktualizowanie asercji.

Aktualizowanie klasy BadgeClass

Zaktualizuj istniejącą klasę BadgeClass. Wcześniej wystawione klasy BadgeInstance nie zostaną zaktualizowane.

Aktualizowanie kolekcji

Zaktualizuj kolekcję w plecaku.

Aktualizowanie wskaźnikaUser

Zaktualizuj konto badgeUser. Użyj identyfikatora entityId "self", aby zaktualizować profil uwierzytelnioowanego użytkownika

Aktualizowanie wystawcy

Aktualizowanie pojedynczego wystawcy.

Importowanie potwierdzenia do plecaka

Zaimportuj nową asercję do plecaka użytkownika.

Odwoływanie asercji

Odwoływanie asercji.

Odwoływanie tokenu AccessToken

Odwoływanie tokenu AccessToken użytkownika.

Odwoływanie wielu asercji

Odwoływanie wielu asercji dla wielu adresatów.

Odzyskiwanie konta

Odzyskaj konto i ustaw nowe hasło.

Pobieranie asercji w plecaku użytkownika

Pobierz listę asercji w plecaku uwierzytelnionego użytkownika.

Pobieranie klasy BadgeClasses użytkownika

Pobierz listę klasy BadgeClasses dla uwierzytelnionego użytkownika.

Pobieranie kolekcji

Pobierz pojedynczą kolekcję.

Pobieranie kolekcji

Pobierz listę kolekcji.

Pobieranie tokenów wystawcy

Pobieranie tokenów wystawcy.

Przekazywanie potwierdzenia do plecaka

Przekaż nową asercję do plecaka użytkownika.

Tworzenie klasy BadgeClass

Utwórz nową klasę BadgeClass.

Tworzenie klasy BadgeClass wystawcy

Utwórz nową klasę BadgeClass skojarzona z wystawcą. Uwierzytelniony użytkownik musi mieć stan właściciela, edytora lub personelu wystawcy.

Tworzenie kolekcji

Utwórz nową kolekcję.

Tworzenie konta BadgeUser

Utwórz konto badgeUser i profil.

Tworzenie wystawcy

Utwórz nowego wystawcę.

Usuwanie klasy BadgeClass

Usuń klasę BadgeClass. Ograniczone do właścicieli lub redaktorów (nie pracowników) odpowiedniego wystawcy.

Usuwanie kolekcji

Usuń kolekcję z plecaka.

Usuwanie potwierdzenia z plecaka

Usuń potwierdzenie z plecaka użytkownika.

Usuwanie wystawcy

Usuń pojedynczego wystawcę.

Uzyskiwanie asercji

Pobierz listę asercji dla pojedynczego wystawcy.

Uzyskiwanie asercji BadgeClass

Pobierz listę asercji dla pojedynczej klasy BadgeClass.

Uzyskiwanie klasy BadgeClass

Uzyskaj pojedynczą klasę BadgeClass.

Uzyskiwanie klasy BadgeClasses wystawcy

Pobierz listę klasy BadgeClasses dla pojedynczego wystawcy. Uwierzytelniony użytkownik musi mieć stan właściciela, edytora lub personelu wystawcy.

Uzyskiwanie pojedynczej asercji

Uzyskiwanie asercji

Uzyskiwanie profilu badgeUser

Uzyskaj pojedynczy profil BadgeUser. Użyj identyfikatora entityId "self", aby pobrać profil uwierzytelnioowanego użytkownika.

Uzyskiwanie szczegółów potwierdzenia plecaka

Uzyskaj szczegółowe informacje na temat potwierdzenia w plecaku użytkownika.

Uzyskiwanie tokenu AccessToken

Uzyskaj pojedynczy token AccessToken.

Uzyskiwanie tokenów dostępu użytkownika

Pobierz listę tokenów dostępu dla uwierzytelnionego użytkownika.

Uzyskiwanie wystawcy

Uzyskaj pojedynczego wystawcę.

Uzyskiwanie wystawców

Pobierz listę wystawców dla uwierzytelnionego użytkownika.

Wystawianie asercji

Wystawianie nowej asercji odbiorcy.

Wystawianie asercji

Wystawianie asercji jednemu adresatowi.

Wystawianie wielu klasy BadgeClass

Wydaj wiele kopii tej samej klasy BadgeClass wielu adresatom.

Żądanie wiadomości e-mail odzyskiwania konta

Zażądaj wiadomości e-mail dotyczącej odzyskiwania konta dla użytkownika.

Akceptacja potwierdzenia aktualizacji w plecaku

Aktualizowanie akceptacji potwierdzenia w plecaku użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

Przyjęcie
acceptance string

Akceptacja.

BadgeClass
badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym. .

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Tożsamość
identity string

Tożsamość.

Typ
type string

Typ.

Mieszany
hashed boolean

Czy skrót.

Tożsamość w postaci zwykłego tekstu
plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Wystawione
issuedOn string

Po wystawieniu.

Narracja
narrative string

Narracja dla znaczka wydanego.

adres URL
url string

Adres URL.

Narracja
narrative string

Narracja dla znaczka wydanego.

Wygasa
expires string

Po wygaśnięciu.

W oczekiwaniu
pending string

Oczekujące.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Typ
result.recipient.type string

Typ.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

W oczekiwaniu
result.pending string

Oczekujące.

Aktualizowanie asercji

Aktualizowanie asercji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

BadgeClass
badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym. .

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Tożsamość
identity string

Tożsamość.

Mieszany
hashed boolean

Czy skrót.

Typ
type string

Typ.

Tożsamość w postaci zwykłego tekstu
plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
salt string

Jeśli skrót, sól.

Wystawione
issuedOn string

Po wystawieniu.

Narracja
narrative string

Narracja dla znaczka wydanego.

adres URL
url string

Adres URL.

Narracja
narrative string

Narracja dla znaczka wydanego.

Wygasa
expires string

Po wygaśnięciu.

Extensions
extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
badgeclassName string

Nazwa klasy BadgeClass.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Typ
result.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

Extensions
result.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.badgeclassName string

Nazwa klasy BadgeClass.

Aktualizowanie klasy BadgeClass

Zaktualizuj istniejącą klasę BadgeClass. Wcześniej wystawione klasy BadgeInstance nie zostaną zaktualizowane.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym. .

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Name
name string

Nazwa.

obraz
image string

Obraz.

Description
description string

Opis.

Typ osiągnięcia
achievementType string

Typ osiągnięcia.

Adres URL kryteriów
criteriaUrl string

Adres URL kryteriów.

Narracja kryteriów
criteriaNarrative string

Narracja kryteriów.

Nazwa docelowa
targetName string

Nazwa obiektu docelowego.

Docelowy adres URL
targetUrl string

Adres URL obiektu docelowego.

Opis docelowy
targetDescription string

Opis obiektu docelowego.

Struktura docelowa
targetFramework string

Struktura celu.

Kod docelowy
targetCode string

Kod obiektu docelowego.

Etykiety
tags array of string
Kwota
amount string

Kwota.

Czas trwania
duration string

Czas trwania.

Extensions
extensions string

Rozszerzenia.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Name
result.name string

Nazwa.

obraz
result.image string

Obraz.

Description
result.description string

Opis.

Typ osiągnięcia
result.achievementType string

Typ osiągnięcia.

Adres URL kryteriów
result.criteriaUrl string

Adres URL kryteriów.

Narracja kryteriów
result.criteriaNarrative string

Narracja kryteriów.

Linie trasowania
result.alignments array of object
Nazwa docelowa
result.alignments.targetName string

Nazwa obiektu docelowego.

Docelowy adres URL
result.alignments.targetUrl string

Adres URL obiektu docelowego.

Opis docelowy
result.alignments.targetDescription string

Opis obiektu docelowego.

Struktura docelowa
result.alignments.targetFramework string

Struktura celu.

Kod docelowy
result.alignments.targetCode string

Kod obiektu docelowego.

Etykiety
result.tags array of string
Kwota
result.expires.amount string

Kwota.

Czas trwania
result.expires.duration string

Czas trwania.

Extensions
result.extensions string

Rozszerzenia.

Aktualizowanie kolekcji

Zaktualizuj kolekcję w plecaku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

Typ jednostki
entityType string

Typ jednostki.

Identyfikator jednostki
entityId string

Identyfikator jednostki.

Name
name string

Nazwa.

Description
description string

Opis.

Właściciel
owner string

Właściciel.

Adres URL udostępniania
share_url string

Adres URL udziału.

Udostępnianie skrótu
shareHash string

Skrót udziału.

Opublikowany
published boolean

Czy opublikowano.

BadgeClass
badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Tożsamość
identity string

Tożsamość.

Mieszany
hashed boolean

Czy skrót.

Typ
type string

Typ.

Tożsamość w postaci zwykłego tekstu
plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
salt string

Jeśli skrót, sól.

Wystawione
issuedOn string

Po wystawieniu.

Narracja
narrative string

Narracja dla znaczka wydanego.

adres URL
url string

Adres URL.

Narracja
narrative string

Narracja dla znaczka wydanego.

Wygasa
expires string

Po wygaśnięciu wskaźnika.

Extensions
extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
badgeclassName string

Nazwa klasy BadgeClass.

Utworzono pod adresem
createdAt string

Utworzono pod adresem.

Stworzone przez
createdBy string

Przez kogo utworzono.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Name
result.name string

Nazwa.

Description
result.description string

Opis.

Właściciel
result.owner string

Właściciel.

Adres URL udostępniania
result.share_url string

Adres URL udziału.

Udostępnianie skrótu
result.shareHash string

Skrót udziału.

Opublikowany
result.published boolean

Czy opublikowano.

Assertions
result.assertions array of object
Typ jednostki
result.assertions.entityType string

Typ jednostki.

Identyfikator jednostki
result.assertions.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.assertions.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.assertions.createdAt string

Po utworzeniu na.

Stworzone przez
result.assertions.createdBy string

Utworzone przez.

BadgeClass
result.assertions.badgeclass string

The BadgeClass.

BadgeClass Open Badge ID
result.assertions.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.assertions.issuer string

Wystawca.

Identyfikator wskaźnika Otwarcia wystawcy
result.assertions.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.assertions.image string

Obraz.

Tożsamość
result.assertions.recipient.identity string

Tożsamość.

Mieszany
result.assertions.recipient.hashed boolean

Czy skrót.

Typ
result.assertions.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.assertions.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.assertions.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.assertions.issuedOn string

Po wystawieniu.

Narracja
result.assertions.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.assertions.evidence.narrative string

Narracja.

Odwołany
result.assertions.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.assertions.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.assertions.acceptance string

Akceptacja.

Wygasa
result.assertions.expires string

Po wygaśnięciu.

Extensions
result.assertions.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.assertions.badgeclassName string

Nazwa klasy BadgeClass.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Aktualizowanie wskaźnikaUser

Zaktualizuj konto badgeUser. Użyj identyfikatora entityId "self", aby zaktualizować profil uwierzytelnioowanego użytkownika

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

Typ jednostki
entityType string

Typ jednostki.

Identyfikator jednostki
entityId string

Identyfikator jednostki.

Imię
firstName string

Imię.

Nazwisko
lastName string

Nazwisko.

Typ jednostki
entityType string

Typ jednostki.

Identyfikator jednostki
entityId string

Identyfikator jednostki.

Email
email string

Adres e-mail.

Sprawdzonych
verified boolean

Czy zweryfikowano.

Primary
primary boolean

Czy podstawowe.

Warianty wielkości liter
caseVariants string

Warianty wielkości liter.

adres URL
url string

Adres URL.

Telefon
telephone string

Numer telefonu.

Uzgodniona wersja warunków
agreedTermsVersion string

Wersja uzgodnionych warunków.

Zgodził się na najnowszą wersję warunków
hasAgreedToLatestTermsVersion string

Wersja najnowszych warunków uzgodnionych.

Zgoda marketingowa
marketingOptIn string

Zdecydował się na marketing.

Zła domena
badgrDomain string

Domena Badgr.

Ma zestaw haseł
hasPasswordSet string

Ma ustawione hasło.

Recipient
recipient string

Odbiorca.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Imię
result.firstName string

Imię.

Nazwisko
result.lastName string

Nazwisko.

Wiadomości e-mail
result.emails array of object
Typ jednostki
result.emails.entityType string

Typ jednostki.

Identyfikator jednostki
result.emails.entityId string

Identyfikator jednostki.

Email
result.emails.email string

Adres e-mail.

Sprawdzonych
result.emails.verified boolean

Czy zweryfikowano.

Primary
result.emails.primary boolean

Czy podstawowe.

Warianty wielkości liter
result.emails.caseVariants string

Warianty wielkości liter.

adres URL
result.url string

Adres URL.

Telefon
result.telephone string

Numer telefonu.

Uzgodniona wersja warunków
result.agreedTermsVersion string

Wersja terminów aggreed.

Zgodził się na najnowszą wersję warunków
result.hasAgreedToLatestTermsVersion string

Wersja nowszych terminów aggree.

Zgoda marketingowa
result.marketingOptIn string

Zgodziła się na zgodę marketingową.

Zła domena
result.badgrDomain string

Domena Badgr.

Ma zestaw haseł
result.hasPasswordSet string

Jeśli ma ustawione hasło.

Recipient
result.recipient string

Odbiorca.

Aktualizowanie wystawcy

Aktualizowanie pojedynczego wystawcy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

Stworzone przez
createdBy string

Przez kogo utworzono.

Name
name string

Nazwa.

obraz
image string

Obraz.

Email
email string

Adres e-mail.

Description
description string

Opis.

adres URL
url string

Adres URL.

Typ jednostki
entityType string

Typ jednostki.

Identyfikator jednostki
entityId string

Identyfikator jednostki.

Profil użytkownika
userProfile string

Profil użytkownika.

User
user string

Użytkownik.

Role
role string

Rola.

Extensions
extensions string

Rozszerzenia.

Zła domena
badgrDomain string

Domena Badgr.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Name
result.name string

Nazwa.

obraz
result.image string

Obraz.

Email
result.email string

Adres e-mail.

Description
result.description string

Opis.

adres URL
result.url string

Adres URL.

Personel
result.staff array of object
Typ jednostki
result.staff.entityType string

Typ jednostki.

Identyfikator jednostki
result.staff.entityId string

Identyfikator jednostki.

Profil użytkownika
result.staff.userProfile string

Profil użytkownika.

User
result.staff.user string

Użytkownik.

Role
result.staff.role string

Rola.

Extensions
result.extensions string

Rozszerzenia.

Zła domena
result.badgrDomain string

Domena Badgr.

Importowanie potwierdzenia do plecaka

Zaimportuj nową asercję do plecaka użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
adres URL
url string

Znaczek Adres URL zgodny ze standardem OpenBadge.

obraz
image string

Obraz Baked OpenBadge zakodowany w formacie Base64.

Twierdzenie
assertion object

Plik JSON zgodny ze standardem OpenBadge.

Odwoływanie asercji

Odwoływanie asercji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Przyczyna odwołania
revocation_reason string

Przyczyna cofnięcia tej asercji

Odwoływanie tokenu AccessToken

Odwoływanie tokenu AccessToken użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Odwoływanie wielu asercji

Odwoływanie wielu asercji dla wielu adresatów.

Parametry

Nazwa Klucz Wymagane Typ Opis
BadgeClass
badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym. .

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Tożsamość
identity string

Tożsamość.

Mieszany
hashed boolean

Czy skrót.

Typ
type string

Typ.

Tożsamość w postaci zwykłego tekstu
plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
salt string

Jeśli skrót, sól.

Wystawione
issuedOn string

Po wystawieniu.

Narracja
narrative string

Narracja dla znaczka wydanego.

adres URL
url string

Adres URL.

Narracja
narrative string

Narracja dla znaczka wydanego.

Wygasa
expires string

Po wygaśnięciu.

Extensions
extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
badgeclassName string

Nazwa klasy BadgeClass.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Typ
result.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

Extensions
result.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.badgeclassName string

Nazwa klasy BadgeClass.

Odzyskiwanie konta

Odzyskaj konto i ustaw nowe hasło.

Parametry

Nazwa Klucz Wymagane Typ Opis
Żeton
token string

Token otrzymany w wiadomości e-mail dotyczącej odzyskiwania.

Hasło
password string

Nowe hasło do użycia.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result

Pobieranie asercji w plecaku użytkownika

Pobierz listę asercji w plecaku uwierzytelnionego użytkownika.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Typ
result.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

Extensions
result.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.badgeclassName string

Nazwa klasy BadgeClass.

Pobieranie klasy BadgeClasses użytkownika

Pobierz listę klasy BadgeClasses dla uwierzytelnionego użytkownika.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Name
result.name string

Nazwa.

obraz
result.image string

Obraz.

Description
result.description string

Opis.

Typ osiągnięcia
result.achievementType string

Typ osiągnięcia.

Adres URL kryteriów
result.criteriaUrl string

Adres URL kryteriów.

Narracja kryteriów
result.criteriaNarrative string

Narracja kryteriów.

Linie trasowania
result.alignments array of object
Nazwa docelowa
result.alignments.targetName string

Nazwa obiektu docelowego.

Docelowy adres URL
result.alignments.targetUrl string

Adres URL obiektu docelowego.

Opis docelowy
result.alignments.targetDescription string

Opis obiektu docelowego.

Struktura docelowa
result.alignments.targetFramework string

Struktura celu.

Kod docelowy
result.alignments.targetCode string

Kod obiektu docelowego.

Etykiety
result.tags array of string
Kwota
result.expires.amount string

Kwota.

Czas trwania
result.expires.duration string

Czas trwania.

Extensions
result.extensions string

Rozszerzenia.

Pobieranie kolekcji

Pobierz pojedynczą kolekcję.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Name
result.name string

Nazwa.

Description
result.description string

Opis.

Właściciel
result.owner string

Właściciel.

Adres URL udostępniania
result.share_url string

Adres URL udziału.

Udostępnianie skrótu
result.shareHash string

Skrót udziału.

Opublikowany
result.published boolean

Czy opublikowano.

Assertions
result.assertions array of object
Typ jednostki
result.assertions.entityType string

Typ jednostki.

Identyfikator jednostki
result.assertions.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.assertions.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.assertions.createdAt string

Po utworzeniu na.

Stworzone przez
result.assertions.createdBy string

Utworzone przez.

BadgeClass
result.assertions.badgeclass string

The BadgeClass.

BadgeClass Open Badge ID
result.assertions.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.assertions.issuer string

Wystawca.

Identyfikator wskaźnika Otwarcia wystawcy
result.assertions.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.assertions.image string

Obraz.

Tożsamość
result.assertions.recipient.identity string

Tożsamość.

Mieszany
result.assertions.recipient.hashed boolean

Czy skrót.

Typ
result.assertions.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.assertions.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.assertions.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.assertions.issuedOn string

Po wystawieniu.

Narracja
result.assertions.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.assertions.evidence.narrative string

Narracja.

Odwołany
result.assertions.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.assertions.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.assertions.acceptance string

Akceptacja.

Wygasa
result.assertions.expires string

Po wygaśnięciu.

Extensions
result.assertions.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.assertions.badgeclassName string

Nazwa klasy BadgeClass.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Pobieranie kolekcji

Pobierz listę kolekcji.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Name
result.name string

Nazwa.

Description
result.description string

Opis.

Właściciel
result.owner string

Właściciel.

Adres URL udostępniania
result.share_url string

Adres URL udziału.

Udostępnianie skrótu
result.shareHash string

Skrót udziału.

Opublikowany
result.published boolean

Czy opublikowano.

Assertions
result.assertions array of object
Typ jednostki
result.assertions.entityType string

Typ jednostki.

Identyfikator jednostki
result.assertions.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.assertions.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.assertions.createdAt string

Po utworzeniu na.

Stworzone przez
result.assertions.createdBy string

Utworzone przez.

BadgeClass
result.assertions.badgeclass string

The BadgeClass.

BadgeClass Open Badge ID
result.assertions.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.assertions.issuer string

Wystawca.

Identyfikator wskaźnika Otwarcia wystawcy
result.assertions.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.assertions.image string

Obraz.

Tożsamość
result.assertions.recipient.identity string

Tożsamość.

Mieszany
result.assertions.recipient.hashed boolean

Czy skrót.

Typ
result.assertions.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.assertions.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.assertions.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.assertions.issuedOn string

Po wystawieniu.

Narracja
result.assertions.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.assertions.evidence.narrative string

Narracja.

Odwołany
result.assertions.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.assertions.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.assertions.acceptance string

Akceptacja.

Wygasa
result.assertions.expires string

Po wygaśnięciu.

Extensions
result.assertions.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.assertions.badgeclassName string

Nazwa klasy BadgeClass.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Pobieranie tokenów wystawcy

Pobieranie tokenów wystawcy.

Parametry

Nazwa Klucz Wymagane Typ Opis
body
body True

Zwraca

response
AccessToken

Przekazywanie potwierdzenia do plecaka

Przekaż nową asercję do plecaka użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
BadgeClass
badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym. .

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Tożsamość
identity string

Tożsamość.

Mieszany
hashed boolean

Czy skrót.

Typ
type string

Typ.

Tożsamość w postaci zwykłego tekstu
plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
salt string

Jeśli skrót, sól.

Wystawione
issuedOn string

Po wystawieniu.

Narracja
narrative string

Narracja dla znaczka wydanego.

adres URL
url string

Adres URL.

Narracja
narrative string

Narracja dla znaczka wydanego.

Wygasa
expires string

Po wygaśnięciu.

Extensions
extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
badgeclassName string

Nazwa klasy BadgeClass.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Typ
result.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

Extensions
result.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.badgeclassName string

Nazwa klasy BadgeClass.

Tworzenie klasy BadgeClass

Utwórz nową klasę BadgeClass.

Parametry

Nazwa Klucz Wymagane Typ Opis
Number
num integer

Żądanie stronicowania wyników

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym. .

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Name
name string

Nazwa.

obraz
image string

Obraz.

Description
description string

Opis.

Typ osiągnięcia
achievementType string

Typ osiągnięcia.

Adres URL kryteriów
criteriaUrl string

Adres URL kryteriów.

Narracja kryteriów
criteriaNarrative string

Narracja kryteriów.

Nazwa docelowa
targetName string

Nazwa obiektu docelowego.

Docelowy adres URL
targetUrl string

Adres URL obiektu docelowego.

Opis docelowy
targetDescription string

Opis obiektu docelowego.

Struktura docelowa
targetFramework string

Struktura celu.

Kod docelowy
targetCode string

Kod obiektu docelowego.

Etykiety
tags array of string
Kwota
amount string

Kwota.

Czas trwania
duration string

Czas trwania.

Extensions
extensions string

Rozszerzenia.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Name
result.name string

Nazwa.

obraz
result.image string

Obraz.

Description
result.description string

Opis.

Typ osiągnięcia
result.achievementType string

Typ osiągnięcia.

Adres URL kryteriów
result.criteriaUrl string

Adres URL kryteriów.

Narracja kryteriów
result.criteriaNarrative string

Narracja kryteriów.

Linie trasowania
result.alignments array of object
Nazwa docelowa
result.alignments.targetName string

Nazwa obiektu docelowego.

Docelowy adres URL
result.alignments.targetUrl string

Adres URL obiektu docelowego.

Opis docelowy
result.alignments.targetDescription string

Opis obiektu docelowego.

Struktura docelowa
result.alignments.targetFramework string

Struktura celu.

Kod docelowy
result.alignments.targetCode string

Kod obiektu docelowego.

Etykiety
result.tags array of string
Kwota
result.expires.amount string

Kwota.

Czas trwania
result.expires.duration string

Czas trwania.

Extensions
result.extensions string

Rozszerzenia.

Tworzenie klasy BadgeClass wystawcy

Utwórz nową klasę BadgeClass skojarzona z wystawcą. Uwierzytelniony użytkownik musi mieć stan właściciela, edytora lub personelu wystawcy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym. .

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Name
name string

Nazwa.

obraz
image string

Obraz.

Description
description string

Opis.

Typ osiągnięcia
achievementType string

Typ osiągnięcia.

Adres URL kryteriów
criteriaUrl string

Adres URL kryteriów.

Narracja kryteriów
criteriaNarrative string

Narracja kryteriów.

Nazwa docelowa
targetName string

Nazwa obiektu docelowego.

Docelowy adres URL
targetUrl string

Adres URL obiektu docelowego.

Opis docelowy
targetDescription string

Opis obiektu docelowego.

Struktura docelowa
targetFramework string

Struktura celu.

Kod docelowy
targetCode string

Kod obiektu docelowego.

Etykiety
tags array of string
Kwota
amount string

Kwota.

Czas trwania
duration string

Czas trwania.

Extensions
extensions string

Rozszerzenia.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Name
result.name string

Nazwa.

obraz
result.image string

Obraz.

Description
result.description string

Opis.

Typ osiągnięcia
result.achievementType string

Typ osiągnięcia.

Adres URL kryteriów
result.criteriaUrl string

Adres URL kryteriów.

Narracja kryteriów
result.criteriaNarrative string

Narracja kryteriów.

Linie trasowania
result.alignments array of object
Nazwa docelowa
result.alignments.targetName string

Nazwa obiektu docelowego.

Docelowy adres URL
result.alignments.targetUrl string

Adres URL obiektu docelowego.

Opis docelowy
result.alignments.targetDescription string

Opis obiektu docelowego.

Struktura docelowa
result.alignments.targetFramework string

Struktura celu.

Kod docelowy
result.alignments.targetCode string

Kod obiektu docelowego.

Etykiety
result.tags array of string
Kwota
result.expires.amount string

Kwota.

Czas trwania
result.expires.duration string

Czas trwania.

Extensions
result.extensions string

Rozszerzenia.

Tworzenie kolekcji

Utwórz nową kolekcję.

Parametry

Nazwa Klucz Wymagane Typ Opis
Typ jednostki
entityType string

Typ jednostki.

Identyfikator jednostki
entityId string

Identyfikator jednostki.

Name
name string

Nazwa.

Description
description string

Opis.

Właściciel
owner string

Właściciel.

Adres URL udostępniania
share_url string

Adres URL udziału.

Udostępnianie skrótu
shareHash string

Skrót udziału.

Opublikowany
published boolean

Czy opublikowano.

BadgeClass
badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Tożsamość
identity string

Tożsamość.

Mieszany
hashed boolean

Czy skrót.

Typ
type string

Typ.

Tożsamość w postaci zwykłego tekstu
plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
salt string

Jeśli skrót, sól.

Wystawione
issuedOn string

Po wystawieniu.

Narracja
narrative string

Narracja dla znaczka wydanego.

adres URL
url string

Adres URL.

Narracja
narrative string

Narracja dla znaczka wydanego.

Wygasa
expires string

Po wygaśnięciu wskaźnika.

Extensions
extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
badgeclassName string

Nazwa klasy BadgeClass.

Utworzono pod adresem
createdAt string

Utworzono pod adresem.

Stworzone przez
createdBy string

Przez kogo utworzono.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Name
result.name string

Nazwa.

Description
result.description string

Opis.

Właściciel
result.owner string

Właściciel.

Adres URL udostępniania
result.share_url string

Adres URL udziału.

Udostępnianie skrótu
result.shareHash string

Skrót udziału.

Opublikowany
result.published boolean

Czy opublikowano.

Assertions
result.assertions array of object
Typ jednostki
result.assertions.entityType string

Typ jednostki.

Identyfikator jednostki
result.assertions.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.assertions.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.assertions.createdAt string

Po utworzeniu na.

Stworzone przez
result.assertions.createdBy string

Utworzone przez.

BadgeClass
result.assertions.badgeclass string

The BadgeClass.

BadgeClass Open Badge ID
result.assertions.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.assertions.issuer string

Wystawca.

Identyfikator wskaźnika Otwarcia wystawcy
result.assertions.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.assertions.image string

Obraz.

Tożsamość
result.assertions.recipient.identity string

Tożsamość.

Mieszany
result.assertions.recipient.hashed boolean

Czy skrót.

Typ
result.assertions.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.assertions.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.assertions.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.assertions.issuedOn string

Po wystawieniu.

Narracja
result.assertions.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.assertions.evidence.narrative string

Narracja.

Odwołany
result.assertions.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.assertions.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.assertions.acceptance string

Akceptacja.

Wygasa
result.assertions.expires string

Po wygaśnięciu.

Extensions
result.assertions.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.assertions.badgeclassName string

Nazwa klasy BadgeClass.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Tworzenie konta BadgeUser

Utwórz konto badgeUser i profil.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

Typ jednostki
entityType string

Typ jednostki.

Identyfikator jednostki
entityId string

Identyfikator jednostki.

Imię
firstName string

Imię.

Nazwisko
lastName string

Nazwisko.

Typ jednostki
entityType string

Typ jednostki.

Identyfikator jednostki
entityId string

Identyfikator jednostki.

Email
email string

Adres e-mail.

Sprawdzonych
verified boolean

Czy zweryfikowano.

Primary
primary boolean

Czy podstawowe.

Warianty wielkości liter
caseVariants string

Warianty wielkości liter.

adres URL
url string

Adres URL.

Telefon
telephone string

Numer telefonu.

Uzgodniona wersja warunków
agreedTermsVersion string

Wersja uzgodnionych warunków.

Zgodził się na najnowszą wersję warunków
hasAgreedToLatestTermsVersion string

Wersja najnowszych warunków uzgodnionych.

Zgoda marketingowa
marketingOptIn string

Zdecydował się na marketing.

Zła domena
badgrDomain string

Domena Badgr.

Ma zestaw haseł
hasPasswordSet string

Ma ustawione hasło.

Recipient
recipient string

Odbiorca.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Imię
result.firstName string

Imię.

Nazwisko
result.lastName string

Nazwisko.

Wiadomości e-mail
result.emails array of object
Typ jednostki
result.emails.entityType string

Typ jednostki.

Identyfikator jednostki
result.emails.entityId string

Identyfikator jednostki.

Email
result.emails.email string

Adres e-mail.

Sprawdzonych
result.emails.verified boolean

Czy zweryfikowano.

Primary
result.emails.primary boolean

Czy podstawowe.

Warianty wielkości liter
result.emails.caseVariants string

Warianty wielkości liter.

adres URL
result.url string

Adres URL.

Telefon
result.telephone string

Numer telefonu.

Uzgodniona wersja warunków
result.agreedTermsVersion string

Wersja terminów aggreed.

Zgodził się na najnowszą wersję warunków
result.hasAgreedToLatestTermsVersion string

Wersja nowszych terminów aggree.

Zgoda marketingowa
result.marketingOptIn string

Zgodziła się na zgodę marketingową.

Zła domena
result.badgrDomain string

Domena Badgr.

Ma zestaw haseł
result.hasPasswordSet string

Jeśli ma ustawione hasło.

Recipient
result.recipient string

Odbiorca.

Tworzenie wystawcy

Utwórz nowego wystawcę.

Parametry

Nazwa Klucz Wymagane Typ Opis
Stworzone przez
createdBy string

Przez kogo utworzono.

Name
name string

Nazwa.

obraz
image string

Obraz.

Email
email string

Adres e-mail.

Description
description string

Opis.

adres URL
url string

Adres URL.

Typ jednostki
entityType string

Typ jednostki.

Identyfikator jednostki
entityId string

Identyfikator jednostki.

Profil użytkownika
userProfile string

Profil użytkownika.

User
user string

Użytkownik.

Role
role string

Rola.

Extensions
extensions string

Rozszerzenia.

Zła domena
badgrDomain string

Domena Badgr.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Name
result.name string

Nazwa.

obraz
result.image string

Obraz.

Email
result.email string

Adres e-mail.

Description
result.description string

Opis.

adres URL
result.url string

Adres URL.

Personel
result.staff array of object
Typ jednostki
result.staff.entityType string

Typ jednostki.

Identyfikator jednostki
result.staff.entityId string

Identyfikator jednostki.

Profil użytkownika
result.staff.userProfile string

Profil użytkownika.

User
result.staff.user string

Użytkownik.

Role
result.staff.role string

Rola.

Extensions
result.extensions string

Rozszerzenia.

Zła domena
result.badgrDomain string

Domena Badgr.

Usuwanie klasy BadgeClass

Usuń klasę BadgeClass. Ograniczone do właścicieli lub redaktorów (nie pracowników) odpowiedniego wystawcy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Usuwanie kolekcji

Usuń kolekcję z plecaka.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Usuwanie potwierdzenia z plecaka

Usuń potwierdzenie z plecaka użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Usuwanie wystawcy

Usuń pojedynczego wystawcę.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Uzyskiwanie asercji

Pobierz listę asercji dla pojedynczego wystawcy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Recipient
recipient string

Identyfikator adresata do filtrowania według

Number
num string

Żądanie stronicowania wyników

Uwzględnij wygasłe
include_expired boolean

Uwzględnianie wygasłych asercji

Uwzględnij odwołane
include_revoked boolean

Dołączanie odwołanych asercji

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Typ
result.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

Extensions
result.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.badgeclassName string

Nazwa klasy BadgeClass.

Uzyskiwanie asercji BadgeClass

Pobierz listę asercji dla pojedynczej klasy BadgeClass.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Recipient
recipient string

Identyfikator adresata do filtrowania według

Number
num string

Żądanie stronicowania wyników

Uwzględnij wygasłe
include_expired boolean

Uwzględnianie wygasłych asercji

Uwzględnij odwołane
include_revoked boolean

Dołączanie odwołanych asercji

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Typ
result.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

Extensions
result.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.badgeclassName string

Nazwa klasy BadgeClass.

Uzyskiwanie klasy BadgeClass

Uzyskaj pojedynczą klasę BadgeClass.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Name
result.name string

Nazwa.

obraz
result.image string

Obraz.

Description
result.description string

Opis.

Typ osiągnięcia
result.achievementType string

Typ osiągnięcia.

Adres URL kryteriów
result.criteriaUrl string

Adres URL kryteriów.

Narracja kryteriów
result.criteriaNarrative string

Narracja kryteriów.

Linie trasowania
result.alignments array of object
Nazwa docelowa
result.alignments.targetName string

Nazwa obiektu docelowego.

Docelowy adres URL
result.alignments.targetUrl string

Adres URL obiektu docelowego.

Opis docelowy
result.alignments.targetDescription string

Opis obiektu docelowego.

Struktura docelowa
result.alignments.targetFramework string

Struktura celu.

Kod docelowy
result.alignments.targetCode string

Kod obiektu docelowego.

Etykiety
result.tags array of string
Kwota
result.expires.amount string

Kwota.

Czas trwania
result.expires.duration string

Czas trwania.

Extensions
result.extensions string

Rozszerzenia.

Uzyskiwanie klasy BadgeClasses wystawcy

Pobierz listę klasy BadgeClasses dla pojedynczego wystawcy. Uwierzytelniony użytkownik musi mieć stan właściciela, edytora lub personelu wystawcy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Number
num string

Żądanie stronicowania wyników

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Name
result.name string

Nazwa.

obraz
result.image string

Obraz.

Description
result.description string

Opis.

Typ osiągnięcia
result.achievementType string

Typ osiągnięcia.

Adres URL kryteriów
result.criteriaUrl string

Adres URL kryteriów.

Narracja kryteriów
result.criteriaNarrative string

Narracja kryteriów.

Linie trasowania
result.alignments array of object
Nazwa docelowa
result.alignments.targetName string

Nazwa obiektu docelowego.

Docelowy adres URL
result.alignments.targetUrl string

Adres URL obiektu docelowego.

Opis docelowy
result.alignments.targetDescription string

Opis obiektu docelowego.

Struktura docelowa
result.alignments.targetFramework string

Struktura celu.

Kod docelowy
result.alignments.targetCode string

Kod obiektu docelowego.

Etykiety
result.tags array of string
Kwota
result.expires.amount string

Kwota.

Czas trwania
result.expires.duration string

Czas trwania.

Extensions
result.extensions string

Rozszerzenia.

Uzyskiwanie pojedynczej asercji

Uzyskiwanie asercji

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Typ
result.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

Extensions
result.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.badgeclassName string

Nazwa klasy BadgeClass.

Uzyskiwanie profilu badgeUser

Uzyskaj pojedynczy profil BadgeUser. Użyj identyfikatora entityId "self", aby pobrać profil uwierzytelnioowanego użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Imię
result.firstName string

Imię.

Nazwisko
result.lastName string

Nazwisko.

Wiadomości e-mail
result.emails array of object
Typ jednostki
result.emails.entityType string

Typ jednostki.

Identyfikator jednostki
result.emails.entityId string

Identyfikator jednostki.

Email
result.emails.email string

Adres e-mail.

Sprawdzonych
result.emails.verified boolean

Czy zweryfikowano.

Primary
result.emails.primary boolean

Czy podstawowe.

Warianty wielkości liter
result.emails.caseVariants string

Warianty wielkości liter.

adres URL
result.url string

Adres URL.

Telefon
result.telephone string

Numer telefonu.

Uzgodniona wersja warunków
result.agreedTermsVersion string

Wersja terminów aggreed.

Zgodził się na najnowszą wersję warunków
result.hasAgreedToLatestTermsVersion string

Wersja nowszych terminów aggree.

Zgoda marketingowa
result.marketingOptIn string

Zgodziła się na zgodę marketingową.

Zła domena
result.badgrDomain string

Domena Badgr.

Ma zestaw haseł
result.hasPasswordSet string

Jeśli ma ustawione hasło.

Recipient
result.recipient string

Odbiorca.

Uzyskiwanie szczegółów potwierdzenia plecaka

Uzyskaj szczegółowe informacje na temat potwierdzenia w plecaku użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Typ
result.recipient.type string

Typ.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

W oczekiwaniu
result.pending string

Oczekujące.

Uzyskiwanie tokenu AccessToken

Uzyskaj pojedynczy token AccessToken.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result AccessToken

Uzyskiwanie tokenów dostępu użytkownika

Pobierz listę tokenów dostępu dla uwierzytelnionego użytkownika.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of AccessToken

Uzyskiwanie wystawcy

Uzyskaj pojedynczego wystawcę.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

Results
result array of object

Tablica wyników.

Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Name
result.name string

Nazwa.

obraz
result.image string

Obraz.

Email
result.email string

Adres e-mail.

Description
result.description string

Opis.

adres URL
result.url string

Adres URL.

Personel
result.staff array of object
Typ jednostki
result.staff.entityType string

Typ jednostki.

Identyfikator jednostki
result.staff.entityId string

Identyfikator jednostki.

Profil użytkownika
result.staff.userProfile string

Profil użytkownika.

User
result.staff.user string

Użytkownik.

Role
result.staff.role string

Rola.

Extensions
result.extensions string

Rozszerzenia.

Zła domena
result.badgrDomain string

Domena Badgr.

Uzyskiwanie wystawców

Pobierz listę wystawców dla uwierzytelnionego użytkownika.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

Name
result.name string

Nazwa.

obraz
result.image string

Obraz.

Email
result.email string

Adres e-mail.

Description
result.description string

Opis.

adres URL
result.url string

Adres URL.

Personel
result.staff array of object
Typ jednostki
result.staff.entityType string

Typ jednostki.

Identyfikator jednostki
result.staff.entityId string

Identyfikator jednostki.

Typ jednostki
result.staff.userProfile.entityType string

Typ jednostki.

Identyfikator jednostki
result.staff.userProfile.entityId string

Identyfikator jednostki.

Imię
result.staff.userProfile.firstName string

Imię.

Nazwisko
result.staff.userProfile.lastName string

Nazwisko.

Wiadomości e-mail
result.staff.userProfile.emails array of object
Email
result.staff.userProfile.emails.email string

Adres e-mail.

Sprawdzonych
result.staff.userProfile.emails.verified boolean

Czy zweryfikowano.

Primary
result.staff.userProfile.emails.primary boolean

Czy podstawowe.

Warianty wielkości liter
result.staff.userProfile.emails.caseVariants array of string

Warianty wielkości liter.

Adresy URL
result.staff.userProfile.url array of string

Adresy URL.

Numery telefonów
result.staff.userProfile.telephone array of string

Numery telefonów.

Zła domena
result.staff.userProfile.badgrDomain string

Domena Badgr.

User
result.staff.user string

Użytkownik.

Role
result.staff.role string

Rola.

Extensions
result.extensions string

Rozszerzenia.

Zła domena
result.badgrDomain string

Domena Badgr.

Wystawianie asercji

Wystawianie nowej asercji odbiorcy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

BadgeClass
badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym. .

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Tożsamość
identity string

Tożsamość.

Mieszany
hashed boolean

Czy skrót.

Typ
type string

Typ.

Tożsamość w postaci zwykłego tekstu
plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
salt string

Jeśli skrót, sól.

Wystawione
issuedOn string

Po wystawieniu.

Narracja
narrative string

Narracja dla znaczka wydanego.

adres URL
url string

Adres URL.

Narracja
narrative string

Narracja dla znaczka wydanego.

Wygasa
expires string

Po wygaśnięciu.

Extensions
extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
badgeclassName string

Nazwa klasy BadgeClass.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Typ
result.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

Extensions
result.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.badgeclassName string

Nazwa klasy BadgeClass.

Wystawianie asercji

Wystawianie asercji jednemu adresatowi.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

BadgeClass
badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym. .

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Tożsamość
identity string

Tożsamość.

Mieszany
hashed boolean

Czy skrót.

Typ
type string

Typ.

Tożsamość w postaci zwykłego tekstu
plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
salt string

Jeśli skrót, sól.

Wystawione
issuedOn string

Po wystawieniu.

Narracja
narrative string

Narracja dla znaczka wydanego.

adres URL
url string

Adres URL.

Narracja
narrative string

Narracja dla znaczka wydanego.

Wygasa
expires string

Po wygaśnięciu.

Extensions
extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
badgeclassName string

Nazwa klasy BadgeClass.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Typ
result.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

Extensions
result.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.badgeclassName string

Nazwa klasy BadgeClass.

Wystawianie wielu klasy BadgeClass

Wydaj wiele kopii tej samej klasy BadgeClass wielu adresatom.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator jednostki
entity_id True string

Identyfikator jednostki.

BadgeClass
badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym. .

Identyfikator wskaźnika Otwarcia wystawcy
issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

Tożsamość
identity string

Tożsamość.

Mieszany
hashed boolean

Czy skrót.

Typ
type string

Typ.

Tożsamość w postaci zwykłego tekstu
plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
salt string

Jeśli skrót, sól.

Wystawione
issuedOn string

Po wystawieniu.

Narracja
narrative string

Narracja dla znaczka wydanego.

adres URL
url string

Adres URL.

Narracja
narrative string

Narracja dla znaczka wydanego.

Wygasa
expires string

Po wygaśnięciu.

Extensions
extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
badgeclassName string

Nazwa klasy BadgeClass.

Zwraca

Nazwa Ścieżka Typ Opis
Description
status.description string

Opis.

Powodzenie
status.success boolean

Czy sukces.

wynik
result array of object
Typ jednostki
result.entityType string

Typ jednostki.

Identyfikator jednostki
result.entityId string

Identyfikator jednostki.

Identyfikator wskaźnika otwórz
result.openBadgeId string

Identyfikator wskaźnika Otwórz.

Utworzono pod adresem
result.createdAt string

Po utworzeniu na.

Stworzone przez
result.createdBy string

Przez kogo utworzono.

BadgeClass
result.badgeclass string

Definicja wskaźnika umożliwiającego uzyskanie zarobku.

BadgeClass Open Badge ID
result.badgeclassOpenBadgeId string

Identyfikator wskaźnika OpenClass klasy BadgeClass.

Wystawca
result.issuer string

Osoba lub organizacja, która tworzy/ oferuje znaczki i wystawia je zarabiającym.

Identyfikator wskaźnika Otwarcia wystawcy
result.issuerOpenBadgeId string

Identyfikator identyfikatora open badge wystawcy.

obraz
result.image string

Obraz.

Tożsamość
result.recipient.identity string

Tożsamość.

Mieszany
result.recipient.hashed boolean

Czy skrót.

Typ
result.recipient.type string

Typ.

Tożsamość w postaci zwykłego tekstu
result.recipient.plaintextIdentity string

Tożsamość w postaci zwykłego tekstu.

Salt
result.recipient.salt string

Jeśli skrót, sól.

Wystawione
result.issuedOn string

Po wystawieniu.

Narracja
result.narrative string

Narracja dla znaczka wydanego.

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

Adres URL.

Narracja
result.evidence.narrative string

Narracja dla znaczka wydanego.

Odwołany
result.revoked boolean

Czy odwołano.

Przyczyna odwołania
result.revocationReason string

Przyczyna odwołania.

Przyjęcie
result.acceptance string

Kiedy wskaźnik został zaakceptowany.

Wygasa
result.expires string

Po wygaśnięciu wskaźnika.

Extensions
result.extensions string

Rozszerzenia.

Nazwa klasy BadgeClass
result.badgeclassName string

Nazwa klasy BadgeClass.

Żądanie wiadomości e-mail odzyskiwania konta

Zażądaj wiadomości e-mail dotyczącej odzyskiwania konta dla użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Email
email string

Adres e-mail w pliku do wysłania wiadomości e-mail z odzyskiwaniem.

Definicje

Token dostępu