Badgr (nezávislý vydavatel)

Organizace po celém světě používají Badgr k vytváření ekosystémů branded learning, které podporují své komunity pomocí digitálních přihlašovacích údajů založených na dovednostech, stackable studijních cest a přenositelných záznamů učení.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících:      – Oblasti Azure Government      – Oblasti Azure China      - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)

Kontakt
Název	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadata konektoru
Vydavatel	Troy Taylor, Hitachi Solutions
Internetová stránka	https://badgr.com
Zásady ochrany osobních údajů	https://info.badgr.com/privacy-policy.html
Kategorie	Lidské zdroje

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Aktualizace kolekce	Aktualizujte kolekci v batohu.
Aktualizace kontrolního výrazu	Aktualizace kontrolního výrazu
Aktualizace odznáčku	Aktualizujte účet odznáček. K aktualizaci profilu ověřeného uživatele použijte id entity 'self'.
Aktualizace přijetí kontrolního výrazu v batohu	Aktualizace přijetí kontrolního výrazu v batohu uživatele.
Aktualizace třídy BadgeClass	Aktualizace existující třídy BadgeClass Dříve vydané instance BadgeInstances nebudou aktualizovány.
Aktualizace vystavitele	Aktualizujte jednoho vystavitele.
Get Issuer's BadgeClasses	Získejte seznam badgeClasses pro jednoho vystavitele. Ověřený uživatel musí mít u vystavitele stav vlastníka, editoru nebo pedagoga.
Import kontrolního výrazu do batohu	Import nového kontrolního výrazu do batohu uživatele.
Nahrání kontrolního výrazu do batohu	Nahrajte nový kontrolní výraz do batohu uživatele.
Načtení tokenů vystavitele	Načtěte tokeny vystavitele.
Obnovení účtu	Obnovte účet a nastavte nové heslo.
Odebrání kontrolního výrazu z batohu	Odstraňte kontrolní výraz z batohu uživatele.
Odstranit kolekci	Odstraňte kolekci z batohu.
Odstranění třídy BadgeClass	Odstranění třídy BadgeClass Omezeno na vlastníky nebo editory (ne zaměstnance) odpovídajícího vystavitele.
Odstranění vystavitele	Odstraňte jednoho vystavitele.
Odvolání kontrolního výrazu	Odvolání kontrolního výrazu
Odvolání přístupového objektu	Odvolá přístup uživatele AccessToken.
Odvolání více kontrolních výrazů	Odvolání více kontrolních výrazů pro více příjemců
Problém s více třídami BadgeClass	Zadejte více kopií stejné třídy BadgeClass více příjemcům.
Vydání kontrolního výrazu	Zadejte pro příjemce nový kontrolní výraz.
Vydání kontrolního výrazu	Vystavení kontrolního výrazu jednomu příjemci
Vytvoření kolekce	Vytvořte novou kolekci.
Vytvoření třídy BadgeClass	Vytvořte novou třídu BadgeClass.
Vytvoření třídy BadgeClass vystavitele	Vytvořte novou třídu BadgeClass přidruženou k vystaviteli. Ověřený uživatel musí mít u vystavitele stav vlastníka, editoru nebo pedagoga.
Vytvoření vystavitele	Vytvořte nového vystavitele.
Vytvoření účtu BadgeUser	Vytvořte účet a profil badgeUser.
Získání accesstokenu	Získejte jeden AccessToken.
Získání jednoho kontrolního výrazu	Získání kontrolního výrazu
Získání kolekce	Získejte jednu kolekci.
Získání kolekcí	Získejte seznam kolekcí.
Získání kontrolních výrazů	Získá seznam kontrolních výrazů pro jednoho vystavitele.
Získání kontrolních výrazů třídy BadgeClass	Získejte seznam kontrolních výrazů pro jednu třídu BadgeClass.
Získání kontrolních výrazů v batohu uživatele	Získejte seznam kontrolních výrazů v batohu ověřeného uživatele.
Získání odznáčku odznáček uživatele	Získejte seznam badgeClasses pro ověřeného uživatele.
Získání podrobností o kontrolním výrazu batohu	Získejte podrobnosti o kontrolním výrazu v batohu uživatele.
Získání profilu BadgeUser	Získejte jeden profil BadgeUser. Pomocí entityId self načtěte profil ověřeného uživatele.
Získání přístupových tokenů uživatele	Získejte seznam přístupových tokenů pro ověřeného uživatele.
Získání třídy BadgeClass	Získejte jednu třídu BadgeClass.
Získání vystavitele	Získejte jednoho vystavitele.
Získání vystavitelů	Získejte seznam vystavitelů pro ověřeného uživatele.
Žádost o e-mail pro obnovení účtu	Požádejte uživatele o e-mail pro obnovení účtu.

Aktualizace kolekce

ID operace:

CollectionUpdate

Aktualizujte kolekci v batohu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
Typ entity	entityType		string	Typ entity.
ID subjektu	entityId		string	Identifikátor entity.
Název	name		string	Název.
Description	description		string	Popis.
Vlastník	owner		string	Vlastník.
Adresa URL pro sdílení	share_url		string	Adresa URL sdílené složky.
Sdílet hodnotu hash	shareHash		string	Hodnota hash sdílené složky.
Publikováno	published		boolean	Zda je publikováno.
BadgeClass	badgeclass		string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	badgeclassOpenBadgeId		string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Identita	identity		string	Identita.
Hashed	hashed		boolean	Určuje, jestli je hodnota hash.
Typ	type		string	Typ.
Identita prostého textu	plaintextIdentity		string	Identita v prostém textu.
Salt	salt		string	Pokud je hodnota hash, sůl.
Vydáno dne	issuedOn		string	Při vydání.
Vyprávění	narrative		string	Příběh vydaného odznáček.
URL	url		string	Adresa URL.
Vyprávění	narrative		string	Příběh vydaného odznáček.
Propadává	expires		string	Když vyprší platnost odznáček.
Extensions	extensions		string	Rozšíření.
Název třídy BadgeClass	badgeclassName		string	Název BadgeClass.
Vytvořeno na adrese	createdAt		string	Vytvořeno v:
Vytvořil	createdBy		string	Koho vytvořil.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Název	result.name	string	Název.
Description	result.description	string	Popis.
Vlastník	result.owner	string	Vlastník.
Adresa URL pro sdílení	result.share_url	string	Adresa URL sdílené složky.
Sdílet hodnotu hash	result.shareHash	string	Hodnota hash sdílené složky.
Publikováno	result.published	boolean	Zda je publikováno.
Assertions	result.assertions	array of object
Typ entity	result.assertions.entityType	string	Typ entity.
ID subjektu	result.assertions.entityId	string	Identifikátor entity.
Open Badge ID	result.assertions.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.assertions.createdAt	string	Při vytváření na adrese.
Vytvořil	result.assertions.createdBy	string	Vytvořil(a).
BadgeClass	result.assertions.badgeclass	string	Třída BadgeClass.
Id odznáčku BadgeClass Open	result.assertions.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.assertions.issuer	string	Vystavitel.
ID otevřeného odznaku vystavitele	result.assertions.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.assertions.image	string	Obrázek.
Identita	result.assertions.recipient.identity	string	Identita.
Hashed	result.assertions.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.assertions.recipient.type	string	Typ.
Identita prostého textu	result.assertions.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.assertions.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.assertions.issuedOn	string	Při vydání.
Vyprávění	result.assertions.narrative	string	Příběh vydaného odznáček.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	Adresa URL.
Vyprávění	result.assertions.evidence.narrative	string	Příběh.
Odvolaný	result.assertions.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.assertions.revocationReason	string	Důvod odvolání.
Přijetí	result.assertions.acceptance	string	Přijetí.
Propadává	result.assertions.expires	string	Když vyprší platnost.
Extensions	result.assertions.extensions	string	Rozšíření.
Název třídy BadgeClass	result.assertions.badgeclassName	string	Název BadgeClass.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.

Aktualizace kontrolního výrazu

ID operace:

AssertionUpdate

Aktualizace kontrolního výrazu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
BadgeClass	badgeclass		string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	badgeclassOpenBadgeId		string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce. .
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Identita	identity		string	Identita.
Hashed	hashed		boolean	Určuje, jestli je hodnota hash.
Typ	type		string	Typ.
Identita prostého textu	plaintextIdentity		string	Identita v prostém textu.
Salt	salt		string	Pokud je hodnota hash, sůl.
Vydáno dne	issuedOn		string	Při vydání.
Vyprávění	narrative		string	Příběh vydaného odznáček.
URL	url		string	Adresa URL.
Vyprávění	narrative		string	Příběh vydaného odznáček.
Propadává	expires		string	Když vyprší platnost.
Extensions	extensions		string	Rozšíření.
Název třídy BadgeClass	badgeclassName		string	Název BadgeClass.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.recipient.type	string	Typ.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Extensions	result.extensions	string	Rozšíření.
Název třídy BadgeClass	result.badgeclassName	string	Název BadgeClass.

Aktualizace odznáčku

ID operace:

UserUpdate

Aktualizujte účet odznáček. K aktualizaci profilu ověřeného uživatele použijte id entity 'self'.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
Typ entity	entityType		string	Typ entity.
ID subjektu	entityId		string	Identifikátor entity.
Křestní jméno	firstName		string	Jméno.
Příjmení	lastName		string	Příjmení.
Typ entity	entityType		string	Typ entity.
ID subjektu	entityId		string	Identifikátor entity.
Email	email		string	E-mailová adresa.
Ověřený	verified		boolean	Zda je ověřeno.
Primary	primary		boolean	Určuje, jestli primární.
Varianty případu	caseVariants		string	Varianty případu.
URL	url		string	Adresa URL.
Telefon	telephone		string	Telefonní číslo.
Odsouhlasená verze podmínek	agreedTermsVersion		string	Verze dohodnutých podmínek.
Souhlasil(a) s nejnovější verzí podmínek.	hasAgreedToLatestTermsVersion		string	Verze nejnovějších podmínek se dohodla.
Marketing Opt In	marketingOptIn		string	Přihlásil se k marketingu.
Chybná doména	badgrDomain		string	Doména Badgr.
Má nastavené heslo	hasPasswordSet		string	Má nastavené heslo.
Recipient	recipient		string	Příjemce.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Křestní jméno	result.firstName	string	Jméno.
Příjmení	result.lastName	string	Příjmení.
E-maily	result.emails	array of object
Typ entity	result.emails.entityType	string	Typ entity.
ID subjektu	result.emails.entityId	string	Identifikátor entity.
Email	result.emails.email	string	E-mailová adresa.
Ověřený	result.emails.verified	boolean	Zda je ověřeno.
Primary	result.emails.primary	boolean	Určuje, jestli primární.
Varianty případu	result.emails.caseVariants	string	Varianty případu.
URL	result.url	string	Adresa URL.
Telefon	result.telephone	string	Telefonní číslo.
Odsouhlasená verze podmínek	result.agreedTermsVersion	string	Verze podmínek aggreed.
Souhlasil(a) s nejnovější verzí podmínek.	result.hasAgreedToLatestTermsVersion	string	Verze laterst terms aggree.
Marketing Opt In	result.marketingOptIn	string	Souhlasil s výslovným souhlasem s marketingem.
Chybná doména	result.badgrDomain	string	Doména Badgr.
Má nastavené heslo	result.hasPasswordSet	string	Pokud je nastavené heslo.
Recipient	result.recipient	string	Příjemce.

Aktualizace přijetí kontrolního výrazu v batohu

ID operace:

BackpackUpdateAcceptance

Aktualizace přijetí kontrolního výrazu v batohu uživatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
Přijetí	acceptance		string	Přijetí.
BadgeClass	badgeclass		string	Definice získatelného odznáček.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce. .
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Identita	identity		string	Identita.
Typ	type		string	Typ.
Hashed	hashed		boolean	Určuje, jestli je hodnota hash.
Identita prostého textu	plaintextIdentity		string	Identita v prostém textu.
Vydáno dne	issuedOn		string	Při vydání.
Vyprávění	narrative		string	Příběh vydaného odznáček.
URL	url		string	Adresa URL.
Vyprávění	narrative		string	Příběh vydaného odznáček.
Propadává	expires		string	Když vyprší platnost.
Čekající	pending		string	Zahájený.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Typ	result.recipient.type	string	Typ.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Čekající	result.pending	string	Zahájený.

Aktualizace třídy BadgeClass

ID operace:

ClassUpdate

Aktualizace existující třídy BadgeClass Dříve vydané instance BadgeInstances nebudou aktualizovány.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce. .
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Název	name		string	Název.
Obrázek	image		string	Obrázek.
Description	description		string	Popis.
Typ dosaženého úspěchu	achievementType		string	Typ dosaženého úspěchu.
Adresa URL kritérií	criteriaUrl		string	Adresa URL kritérií.
Vyprávění kritérií	criteriaNarrative		string	Příběh kritérií.
Název cíle	targetName		string	Název cíle.
Cílová adresa URL	targetUrl		string	Adresa URL cíle.
Popis cíle	targetDescription		string	Popis cíle.
Cílový rámec	targetFramework		string	Rámec cíle.
Cílový kód	targetCode		string	Kód cíle.
Štítky	tags		array of string
Množství	amount		string	Částka.
Doba trvání	duration		string	Doba trvání.
Extensions	extensions		string	Rozšíření.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Název	result.name	string	Název.
Obrázek	result.image	string	Obrázek.
Description	result.description	string	Popis.
Typ dosaženého úspěchu	result.achievementType	string	Typ dosaženého úspěchu.
Adresa URL kritérií	result.criteriaUrl	string	Adresa URL kritérií.
Vyprávění kritérií	result.criteriaNarrative	string	Příběh kritérií.
Vyrovnání	result.alignments	array of object
Název cíle	result.alignments.targetName	string	Název cíle.
Cílová adresa URL	result.alignments.targetUrl	string	Adresa URL cíle.
Popis cíle	result.alignments.targetDescription	string	Popis cíle.
Cílový rámec	result.alignments.targetFramework	string	Rámec cíle.
Cílový kód	result.alignments.targetCode	string	Kód cíle.
Štítky	result.tags	array of string
Množství	result.expires.amount	string	Částka.
Doba trvání	result.expires.duration	string	Doba trvání.
Extensions	result.extensions	string	Rozšíření.

Aktualizace vystavitele

ID operace:

IssuerUpdate

Aktualizujte jednoho vystavitele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
Vytvořil	createdBy		string	Koho vytvořil.
Název	name		string	Název.
Obrázek	image		string	Obrázek.
Email	email		string	E-mailová adresa.
Description	description		string	Popis.
URL	url		string	Adresa URL.
Typ entity	entityType		string	Typ entity.
ID subjektu	entityId		string	Identifikátor entity.
Profil uživatele	userProfile		string	Profil uživatele.
Uživatel	user		string	Uživatel.
Role	role		string	Role.
Extensions	extensions		string	Rozšíření.
Chybná doména	badgrDomain		string	Doména Badgr.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
Název	result.name	string	Název.
Obrázek	result.image	string	Obrázek.
Email	result.email	string	E-mailová adresa.
Description	result.description	string	Popis.
URL	result.url	string	Adresa URL.
Personál	result.staff	array of object
Typ entity	result.staff.entityType	string	Typ entity.
ID subjektu	result.staff.entityId	string	Identifikátor entity.
Profil uživatele	result.staff.userProfile	string	Profil uživatele.
Uživatel	result.staff.user	string	Uživatel.
Role	result.staff.role	string	Role.
Extensions	result.extensions	string	Rozšíření.
Chybná doména	result.badgrDomain	string	Doména Badgr.

Get Issuer's BadgeClasses

ID operace:

ClassGetIssuer

Získejte seznam badgeClasses pro jednoho vystavitele. Ověřený uživatel musí mít u vystavitele stav vlastníka, editoru nebo pedagoga.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu
Number	num		string	Vyžádání stránkování výsledků

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Název	result.name	string	Název.
Obrázek	result.image	string	Obrázek.
Description	result.description	string	Popis.
Typ dosaženého úspěchu	result.achievementType	string	Typ dosaženého úspěchu.
Adresa URL kritérií	result.criteriaUrl	string	Adresa URL kritérií.
Vyprávění kritérií	result.criteriaNarrative	string	Příběh kritérií.
Vyrovnání	result.alignments	array of object
Název cíle	result.alignments.targetName	string	Název cíle.
Cílová adresa URL	result.alignments.targetUrl	string	Adresa URL cíle.
Popis cíle	result.alignments.targetDescription	string	Popis cíle.
Cílový rámec	result.alignments.targetFramework	string	Rámec cíle.
Cílový kód	result.alignments.targetCode	string	Kód cíle.
Štítky	result.tags	array of string
Množství	result.expires.amount	string	Částka.
Doba trvání	result.expires.duration	string	Doba trvání.
Extensions	result.extensions	string	Rozšíření.

Import kontrolního výrazu do batohu

ID operace:

BackpackImportAssertion

Import nového kontrolního výrazu do batohu uživatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
URL	url		string	Adresa URL odznáčku kompatibilního se standardem OpenBadge
Obrázek	image		string	Image Baked OpenBadge s kódováním Base64
Tvrzení	assertion		object	Json kompatibilní s OpenBadge

Nahrání kontrolního výrazu do batohu

ID operace:

BackpackUploadAssertion

Nahrajte nový kontrolní výraz do batohu uživatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
BadgeClass	badgeclass		string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	badgeclassOpenBadgeId		string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce. .
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Identita	identity		string	Identita.
Hashed	hashed		boolean	Určuje, jestli je hodnota hash.
Typ	type		string	Typ.
Identita prostého textu	plaintextIdentity		string	Identita v prostém textu.
Salt	salt		string	Pokud je hodnota hash, sůl.
Vydáno dne	issuedOn		string	Při vydání.
Vyprávění	narrative		string	Příběh vydaného odznáček.
URL	url		string	Adresa URL.
Vyprávění	narrative		string	Příběh vydaného odznáček.
Propadává	expires		string	Když vyprší platnost.
Extensions	extensions		string	Rozšíření.
Název třídy BadgeClass	badgeclassName		string	Název BadgeClass.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.recipient.type	string	Typ.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Extensions	result.extensions	string	Rozšíření.
Název třídy BadgeClass	result.badgeclassName	string	Název BadgeClass.

Načtení tokenů vystavitele

ID operace:

TokenRetrieve

Načtěte tokeny vystavitele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
body	body	True

Návraty

response

AccessToken

Obnovení účtu

ID operace:

AccountRecover

Obnovte účet a nastavte nové heslo.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Žeton	token		string	Token přijatý v e-mailu pro obnovení.
Heslo	password		string	Nové heslo, které se má použít.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result

Odebrání kontrolního výrazu z batohu

ID operace:

BackpackRemoteAssertion

Odstraňte kontrolní výraz z batohu uživatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Odstranit kolekci

ID operace:

CollectionDelete

Odstraňte kolekci z batohu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Odstranění třídy BadgeClass

ID operace:

ClassDelete

Odstranění třídy BadgeClass Omezeno na vlastníky nebo editory (ne zaměstnance) odpovídajícího vystavitele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Odstranění vystavitele

ID operace:

IssuerDelete

Odstraňte jednoho vystavitele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Odvolání kontrolního výrazu

ID operace:

AssertionRevoke

Odvolání kontrolního výrazu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu
Důvod odvolání	revocation_reason		string	Důvod odvolání tohoto kontrolního výrazu

Odvolání přístupového objektu

ID operace:

TokenRevoke

Odvolá přístup uživatele AccessToken.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Odvolání více kontrolních výrazů

ID operace:

AssertionRevokeBulk

Odvolání více kontrolních výrazů pro více příjemců

Parametry

Name	Klíč	Vyžadováno	Typ	Description
BadgeClass	badgeclass		string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	badgeclassOpenBadgeId		string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce. .
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Identita	identity		string	Identita.
Hashed	hashed		boolean	Určuje, jestli je hodnota hash.
Typ	type		string	Typ.
Identita prostého textu	plaintextIdentity		string	Identita v prostém textu.
Salt	salt		string	Pokud je hodnota hash, sůl.
Vydáno dne	issuedOn		string	Při vydání.
Vyprávění	narrative		string	Příběh vydaného odznáček.
URL	url		string	Adresa URL.
Vyprávění	narrative		string	Příběh vydaného odznáček.
Propadává	expires		string	Když vyprší platnost.
Extensions	extensions		string	Rozšíření.
Název třídy BadgeClass	badgeclassName		string	Název BadgeClass.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.recipient.type	string	Typ.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Extensions	result.extensions	string	Rozšíření.
Název třídy BadgeClass	result.badgeclassName	string	Název BadgeClass.

Problém s více třídami BadgeClass

ID operace:

ClassIssueBulk

Zadejte více kopií stejné třídy BadgeClass více příjemcům.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
BadgeClass	badgeclass		string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	badgeclassOpenBadgeId		string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce. .
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Identita	identity		string	Identita.
Hashed	hashed		boolean	Určuje, jestli je hodnota hash.
Typ	type		string	Typ.
Identita prostého textu	plaintextIdentity		string	Identita v prostém textu.
Salt	salt		string	Pokud je hodnota hash, sůl.
Vydáno dne	issuedOn		string	Při vydání.
Vyprávění	narrative		string	Příběh vydaného odznáček.
URL	url		string	Adresa URL.
Vyprávění	narrative		string	Příběh vydaného odznáček.
Propadává	expires		string	Když vyprší platnost.
Extensions	extensions		string	Rozšíření.
Název třídy BadgeClass	badgeclassName		string	Název BadgeClass.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.recipient.type	string	Typ.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Extensions	result.extensions	string	Rozšíření.
Název třídy BadgeClass	result.badgeclassName	string	Název BadgeClass.

Vydání kontrolního výrazu

ID operace:

AssertionIssue

Zadejte pro příjemce nový kontrolní výraz.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
BadgeClass	badgeclass		string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	badgeclassOpenBadgeId		string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce. .
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Identita	identity		string	Identita.
Hashed	hashed		boolean	Určuje, jestli je hodnota hash.
Typ	type		string	Typ.
Identita prostého textu	plaintextIdentity		string	Identita v prostém textu.
Salt	salt		string	Pokud je hodnota hash, sůl.
Vydáno dne	issuedOn		string	Při vydání.
Vyprávění	narrative		string	Příběh vydaného odznáček.
URL	url		string	Adresa URL.
Vyprávění	narrative		string	Příběh vydaného odznáček.
Propadává	expires		string	Když vyprší platnost.
Extensions	extensions		string	Rozšíření.
Název třídy BadgeClass	badgeclassName		string	Název BadgeClass.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.recipient.type	string	Typ.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Extensions	result.extensions	string	Rozšíření.
Název třídy BadgeClass	result.badgeclassName	string	Název BadgeClass.

Vydání kontrolního výrazu

ID operace:

ClassIssueAssertion

Vystavení kontrolního výrazu jednomu příjemci

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
BadgeClass	badgeclass		string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	badgeclassOpenBadgeId		string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce. .
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Identita	identity		string	Identita.
Hashed	hashed		boolean	Určuje, jestli je hodnota hash.
Typ	type		string	Typ.
Identita prostého textu	plaintextIdentity		string	Identita v prostém textu.
Salt	salt		string	Pokud je hodnota hash, sůl.
Vydáno dne	issuedOn		string	Při vydání.
Vyprávění	narrative		string	Příběh vydaného odznáček.
URL	url		string	Adresa URL.
Vyprávění	narrative		string	Příběh vydaného odznáček.
Propadává	expires		string	Když vyprší platnost.
Extensions	extensions		string	Rozšíření.
Název třídy BadgeClass	badgeclassName		string	Název BadgeClass.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.recipient.type	string	Typ.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Extensions	result.extensions	string	Rozšíření.
Název třídy BadgeClass	result.badgeclassName	string	Název BadgeClass.

Vytvoření kolekce

ID operace:

CollectionCreate

Vytvořte novou kolekci.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Typ entity	entityType		string	Typ entity.
ID subjektu	entityId		string	Identifikátor entity.
Název	name		string	Název.
Description	description		string	Popis.
Vlastník	owner		string	Vlastník.
Adresa URL pro sdílení	share_url		string	Adresa URL sdílené složky.
Sdílet hodnotu hash	shareHash		string	Hodnota hash sdílené složky.
Publikováno	published		boolean	Zda je publikováno.
BadgeClass	badgeclass		string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	badgeclassOpenBadgeId		string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Identita	identity		string	Identita.
Hashed	hashed		boolean	Určuje, jestli je hodnota hash.
Typ	type		string	Typ.
Identita prostého textu	plaintextIdentity		string	Identita v prostém textu.
Salt	salt		string	Pokud je hodnota hash, sůl.
Vydáno dne	issuedOn		string	Při vydání.
Vyprávění	narrative		string	Příběh vydaného odznáček.
URL	url		string	Adresa URL.
Vyprávění	narrative		string	Příběh vydaného odznáček.
Propadává	expires		string	Když vyprší platnost odznáček.
Extensions	extensions		string	Rozšíření.
Název třídy BadgeClass	badgeclassName		string	Název BadgeClass.
Vytvořeno na adrese	createdAt		string	Vytvořeno v:
Vytvořil	createdBy		string	Koho vytvořil.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Název	result.name	string	Název.
Description	result.description	string	Popis.
Vlastník	result.owner	string	Vlastník.
Adresa URL pro sdílení	result.share_url	string	Adresa URL sdílené složky.
Sdílet hodnotu hash	result.shareHash	string	Hodnota hash sdílené složky.
Publikováno	result.published	boolean	Zda je publikováno.
Assertions	result.assertions	array of object
Typ entity	result.assertions.entityType	string	Typ entity.
ID subjektu	result.assertions.entityId	string	Identifikátor entity.
Open Badge ID	result.assertions.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.assertions.createdAt	string	Při vytváření na adrese.
Vytvořil	result.assertions.createdBy	string	Vytvořil(a).
BadgeClass	result.assertions.badgeclass	string	Třída BadgeClass.
Id odznáčku BadgeClass Open	result.assertions.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.assertions.issuer	string	Vystavitel.
ID otevřeného odznaku vystavitele	result.assertions.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.assertions.image	string	Obrázek.
Identita	result.assertions.recipient.identity	string	Identita.
Hashed	result.assertions.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.assertions.recipient.type	string	Typ.
Identita prostého textu	result.assertions.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.assertions.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.assertions.issuedOn	string	Při vydání.
Vyprávění	result.assertions.narrative	string	Příběh vydaného odznáček.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	Adresa URL.
Vyprávění	result.assertions.evidence.narrative	string	Příběh.
Odvolaný	result.assertions.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.assertions.revocationReason	string	Důvod odvolání.
Přijetí	result.assertions.acceptance	string	Přijetí.
Propadává	result.assertions.expires	string	Když vyprší platnost.
Extensions	result.assertions.extensions	string	Rozšíření.
Název třídy BadgeClass	result.assertions.badgeclassName	string	Název BadgeClass.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.

Vytvoření třídy BadgeClass

ID operace:

ClassCreate

Vytvořte novou třídu BadgeClass.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Number	num		integer	Vyžádání stránkování výsledků
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce. .
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Název	name		string	Název.
Obrázek	image		string	Obrázek.
Description	description		string	Popis.
Typ dosaženého úspěchu	achievementType		string	Typ dosaženého úspěchu.
Adresa URL kritérií	criteriaUrl		string	Adresa URL kritérií.
Vyprávění kritérií	criteriaNarrative		string	Příběh kritérií.
Název cíle	targetName		string	Název cíle.
Cílová adresa URL	targetUrl		string	Adresa URL cíle.
Popis cíle	targetDescription		string	Popis cíle.
Cílový rámec	targetFramework		string	Rámec cíle.
Cílový kód	targetCode		string	Kód cíle.
Štítky	tags		array of string
Množství	amount		string	Částka.
Doba trvání	duration		string	Doba trvání.
Extensions	extensions		string	Rozšíření.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Název	result.name	string	Název.
Obrázek	result.image	string	Obrázek.
Description	result.description	string	Popis.
Typ dosaženého úspěchu	result.achievementType	string	Typ dosaženého úspěchu.
Adresa URL kritérií	result.criteriaUrl	string	Adresa URL kritérií.
Vyprávění kritérií	result.criteriaNarrative	string	Příběh kritérií.
Vyrovnání	result.alignments	array of object
Název cíle	result.alignments.targetName	string	Název cíle.
Cílová adresa URL	result.alignments.targetUrl	string	Adresa URL cíle.
Popis cíle	result.alignments.targetDescription	string	Popis cíle.
Cílový rámec	result.alignments.targetFramework	string	Rámec cíle.
Cílový kód	result.alignments.targetCode	string	Kód cíle.
Štítky	result.tags	array of string
Množství	result.expires.amount	string	Částka.
Doba trvání	result.expires.duration	string	Doba trvání.
Extensions	result.extensions	string	Rozšíření.

Vytvoření třídy BadgeClass vystavitele

ID operace:

ClassCreateIssuer

Vytvořte novou třídu BadgeClass přidruženou k vystaviteli. Ověřený uživatel musí mít u vystavitele stav vlastníka, editoru nebo pedagoga.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
Issuer	issuer		string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce. .
ID otevřeného odznaku vystavitele	issuerOpenBadgeId		string	Identifikátor otevřeného odznaku vystavitele.
Název	name		string	Název.
Obrázek	image		string	Obrázek.
Description	description		string	Popis.
Typ dosaženého úspěchu	achievementType		string	Typ dosaženého úspěchu.
Adresa URL kritérií	criteriaUrl		string	Adresa URL kritérií.
Vyprávění kritérií	criteriaNarrative		string	Příběh kritérií.
Název cíle	targetName		string	Název cíle.
Cílová adresa URL	targetUrl		string	Adresa URL cíle.
Popis cíle	targetDescription		string	Popis cíle.
Cílový rámec	targetFramework		string	Rámec cíle.
Cílový kód	targetCode		string	Kód cíle.
Štítky	tags		array of string
Množství	amount		string	Částka.
Doba trvání	duration		string	Doba trvání.
Extensions	extensions		string	Rozšíření.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Název	result.name	string	Název.
Obrázek	result.image	string	Obrázek.
Description	result.description	string	Popis.
Typ dosaženého úspěchu	result.achievementType	string	Typ dosaženého úspěchu.
Adresa URL kritérií	result.criteriaUrl	string	Adresa URL kritérií.
Vyprávění kritérií	result.criteriaNarrative	string	Příběh kritérií.
Vyrovnání	result.alignments	array of object
Název cíle	result.alignments.targetName	string	Název cíle.
Cílová adresa URL	result.alignments.targetUrl	string	Adresa URL cíle.
Popis cíle	result.alignments.targetDescription	string	Popis cíle.
Cílový rámec	result.alignments.targetFramework	string	Rámec cíle.
Cílový kód	result.alignments.targetCode	string	Kód cíle.
Štítky	result.tags	array of string
Množství	result.expires.amount	string	Částka.
Doba trvání	result.expires.duration	string	Doba trvání.
Extensions	result.extensions	string	Rozšíření.

Vytvoření vystavitele

ID operace:

IssuerCreate

Vytvořte nového vystavitele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Vytvořil	createdBy		string	Koho vytvořil.
Název	name		string	Název.
Obrázek	image		string	Obrázek.
Email	email		string	E-mailová adresa.
Description	description		string	Popis.
URL	url		string	Adresa URL.
Typ entity	entityType		string	Typ entity.
ID subjektu	entityId		string	Identifikátor entity.
Profil uživatele	userProfile		string	Profil uživatele.
Uživatel	user		string	Uživatel.
Role	role		string	Role.
Extensions	extensions		string	Rozšíření.
Chybná doména	badgrDomain		string	Doména Badgr.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
Název	result.name	string	Název.
Obrázek	result.image	string	Obrázek.
Email	result.email	string	E-mailová adresa.
Description	result.description	string	Popis.
URL	result.url	string	Adresa URL.
Personál	result.staff	array of object
Typ entity	result.staff.entityType	string	Typ entity.
ID subjektu	result.staff.entityId	string	Identifikátor entity.
Profil uživatele	result.staff.userProfile	string	Profil uživatele.
Uživatel	result.staff.user	string	Uživatel.
Role	result.staff.role	string	Role.
Extensions	result.extensions	string	Rozšíření.
Chybná doména	result.badgrDomain	string	Doména Badgr.

Vytvoření účtu BadgeUser

ID operace:

UserCreate

Vytvořte účet a profil badgeUser.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor entity.
Typ entity	entityType		string	Typ entity.
ID subjektu	entityId		string	Identifikátor entity.
Křestní jméno	firstName		string	Jméno.
Příjmení	lastName		string	Příjmení.
Typ entity	entityType		string	Typ entity.
ID subjektu	entityId		string	Identifikátor entity.
Email	email		string	E-mailová adresa.
Ověřený	verified		boolean	Zda je ověřeno.
Primary	primary		boolean	Určuje, jestli primární.
Varianty případu	caseVariants		string	Varianty případu.
URL	url		string	Adresa URL.
Telefon	telephone		string	Telefonní číslo.
Odsouhlasená verze podmínek	agreedTermsVersion		string	Verze dohodnutých podmínek.
Souhlasil(a) s nejnovější verzí podmínek.	hasAgreedToLatestTermsVersion		string	Verze nejnovějších podmínek se dohodla.
Marketing Opt In	marketingOptIn		string	Přihlásil se k marketingu.
Chybná doména	badgrDomain		string	Doména Badgr.
Má nastavené heslo	hasPasswordSet		string	Má nastavené heslo.
Recipient	recipient		string	Příjemce.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Křestní jméno	result.firstName	string	Jméno.
Příjmení	result.lastName	string	Příjmení.
E-maily	result.emails	array of object
Typ entity	result.emails.entityType	string	Typ entity.
ID subjektu	result.emails.entityId	string	Identifikátor entity.
Email	result.emails.email	string	E-mailová adresa.
Ověřený	result.emails.verified	boolean	Zda je ověřeno.
Primary	result.emails.primary	boolean	Určuje, jestli primární.
Varianty případu	result.emails.caseVariants	string	Varianty případu.
URL	result.url	string	Adresa URL.
Telefon	result.telephone	string	Telefonní číslo.
Odsouhlasená verze podmínek	result.agreedTermsVersion	string	Verze podmínek aggreed.
Souhlasil(a) s nejnovější verzí podmínek.	result.hasAgreedToLatestTermsVersion	string	Verze laterst terms aggree.
Marketing Opt In	result.marketingOptIn	string	Souhlasil s výslovným souhlasem s marketingem.
Chybná doména	result.badgrDomain	string	Doména Badgr.
Má nastavené heslo	result.hasPasswordSet	string	Pokud je nastavené heslo.
Recipient	result.recipient	string	Příjemce.

Získání accesstokenu

ID operace:

TokenGetA

Získejte jeden AccessToken.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	AccessToken

Získání jednoho kontrolního výrazu

ID operace:

AssertionGetA

Získání kontrolního výrazu

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.recipient.type	string	Typ.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Extensions	result.extensions	string	Rozšíření.
Název třídy BadgeClass	result.badgeclassName	string	Název BadgeClass.

Získání kolekce

ID operace:

CollectionGetA

Získejte jednu kolekci.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Název	result.name	string	Název.
Description	result.description	string	Popis.
Vlastník	result.owner	string	Vlastník.
Adresa URL pro sdílení	result.share_url	string	Adresa URL sdílené složky.
Sdílet hodnotu hash	result.shareHash	string	Hodnota hash sdílené složky.
Publikováno	result.published	boolean	Zda je publikováno.
Assertions	result.assertions	array of object
Typ entity	result.assertions.entityType	string	Typ entity.
ID subjektu	result.assertions.entityId	string	Identifikátor entity.
Open Badge ID	result.assertions.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.assertions.createdAt	string	Při vytváření na adrese.
Vytvořil	result.assertions.createdBy	string	Vytvořil(a).
BadgeClass	result.assertions.badgeclass	string	Třída BadgeClass.
Id odznáčku BadgeClass Open	result.assertions.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.assertions.issuer	string	Vystavitel.
ID otevřeného odznaku vystavitele	result.assertions.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.assertions.image	string	Obrázek.
Identita	result.assertions.recipient.identity	string	Identita.
Hashed	result.assertions.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.assertions.recipient.type	string	Typ.
Identita prostého textu	result.assertions.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.assertions.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.assertions.issuedOn	string	Při vydání.
Vyprávění	result.assertions.narrative	string	Příběh vydaného odznáček.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	Adresa URL.
Vyprávění	result.assertions.evidence.narrative	string	Příběh.
Odvolaný	result.assertions.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.assertions.revocationReason	string	Důvod odvolání.
Přijetí	result.assertions.acceptance	string	Přijetí.
Propadává	result.assertions.expires	string	Když vyprší platnost.
Extensions	result.assertions.extensions	string	Rozšíření.
Název třídy BadgeClass	result.assertions.badgeclassName	string	Název BadgeClass.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.

Získání kolekcí

ID operace:

CollectionGet

Získejte seznam kolekcí.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Název	result.name	string	Název.
Description	result.description	string	Popis.
Vlastník	result.owner	string	Vlastník.
Adresa URL pro sdílení	result.share_url	string	Adresa URL sdílené složky.
Sdílet hodnotu hash	result.shareHash	string	Hodnota hash sdílené složky.
Publikováno	result.published	boolean	Zda je publikováno.
Assertions	result.assertions	array of object
Typ entity	result.assertions.entityType	string	Typ entity.
ID subjektu	result.assertions.entityId	string	Identifikátor entity.
Open Badge ID	result.assertions.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.assertions.createdAt	string	Při vytváření na adrese.
Vytvořil	result.assertions.createdBy	string	Vytvořil(a).
BadgeClass	result.assertions.badgeclass	string	Třída BadgeClass.
Id odznáčku BadgeClass Open	result.assertions.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.assertions.issuer	string	Vystavitel.
ID otevřeného odznaku vystavitele	result.assertions.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.assertions.image	string	Obrázek.
Identita	result.assertions.recipient.identity	string	Identita.
Hashed	result.assertions.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.assertions.recipient.type	string	Typ.
Identita prostého textu	result.assertions.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.assertions.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.assertions.issuedOn	string	Při vydání.
Vyprávění	result.assertions.narrative	string	Příběh vydaného odznáček.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	Adresa URL.
Vyprávění	result.assertions.evidence.narrative	string	Příběh.
Odvolaný	result.assertions.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.assertions.revocationReason	string	Důvod odvolání.
Přijetí	result.assertions.acceptance	string	Přijetí.
Propadává	result.assertions.expires	string	Když vyprší platnost.
Extensions	result.assertions.extensions	string	Rozšíření.
Název třídy BadgeClass	result.assertions.badgeclassName	string	Název BadgeClass.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.

Získání kontrolních výrazů

ID operace:

AssertionGet

Získá seznam kontrolních výrazů pro jednoho vystavitele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu
Recipient	recipient		string	Identifikátor příjemce pro filtrování podle
Number	num		string	Vyžádání stránkování výsledků
Včetně vypršení platnosti	include_expired		boolean	Zahrnout kontrolní výrazy s vypršenou platností
Zahrnout odvolané	include_revoked		boolean	Zahrnutí odvolaných kontrolních výrazů

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.recipient.type	string	Typ.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Extensions	result.extensions	string	Rozšíření.
Název třídy BadgeClass	result.badgeclassName	string	Název BadgeClass.

Získání kontrolních výrazů třídy BadgeClass

ID operace:

ClassGetAssertion

Získejte seznam kontrolních výrazů pro jednu třídu BadgeClass.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu
Recipient	recipient		string	Identifikátor příjemce pro filtrování podle
Number	num		string	Vyžádání stránkování výsledků
Včetně vypršení platnosti	include_expired		boolean	Zahrnout kontrolní výrazy s vypršenou platností
Zahrnout odvolané	include_revoked		boolean	Zahrnutí odvolaných kontrolních výrazů

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.recipient.type	string	Typ.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Extensions	result.extensions	string	Rozšíření.
Název třídy BadgeClass	result.badgeclassName	string	Název BadgeClass.

Získání kontrolních výrazů v batohu uživatele

ID operace:

BackpackGetAssertion

Získejte seznam kontrolních výrazů v batohu ověřeného uživatele.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Typ	result.recipient.type	string	Typ.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Salt	result.recipient.salt	string	Pokud je hodnota hash, sůl.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Extensions	result.extensions	string	Rozšíření.
Název třídy BadgeClass	result.badgeclassName	string	Název BadgeClass.

Získání odznáčku odznáček uživatele

ID operace:

ClassGetUser

Získejte seznam badgeClasses pro ověřeného uživatele.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Název	result.name	string	Název.
Obrázek	result.image	string	Obrázek.
Description	result.description	string	Popis.
Typ dosaženého úspěchu	result.achievementType	string	Typ dosaženého úspěchu.
Adresa URL kritérií	result.criteriaUrl	string	Adresa URL kritérií.
Vyprávění kritérií	result.criteriaNarrative	string	Příběh kritérií.
Vyrovnání	result.alignments	array of object
Název cíle	result.alignments.targetName	string	Název cíle.
Cílová adresa URL	result.alignments.targetUrl	string	Adresa URL cíle.
Popis cíle	result.alignments.targetDescription	string	Popis cíle.
Cílový rámec	result.alignments.targetFramework	string	Rámec cíle.
Cílový kód	result.alignments.targetCode	string	Kód cíle.
Štítky	result.tags	array of string
Množství	result.expires.amount	string	Částka.
Doba trvání	result.expires.duration	string	Doba trvání.
Extensions	result.extensions	string	Rozšíření.

Získání podrobností o kontrolním výrazu batohu

ID operace:

BackpackGetAssertionDetails

Získejte podrobnosti o kontrolním výrazu v batohu uživatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Přijetí	result.acceptance	string	Když byl odznáček přijat.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
BadgeClass	result.badgeclass	string	Definice získatelného odznáček.
Id odznáčku BadgeClass Open	result.badgeclassOpenBadgeId	string	Identifikátor otevřeného odznaku BadgeClass.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Obrázek	result.image	string	Obrázek.
Identita	result.recipient.identity	string	Identita.
Typ	result.recipient.type	string	Typ.
Hashed	result.recipient.hashed	boolean	Určuje, jestli je hodnota hash.
Identita prostého textu	result.recipient.plaintextIdentity	string	Identita v prostém textu.
Vydáno dne	result.issuedOn	string	Při vydání.
Vyprávění	result.narrative	string	Příběh vydaného odznáček.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	Adresa URL.
Vyprávění	result.evidence.narrative	string	Příběh vydaného odznáček.
Odvolaný	result.revoked	boolean	Bez ohledu na to, jestli byl odvolán.
Důvod odvolání	result.revocationReason	string	Důvod odvolání.
Propadává	result.expires	string	Když vyprší platnost odznáček.
Čekající	result.pending	string	Zahájený.

Získání profilu BadgeUser

ID operace:

UserGetProfile

Získejte jeden profil BadgeUser. Pomocí entityId self načtěte profil ověřeného uživatele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Křestní jméno	result.firstName	string	Jméno.
Příjmení	result.lastName	string	Příjmení.
E-maily	result.emails	array of object
Typ entity	result.emails.entityType	string	Typ entity.
ID subjektu	result.emails.entityId	string	Identifikátor entity.
Email	result.emails.email	string	E-mailová adresa.
Ověřený	result.emails.verified	boolean	Zda je ověřeno.
Primary	result.emails.primary	boolean	Určuje, jestli primární.
Varianty případu	result.emails.caseVariants	string	Varianty případu.
URL	result.url	string	Adresa URL.
Telefon	result.telephone	string	Telefonní číslo.
Odsouhlasená verze podmínek	result.agreedTermsVersion	string	Verze podmínek aggreed.
Souhlasil(a) s nejnovější verzí podmínek.	result.hasAgreedToLatestTermsVersion	string	Verze laterst terms aggree.
Marketing Opt In	result.marketingOptIn	string	Souhlasil s výslovným souhlasem s marketingem.
Chybná doména	result.badgrDomain	string	Doména Badgr.
Má nastavené heslo	result.hasPasswordSet	string	Pokud je nastavené heslo.
Recipient	result.recipient	string	Příjemce.

Získání přístupových tokenů uživatele

ID operace:

TokenGet

Získejte seznam přístupových tokenů pro ověřeného uživatele.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of AccessToken

Získání třídy BadgeClass

ID operace:

ClassGet

Získejte jednu třídu BadgeClass.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
Issuer	result.issuer	string	Osoba nebo organizace, která vytváří nebo nabízí odznáčky a vydává je pro příjemce.
ID otevřeného odznaku vystavitele	result.issuerOpenBadgeId	string	Identifikátor otevřeného odznaku vystavitele.
Název	result.name	string	Název.
Obrázek	result.image	string	Obrázek.
Description	result.description	string	Popis.
Typ dosaženého úspěchu	result.achievementType	string	Typ dosaženého úspěchu.
Adresa URL kritérií	result.criteriaUrl	string	Adresa URL kritérií.
Vyprávění kritérií	result.criteriaNarrative	string	Příběh kritérií.
Vyrovnání	result.alignments	array of object
Název cíle	result.alignments.targetName	string	Název cíle.
Cílová adresa URL	result.alignments.targetUrl	string	Adresa URL cíle.
Popis cíle	result.alignments.targetDescription	string	Popis cíle.
Cílový rámec	result.alignments.targetFramework	string	Rámec cíle.
Cílový kód	result.alignments.targetCode	string	Kód cíle.
Štítky	result.tags	array of string
Množství	result.expires.amount	string	Částka.
Doba trvání	result.expires.duration	string	Doba trvání.
Extensions	result.extensions	string	Rozšíření.

Získání vystavitele

ID operace:

IssuerGetA

Získejte jednoho vystavitele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID subjektu	entity_id	True	string	Identifikátor subjektu

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
Results	result	array of object	Pole výsledků.
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
Název	result.name	string	Název.
Obrázek	result.image	string	Obrázek.
Email	result.email	string	E-mailová adresa.
Description	result.description	string	Popis.
URL	result.url	string	Adresa URL.
Personál	result.staff	array of object
Typ entity	result.staff.entityType	string	Typ entity.
ID subjektu	result.staff.entityId	string	Identifikátor entity.
Profil uživatele	result.staff.userProfile	string	Profil uživatele.
Uživatel	result.staff.user	string	Uživatel.
Role	result.staff.role	string	Role.
Extensions	result.extensions	string	Rozšíření.
Chybná doména	result.badgrDomain	string	Doména Badgr.

Získání vystavitelů

ID operace:

IssuerGet

Získejte seznam vystavitelů pro ověřeného uživatele.

Návraty

Name	Cesta	Typ	Description
Description	status.description	string	Popis.
Success	status.success	boolean	Zda úspěch.
výsledek	result	array of object
Typ entity	result.entityType	string	Typ entity.
ID subjektu	result.entityId	string	Identifikátor entity.
Open Badge ID	result.openBadgeId	string	Identifikátor otevřeného odznaku.
Vytvořeno na adrese	result.createdAt	string	Při vytváření na adrese.
Vytvořil	result.createdBy	string	Koho vytvořil.
Název	result.name	string	Název.
Obrázek	result.image	string	Obrázek.
Email	result.email	string	E-mailová adresa.
Description	result.description	string	Popis.
URL	result.url	string	Adresa URL.
Personál	result.staff	array of object
Typ entity	result.staff.entityType	string	Typ entity.
ID subjektu	result.staff.entityId	string	Identifikátor entity.
Typ entity	result.staff.userProfile.entityType	string	Typ entity.
ID subjektu	result.staff.userProfile.entityId	string	Identifikátor entity.
Křestní jméno	result.staff.userProfile.firstName	string	Jméno.
Příjmení	result.staff.userProfile.lastName	string	Příjmení.
E-maily	result.staff.userProfile.emails	array of object
Email	result.staff.userProfile.emails.email	string	E-mailová adresa.
Ověřený	result.staff.userProfile.emails.verified	boolean	Zda je ověřeno.
Primary	result.staff.userProfile.emails.primary	boolean	Určuje, jestli primární.
Varianty případu	result.staff.userProfile.emails.caseVariants	array of string	Varianty případu.
Adresy URL	result.staff.userProfile.url	array of string	Adresy URL.
Telefonní čísla	result.staff.userProfile.telephone	array of string	Telefonní čísla.
Chybná doména	result.staff.userProfile.badgrDomain	string	Doména Badgr.
Uživatel	result.staff.user	string	Uživatel.
Role	result.staff.role	string	Role.
Extensions	result.extensions	string	Rozšíření.
Chybná doména	result.badgrDomain	string	Doména Badgr.

Žádost o e-mail pro obnovení účtu

ID operace:

AccountRequestRecovery

Požádejte uživatele o e-mail pro obnovení účtu.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Email	email		string	E-mailová adresa v souboru pro odeslání obnovovacího e-mailu.

Definice

Přístupový token