Badgr (Editor Independente)

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

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

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Publicador	Troy Taylor, Hitachi Solutions
Site	https://badgr.com
Política de privacidade	https://info.badgr.com/privacy-policy.html
Categorias	Recursos Humanos

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualizar a aceitação da declaração na mochila	Atualize a aceitação de uma Declaração na Mochila de um usuário.
Atualizar um BadgeClass	Atualize um BadgeClass existente. As BadgeInstances emitidas anteriormente não serão atualizadas.
Atualizar um BadgeUser	Atualize a conta de um BadgeUser. Use a entityId 'self' para atualizar o perfil do usuário autenticado
Atualizar um emissor	Atualize um único Emissor.
Atualizar uma coleção	Atualize uma coleção em uma mochila.
Atualizar uma declaração	Atualizar uma declaração.
Carregar uma declaração para a mochila	Carregue uma nova Declaração na mochila de um usuário.
Criar o BadgeClass de um emissor	Crie um novo BadgeClass associado a um Emissor. O usuário autenticado deve ter o status de proprietário, editor ou equipe no Emissor.
Criar um BadgeClass	Crie um novo BadgeClass.
Criar um emissor	Crie um emissor.
Criar uma coleção	Crie uma nova Coleção.
Criar uma conta do BadgeUser	Crie uma conta e um perfil do BadgeUser.
Emitir uma declaração	Emita uma nova Declaração para um destinatário.
Emitir uma declaração	Emita uma declaração para um único destinatário.
Emitir vários BadgeClass	Emita várias cópias do mesmo BadgeClass para vários destinatários.
Excluir um BadgeClass	Excluir 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	Exclua uma coleção de uma mochila.
Importar uma declaração para mochila	Importe uma nova Declaração para a mochila de um usuário.
Obter BadgeClasses do Emissor	Obtenha uma lista de BadgeClasses para um único Emissor. O usuário autenticado deve ter o 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 declarações	Obtenha uma lista de Declarações para um único Emissor.
Obter declarações de BadgeClass	Obtenha uma lista de Declarações para um único BadgeClass.
Obter declarações na mochila de um usuário	Obtenha uma lista de Declarações na mochila do usuário autenticado.
Obter detalhes da declaração de mochila	Obtenha detalhes sobre uma Declaração na Mochila de um usuário.
Obter emissores	Obtenha uma lista de Emissores para usuário autenticado.
Obter o perfil de um BadgeUser	Obtenha um único perfil do BadgeUser. Use a entityId 'self' para recuperar o perfil do usuário autenticado.
Obter tokens de acesso do usuário	Obtenha uma lista de tokens de acesso para o 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 uma coleção	Obtenha uma única coleção.
Obter uma única asserção	Obter uma declaração
Recuperar tokens do emissor	Recuperar tokens do emissor.
Recuperar uma conta	Recupere uma conta e defina uma nova senha.
Remover uma asserção da mochila	Remova uma declaração da mochila de um usuário.
Revogar um AccessToken	Revogar o AccessToken de um usuário.
Revogar uma declaração	Revogar uma declaração.
Revogar várias declarações	Revogar várias Declarações para vários destinatários.
Solicitar um email de recuperação de conta	Solicite um email de recuperação de conta para um usuário.

Atualizar a aceitação da declaração na mochila

ID da operação:: BackpackUpdateAcceptance

Atualize a aceitação de uma Declaração na Mochila de um usuário.

Parâmetros

Nome	Chave	Obrigató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 selo que pode ser ganho.
Emissor	issuer		string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados. .
ID do Selo Aberto do Emissor	issuerOpenBadgeId		string	O identificador do Selo Aberto do emissor.
Identidade	identity		string	A identidade.
Tipo	type		string	O tipo.
Hash	hashed		boolean	Se hash.
Identidade de texto sem formatação	plaintextIdentity		string	A identidade em texto não criptografado.
Emitido em	issuedOn		string	Quando emitido.
Narrativa	narrative		string	A narrativa do selo emitido.
URL	url		string	O endereço da URL.
Narrativa	narrative		string	A narrativa do selo emitido.
Expira	expires		string	Quando expirar.
Pendente	pending		string	Pendente.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 selo foi aceito.
Abrir ID do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Tipo	result.recipient.type	string	O tipo.
Hash	result.recipient.hashed	boolean	Se hash.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	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. As BadgeInstances emitidas anteriormente não serão atualizadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
Emissor	issuer		string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados. .
ID do Selo Aberto do Emissor	issuerOpenBadgeId		string	O identificador do Selo Aberto 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 de critérios	criteriaUrl		string	A URL dos critérios.
Narrativa de critérios	criteriaNarrative		string	A narrativa dos critérios.
Nome de destino	targetName		string	O nome do destino.
URL de Destino	targetUrl		string	A URL do destino.
Descrição de destino	targetDescription		string	A descrição do destino.
Estrutura de Destino	targetFramework		string	A estrutura do destino.
Código de destino	targetCode		string	O código do destino.
Etiquetas	tags		array of string
Quantidade	amount		string	O valor.
Duração	duration		string	A duração.
Extensions	extensions		string	As extensões.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto 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 de critérios	result.criteriaUrl	string	O endereço de URL dos critérios.
Narrativa de critérios	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome de destino	result.alignments.targetName	string	O nome do destino.
URL de Destino	result.alignments.targetUrl	string	O endereço de URL do destino.
Descrição de destino	result.alignments.targetDescription	string	A descrição do destino.
Estrutura de Destino	result.alignments.targetFramework	string	A estrutura do destino.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Quantidade	result.expires.amount	string	O valor.
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 a entityId 'self' para atualizar o perfil do usuário autenticado

Parâmetros

Nome	Chave	Obrigató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.
Primeiro Nome	firstName		string	O 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 email.
Verificado(a)	verified		boolean	Se verificado.
Primária	primary		boolean	Se primário.
Variantes de maiúsculas e minúsculas	caseVariants		string	As variantes de maiúsculas e minúsculas.
URL	url		string	O endereço da 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 dos termos mais recentes	hasAgreedToLatestTermsVersion		string	A versão dos termos mais recentes acordada.
Aceitação de marketing	marketingOptIn		string	Optou pelo marketing.
Domínio do Badgr	badgrDomain		string	O domínio do Badgr.
Tem Conjunto de Senhas	hasPasswordSet		string	Tem a senha definida.
Recipient	recipient		string	O destinatário.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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.
Primeiro Nome	result.firstName	string	O nome.
Apelido	result.lastName	string	O sobrenome.
Emails	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 email.
Verificado(a)	result.emails.verified	boolean	Se verificado.
Primária	result.emails.primary	boolean	Se primário.
Variantes de maiúsculas e minúsculas	result.emails.caseVariants	string	As variantes de maiúsculas e minúsculas.
URL	result.url	string	O endereço da URL.
Telefone	result.telephone	string	O número de telefone.
Versão dos termos acordados	result.agreedTermsVersion	string	A versão dos termos se aggre.
Concordou com a versão dos termos mais recentes	result.hasAgreedToLatestTermsVersion	string	A versão do agregador de termos mais recentes.
Aceitação de marketing	result.marketingOptIn	string	Concordou com a aceitação de marketing.
Domínio do Badgr	result.badgrDomain	string	O domínio do Badgr.
Tem Conjunto de Senhas	result.hasPasswordSet	string	Se tiver a senha definida.
Recipient	result.recipient	string	O destinatário.

Atualizar um emissor

ID da operação:: IssuerUpdate

Atualize um único Emissor.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
Criado por	createdBy		string	Por quem foi criado.
Nome	name		string	O nome.
Imagem	image		string	A imagem.
Email	email		string	O endereço de email.
Description	description		string	A descrição.
URL	url		string	O endereço da URL.
Tipo de entidade	entityType		string	O tipo de entidade.
ID da entidade	entityId		string	O identificador da entidade.
Perfil do Usuário	userProfile		string	O perfil do usuário.
Utilizador	user		string	O usuário.
Função	role		string	A função.
Extensions	extensions		string	As extensões.
Domínio do Badgr	badgrDomain		string	O domínio do Badgr.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Email	result.email	string	O endereço de email.
Description	result.description	string	A descrição.
URL	result.url	string	O endereço da URL.
Equipe	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 do Usuário	result.staff.userProfile	string	O perfil do usuário.
Utilizador	result.staff.user	string	O usuário.
Função	result.staff.role	string	A função.
Extensions	result.extensions	string	As extensões.
Domínio do Badgr	result.badgrDomain	string	O domínio do Badgr.

Atualizar uma coleção

ID da operação:: CollectionUpdate

Atualize uma coleção em uma mochila.

Parâmetros

Nome	Chave	Obrigató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.
URL de compartilhamento	share_url		string	O endereço de URL do compartilhamento.
Compartilhar Hash	shareHash		string	O hash do compartilhamento.
Publicado	published		boolean	Se publicado.
BadgeClass	badgeclass		string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	badgeclassOpenBadgeId		string	O identificador do Selo Aberto do BadgeClass.
Emissor	issuer		string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	issuerOpenBadgeId		string	O identificador do Selo Aberto do emissor.
Identidade	identity		string	A identidade.
Hash	hashed		boolean	Se hash.
Tipo	type		string	O tipo.
Identidade de texto sem formatação	plaintextIdentity		string	A identidade em texto não criptografado.
Salt	salt		string	Se hash, o sal.
Emitido em	issuedOn		string	Quando emitido.
Narrativa	narrative		string	A narrativa do selo emitido.
URL	url		string	O endereço da URL.
Narrativa	narrative		string	A narrativa do selo emitido.
Expira	expires		string	Quando o selo expirar.
Extensions	extensions		string	As extensões.
Nome de BadgeClass	badgeclassName		string	O nome do BadgeClass.
Criado em	createdAt		string	Criado em.
Criado por	createdBy		string	Por quem foi criado.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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.
URL de compartilhamento	result.share_url	string	O endereço de 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 do Selo	result.assertions.openBadgeId	string	O identificador do Selo Aberto.
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 de Selo Aberto do BadgeClass	result.assertions.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.assertions.issuer	string	O emissor.
ID do Selo Aberto do Emissor	result.assertions.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.assertions.image	string	A imagem.
Identidade	result.assertions.recipient.identity	string	A identidade.
Hash	result.assertions.recipient.hashed	boolean	Se hash.
Tipo	result.assertions.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.assertions.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.assertions.recipient.salt	string	Se hash, o sal.
Emitido em	result.assertions.issuedOn	string	Quando emitido.
Narrativa	result.assertions.narrative	string	A narrativa do selo emitido.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	O endereço da URL.
Narrativa	result.assertions.evidence.narrative	string	A narrativa.
Revogada	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 expirar.
Extensions	result.assertions.extensions	string	As extensões.
Nome de BadgeClass	result.assertions.badgeclassName	string	O nome do BadgeClass.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.

Atualizar uma declaração

ID da operação:: AssertionUpdate

Atualizar uma declaração.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
BadgeClass	badgeclass		string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	badgeclassOpenBadgeId		string	O identificador do Selo Aberto do BadgeClass.
Emissor	issuer		string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados. .
ID do Selo Aberto do Emissor	issuerOpenBadgeId		string	O identificador do Selo Aberto do emissor.
Identidade	identity		string	A identidade.
Hash	hashed		boolean	Se hash.
Tipo	type		string	O tipo.
Identidade de texto sem formatação	plaintextIdentity		string	A identidade em texto não criptografado.
Salt	salt		string	Se hash, o sal.
Emitido em	issuedOn		string	Quando emitido.
Narrativa	narrative		string	A narrativa do selo emitido.
URL	url		string	O endereço da URL.
Narrativa	narrative		string	A narrativa do selo emitido.
Expira	expires		string	Quando expirar.
Extensions	extensions		string	As extensões.
Nome de BadgeClass	badgeclassName		string	O nome do BadgeClass.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Hash	result.recipient.hashed	boolean	Se hash.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.recipient.salt	string	Se hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o selo foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome de BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Carregar uma declaração para a mochila

ID da operação:: BackpackUploadAssertion

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

Parâmetros

Nome	Chave	Tipo	Description
BadgeClass	badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados. .
ID do Selo Aberto do Emissor	issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Identidade	identity	string	A identidade.
Hash	hashed	boolean	Se hash.
Tipo	type	string	O tipo.
Identidade de texto sem formatação	plaintextIdentity	string	A identidade em texto não criptografado.
Salt	salt	string	Se hash, o sal.
Emitido em	issuedOn	string	Quando emitido.
Narrativa	narrative	string	A narrativa do selo emitido.
URL	url	string	O endereço da URL.
Narrativa	narrative	string	A narrativa do selo emitido.
Expira	expires	string	Quando expirar.
Extensions	extensions	string	As extensões.
Nome de BadgeClass	badgeclassName	string	O nome do BadgeClass.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Hash	result.recipient.hashed	boolean	Se hash.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.recipient.salt	string	Se hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o selo foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome de BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Criar o BadgeClass de um emissor

ID da operação:: ClassCreateIssuer

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
Emissor	issuer		string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados. .
ID do Selo Aberto do Emissor	issuerOpenBadgeId		string	O identificador do Selo Aberto 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 de critérios	criteriaUrl		string	A URL dos critérios.
Narrativa de critérios	criteriaNarrative		string	A narrativa dos critérios.
Nome de destino	targetName		string	O nome do destino.
URL de Destino	targetUrl		string	A URL do destino.
Descrição de destino	targetDescription		string	A descrição do destino.
Estrutura de Destino	targetFramework		string	A estrutura do destino.
Código de destino	targetCode		string	O código do destino.
Etiquetas	tags		array of string
Quantidade	amount		string	O valor.
Duração	duration		string	A duração.
Extensions	extensions		string	As extensões.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto 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 de critérios	result.criteriaUrl	string	O endereço de URL dos critérios.
Narrativa de critérios	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome de destino	result.alignments.targetName	string	O nome do destino.
URL de Destino	result.alignments.targetUrl	string	O endereço de URL do destino.
Descrição de destino	result.alignments.targetDescription	string	A descrição do destino.
Estrutura de Destino	result.alignments.targetFramework	string	A estrutura do destino.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Quantidade	result.expires.amount	string	O valor.
Duração	result.expires.duration	string	A duração.
Extensions	result.extensions	string	As extensões.

Criar um BadgeClass

ID da operação:: ClassCreate

Crie um novo BadgeClass.

Parâmetros

Nome	Chave	Tipo	Description
Número	num	integer	Solicitar paginação de resultados
Emissor	issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados. .
ID do Selo Aberto do Emissor	issuerOpenBadgeId	string	O identificador do Selo Aberto 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 de critérios	criteriaUrl	string	A URL dos critérios.
Narrativa de critérios	criteriaNarrative	string	A narrativa dos critérios.
Nome de destino	targetName	string	O nome do destino.
URL de Destino	targetUrl	string	A URL do destino.
Descrição de destino	targetDescription	string	A descrição do destino.
Estrutura de Destino	targetFramework	string	A estrutura do destino.
Código de destino	targetCode	string	O código do destino.
Etiquetas	tags	array of string
Quantidade	amount	string	O valor.
Duração	duration	string	A duração.
Extensions	extensions	string	As extensões.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto 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 de critérios	result.criteriaUrl	string	O endereço de URL dos critérios.
Narrativa de critérios	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome de destino	result.alignments.targetName	string	O nome do destino.
URL de Destino	result.alignments.targetUrl	string	O endereço de URL do destino.
Descrição de destino	result.alignments.targetDescription	string	A descrição do destino.
Estrutura de Destino	result.alignments.targetFramework	string	A estrutura do destino.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Quantidade	result.expires.amount	string	O valor.
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 emissor.

Parâmetros

Nome	Chave	Tipo	Description
Criado por	createdBy	string	Por quem foi criado.
Nome	name	string	O nome.
Imagem	image	string	A imagem.
Email	email	string	O endereço de email.
Description	description	string	A descrição.
URL	url	string	O endereço da URL.
Tipo de entidade	entityType	string	O tipo de entidade.
ID da entidade	entityId	string	O identificador da entidade.
Perfil do Usuário	userProfile	string	O perfil do usuário.
Utilizador	user	string	O usuário.
Função	role	string	A função.
Extensions	extensions	string	As extensões.
Domínio do Badgr	badgrDomain	string	O domínio do Badgr.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Email	result.email	string	O endereço de email.
Description	result.description	string	A descrição.
URL	result.url	string	O endereço da URL.
Equipe	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 do Usuário	result.staff.userProfile	string	O perfil do usuário.
Utilizador	result.staff.user	string	O usuário.
Função	result.staff.role	string	A função.
Extensions	result.extensions	string	As extensões.
Domínio do Badgr	result.badgrDomain	string	O domínio do Badgr.

Criar uma coleção

ID da operação:: CollectionCreate

Crie uma nova Coleção.

Parâmetros

Nome	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.
URL de compartilhamento	share_url	string	O endereço de URL do compartilhamento.
Compartilhar Hash	shareHash	string	O hash do compartilhamento.
Publicado	published	boolean	Se publicado.
BadgeClass	badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Identidade	identity	string	A identidade.
Hash	hashed	boolean	Se hash.
Tipo	type	string	O tipo.
Identidade de texto sem formatação	plaintextIdentity	string	A identidade em texto não criptografado.
Salt	salt	string	Se hash, o sal.
Emitido em	issuedOn	string	Quando emitido.
Narrativa	narrative	string	A narrativa do selo emitido.
URL	url	string	O endereço da URL.
Narrativa	narrative	string	A narrativa do selo emitido.
Expira	expires	string	Quando o selo expirar.
Extensions	extensions	string	As extensões.
Nome de BadgeClass	badgeclassName	string	O nome do BadgeClass.
Criado em	createdAt	string	Criado em.
Criado por	createdBy	string	Por quem foi criado.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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.
URL de compartilhamento	result.share_url	string	O endereço de 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 do Selo	result.assertions.openBadgeId	string	O identificador do Selo Aberto.
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 de Selo Aberto do BadgeClass	result.assertions.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.assertions.issuer	string	O emissor.
ID do Selo Aberto do Emissor	result.assertions.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.assertions.image	string	A imagem.
Identidade	result.assertions.recipient.identity	string	A identidade.
Hash	result.assertions.recipient.hashed	boolean	Se hash.
Tipo	result.assertions.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.assertions.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.assertions.recipient.salt	string	Se hash, o sal.
Emitido em	result.assertions.issuedOn	string	Quando emitido.
Narrativa	result.assertions.narrative	string	A narrativa do selo emitido.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	O endereço da URL.
Narrativa	result.assertions.evidence.narrative	string	A narrativa.
Revogada	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 expirar.
Extensions	result.assertions.extensions	string	As extensões.
Nome de BadgeClass	result.assertions.badgeclassName	string	O nome do BadgeClass.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.

Criar uma conta do BadgeUser

ID da operação:: UserCreate

Crie uma conta e um perfil do BadgeUser.

Parâmetros

Nome	Chave	Obrigató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.
Primeiro Nome	firstName		string	O 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 email.
Verificado(a)	verified		boolean	Se verificado.
Primária	primary		boolean	Se primário.
Variantes de maiúsculas e minúsculas	caseVariants		string	As variantes de maiúsculas e minúsculas.
URL	url		string	O endereço da 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 dos termos mais recentes	hasAgreedToLatestTermsVersion		string	A versão dos termos mais recentes acordada.
Aceitação de marketing	marketingOptIn		string	Optou pelo marketing.
Domínio do Badgr	badgrDomain		string	O domínio do Badgr.
Tem Conjunto de Senhas	hasPasswordSet		string	Tem a senha definida.
Recipient	recipient		string	O destinatário.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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.
Primeiro Nome	result.firstName	string	O nome.
Apelido	result.lastName	string	O sobrenome.
Emails	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 email.
Verificado(a)	result.emails.verified	boolean	Se verificado.
Primária	result.emails.primary	boolean	Se primário.
Variantes de maiúsculas e minúsculas	result.emails.caseVariants	string	As variantes de maiúsculas e minúsculas.
URL	result.url	string	O endereço da URL.
Telefone	result.telephone	string	O número de telefone.
Versão dos termos acordados	result.agreedTermsVersion	string	A versão dos termos se aggre.
Concordou com a versão dos termos mais recentes	result.hasAgreedToLatestTermsVersion	string	A versão do agregador de termos mais recentes.
Aceitação de marketing	result.marketingOptIn	string	Concordou com a aceitação de marketing.
Domínio do Badgr	result.badgrDomain	string	O domínio do Badgr.
Tem Conjunto de Senhas	result.hasPasswordSet	string	Se tiver a senha definida.
Recipient	result.recipient	string	O destinatário.

Emitir uma declaração

ID da operação:: AssertionIssue

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
BadgeClass	badgeclass		string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	badgeclassOpenBadgeId		string	O identificador do Selo Aberto do BadgeClass.
Emissor	issuer		string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados. .
ID do Selo Aberto do Emissor	issuerOpenBadgeId		string	O identificador do Selo Aberto do emissor.
Identidade	identity		string	A identidade.
Hash	hashed		boolean	Se hash.
Tipo	type		string	O tipo.
Identidade de texto sem formatação	plaintextIdentity		string	A identidade em texto não criptografado.
Salt	salt		string	Se hash, o sal.
Emitido em	issuedOn		string	Quando emitido.
Narrativa	narrative		string	A narrativa do selo emitido.
URL	url		string	O endereço da URL.
Narrativa	narrative		string	A narrativa do selo emitido.
Expira	expires		string	Quando expirar.
Extensions	extensions		string	As extensões.
Nome de BadgeClass	badgeclassName		string	O nome do BadgeClass.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Hash	result.recipient.hashed	boolean	Se hash.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.recipient.salt	string	Se hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o selo foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome de BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Emitir uma declaração

ID da operação:: ClassIssueAssertion

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
BadgeClass	badgeclass		string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	badgeclassOpenBadgeId		string	O identificador do Selo Aberto do BadgeClass.
Emissor	issuer		string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados. .
ID do Selo Aberto do Emissor	issuerOpenBadgeId		string	O identificador do Selo Aberto do emissor.
Identidade	identity		string	A identidade.
Hash	hashed		boolean	Se hash.
Tipo	type		string	O tipo.
Identidade de texto sem formatação	plaintextIdentity		string	A identidade em texto não criptografado.
Salt	salt		string	Se hash, o sal.
Emitido em	issuedOn		string	Quando emitido.
Narrativa	narrative		string	A narrativa do selo emitido.
URL	url		string	O endereço da URL.
Narrativa	narrative		string	A narrativa do selo emitido.
Expira	expires		string	Quando expirar.
Extensions	extensions		string	As extensões.
Nome de BadgeClass	badgeclassName		string	O nome do BadgeClass.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Hash	result.recipient.hashed	boolean	Se hash.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.recipient.salt	string	Se hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o selo foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome de BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Emitir vários BadgeClass

ID da operação:: ClassIssueBulk

Emita várias cópias do mesmo BadgeClass para vários destinatários.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade.
BadgeClass	badgeclass		string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	badgeclassOpenBadgeId		string	O identificador do Selo Aberto do BadgeClass.
Emissor	issuer		string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados. .
ID do Selo Aberto do Emissor	issuerOpenBadgeId		string	O identificador do Selo Aberto do emissor.
Identidade	identity		string	A identidade.
Hash	hashed		boolean	Se hash.
Tipo	type		string	O tipo.
Identidade de texto sem formatação	plaintextIdentity		string	A identidade em texto não criptografado.
Salt	salt		string	Se hash, o sal.
Emitido em	issuedOn		string	Quando emitido.
Narrativa	narrative		string	A narrativa do selo emitido.
URL	url		string	O endereço da URL.
Narrativa	narrative		string	A narrativa do selo emitido.
Expira	expires		string	Quando expirar.
Extensions	extensions		string	As extensões.
Nome de BadgeClass	badgeclassName		string	O nome do BadgeClass.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Hash	result.recipient.hashed	boolean	Se hash.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.recipient.salt	string	Se hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o selo foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome de BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Excluir um BadgeClass

ID da operação:: ClassDelete

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

Parâmetros

Nome	Chave	Obrigató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

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Excluir uma coleção

ID da operação:: CollectionDelete

Exclua uma coleção de uma mochila.

Parâmetros

Nome	Chave	Obrigató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

Nome	Chave	Tipo	Description
URL	url	string	URL para um selo compatível com OpenBadge.
Imagem	image	string	Imagem openbadge assada codificada em Base64.
Asserção	assertion	object	JSON compatível com OpenBadge.

Obter BadgeClasses do Emissor

ID da operação:: ClassGetIssuer

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade
Número	num		string	Solicitar paginação de resultados

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto 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 de critérios	result.criteriaUrl	string	O endereço de URL dos critérios.
Narrativa de critérios	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome de destino	result.alignments.targetName	string	O nome do destino.
URL de Destino	result.alignments.targetUrl	string	O endereço de URL do destino.
Descrição de destino	result.alignments.targetDescription	string	A descrição do destino.
Estrutura de Destino	result.alignments.targetFramework	string	A estrutura do destino.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Quantidade	result.expires.amount	string	O valor.
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.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto 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 de critérios	result.criteriaUrl	string	O endereço de URL dos critérios.
Narrativa de critérios	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome de destino	result.alignments.targetName	string	O nome do destino.
URL de Destino	result.alignments.targetUrl	string	O endereço de URL do destino.
Descrição de destino	result.alignments.targetDescription	string	A descrição do destino.
Estrutura de Destino	result.alignments.targetFramework	string	A estrutura do destino.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Quantidade	result.expires.amount	string	O valor.
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.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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.
URL de compartilhamento	result.share_url	string	O endereço de 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 do Selo	result.assertions.openBadgeId	string	O identificador do Selo Aberto.
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 de Selo Aberto do BadgeClass	result.assertions.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.assertions.issuer	string	O emissor.
ID do Selo Aberto do Emissor	result.assertions.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.assertions.image	string	A imagem.
Identidade	result.assertions.recipient.identity	string	A identidade.
Hash	result.assertions.recipient.hashed	boolean	Se hash.
Tipo	result.assertions.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.assertions.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.assertions.recipient.salt	string	Se hash, o sal.
Emitido em	result.assertions.issuedOn	string	Quando emitido.
Narrativa	result.assertions.narrative	string	A narrativa do selo emitido.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	O endereço da URL.
Narrativa	result.assertions.evidence.narrative	string	A narrativa.
Revogada	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 expirar.
Extensions	result.assertions.extensions	string	As extensões.
Nome de BadgeClass	result.assertions.badgeclassName	string	O nome do BadgeClass.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.

Obter declarações

ID da operação:: AssertionGet

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade
Recipient	recipient		string	Um identificador de destinatário a ser filtrado por
Número	num		string	Solicitar paginação de resultados
Incluir Expirado	include_expired		boolean	Incluir asserções expiradas
Incluir Revogado	include_revoked		boolean	Incluir asserções revogadas

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Hash	result.recipient.hashed	boolean	Se hash.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.recipient.salt	string	Se hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o selo foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome de BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Obter declarações de BadgeClass

ID da operação:: ClassGetAssertion

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade
Recipient	recipient		string	Um identificador de destinatário a ser filtrado por
Número	num		string	Solicitar paginação de resultados
Incluir Expirado	include_expired		boolean	Incluir asserções expiradas
Incluir Revogado	include_revoked		boolean	Incluir asserções revogadas

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Hash	result.recipient.hashed	boolean	Se hash.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.recipient.salt	string	Se hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o selo foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome de BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

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

ID da operação:: BackpackGetAssertion

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

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Hash	result.recipient.hashed	boolean	Se hash.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.recipient.salt	string	Se hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o selo foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome de BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Obter detalhes da declaração de mochila

ID da operação:: BackpackGetAssertionDetails

Obtenha detalhes sobre uma Declaração na Mochila de um usuário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 selo foi aceito.
Abrir ID do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Tipo	result.recipient.type	string	O tipo.
Hash	result.recipient.hashed	boolean	Se hash.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	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.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Email	result.email	string	O endereço de email.
Description	result.description	string	A descrição.
URL	result.url	string	O endereço da URL.
Equipe	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.
Primeiro Nome	result.staff.userProfile.firstName	string	O nome.
Apelido	result.staff.userProfile.lastName	string	O sobrenome.
Emails	result.staff.userProfile.emails	array of object
Email	result.staff.userProfile.emails.email	string	O endereço de email.
Verificado(a)	result.staff.userProfile.emails.verified	boolean	Se verificado.
Primária	result.staff.userProfile.emails.primary	boolean	Se primário.
Variantes de maiúsculas e minúsculas	result.staff.userProfile.emails.caseVariants	array of string	As variantes de maiúsculas e minúsculas.
URLs	result.staff.userProfile.url	array of string	Os endereços de URL.
Números de telefone	result.staff.userProfile.telephone	array of string	Os números de telefone.
Domínio do Badgr	result.staff.userProfile.badgrDomain	string	O domínio Badgr.
Utilizador	result.staff.user	string	O usuário.
Função	result.staff.role	string	A função.
Extensions	result.extensions	string	As extensões.
Domínio do Badgr	result.badgrDomain	string	O domínio do Badgr.

Obter o perfil de um BadgeUser

ID da operação:: UserGetProfile

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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.
Primeiro Nome	result.firstName	string	O nome.
Apelido	result.lastName	string	O sobrenome.
Emails	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 email.
Verificado(a)	result.emails.verified	boolean	Se verificado.
Primária	result.emails.primary	boolean	Se primário.
Variantes de maiúsculas e minúsculas	result.emails.caseVariants	string	As variantes de maiúsculas e minúsculas.
URL	result.url	string	O endereço da URL.
Telefone	result.telephone	string	O número de telefone.
Versão dos termos acordados	result.agreedTermsVersion	string	A versão dos termos se aggre.
Concordou com a versão dos termos mais recentes	result.hasAgreedToLatestTermsVersion	string	A versão do agregador de termos mais recentes.
Aceitação de marketing	result.marketingOptIn	string	Concordou com a aceitação de marketing.
Domínio do Badgr	result.badgrDomain	string	O domínio do Badgr.
Tem Conjunto de Senhas	result.hasPasswordSet	string	Se tiver a senha definida.
Recipient	result.recipient	string	O destinatário.

Obter tokens de acesso do usuário

ID da operação:: TokenGet

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

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	status.success	boolean	Se um sucesso.
resultado	result	AccessToken

Obter um BadgeClass

ID da operação:: ClassGet

Obtenha um único BadgeClass.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto 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 de critérios	result.criteriaUrl	string	O endereço de URL dos critérios.
Narrativa de critérios	result.criteriaNarrative	string	A narrativa dos critérios.
Alinhamentos	result.alignments	array of object
Nome de destino	result.alignments.targetName	string	O nome do destino.
URL de Destino	result.alignments.targetUrl	string	O endereço de URL do destino.
Descrição de destino	result.alignments.targetDescription	string	A descrição do destino.
Estrutura de Destino	result.alignments.targetFramework	string	A estrutura do destino.
Código de destino	result.alignments.targetCode	string	O código do destino.
Etiquetas	result.tags	array of string
Quantidade	result.expires.amount	string	O valor.
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

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
Nome	result.name	string	O nome.
Imagem	result.image	string	A imagem.
Email	result.email	string	O endereço de email.
Description	result.description	string	A descrição.
URL	result.url	string	O endereço da URL.
Equipe	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 do Usuário	result.staff.userProfile	string	O perfil do usuário.
Utilizador	result.staff.user	string	O usuário.
Função	result.staff.role	string	A função.
Extensions	result.extensions	string	As extensões.
Domínio do Badgr	result.badgrDomain	string	O domínio do Badgr.

Obter uma coleção

ID da operação:: CollectionGetA

Obtenha uma única coleção.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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.
URL de compartilhamento	result.share_url	string	O endereço de 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 do Selo	result.assertions.openBadgeId	string	O identificador do Selo Aberto.
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 de Selo Aberto do BadgeClass	result.assertions.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.assertions.issuer	string	O emissor.
ID do Selo Aberto do Emissor	result.assertions.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.assertions.image	string	A imagem.
Identidade	result.assertions.recipient.identity	string	A identidade.
Hash	result.assertions.recipient.hashed	boolean	Se hash.
Tipo	result.assertions.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.assertions.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.assertions.recipient.salt	string	Se hash, o sal.
Emitido em	result.assertions.issuedOn	string	Quando emitido.
Narrativa	result.assertions.narrative	string	A narrativa do selo emitido.
Evidence	result.assertions.evidence	array of object
URL	result.assertions.evidence.url	string	O endereço da URL.
Narrativa	result.assertions.evidence.narrative	string	A narrativa.
Revogada	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 expirar.
Extensions	result.assertions.extensions	string	As extensões.
Nome de BadgeClass	result.assertions.badgeclassName	string	O nome do BadgeClass.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.

Obter uma única asserção

ID da operação:: AssertionGetA

Obter uma declaração

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Hash	result.recipient.hashed	boolean	Se hash.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.recipient.salt	string	Se hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o selo foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome de BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Recuperar tokens do emissor

ID da operação:: TokenRetrieve

Recuperar tokens do emissor.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
body	body	True

Retornos

response: AccessToken

Recuperar uma conta

ID da operação:: AccountRecover

Recupere uma conta e defina uma nova senha.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token		string	O token recebido no email de recuperação.
Senha	password		string	A nova senha a ser usada.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	status.success	boolean	Se um sucesso.
resultado	result

Remover uma asserção da mochila

ID da operação:: BackpackRemoteAssertion

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

Parâmetros

Nome	Chave	Obrigató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

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade

Revogar uma declaração

ID da operação:: AssertionRevoke

Revogar uma declaração.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da entidade	entity_id	True	string	O identificador da entidade
Motivo da revogação	revocation_reason		string	O motivo para revogar essa asserção

Revogar várias declarações

ID da operação:: AssertionRevokeBulk

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

Parâmetros

Nome	Chave	Tipo	Description
BadgeClass	badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados. .
ID do Selo Aberto do Emissor	issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Identidade	identity	string	A identidade.
Hash	hashed	boolean	Se hash.
Tipo	type	string	O tipo.
Identidade de texto sem formatação	plaintextIdentity	string	A identidade em texto não criptografado.
Salt	salt	string	Se hash, o sal.
Emitido em	issuedOn	string	Quando emitido.
Narrativa	narrative	string	A narrativa do selo emitido.
URL	url	string	O endereço da URL.
Narrativa	narrative	string	A narrativa do selo emitido.
Expira	expires	string	Quando expirar.
Extensions	extensions	string	As extensões.
Nome de BadgeClass	badgeclassName	string	O nome do BadgeClass.

Retornos

Nome	Caminho	Tipo	Description
Description	status.description	string	A descrição.
Êxito	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 do Selo	result.openBadgeId	string	O identificador do Selo Aberto.
Criado em	result.createdAt	string	Quando criado em.
Criado por	result.createdBy	string	Por quem foi criado.
BadgeClass	result.badgeclass	string	A definição de um selo que pode ser ganho.
ID de Selo Aberto do BadgeClass	result.badgeclassOpenBadgeId	string	O identificador do Selo Aberto do BadgeClass.
Emissor	result.issuer	string	A pessoa ou organização que cria/oferece selos e os emite aos assalariados.
ID do Selo Aberto do Emissor	result.issuerOpenBadgeId	string	O identificador do Selo Aberto do emissor.
Imagem	result.image	string	A imagem.
Identidade	result.recipient.identity	string	A identidade.
Hash	result.recipient.hashed	boolean	Se hash.
Tipo	result.recipient.type	string	O tipo.
Identidade de texto sem formatação	result.recipient.plaintextIdentity	string	A identidade em texto não criptografado.
Salt	result.recipient.salt	string	Se hash, o sal.
Emitido em	result.issuedOn	string	Quando emitido.
Narrativa	result.narrative	string	A narrativa do selo emitido.
Evidence	result.evidence	array of object
URL	result.evidence.url	string	O endereço da URL.
Narrativa	result.evidence.narrative	string	A narrativa do selo emitido.
Revogada	result.revoked	boolean	Se revogado.
Motivo da revogação	result.revocationReason	string	O motivo da revogação.
Aceitação	result.acceptance	string	Quando o selo foi aceito.
Expira	result.expires	string	Quando o selo expirar.
Extensions	result.extensions	string	As extensões.
Nome de BadgeClass	result.badgeclassName	string	O nome do BadgeClass.

Solicitar um email de recuperação de conta

ID da operação:: AccountRequestRecovery

Solicite um email de recuperação de conta para um usuário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Email	email		string	O endereço de email no arquivo para o qual enviar o email de recuperação.

Definições

AccessToken

Compartilhar via

Badgr (Editor Independente)

Limitações

Ações

Atualizar a aceitação da declaração na mochila

Parâmetros

Retornos

Atualizar um BadgeClass

Parâmetros

Retornos

Atualizar um BadgeUser

Parâmetros

Retornos

Atualizar um emissor

Parâmetros

Retornos

Atualizar uma coleção

Parâmetros

Retornos

Atualizar uma declaração

Parâmetros

Retornos

Carregar uma declaração para a mochila

Parâmetros

Retornos

Criar o BadgeClass de um emissor

Parâmetros

Retornos

Criar um BadgeClass

Parâmetros

Retornos

Criar um emissor

Parâmetros

Retornos

Criar uma coleção

Parâmetros

Retornos

Criar uma conta do BadgeUser

Parâmetros

Retornos

Emitir uma declaração

Parâmetros

Retornos

Emitir uma declaração

Parâmetros

Retornos

Emitir vários BadgeClass

Parâmetros

Retornos

Excluir um BadgeClass

Parâmetros

Excluir um emissor

Parâmetros

Excluir uma coleção

Parâmetros

Importar uma declaração para mochila

Parâmetros

Obter BadgeClasses do Emissor

Parâmetros

Retornos

Obter BadgeClasses do usuário

Retornos

Obter coleções

Retornos

Obter declarações

Parâmetros

Retornos

Obter declarações de BadgeClass

Parâmetros

Retornos

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

Retornos

Obter detalhes da declaração de mochila

Parâmetros

Retornos

Obter emissores

Retornos

Obter o perfil de um BadgeUser

Parâmetros

Retornos