Badgr (Editora Independente)

Organizações em todo o mundo usam o Badgr para criar ecossistemas de aprendizagem de marca que apoiam suas comunidades com credenciais digitais baseadas em habilidades, caminhos de aprendizagem empilháveis e registros portáteis de alunos.

Este conector está disponível nos seguintes produtos e regiões:

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Troia Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadados do conector
Editora	Troy Taylor, Soluções Hitachi
Sítio Web	https://badgr.com
Política de privacidade	https://info.badgr.com/privacy-policy.html
Categorias	Recursos Humanos

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Aceitação de asserção de atualização na mochila	Atualizar a aceitação de uma asserção na mochila de um usuário.
Atualizar um BadgeClass	Atualize um BadgeClass existente. BadgeInstances emitidos anteriormente não serão atualizados.
Atualizar um BadgeUser	Atualize a conta de um BadgeUser. Use o entityId 'self' para atualizar o perfil do usuário autenticado
Atualizar um emissor	Atualize um único emissor.
Atualizar uma asserção	Atualize uma asserção.
Atualizar uma coleção	Atualize uma coleção em uma mochila.
Carregue uma declaração na mochila	Carregue uma nova Declaração na mochila de um usuário.
Criar um BadgeClass	Crie um novo BadgeClass.
Criar um BadgeClass do emissor	Crie um novo BadgeClass associado a um emissor. O usuário autenticado deve ter status de proprietário, editor ou equipe no Emissor.
Criar um emissor	Crie um novo emissor.
Criar uma coleção	Crie uma nova coleção.
Criar uma conta BadgeUser	Crie uma conta e um perfil BadgeUser.
Emitir uma asserção	Emita uma nova Declaração para um destinatário.
Emitir uma asserção	Emita uma declaração para um único destinatário.
Emitir vários BadgeClass	Emita várias cópias da mesma BadgeClass para vários destinatários.
Excluir um BadgeClass	Exclua um BadgeClass. Restrito a proprietários ou editores (não funcionários) do Emissor correspondente.
Excluir um emissor	Exclua um único emissor.
Excluir uma coleção	Excluir uma coleção de uma mochila.
Importar uma declaração para mochila	Importe uma nova Declaração para a mochila de um usuário.
Obtenha uma coleção	Obtenha uma única coleção.
Obtenha uma única asserção	Obter uma asserção
Obter asserções	Obtenha uma lista de Asserções para um único Emissor.
Obter asserções de BadgeClass	Obtenha uma lista de asserções para um único BadgeClass.
Obter asserções na mochila de um usuário	Obtenha uma lista de Asserções na mochila do usuário autenticado.
Obter BadgeClasses do Emissor	Obtenha uma lista de BadgeClasses para um único emissor. O usuário autenticado deve ter status de proprietário, editor ou equipe no Emissor.
Obter BadgeClasses do usuário	Obtenha uma lista de BadgeClasses para usuário autenticado.
Obter coleções	Obtenha uma lista de Coleções.
Obter detalhes da Declaração de Mochila	Obtenha detalhes sobre uma asserção na mochila de um usuário.
Obter Emissores	Obtenha uma lista de Emissores para usuário autenticado.
Obter tokens de acesso do usuário	Obtenha uma lista de tokens de acesso para usuário autenticado.
Obter um AccessToken	Obtenha um único AccessToken.
Obter um BadgeClass	Obtenha um único BadgeClass.
Obter um emissor	Obtenha um único emissor.
Obter um seloPerfil do usuário	Obtenha um único perfil BadgeUser. Use o entityId 'self' para recuperar o perfil do usuário autenticado.
Recuperar tokens de emissor	Recupere tokens de emissor.
Recuperar uma conta	Recupere uma conta e defina uma nova senha.
Remover uma asserção da mochila	Remova uma afirmação da mochila de um usuário.
Revogar um AccessToken	Revogar o AccessToken de um usuário.
Revogar uma asserção	Revogar uma afirmação.
Revogar várias asserções	Revogar várias asserções para vários destinatários.
Solicitar um e-mail de recuperação de conta	Solicite um e-mail de recuperação de conta para um usuário.

Aceitação de asserção de atualização na mochila

ID da Operação:: BackpackUpdateAcceptance

Atualizar a aceitação de uma asserção na mochila de um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
Aceitação	acceptance		string	A aceitação.
BadgeClass	badgeclass		string	A definição de um distintivo ganho.
Issuer	issuer		string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores. .
ID do selo aberto do emissor	issuerOpenBadgeId		string	O identificador do Open Badge do emissor.
Identidade	identity		string	A identidade.
Tipo	type		string	O tipo.
Arrasado	hashed		boolean	Se hashed.
Identidade de texto simples	plaintextIdentity		string	A identidade em texto simples.
Emitido em	issuedOn		string	Quando emitido em.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
URL	url		string	O endereço URL.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
Expira	expires		string	Quando expira.
Pendente	pending		string	Pendente.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Tipo	result.recipient.type	string	O tipo.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Expira	result.expires	string	Quando o selo expirar.
Pendente	result.pending	string	Pendente.

Atualizar um BadgeClass

ID da Operação:: ClassUpdate

Atualize um BadgeClass existente. BadgeInstances emitidos anteriormente não serão atualizados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
Issuer	issuer		string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores. .
ID do selo aberto do emissor	issuerOpenBadgeId		string	O identificador do Open Badge do emissor.
Nome	name		string	O nome.
Imagem	image		string	A imagem.
Description	description		string	A descrição.
Tipo de Realização	achievementType		string	O tipo de realização.
URL do critério	criteriaUrl		string	O URL dos critérios.
Critérios Narrativos	criteriaNarrative		string	A narrativa dos critérios.
Nome do destino	targetName		string	O nome do destino.
URL de destino	targetUrl		string	O URL do destino.
Descrição do Destino	targetDescription		string	A descrição do alvo.
Plataforma de Destino	targetFramework		string	O quadro da meta.
Código de destino	targetCode		string	O código do destino.
Etiquetas	tags		array of string
Montante	amount		string	O montante.
Duração	duration		string	A duração.
Extensions	extensions		string	As extensões.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Description	result.description	string	A descrição.
Tipo de Realização	result.achievementType	string	O tipo de realização.
URL do critério	result.criteriaUrl	string	O endereço URL dos critérios.
Critérios Narrativos	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome do destino	result.alignments.targetName	string	O nome do destino.
URL de destino	result.alignments.targetUrl	string	O endereço URL do destino.
Descrição do Destino	result.alignments.targetDescription	string	A descrição do alvo.
Plataforma de Destino	result.alignments.targetFramework	string	O quadro da meta.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Montante	result.expires.amount	string	O montante.
Duração	result.expires.duration	string	A duração.
Extensions	result.extensions	string	As extensões.

Atualizar um BadgeUser

ID da Operação:: UserUpdate

Atualize a conta de um BadgeUser. Use o entityId 'self' para atualizar o perfil do usuário autenticado

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
Tipo de Entidade	entityType		string	O tipo de entidade.
ID da entidade	entityId		string	O identificador da entidade.
Nome Próprio	firstName		string	O primeiro nome.
Apelido	lastName		string	O sobrenome.
Tipo de Entidade	entityType		string	O tipo de entidade.
ID da entidade	entityId		string	O identificador da entidade.
Email	email		string	O endereço de e-mail.
Verificada	verified		boolean	Se verificado.
Primary	primary		boolean	Seja primária.
Variantes de caso	caseVariants		string	As variantes de caso.
URL	url		string	O endereço URL.
Telefone	telephone		string	O número de telefone.
Versão dos Termos Acordados	agreedTermsVersion		string	A versão dos termos acordados.
Concordou com a versão mais recente dos termos	hasAgreedToLatestTermsVersion		string	A versão dos últimos termos acordados.
Marketing Opt In	marketingOptIn		string	Optou pelo marketing.
Domínio Badgr	badgrDomain		string	O domínio de Badgr.
Tem senha definida	hasPasswordSet		string	Tem senha definida.
Recipient	recipient		string	O destinatário.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Nome Próprio	result.firstName	string	O primeiro nome.
Apelido	result.lastName	string	O sobrenome.
E-mails	result.emails	array of object
Tipo de Entidade	result.emails.entityType	string	O tipo da entidade.
ID da entidade	result.emails.entityId	string	O identificador da entidade.
Email	result.emails.email	string	O endereço de e-mail.
Verificada	result.emails.verified	boolean	Se verificado.
Primary	result.emails.primary	boolean	Seja primária.
Variantes de caso	result.emails.caseVariants	string	As variantes de caso.
URL	result.url	string	O endereço URL.
Telefone	result.telephone	string	O número de telefone.
Versão dos Termos Acordados	result.agreedTermsVersion	string	A versão dos termos acordados.
Concordou com a versão mais recente dos termos	result.hasAgreedToLatestTermsVersion	string	A versão dos termos posteriores aggree.
Marketing Opt In	result.marketingOptIn	string	Concordou com o opt-in de marketing.
Domínio Badgr	result.badgrDomain	string	O domínio de Badgr.
Tem senha definida	result.hasPasswordSet	string	Se tiver senha definida.
Recipient	result.recipient	string	O destinatário.

Atualizar um emissor

ID da Operação:: IssuerUpdate

Atualize um único emissor.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
Criado por	createdBy		string	Quem criou por.
Nome	name		string	O nome.
Imagem	image		string	A imagem.
Email	email		string	O endereço de e-mail.
Description	description		string	A descrição.
URL	url		string	O endereço URL.
Tipo de Entidade	entityType		string	O tipo de entidade.
ID da entidade	entityId		string	O identificador da entidade.
Perfil de Utilizador	userProfile		string	O perfil do usuário.
User	user		string	O usuário.
Funções	role		string	O papel.
Extensions	extensions		string	As extensões.
Domínio Badgr	badgrDomain		string	O domínio de Badgr.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Email	result.email	string	O endereço de e-mail.
Description	result.description	string	A descrição.
URL	result.url	string	O endereço URL.
Funcionários	result.staff	array of object
Tipo de Entidade	result.staff.entityType	string	O tipo da entidade.
ID da entidade	result.staff.entityId	string	O identificador da entidade.
Perfil de Utilizador	result.staff.userProfile	string	O perfil do usuário.
User	result.staff.user	string	O usuário.
Funções	result.staff.role	string	O papel.
Extensions	result.extensions	string	As extensões.
Domínio Badgr	result.badgrDomain	string	O domínio de Badgr.

Atualizar uma asserção

ID da Operação:: AssertionUpdate

Atualize uma asserção.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
BadgeClass	badgeclass		string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	badgeclassOpenBadgeId		string	O identificador do Open Badge do BadgeClass.
Issuer	issuer		string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores. .
ID do selo aberto do emissor	issuerOpenBadgeId		string	O identificador do Open Badge do emissor.
Identidade	identity		string	A identidade.
Arrasado	hashed		boolean	Se hashed.
Tipo	type		string	O tipo.
Identidade de texto simples	plaintextIdentity		string	A identidade em texto simples.
Salt	salt		string	Se estiver em hash, o sal.
Emitido em	issuedOn		string	Quando emitido em.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
URL	url		string	O endereço URL.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
Expira	expires		string	Quando expira.
Extensions	extensions		string	As extensões.
Nome BadgeClass	badgeclassName		string	O nome do BadgeClass.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Atualizar uma coleção

ID da Operação:: CollectionUpdate

Atualize uma coleção em uma mochila.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
Tipo de Entidade	entityType		string	O tipo de entidade.
ID da entidade	entityId		string	O identificador da entidade.
Nome	name		string	O nome.
Description	description		string	A descrição.
Proprietário	owner		string	O proprietário.
Partilhar URL	share_url		string	O endereço URL do compartilhamento.
Compartilhar hash	shareHash		string	O hash do compartilhamento.
Publicado	published		boolean	Se publicado.
BadgeClass	badgeclass		string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	badgeclassOpenBadgeId		string	O identificador do Open Badge do BadgeClass.
Issuer	issuer		string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	issuerOpenBadgeId		string	O identificador do Open Badge do emissor.
Identidade	identity		string	A identidade.
Arrasado	hashed		boolean	Se hashed.
Tipo	type		string	O tipo.
Identidade de texto simples	plaintextIdentity		string	A identidade em texto simples.
Salt	salt		string	Se estiver em hash, o sal.
Emitido em	issuedOn		string	Quando emitido em.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
URL	url		string	O endereço URL.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
Expira	expires		string	Quando o selo expirar.
Extensions	extensions		string	As extensões.
Nome BadgeClass	badgeclassName		string	O nome do BadgeClass.
Criado em	createdAt		string	Criado em.
Criado por	createdBy		string	Quem criou por.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Nome	result.name	string	O nome.
Description	result.description	string	A descrição.
Proprietário	result.owner	string	O proprietário.
Partilhar URL	result.share_url	string	O endereço URL do compartilhamento.
Compartilhar hash	result.shareHash	string	O hash do compartilhamento.
Publicado	result.published	boolean	Se publicado.
Assertions	result.assertions	array of object
Tipo de Entidade	result.assertions.entityType	string	O tipo da entidade.
ID da entidade	result.assertions.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.assertions.openBadgeId	string	O identificador do Open Badge.
Criado em	result.assertions.createdAt	string	Quando criado em.
Criado por	result.assertions.createdBy	string	Criado por.
BadgeClass	result.assertions.badgeclass	string	O BadgeClass.
ID do selo aberto BadgeClass	result.assertions.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.assertions.issuer	string	O emitente.
ID do selo aberto do emissor	result.assertions.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.assertions.image	string	A imagem.
Identidade	result.assertions.recipient.identity	string	A identidade.
Arrasado	result.assertions.recipient.hashed	boolean	Se hashed.
Tipo	result.assertions.recipient.type	string	O tipo.
Identidade de texto simples	result.assertions.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.assertions.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.assertions.issuedOn	string	Quando emitido em.
Narrativa	result.assertions.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	O endereço URL.
Narrativa	result.assertions.evidence.narrative	string	A narrativa.
Revogado	result.assertions.revoked	boolean	Se revogado.
Motivo da revogação	result.assertions.revocationReason	string	O motivo da revogação.
Aceitação	result.assertions.acceptance	string	A aceitação.
Expira	result.assertions.expires	string	Quando expira.
Extensions	result.assertions.extensions	string	As extensões.
Nome BadgeClass	result.assertions.badgeclassName	string	O nome do BadgeClass.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.

Carregue uma declaração na mochila

ID da Operação:: BackpackUploadAssertion

Carregue uma nova Declaração na mochila de um usuário.

Parâmetros

Name	Chave	Tipo	Description
BadgeClass	badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores. .
ID do selo aberto do emissor	issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Identidade	identity	string	A identidade.
Arrasado	hashed	boolean	Se hashed.
Tipo	type	string	O tipo.
Identidade de texto simples	plaintextIdentity	string	A identidade em texto simples.
Salt	salt	string	Se estiver em hash, o sal.
Emitido em	issuedOn	string	Quando emitido em.
Narrativa	narrative	string	A narrativa para o distintivo emitido.
URL	url	string	O endereço URL.
Narrativa	narrative	string	A narrativa para o distintivo emitido.
Expira	expires	string	Quando expira.
Extensions	extensions	string	As extensões.
Nome BadgeClass	badgeclassName	string	O nome do BadgeClass.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Criar um BadgeClass

ID da Operação:: ClassCreate

Crie um novo BadgeClass.

Parâmetros

Name	Chave	Tipo	Description
Número	num	integer	Solicitar paginação dos resultados
Issuer	issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores. .
ID do selo aberto do emissor	issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Nome	name	string	O nome.
Imagem	image	string	A imagem.
Description	description	string	A descrição.
Tipo de Realização	achievementType	string	O tipo de realização.
URL do critério	criteriaUrl	string	O URL dos critérios.
Critérios Narrativos	criteriaNarrative	string	A narrativa dos critérios.
Nome do destino	targetName	string	O nome do destino.
URL de destino	targetUrl	string	O URL do destino.
Descrição do Destino	targetDescription	string	A descrição do alvo.
Plataforma de Destino	targetFramework	string	O quadro da meta.
Código de destino	targetCode	string	O código do destino.
Etiquetas	tags	array of string
Montante	amount	string	O montante.
Duração	duration	string	A duração.
Extensions	extensions	string	As extensões.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Description	result.description	string	A descrição.
Tipo de Realização	result.achievementType	string	O tipo de realização.
URL do critério	result.criteriaUrl	string	O endereço URL dos critérios.
Critérios Narrativos	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome do destino	result.alignments.targetName	string	O nome do destino.
URL de destino	result.alignments.targetUrl	string	O endereço URL do destino.
Descrição do Destino	result.alignments.targetDescription	string	A descrição do alvo.
Plataforma de Destino	result.alignments.targetFramework	string	O quadro da meta.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Montante	result.expires.amount	string	O montante.
Duração	result.expires.duration	string	A duração.
Extensions	result.extensions	string	As extensões.

Criar um BadgeClass do emissor

ID da Operação:: ClassCreateIssuer

Crie um novo BadgeClass associado a um emissor. O usuário autenticado deve ter status de proprietário, editor ou equipe no Emissor.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
Issuer	issuer		string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores. .
ID do selo aberto do emissor	issuerOpenBadgeId		string	O identificador do Open Badge do emissor.
Nome	name		string	O nome.
Imagem	image		string	A imagem.
Description	description		string	A descrição.
Tipo de Realização	achievementType		string	O tipo de realização.
URL do critério	criteriaUrl		string	O URL dos critérios.
Critérios Narrativos	criteriaNarrative		string	A narrativa dos critérios.
Nome do destino	targetName		string	O nome do destino.
URL de destino	targetUrl		string	O URL do destino.
Descrição do Destino	targetDescription		string	A descrição do alvo.
Plataforma de Destino	targetFramework		string	O quadro da meta.
Código de destino	targetCode		string	O código do destino.
Etiquetas	tags		array of string
Montante	amount		string	O montante.
Duração	duration		string	A duração.
Extensions	extensions		string	As extensões.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Description	result.description	string	A descrição.
Tipo de Realização	result.achievementType	string	O tipo de realização.
URL do critério	result.criteriaUrl	string	O endereço URL dos critérios.
Critérios Narrativos	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome do destino	result.alignments.targetName	string	O nome do destino.
URL de destino	result.alignments.targetUrl	string	O endereço URL do destino.
Descrição do Destino	result.alignments.targetDescription	string	A descrição do alvo.
Plataforma de Destino	result.alignments.targetFramework	string	O quadro da meta.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Montante	result.expires.amount	string	O montante.
Duração	result.expires.duration	string	A duração.
Extensions	result.extensions	string	As extensões.

Criar um emissor

ID da Operação:: IssuerCreate

Crie um novo emissor.

Parâmetros

Name	Chave	Tipo	Description
Criado por	createdBy	string	Quem criou por.
Nome	name	string	O nome.
Imagem	image	string	A imagem.
Email	email	string	O endereço de e-mail.
Description	description	string	A descrição.
URL	url	string	O endereço URL.
Tipo de Entidade	entityType	string	O tipo de entidade.
ID da entidade	entityId	string	O identificador da entidade.
Perfil de Utilizador	userProfile	string	O perfil do usuário.
User	user	string	O usuário.
Funções	role	string	O papel.
Extensions	extensions	string	As extensões.
Domínio Badgr	badgrDomain	string	O domínio de Badgr.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Email	result.email	string	O endereço de e-mail.
Description	result.description	string	A descrição.
URL	result.url	string	O endereço URL.
Funcionários	result.staff	array of object
Tipo de Entidade	result.staff.entityType	string	O tipo da entidade.
ID da entidade	result.staff.entityId	string	O identificador da entidade.
Perfil de Utilizador	result.staff.userProfile	string	O perfil do usuário.
User	result.staff.user	string	O usuário.
Funções	result.staff.role	string	O papel.
Extensions	result.extensions	string	As extensões.
Domínio Badgr	result.badgrDomain	string	O domínio de Badgr.

Criar uma coleção

ID da Operação:: CollectionCreate

Crie uma nova coleção.

Parâmetros

Name	Chave	Tipo	Description
Tipo de Entidade	entityType	string	O tipo de entidade.
ID da entidade	entityId	string	O identificador da entidade.
Nome	name	string	O nome.
Description	description	string	A descrição.
Proprietário	owner	string	O proprietário.
Partilhar URL	share_url	string	O endereço URL do compartilhamento.
Compartilhar hash	shareHash	string	O hash do compartilhamento.
Publicado	published	boolean	Se publicado.
BadgeClass	badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Identidade	identity	string	A identidade.
Arrasado	hashed	boolean	Se hashed.
Tipo	type	string	O tipo.
Identidade de texto simples	plaintextIdentity	string	A identidade em texto simples.
Salt	salt	string	Se estiver em hash, o sal.
Emitido em	issuedOn	string	Quando emitido em.
Narrativa	narrative	string	A narrativa para o distintivo emitido.
URL	url	string	O endereço URL.
Narrativa	narrative	string	A narrativa para o distintivo emitido.
Expira	expires	string	Quando o selo expirar.
Extensions	extensions	string	As extensões.
Nome BadgeClass	badgeclassName	string	O nome do BadgeClass.
Criado em	createdAt	string	Criado em.
Criado por	createdBy	string	Quem criou por.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Nome	result.name	string	O nome.
Description	result.description	string	A descrição.
Proprietário	result.owner	string	O proprietário.
Partilhar URL	result.share_url	string	O endereço URL do compartilhamento.
Compartilhar hash	result.shareHash	string	O hash do compartilhamento.
Publicado	result.published	boolean	Se publicado.
Assertions	result.assertions	array of object
Tipo de Entidade	result.assertions.entityType	string	O tipo da entidade.
ID da entidade	result.assertions.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.assertions.openBadgeId	string	O identificador do Open Badge.
Criado em	result.assertions.createdAt	string	Quando criado em.
Criado por	result.assertions.createdBy	string	Criado por.
BadgeClass	result.assertions.badgeclass	string	O BadgeClass.
ID do selo aberto BadgeClass	result.assertions.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.assertions.issuer	string	O emitente.
ID do selo aberto do emissor	result.assertions.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.assertions.image	string	A imagem.
Identidade	result.assertions.recipient.identity	string	A identidade.
Arrasado	result.assertions.recipient.hashed	boolean	Se hashed.
Tipo	result.assertions.recipient.type	string	O tipo.
Identidade de texto simples	result.assertions.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.assertions.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.assertions.issuedOn	string	Quando emitido em.
Narrativa	result.assertions.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	O endereço URL.
Narrativa	result.assertions.evidence.narrative	string	A narrativa.
Revogado	result.assertions.revoked	boolean	Se revogado.
Motivo da revogação	result.assertions.revocationReason	string	O motivo da revogação.
Aceitação	result.assertions.acceptance	string	A aceitação.
Expira	result.assertions.expires	string	Quando expira.
Extensions	result.assertions.extensions	string	As extensões.
Nome BadgeClass	result.assertions.badgeclassName	string	O nome do BadgeClass.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.

Criar uma conta BadgeUser

ID da Operação:: UserCreate

Crie uma conta e um perfil BadgeUser.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
Tipo de Entidade	entityType		string	O tipo de entidade.
ID da entidade	entityId		string	O identificador da entidade.
Nome Próprio	firstName		string	O primeiro nome.
Apelido	lastName		string	O sobrenome.
Tipo de Entidade	entityType		string	O tipo de entidade.
ID da entidade	entityId		string	O identificador da entidade.
Email	email		string	O endereço de e-mail.
Verificada	verified		boolean	Se verificado.
Primary	primary		boolean	Seja primária.
Variantes de caso	caseVariants		string	As variantes de caso.
URL	url		string	O endereço URL.
Telefone	telephone		string	O número de telefone.
Versão dos Termos Acordados	agreedTermsVersion		string	A versão dos termos acordados.
Concordou com a versão mais recente dos termos	hasAgreedToLatestTermsVersion		string	A versão dos últimos termos acordados.
Marketing Opt In	marketingOptIn		string	Optou pelo marketing.
Domínio Badgr	badgrDomain		string	O domínio de Badgr.
Tem senha definida	hasPasswordSet		string	Tem senha definida.
Recipient	recipient		string	O destinatário.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Nome Próprio	result.firstName	string	O primeiro nome.
Apelido	result.lastName	string	O sobrenome.
E-mails	result.emails	array of object
Tipo de Entidade	result.emails.entityType	string	O tipo da entidade.
ID da entidade	result.emails.entityId	string	O identificador da entidade.
Email	result.emails.email	string	O endereço de e-mail.
Verificada	result.emails.verified	boolean	Se verificado.
Primary	result.emails.primary	boolean	Seja primária.
Variantes de caso	result.emails.caseVariants	string	As variantes de caso.
URL	result.url	string	O endereço URL.
Telefone	result.telephone	string	O número de telefone.
Versão dos Termos Acordados	result.agreedTermsVersion	string	A versão dos termos acordados.
Concordou com a versão mais recente dos termos	result.hasAgreedToLatestTermsVersion	string	A versão dos termos posteriores aggree.
Marketing Opt In	result.marketingOptIn	string	Concordou com o opt-in de marketing.
Domínio Badgr	result.badgrDomain	string	O domínio de Badgr.
Tem senha definida	result.hasPasswordSet	string	Se tiver senha definida.
Recipient	result.recipient	string	O destinatário.

Emitir uma asserção

ID da Operação:: AssertionIssue

Emita uma nova Declaração para um destinatário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
BadgeClass	badgeclass		string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	badgeclassOpenBadgeId		string	O identificador do Open Badge do BadgeClass.
Issuer	issuer		string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores. .
ID do selo aberto do emissor	issuerOpenBadgeId		string	O identificador do Open Badge do emissor.
Identidade	identity		string	A identidade.
Arrasado	hashed		boolean	Se hashed.
Tipo	type		string	O tipo.
Identidade de texto simples	plaintextIdentity		string	A identidade em texto simples.
Salt	salt		string	Se estiver em hash, o sal.
Emitido em	issuedOn		string	Quando emitido em.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
URL	url		string	O endereço URL.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
Expira	expires		string	Quando expira.
Extensions	extensions		string	As extensões.
Nome BadgeClass	badgeclassName		string	O nome do BadgeClass.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Emitir uma asserção

ID da Operação:: ClassIssueAssertion

Emita uma declaração para um único destinatário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
BadgeClass	badgeclass		string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	badgeclassOpenBadgeId		string	O identificador do Open Badge do BadgeClass.
Issuer	issuer		string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores. .
ID do selo aberto do emissor	issuerOpenBadgeId		string	O identificador do Open Badge do emissor.
Identidade	identity		string	A identidade.
Arrasado	hashed		boolean	Se hashed.
Tipo	type		string	O tipo.
Identidade de texto simples	plaintextIdentity		string	A identidade em texto simples.
Salt	salt		string	Se estiver em hash, o sal.
Emitido em	issuedOn		string	Quando emitido em.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
URL	url		string	O endereço URL.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
Expira	expires		string	Quando expira.
Extensions	extensions		string	As extensões.
Nome BadgeClass	badgeclassName		string	O nome do BadgeClass.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Emitir vários BadgeClass

ID da Operação:: ClassIssueBulk

Emita várias cópias da mesma BadgeClass para vários destinatários.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
BadgeClass	badgeclass		string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	badgeclassOpenBadgeId		string	O identificador do Open Badge do BadgeClass.
Issuer	issuer		string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores. .
ID do selo aberto do emissor	issuerOpenBadgeId		string	O identificador do Open Badge do emissor.
Identidade	identity		string	A identidade.
Arrasado	hashed		boolean	Se hashed.
Tipo	type		string	O tipo.
Identidade de texto simples	plaintextIdentity		string	A identidade em texto simples.
Salt	salt		string	Se estiver em hash, o sal.
Emitido em	issuedOn		string	Quando emitido em.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
URL	url		string	O endereço URL.
Narrativa	narrative		string	A narrativa para o distintivo emitido.
Expira	expires		string	Quando expira.
Extensions	extensions		string	As extensões.
Nome BadgeClass	badgeclassName		string	O nome do BadgeClass.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Excluir um BadgeClass

ID da Operação:: ClassDelete

Exclua um BadgeClass. Restrito a proprietários ou editores (não funcionários) do Emissor correspondente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Excluir um emissor

ID da Operação:: IssuerDelete

Exclua um único emissor.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Excluir uma coleção

ID da Operação:: CollectionDelete

Excluir uma coleção de uma mochila.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Importar uma declaração para mochila

ID da Operação:: BackpackImportAssertion

Importe uma nova Declaração para a mochila de um usuário.

Parâmetros

Name	Chave	Tipo	Description
URL	url	string	URL para um selo compatível com OpenBadge.
Imagem	image	string	Base64 codificado Baked OpenBadge imagem.
Asserção	assertion	object	JSON compatível com OpenBadge.

Obtenha uma coleção

ID da Operação:: CollectionGetA

Obtenha uma única coleção.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Nome	result.name	string	O nome.
Description	result.description	string	A descrição.
Proprietário	result.owner	string	O proprietário.
Partilhar URL	result.share_url	string	O endereço URL do compartilhamento.
Compartilhar hash	result.shareHash	string	O hash do compartilhamento.
Publicado	result.published	boolean	Se publicado.
Assertions	result.assertions	array of object
Tipo de Entidade	result.assertions.entityType	string	O tipo da entidade.
ID da entidade	result.assertions.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.assertions.openBadgeId	string	O identificador do Open Badge.
Criado em	result.assertions.createdAt	string	Quando criado em.
Criado por	result.assertions.createdBy	string	Criado por.
BadgeClass	result.assertions.badgeclass	string	O BadgeClass.
ID do selo aberto BadgeClass	result.assertions.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.assertions.issuer	string	O emitente.
ID do selo aberto do emissor	result.assertions.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.assertions.image	string	A imagem.
Identidade	result.assertions.recipient.identity	string	A identidade.
Arrasado	result.assertions.recipient.hashed	boolean	Se hashed.
Tipo	result.assertions.recipient.type	string	O tipo.
Identidade de texto simples	result.assertions.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.assertions.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.assertions.issuedOn	string	Quando emitido em.
Narrativa	result.assertions.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	O endereço URL.
Narrativa	result.assertions.evidence.narrative	string	A narrativa.
Revogado	result.assertions.revoked	boolean	Se revogado.
Motivo da revogação	result.assertions.revocationReason	string	O motivo da revogação.
Aceitação	result.assertions.acceptance	string	A aceitação.
Expira	result.assertions.expires	string	Quando expira.
Extensions	result.assertions.extensions	string	As extensões.
Nome BadgeClass	result.assertions.badgeclassName	string	O nome do BadgeClass.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.

Obtenha uma única asserção

ID da Operação:: AssertionGetA

Obter uma asserção

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Obter asserções

ID da Operação:: AssertionGet

Obtenha uma lista de Asserções para um único Emissor.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade
Recipient	recipient		string	Um identificador de destinatário pelo qual filtrar
Número	num		string	Solicitar paginação dos resultados
Incluir expirado	include_expired		boolean	Incluir asserções expiradas
Incluir Revogado	include_revoked		boolean	Incluir asserções revogadas

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Obter asserções de BadgeClass

ID da Operação:: ClassGetAssertion

Obtenha uma lista de asserções para um único BadgeClass.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade
Recipient	recipient		string	Um identificador de destinatário pelo qual filtrar
Número	num		string	Solicitar paginação dos resultados
Incluir expirado	include_expired		boolean	Incluir asserções expiradas
Incluir Revogado	include_revoked		boolean	Incluir asserções revogadas

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Obter asserções na mochila de um usuário

ID da Operação:: BackpackGetAssertion

Obtenha uma lista de Asserções na mochila do usuário autenticado.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Obter BadgeClasses do Emissor

ID da Operação:: ClassGetIssuer

Obtenha uma lista de BadgeClasses para um único emissor. O usuário autenticado deve ter status de proprietário, editor ou equipe no Emissor.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade
Número	num		string	Solicitar paginação dos resultados

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Description	result.description	string	A descrição.
Tipo de Realização	result.achievementType	string	O tipo de realização.
URL do critério	result.criteriaUrl	string	O endereço URL dos critérios.
Critérios Narrativos	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome do destino	result.alignments.targetName	string	O nome do destino.
URL de destino	result.alignments.targetUrl	string	O endereço URL do destino.
Descrição do Destino	result.alignments.targetDescription	string	A descrição do alvo.
Plataforma de Destino	result.alignments.targetFramework	string	O quadro da meta.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Montante	result.expires.amount	string	O montante.
Duração	result.expires.duration	string	A duração.
Extensions	result.extensions	string	As extensões.

Obter BadgeClasses do usuário

ID da Operação:: ClassGetUser

Obtenha uma lista de BadgeClasses para usuário autenticado.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Description	result.description	string	A descrição.
Tipo de Realização	result.achievementType	string	O tipo de realização.
URL do critério	result.criteriaUrl	string	O endereço URL dos critérios.
Critérios Narrativos	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome do destino	result.alignments.targetName	string	O nome do destino.
URL de destino	result.alignments.targetUrl	string	O endereço URL do destino.
Descrição do Destino	result.alignments.targetDescription	string	A descrição do alvo.
Plataforma de Destino	result.alignments.targetFramework	string	O quadro da meta.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Montante	result.expires.amount	string	O montante.
Duração	result.expires.duration	string	A duração.
Extensions	result.extensions	string	As extensões.

Obter coleções

ID da Operação:: CollectionGet

Obtenha uma lista de Coleções.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Nome	result.name	string	O nome.
Description	result.description	string	A descrição.
Proprietário	result.owner	string	O proprietário.
Partilhar URL	result.share_url	string	O endereço URL do compartilhamento.
Compartilhar hash	result.shareHash	string	O hash do compartilhamento.
Publicado	result.published	boolean	Se publicado.
Assertions	result.assertions	array of object
Tipo de Entidade	result.assertions.entityType	string	O tipo da entidade.
ID da entidade	result.assertions.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.assertions.openBadgeId	string	O identificador do Open Badge.
Criado em	result.assertions.createdAt	string	Quando criado em.
Criado por	result.assertions.createdBy	string	Criado por.
BadgeClass	result.assertions.badgeclass	string	O BadgeClass.
ID do selo aberto BadgeClass	result.assertions.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.assertions.issuer	string	O emitente.
ID do selo aberto do emissor	result.assertions.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.assertions.image	string	A imagem.
Identidade	result.assertions.recipient.identity	string	A identidade.
Arrasado	result.assertions.recipient.hashed	boolean	Se hashed.
Tipo	result.assertions.recipient.type	string	O tipo.
Identidade de texto simples	result.assertions.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.assertions.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.assertions.issuedOn	string	Quando emitido em.
Narrativa	result.assertions.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	O endereço URL.
Narrativa	result.assertions.evidence.narrative	string	A narrativa.
Revogado	result.assertions.revoked	boolean	Se revogado.
Motivo da revogação	result.assertions.revocationReason	string	O motivo da revogação.
Aceitação	result.assertions.acceptance	string	A aceitação.
Expira	result.assertions.expires	string	Quando expira.
Extensions	result.assertions.extensions	string	As extensões.
Nome BadgeClass	result.assertions.badgeclassName	string	O nome do BadgeClass.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.

Obter detalhes da Declaração de Mochila

ID da Operação:: BackpackGetAssertionDetails

Obtenha detalhes sobre uma asserção na mochila de um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Tipo	result.recipient.type	string	O tipo.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Expira	result.expires	string	Quando o selo expirar.
Pendente	result.pending	string	Pendente.

Obter Emissores

ID da Operação:: IssuerGet

Obtenha uma lista de Emissores para usuário autenticado.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Email	result.email	string	O endereço de e-mail.
Description	result.description	string	A descrição.
URL	result.url	string	O endereço URL.
Funcionários	result.staff	array of object
Tipo de Entidade	result.staff.entityType	string	O tipo da entidade.
ID da entidade	result.staff.entityId	string	O identificador da entidade.
Tipo de Entidade	result.staff.userProfile.entityType	string	O tipo de entidade.
ID da entidade	result.staff.userProfile.entityId	string	O identificador de entidade.
Nome Próprio	result.staff.userProfile.firstName	string	O primeiro nome.
Apelido	result.staff.userProfile.lastName	string	O sobrenome.
E-mails	result.staff.userProfile.emails	array of object
Email	result.staff.userProfile.emails.email	string	O endereço de e-mail.
Verificada	result.staff.userProfile.emails.verified	boolean	Se verificado.
Primary	result.staff.userProfile.emails.primary	boolean	Seja primária.
Variantes de caso	result.staff.userProfile.emails.caseVariants	array of string	As variantes de caso.
URLs	result.staff.userProfile.url	array of string	Os endereços URL.
Números de telefone	result.staff.userProfile.telephone	array of string	Os números de telefone.
Domínio Badgr	result.staff.userProfile.badgrDomain	string	O domínio Badgr.
User	result.staff.user	string	O usuário.
Funções	result.staff.role	string	O papel.
Extensions	result.extensions	string	As extensões.
Domínio Badgr	result.badgrDomain	string	O domínio de Badgr.

Obter tokens de acesso do usuário

ID da Operação:: TokenGet

Obtenha uma lista de tokens de acesso para usuário autenticado.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of AccessToken

Obter um AccessToken

ID da Operação:: TokenGetA

Obtenha um único AccessToken.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	AccessToken

Obter um BadgeClass

ID da Operação:: ClassGet

Obtenha um único BadgeClass.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Description	result.description	string	A descrição.
Tipo de Realização	result.achievementType	string	O tipo de realização.
URL do critério	result.criteriaUrl	string	O endereço URL dos critérios.
Critérios Narrativos	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome do destino	result.alignments.targetName	string	O nome do destino.
URL de destino	result.alignments.targetUrl	string	O endereço URL do destino.
Descrição do Destino	result.alignments.targetDescription	string	A descrição do alvo.
Plataforma de Destino	result.alignments.targetFramework	string	O quadro da meta.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Montante	result.expires.amount	string	O montante.
Duração	result.expires.duration	string	A duração.
Extensions	result.extensions	string	As extensões.

Obter um emissor

ID da Operação:: IssuerGetA

Obtenha um único emissor.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Email	result.email	string	O endereço de e-mail.
Description	result.description	string	A descrição.
URL	result.url	string	O endereço URL.
Funcionários	result.staff	array of object
Tipo de Entidade	result.staff.entityType	string	O tipo da entidade.
ID da entidade	result.staff.entityId	string	O identificador da entidade.
Perfil de Utilizador	result.staff.userProfile	string	O perfil do usuário.
User	result.staff.user	string	O usuário.
Funções	result.staff.role	string	O papel.
Extensions	result.extensions	string	As extensões.
Domínio Badgr	result.badgrDomain	string	O domínio de Badgr.

Obter um seloPerfil do usuário

ID da Operação:: UserGetProfile

Obtenha um único perfil BadgeUser. Use o entityId 'self' para recuperar o perfil do usuário autenticado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Results	result	array of object	A matriz de resultados.
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Nome Próprio	result.firstName	string	O primeiro nome.
Apelido	result.lastName	string	O sobrenome.
E-mails	result.emails	array of object
Tipo de Entidade	result.emails.entityType	string	O tipo da entidade.
ID da entidade	result.emails.entityId	string	O identificador da entidade.
Email	result.emails.email	string	O endereço de e-mail.
Verificada	result.emails.verified	boolean	Se verificado.
Primary	result.emails.primary	boolean	Seja primária.
Variantes de caso	result.emails.caseVariants	string	As variantes de caso.
URL	result.url	string	O endereço URL.
Telefone	result.telephone	string	O número de telefone.
Versão dos Termos Acordados	result.agreedTermsVersion	string	A versão dos termos acordados.
Concordou com a versão mais recente dos termos	result.hasAgreedToLatestTermsVersion	string	A versão dos termos posteriores aggree.
Marketing Opt In	result.marketingOptIn	string	Concordou com o opt-in de marketing.
Domínio Badgr	result.badgrDomain	string	O domínio de Badgr.
Tem senha definida	result.hasPasswordSet	string	Se tiver senha definida.
Recipient	result.recipient	string	O destinatário.

Recuperar tokens de emissor

ID da Operação:: TokenRetrieve

Recupere tokens de emissor.

Parâmetros

Name	Chave	Necessário	Tipo	Description
body	body	True

Devoluções

response: AccessToken

Recuperar uma conta

ID da Operação:: AccountRecover

Recupere uma conta e defina uma nova senha.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Símbolo	token		string	O token recebido no e-mail de recuperação.
Palavra-passe	password		string	A nova senha a ser usada.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result

Remover uma asserção da mochila

ID da Operação:: BackpackRemoteAssertion

Remova uma afirmação da mochila de um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Revogar um AccessToken

ID da Operação:: TokenRevoke

Revogar o AccessToken de um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Revogar uma asserção

ID da Operação:: AssertionRevoke

Revogar uma afirmação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade
Motivo da revogação	revocation_reason		string	A razão para revogar esta afirmação

Revogar várias asserções

ID da Operação:: AssertionRevokeBulk

Revogar várias asserções para vários destinatários.

Parâmetros

Name	Chave	Tipo	Description
BadgeClass	badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores. .
ID do selo aberto do emissor	issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Identidade	identity	string	A identidade.
Arrasado	hashed	boolean	Se hashed.
Tipo	type	string	O tipo.
Identidade de texto simples	plaintextIdentity	string	A identidade em texto simples.
Salt	salt	string	Se estiver em hash, o sal.
Emitido em	issuedOn	string	Quando emitido em.
Narrativa	narrative	string	A narrativa para o distintivo emitido.
URL	url	string	O endereço URL.
Narrativa	narrative	string	A narrativa para o distintivo emitido.
Expira	expires	string	Quando expira.
Extensions	extensions	string	As extensões.
Nome BadgeClass	badgeclassName	string	O nome do BadgeClass.

Devoluções

Name	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Sucesso	status.success	boolean	Se um sucesso.
Resultado	result	array of object
Tipo de Entidade	result.entityType	string	O tipo de entidade.
ID da entidade	result.entityId	string	O identificador da entidade.
Abrir ID de Emblema	result.openBadgeId	string	O identificador do Open Badge.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Quem criou por.
BadgeClass	result.badgeclass	string	A definição de um distintivo ganho.
ID do selo aberto BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Open Badge do BadgeClass.
Issuer	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite para os ganhadores.
ID do selo aberto do emissor	result.issuerOpenBadgeId	string	O identificador do Open Badge do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Arrasado	result.recipient.hashed	boolean	Se hashed.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto simples	result.recipient.plaintextIdentity	string	A identidade em texto simples.
Salt	result.recipient.salt	string	Se estiver em hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido em.
Narrativa	result.narrative	string	A narrativa para o distintivo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço URL.
Narrativa	result.evidence.narrative	string	A narrativa para o distintivo emitido.
Revogado	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o crachá foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Solicitar um e-mail de recuperação de conta

ID da Operação:: AccountRequestRecovery

Solicite um e-mail de recuperação de conta para um usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Email	email		string	O endereço de e-mail no arquivo para o qual enviar o e-mail de recuperação.

Definições

AccessToken

Partilhar via

Badgr (Editora Independente)

Limites de Limitação

Ações

Aceitação de asserção de atualização na mochila

Parâmetros

Devoluções

Atualizar um BadgeClass

Parâmetros

Devoluções

Atualizar um BadgeUser

Parâmetros

Devoluções

Atualizar um emissor

Parâmetros

Devoluções

Atualizar uma asserção

Parâmetros

Devoluções

Atualizar uma coleção

Parâmetros

Devoluções

Carregue uma declaração na mochila

Parâmetros

Devoluções

Criar um BadgeClass

Parâmetros

Devoluções

Criar um BadgeClass do emissor

Parâmetros

Devoluções

Criar um emissor

Parâmetros

Devoluções

Criar uma coleção

Parâmetros

Devoluções

Criar uma conta BadgeUser

Parâmetros

Devoluções

Emitir uma asserção

Parâmetros

Devoluções

Emitir uma asserção

Parâmetros

Devoluções

Emitir vários BadgeClass

Parâmetros

Devoluções

Excluir um BadgeClass

Parâmetros

Excluir um emissor

Parâmetros

Excluir uma coleção

Parâmetros

Importar uma declaração para mochila

Parâmetros

Obtenha uma coleção

Parâmetros

Devoluções

Obtenha uma única asserção

Parâmetros

Devoluções

Obter asserções

Parâmetros

Devoluções

Obter asserções de BadgeClass

Parâmetros

Devoluções

Obter asserções na mochila de um usuário

Devoluções

Obter BadgeClasses do Emissor

Parâmetros

Devoluções

Obter BadgeClasses do usuário

Devoluções

Obter coleções

Devoluções

Obter detalhes da Declaração de Mochila

Parâmetros