Badgr (независимый издатель)
Организации по всему миру используют Badgr для создания фирменных экосистем обучения, которые поддерживают свои общины с цифровыми учетными данными на основе навыков, стекаемых путей обучения и переносимых записей учащихся.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Трой Тейлор |
| URL | https://www.hitachisolutions.com |
| Адрес электронной почты | ttaylor@hitachisolutions.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Трой Тейлор, Решения Похасти |
| Веб-сайт | https://badgr.com |
| Политика конфиденциальности | https://info.badgr.com/privacy-policy.html |
| Категории | Кадровые ресурсы |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Восстановление учетной записи |
Восстановите учетную запись и задайте новый пароль. |
| Выдача утверждения |
Выдача нового утверждения получателю. |
| Выдача утверждения |
Выдача утверждения одному получателю. |
| Запрос электронной почты восстановления учетной записи |
Запрос электронной почты восстановления учетной записи для пользователя. |
| Импорт утверждения в рюкзак |
Импортируйте новое утверждение в рюкзак пользователя. |
|
Обновление badge |
Обновите учетную запись BadgeUser. Используйте идентификатор entityId "self" для обновления профиля прошедшего проверку подлинности пользователя |
| Обновление издателя |
Обновление одного издателя. |
| Обновление индикатора событий |
Обновите существующий класс badgeClass. Ранее выданные индикаторы эмблемы не будут обновлены. |
| Обновление коллекции |
Обновите коллекцию в рюкзаке. |
| Обновление принятия утверждения в Backpack |
Обновите утверждение утверждения в рюкпаке пользователя. |
| Обновление утверждения |
Обновление утверждения. |
|
Отзыв access |
Отмена доступа пользователя AccessToken. |
| Отзыв утверждения |
Отмена утверждения. |
| Отмена нескольких утверждений |
Отмена нескольких утверждений для нескольких получателей. |
| Отправка утверждения в рюкзак |
Отправьте новое утверждение в рюкзак пользователя. |
|
Получение Access |
Получение одного AccessToken. |
| Получение идентификаторов индикаторов событий пользователя |
Получите список BadgeClasses для прошедшего проверку подлинности пользователя. |
| Получение издателей |
Получите список издателей для прошедшего проверку подлинности пользователя. |
| Получение издателя |
Получение одного издателя. |
| Получение индикатора событий |
Получение одного объекта BadgeClass. |
|
Получение класса badge |
Получите список индикаторов событий для одного издателя. Пользователь, прошедший проверку подлинности, должен иметь состояние владельца, редактора или персонала в издателе. |
| Получение коллекции |
Получение одной коллекции. |
| Получение коллекций |
Получение списка коллекций. |
| Получение маркеров доступа пользователя |
Получите список маркеров доступа для прошедшего проверку подлинности пользователя. |
| Получение маркеров издателя |
Получение маркеров издателя. |
| Получение одного утверждения |
Получение утверждения |
|
Получение профиля Badge |
Получение одного профиля BadgeUser. Используйте идентификатор entityId "self", чтобы получить профиль пользователя, прошедшего проверку подлинности. |
| Получение сведений о утверждении backpack |
Получение сведений об утверждении в рюкпаке пользователя. |
| Получение утверждений |
Получите список утверждений для одного издателя. |
|
Получение утверждений Badge |
Получение списка утверждений для одного объекта BadgeClass. |
| Получение утверждений в рюкзаке пользователя |
Получите список утверждений в рюкзаке пользователя с проверкой подлинности. |
| Проблема с несколькими индикаторами событий |
Выдача нескольких копий одного класса BadgeClass нескольким получателям. |
| Создание издателя |
Создайте издателя. |
| Создание коллекции |
Создайте новую коллекцию. |
|
Создание объекта Badge |
Создайте новый класс BadgeClass. |
|
Создание объекта Badge |
Создайте новый класс badgeClass, связанный с издателем. Пользователь, прошедший проверку подлинности, должен иметь состояние владельца, редактора или персонала в издателе. |
|
Создание учетной записи Badge |
Создайте учетную запись и профиль BadgeUser. |
| Удаление издателя |
Удаление одного издателя. |
| Удаление коллекции |
Удаление коллекции из рюкзака. |
|
Удаление объекта Badge |
Удаление объекта BadgeClass. Ограничено владельцами или редакторами (а не сотрудниками) соответствующего издателя. |
| Удаление утверждения из рюкзака |
Удалите утверждение из рюкзака пользователя. |
Восстановление учетной записи
Восстановите учетную запись и задайте новый пароль.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Токен
|
token | string |
Маркер, полученный в сообщении электронной почты восстановления. |
|
|
Пароль
|
password | string |
Новый пароль для использования. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result |
Выдача утверждения
Выдача нового утверждения получателю.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
BadgeClass
|
badgeclass | string |
Определение заработать эмблемы. |
|
|
Идентификатор значка Open BadgeClass
|
badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. . |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Идентичность
|
identity | string |
Удостоверение. |
|
|
Хэшированные
|
hashed | boolean |
Есть ли хэшированные. |
|
|
Тип
|
type | string |
Тип. |
|
|
Удостоверение обычного текста
|
plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
|
Salt
|
salt | string |
Если хэширован, соль. |
|
|
Выдано
|
issuedOn | string |
При выпуске. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
Действительно до
|
expires | string |
Истекает срок действия. |
|
|
Extensions
|
extensions | string |
Расширения. |
|
|
Имя badgeClass
|
badgeclassName | string |
Имя объекта BadgeClass. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.badgeclassName | string |
Имя объекта BadgeClass. |
Выдача утверждения
Выдача утверждения одному получателю.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
BadgeClass
|
badgeclass | string |
Определение заработать эмблемы. |
|
|
Идентификатор значка Open BadgeClass
|
badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. . |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Идентичность
|
identity | string |
Удостоверение. |
|
|
Хэшированные
|
hashed | boolean |
Есть ли хэшированные. |
|
|
Тип
|
type | string |
Тип. |
|
|
Удостоверение обычного текста
|
plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
|
Salt
|
salt | string |
Если хэширован, соль. |
|
|
Выдано
|
issuedOn | string |
При выпуске. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
Действительно до
|
expires | string |
Истекает срок действия. |
|
|
Extensions
|
extensions | string |
Расширения. |
|
|
Имя badgeClass
|
badgeclassName | string |
Имя объекта BadgeClass. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.badgeclassName | string |
Имя объекта BadgeClass. |
Запрос электронной почты восстановления учетной записи
Запрос электронной почты восстановления учетной записи для пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Адрес электронной почты
|
string |
Адрес электронной почты файла для отправки сообщения электронной почты восстановления. |
Импорт утверждения в рюкзак
Импортируйте новое утверждение в рюкзак пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
URL
|
url | string |
URL-адрес индикатора соответствия OpenBadge. |
|
|
Изображение
|
image | string |
Образ OpenBadge в кодировке Base64. |
|
|
Утверждение
|
assertion | object |
Код JSON, совместимый с OpenBadge. |
Обновление badgeUser
Обновите учетную запись BadgeUser. Используйте идентификатор entityId "self" для обновления профиля прошедшего проверку подлинности пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
Тип сущности
|
entityType | string |
Тип сущности. |
|
|
Идентификатор организации
|
entityId | string |
Идентификатор сущности. |
|
|
Имя (Первое имя)
|
firstName | string |
Первое имя. |
|
|
Фамилия
|
lastName | string |
Фамилия. |
|
|
Тип сущности
|
entityType | string |
Тип сущности. |
|
|
Идентификатор организации
|
entityId | string |
Идентификатор сущности. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты. |
||
|
Проверено
|
verified | boolean |
Проверяется ли проверка. |
|
|
Primary
|
primary | boolean |
Указывает, является ли первичный. |
|
|
Варианты регистра
|
caseVariants | string |
Варианты регистра. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Телефон
|
telephone | string |
Номер телефона. |
|
|
Версия согласованных условий
|
agreedTermsVersion | string |
Версия согласованных условий. |
|
|
Согласилась с последней версией условий
|
hasAgreedToLatestTermsVersion | string |
Версия последних условий, согласованных. |
|
|
Отказ в маркетинге
|
marketingOptIn | string |
Отказался от маркетинга. |
|
|
Домен Badgr
|
badgrDomain | string |
Домен Badgr. |
|
|
Имеет набор паролей
|
hasPasswordSet | string |
Имеет набор паролей. |
|
|
Recipient
|
recipient | string |
Получатель. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Имя (Первое имя)
|
result.firstName | string |
Первое имя. |
|
Фамилия
|
result.lastName | string |
Фамилия. |
|
Сообщения электронной почты
|
result.emails | array of object | |
|
Тип сущности
|
result.emails.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.emails.entityId | string |
Идентификатор сущности. |
|
Адрес электронной почты
|
result.emails.email | string |
Адрес электронной почты. |
|
Проверено
|
result.emails.verified | boolean |
Проверяется ли проверка. |
|
Primary
|
result.emails.primary | boolean |
Указывает, является ли первичный. |
|
Варианты регистра
|
result.emails.caseVariants | string |
Варианты регистра. |
|
URL
|
result.url | string |
URL-адрес. |
|
Телефон
|
result.telephone | string |
Номер телефона. |
|
Версия согласованных условий
|
result.agreedTermsVersion | string |
Версия терминов, защищенная. |
|
Согласилась с последней версией условий
|
result.hasAgreedToLatestTermsVersion | string |
Версия самых поздних терминов aggree. |
|
Отказ в маркетинге
|
result.marketingOptIn | string |
Согласился принять участие в маркетинге. |
|
Домен Badgr
|
result.badgrDomain | string |
Домен Badgr. |
|
Имеет набор паролей
|
result.hasPasswordSet | string |
Если имеется набор паролей. |
|
Recipient
|
result.recipient | string |
Получатель. |
Обновление издателя
Обновление одного издателя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
Создано автором
|
createdBy | string |
Кем создано. |
|
|
Имя
|
name | string |
Имя. |
|
|
Изображение
|
image | string |
Изображение. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты. |
||
|
Description
|
description | string |
Описание. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Тип сущности
|
entityType | string |
Тип сущности. |
|
|
Идентификатор организации
|
entityId | string |
Идентификатор сущности. |
|
|
Профиль пользователя
|
userProfile | string |
Профиль пользователя. |
|
|
User
|
user | string |
Пользователь. |
|
|
Role
|
role | string |
Роль. |
|
|
Extensions
|
extensions | string |
Расширения. |
|
|
Домен Badgr
|
badgrDomain | string |
Домен Badgr. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
Имя
|
result.name | string |
Имя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Адрес электронной почты
|
result.email | string |
Адрес электронной почты. |
|
Description
|
result.description | string |
Описание. |
|
URL
|
result.url | string |
URL-адрес. |
|
Персонал
|
result.staff | array of object | |
|
Тип сущности
|
result.staff.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.staff.entityId | string |
Идентификатор сущности. |
|
Профиль пользователя
|
result.staff.userProfile | string |
Профиль пользователя. |
|
User
|
result.staff.user | string |
Пользователь. |
|
Role
|
result.staff.role | string |
Роль. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Домен Badgr
|
result.badgrDomain | string |
Домен Badgr. |
Обновление индикатора событий
Обновите существующий класс badgeClass. Ранее выданные индикаторы эмблемы не будут обновлены.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. . |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Имя
|
name | string |
Имя. |
|
|
Изображение
|
image | string |
Изображение. |
|
|
Description
|
description | string |
Описание. |
|
|
Тип достижения
|
achievementType | string |
Тип достижения. |
|
|
URL-адрес условия
|
criteriaUrl | string |
URL-адрес критерия. |
|
|
Описание условий
|
criteriaNarrative | string |
Описание критериев. |
|
|
Целевое имя
|
targetName | string |
Имя целевого объекта. |
|
|
Целевой URL-адрес
|
targetUrl | string |
URL-адрес целевого объекта. |
|
|
Описание целевого объекта
|
targetDescription | string |
Описание целевого объекта. |
|
|
Целевая платформа
|
targetFramework | string |
Платформа целевого объекта. |
|
|
Целевой код
|
targetCode | string |
Код целевого объекта. |
|
|
Метки
|
tags | array of string | ||
|
Сумма
|
amount | string |
Сумма. |
|
|
Продолжительность
|
duration | string |
Длительность. |
|
|
Extensions
|
extensions | string |
Расширения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Имя
|
result.name | string |
Имя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Description
|
result.description | string |
Описание. |
|
Тип достижения
|
result.achievementType | string |
Тип достижения. |
|
URL-адрес условия
|
result.criteriaUrl | string |
URL-адрес критерия. |
|
Описание условий
|
result.criteriaNarrative | string |
Описание критериев. |
|
Трассы
|
result.alignments | array of object | |
|
Целевое имя
|
result.alignments.targetName | string |
Имя целевого объекта. |
|
Целевой URL-адрес
|
result.alignments.targetUrl | string |
URL-адрес целевого объекта. |
|
Описание целевого объекта
|
result.alignments.targetDescription | string |
Описание целевого объекта. |
|
Целевая платформа
|
result.alignments.targetFramework | string |
Платформа целевого объекта. |
|
Целевой код
|
result.alignments.targetCode | string |
Код целевого объекта. |
|
Метки
|
result.tags | array of string | |
|
Сумма
|
result.expires.amount | string |
Сумма. |
|
Продолжительность
|
result.expires.duration | string |
Длительность. |
|
Extensions
|
result.extensions | string |
Расширения. |
Обновление коллекции
Обновите коллекцию в рюкзаке.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
Тип сущности
|
entityType | string |
Тип сущности. |
|
|
Идентификатор организации
|
entityId | string |
Идентификатор сущности. |
|
|
Имя
|
name | string |
Имя. |
|
|
Description
|
description | string |
Описание. |
|
|
Владелец
|
owner | string |
Владелец. |
|
|
URL-адрес общего доступа
|
share_url | string |
URL-адрес общей папки. |
|
|
Общий доступ к хэшу
|
shareHash | string |
Хэш общей папки. |
|
|
Опубликовано
|
published | boolean |
Будет ли опубликовано. |
|
|
BadgeClass
|
badgeclass | string |
Определение заработать эмблемы. |
|
|
Идентификатор значка Open BadgeClass
|
badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Идентичность
|
identity | string |
Удостоверение. |
|
|
Хэшированные
|
hashed | boolean |
Есть ли хэшированные. |
|
|
Тип
|
type | string |
Тип. |
|
|
Удостоверение обычного текста
|
plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
|
Salt
|
salt | string |
Если хэширован, соль. |
|
|
Выдано
|
issuedOn | string |
При выпуске. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
Действительно до
|
expires | string |
По истечении срока действия значка. |
|
|
Extensions
|
extensions | string |
Расширения. |
|
|
Имя badgeClass
|
badgeclassName | string |
Имя объекта BadgeClass. |
|
|
Создано в
|
createdAt | string |
Создано в. |
|
|
Создано автором
|
createdBy | string |
Кем создано. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Имя
|
result.name | string |
Имя. |
|
Description
|
result.description | string |
Описание. |
|
Владелец
|
result.owner | string |
Владелец. |
|
URL-адрес общего доступа
|
result.share_url | string |
URL-адрес общей папки. |
|
Общий доступ к хэшу
|
result.shareHash | string |
Хэш общей папки. |
|
Опубликовано
|
result.published | boolean |
Будет ли опубликовано. |
|
Assertions
|
result.assertions | array of object | |
|
Тип сущности
|
result.assertions.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.assertions.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.assertions.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.assertions.createdAt | string |
При создании. |
|
Создано автором
|
result.assertions.createdBy | string |
Создано. |
|
BadgeClass
|
result.assertions.badgeclass | string |
The BadgeClass. |
|
Идентификатор значка Open BadgeClass
|
result.assertions.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.assertions.issuer | string |
Издатель. |
|
Идентификатор открытой эмблемы издателя
|
result.assertions.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.assertions.image | string |
Изображение. |
|
Идентичность
|
result.assertions.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.assertions.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.assertions.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.assertions.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.assertions.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.assertions.issuedOn | string |
При выпуске. |
|
Описание
|
result.assertions.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.assertions.evidence | array of object | |
|
URL
|
result.assertions.evidence.url | string |
URL-адрес. |
|
Описание
|
result.assertions.evidence.narrative | string |
Повествование. |
|
Отозван
|
result.assertions.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.assertions.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.assertions.acceptance | string |
Принятие. |
|
Действительно до
|
result.assertions.expires | string |
Истекает срок действия. |
|
Extensions
|
result.assertions.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.assertions.badgeclassName | string |
Имя объекта BadgeClass. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
Обновление принятия утверждения в Backpack
Обновите утверждение утверждения в рюкпаке пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
Принятие
|
acceptance | string |
Принятие. |
|
|
BadgeClass
|
badgeclass | string |
Определение заработать эмблемы. |
|
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. . |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Идентичность
|
identity | string |
Удостоверение. |
|
|
Тип
|
type | string |
Тип. |
|
|
Хэшированные
|
hashed | boolean |
Есть ли хэшированные. |
|
|
Удостоверение обычного текста
|
plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
|
Выдано
|
issuedOn | string |
При выпуске. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
Действительно до
|
expires | string |
Истекает срок действия. |
|
|
В ожидании
|
pending | string |
Ожидаемый. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
В ожидании
|
result.pending | string |
Ожидаемый. |
Обновление утверждения
Обновление утверждения.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
BadgeClass
|
badgeclass | string |
Определение заработать эмблемы. |
|
|
Идентификатор значка Open BadgeClass
|
badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. . |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Идентичность
|
identity | string |
Удостоверение. |
|
|
Хэшированные
|
hashed | boolean |
Есть ли хэшированные. |
|
|
Тип
|
type | string |
Тип. |
|
|
Удостоверение обычного текста
|
plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
|
Salt
|
salt | string |
Если хэширован, соль. |
|
|
Выдано
|
issuedOn | string |
При выпуске. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
Действительно до
|
expires | string |
Истекает срок действия. |
|
|
Extensions
|
extensions | string |
Расширения. |
|
|
Имя badgeClass
|
badgeclassName | string |
Имя объекта BadgeClass. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.badgeclassName | string |
Имя объекта BadgeClass. |
Отзыв accessToken
Отмена доступа пользователя AccessToken.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Отзыв утверждения
Отмена утверждения.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
|
Причина отзыва
|
revocation_reason | string |
Причина отзыва этого утверждения |
Отмена нескольких утверждений
Отмена нескольких утверждений для нескольких получателей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
BadgeClass
|
badgeclass | string |
Определение заработать эмблемы. |
|
|
Идентификатор значка Open BadgeClass
|
badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. . |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Идентичность
|
identity | string |
Удостоверение. |
|
|
Хэшированные
|
hashed | boolean |
Есть ли хэшированные. |
|
|
Тип
|
type | string |
Тип. |
|
|
Удостоверение обычного текста
|
plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
|
Salt
|
salt | string |
Если хэширован, соль. |
|
|
Выдано
|
issuedOn | string |
При выпуске. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
Действительно до
|
expires | string |
Истекает срок действия. |
|
|
Extensions
|
extensions | string |
Расширения. |
|
|
Имя badgeClass
|
badgeclassName | string |
Имя объекта BadgeClass. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.badgeclassName | string |
Имя объекта BadgeClass. |
Отправка утверждения в рюкзак
Отправьте новое утверждение в рюкзак пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
BadgeClass
|
badgeclass | string |
Определение заработать эмблемы. |
|
|
Идентификатор значка Open BadgeClass
|
badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. . |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Идентичность
|
identity | string |
Удостоверение. |
|
|
Хэшированные
|
hashed | boolean |
Есть ли хэшированные. |
|
|
Тип
|
type | string |
Тип. |
|
|
Удостоверение обычного текста
|
plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
|
Salt
|
salt | string |
Если хэширован, соль. |
|
|
Выдано
|
issuedOn | string |
При выпуске. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
Действительно до
|
expires | string |
Истекает срок действия. |
|
|
Extensions
|
extensions | string |
Расширения. |
|
|
Имя badgeClass
|
badgeclassName | string |
Имя объекта BadgeClass. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.badgeclassName | string |
Имя объекта BadgeClass. |
Получение AccessToken
Получение одного AccessToken.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | AccessToken |
Получение идентификаторов индикаторов событий пользователя
Получите список BadgeClasses для прошедшего проверку подлинности пользователя.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Имя
|
result.name | string |
Имя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Description
|
result.description | string |
Описание. |
|
Тип достижения
|
result.achievementType | string |
Тип достижения. |
|
URL-адрес условия
|
result.criteriaUrl | string |
URL-адрес критерия. |
|
Описание условий
|
result.criteriaNarrative | string |
Описание критериев. |
|
Трассы
|
result.alignments | array of object | |
|
Целевое имя
|
result.alignments.targetName | string |
Имя целевого объекта. |
|
Целевой URL-адрес
|
result.alignments.targetUrl | string |
URL-адрес целевого объекта. |
|
Описание целевого объекта
|
result.alignments.targetDescription | string |
Описание целевого объекта. |
|
Целевая платформа
|
result.alignments.targetFramework | string |
Платформа целевого объекта. |
|
Целевой код
|
result.alignments.targetCode | string |
Код целевого объекта. |
|
Метки
|
result.tags | array of string | |
|
Сумма
|
result.expires.amount | string |
Сумма. |
|
Продолжительность
|
result.expires.duration | string |
Длительность. |
|
Extensions
|
result.extensions | string |
Расширения. |
Получение издателей
Получите список издателей для прошедшего проверку подлинности пользователя.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
Имя
|
result.name | string |
Имя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Адрес электронной почты
|
result.email | string |
Адрес электронной почты. |
|
Description
|
result.description | string |
Описание. |
|
URL
|
result.url | string |
URL-адрес. |
|
Персонал
|
result.staff | array of object | |
|
Тип сущности
|
result.staff.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.staff.entityId | string |
Идентификатор сущности. |
|
Тип сущности
|
result.staff.userProfile.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.staff.userProfile.entityId | string |
Идентификатор сущности. |
|
Имя (Первое имя)
|
result.staff.userProfile.firstName | string |
Первое имя. |
|
Фамилия
|
result.staff.userProfile.lastName | string |
Фамилия. |
|
Сообщения электронной почты
|
result.staff.userProfile.emails | array of object | |
|
Адрес электронной почты
|
result.staff.userProfile.emails.email | string |
Адрес электронной почты. |
|
Проверено
|
result.staff.userProfile.emails.verified | boolean |
Проверяется ли проверка. |
|
Primary
|
result.staff.userProfile.emails.primary | boolean |
Указывает, является ли первичный. |
|
Варианты регистра
|
result.staff.userProfile.emails.caseVariants | array of string |
Варианты регистра. |
|
URL-адреса
|
result.staff.userProfile.url | array of string |
URL-адреса. |
|
Номера телефонов
|
result.staff.userProfile.telephone | array of string |
Номера телефонов. |
|
Домен Badgr
|
result.staff.userProfile.badgrDomain | string |
Домен Badgr. |
|
User
|
result.staff.user | string |
Пользователь. |
|
Role
|
result.staff.role | string |
Роль. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Домен Badgr
|
result.badgrDomain | string |
Домен Badgr. |
Получение издателя
Получение одного издателя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
Имя
|
result.name | string |
Имя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Адрес электронной почты
|
result.email | string |
Адрес электронной почты. |
|
Description
|
result.description | string |
Описание. |
|
URL
|
result.url | string |
URL-адрес. |
|
Персонал
|
result.staff | array of object | |
|
Тип сущности
|
result.staff.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.staff.entityId | string |
Идентификатор сущности. |
|
Профиль пользователя
|
result.staff.userProfile | string |
Профиль пользователя. |
|
User
|
result.staff.user | string |
Пользователь. |
|
Role
|
result.staff.role | string |
Роль. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Домен Badgr
|
result.badgrDomain | string |
Домен Badgr. |
Получение индикатора событий
Получение одного объекта BadgeClass.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Имя
|
result.name | string |
Имя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Description
|
result.description | string |
Описание. |
|
Тип достижения
|
result.achievementType | string |
Тип достижения. |
|
URL-адрес условия
|
result.criteriaUrl | string |
URL-адрес критерия. |
|
Описание условий
|
result.criteriaNarrative | string |
Описание критериев. |
|
Трассы
|
result.alignments | array of object | |
|
Целевое имя
|
result.alignments.targetName | string |
Имя целевого объекта. |
|
Целевой URL-адрес
|
result.alignments.targetUrl | string |
URL-адрес целевого объекта. |
|
Описание целевого объекта
|
result.alignments.targetDescription | string |
Описание целевого объекта. |
|
Целевая платформа
|
result.alignments.targetFramework | string |
Платформа целевого объекта. |
|
Целевой код
|
result.alignments.targetCode | string |
Код целевого объекта. |
|
Метки
|
result.tags | array of string | |
|
Сумма
|
result.expires.amount | string |
Сумма. |
|
Продолжительность
|
result.expires.duration | string |
Длительность. |
|
Extensions
|
result.extensions | string |
Расширения. |
Получение класса badgeClasses издателя
Получите список индикаторов событий для одного издателя. Пользователь, прошедший проверку подлинности, должен иметь состояние владельца, редактора или персонала в издателе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
|
Number
|
num | string |
Запрос разбиения результатов на страницы |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Имя
|
result.name | string |
Имя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Description
|
result.description | string |
Описание. |
|
Тип достижения
|
result.achievementType | string |
Тип достижения. |
|
URL-адрес условия
|
result.criteriaUrl | string |
URL-адрес критерия. |
|
Описание условий
|
result.criteriaNarrative | string |
Описание критериев. |
|
Трассы
|
result.alignments | array of object | |
|
Целевое имя
|
result.alignments.targetName | string |
Имя целевого объекта. |
|
Целевой URL-адрес
|
result.alignments.targetUrl | string |
URL-адрес целевого объекта. |
|
Описание целевого объекта
|
result.alignments.targetDescription | string |
Описание целевого объекта. |
|
Целевая платформа
|
result.alignments.targetFramework | string |
Платформа целевого объекта. |
|
Целевой код
|
result.alignments.targetCode | string |
Код целевого объекта. |
|
Метки
|
result.tags | array of string | |
|
Сумма
|
result.expires.amount | string |
Сумма. |
|
Продолжительность
|
result.expires.duration | string |
Длительность. |
|
Extensions
|
result.extensions | string |
Расширения. |
Получение коллекции
Получение одной коллекции.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Имя
|
result.name | string |
Имя. |
|
Description
|
result.description | string |
Описание. |
|
Владелец
|
result.owner | string |
Владелец. |
|
URL-адрес общего доступа
|
result.share_url | string |
URL-адрес общей папки. |
|
Общий доступ к хэшу
|
result.shareHash | string |
Хэш общей папки. |
|
Опубликовано
|
result.published | boolean |
Будет ли опубликовано. |
|
Assertions
|
result.assertions | array of object | |
|
Тип сущности
|
result.assertions.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.assertions.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.assertions.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.assertions.createdAt | string |
При создании. |
|
Создано автором
|
result.assertions.createdBy | string |
Создано. |
|
BadgeClass
|
result.assertions.badgeclass | string |
The BadgeClass. |
|
Идентификатор значка Open BadgeClass
|
result.assertions.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.assertions.issuer | string |
Издатель. |
|
Идентификатор открытой эмблемы издателя
|
result.assertions.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.assertions.image | string |
Изображение. |
|
Идентичность
|
result.assertions.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.assertions.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.assertions.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.assertions.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.assertions.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.assertions.issuedOn | string |
При выпуске. |
|
Описание
|
result.assertions.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.assertions.evidence | array of object | |
|
URL
|
result.assertions.evidence.url | string |
URL-адрес. |
|
Описание
|
result.assertions.evidence.narrative | string |
Повествование. |
|
Отозван
|
result.assertions.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.assertions.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.assertions.acceptance | string |
Принятие. |
|
Действительно до
|
result.assertions.expires | string |
Истекает срок действия. |
|
Extensions
|
result.assertions.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.assertions.badgeclassName | string |
Имя объекта BadgeClass. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
Получение коллекций
Получение списка коллекций.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Имя
|
result.name | string |
Имя. |
|
Description
|
result.description | string |
Описание. |
|
Владелец
|
result.owner | string |
Владелец. |
|
URL-адрес общего доступа
|
result.share_url | string |
URL-адрес общей папки. |
|
Общий доступ к хэшу
|
result.shareHash | string |
Хэш общей папки. |
|
Опубликовано
|
result.published | boolean |
Будет ли опубликовано. |
|
Assertions
|
result.assertions | array of object | |
|
Тип сущности
|
result.assertions.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.assertions.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.assertions.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.assertions.createdAt | string |
При создании. |
|
Создано автором
|
result.assertions.createdBy | string |
Создано. |
|
BadgeClass
|
result.assertions.badgeclass | string |
The BadgeClass. |
|
Идентификатор значка Open BadgeClass
|
result.assertions.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.assertions.issuer | string |
Издатель. |
|
Идентификатор открытой эмблемы издателя
|
result.assertions.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.assertions.image | string |
Изображение. |
|
Идентичность
|
result.assertions.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.assertions.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.assertions.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.assertions.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.assertions.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.assertions.issuedOn | string |
При выпуске. |
|
Описание
|
result.assertions.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.assertions.evidence | array of object | |
|
URL
|
result.assertions.evidence.url | string |
URL-адрес. |
|
Описание
|
result.assertions.evidence.narrative | string |
Повествование. |
|
Отозван
|
result.assertions.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.assertions.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.assertions.acceptance | string |
Принятие. |
|
Действительно до
|
result.assertions.expires | string |
Истекает срок действия. |
|
Extensions
|
result.assertions.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.assertions.badgeclassName | string |
Имя объекта BadgeClass. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
Получение маркеров доступа пользователя
Получите список маркеров доступа для прошедшего проверку подлинности пользователя.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of AccessToken |
Получение маркеров издателя
Получение маркеров издателя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True |
Возвращаемое значение
- response
- AccessToken
Получение одного утверждения
Получение утверждения
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.badgeclassName | string |
Имя объекта BadgeClass. |
Получение профиля BadgeUser
Получение одного профиля BadgeUser. Используйте идентификатор entityId "self", чтобы получить профиль пользователя, прошедшего проверку подлинности.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Имя (Первое имя)
|
result.firstName | string |
Первое имя. |
|
Фамилия
|
result.lastName | string |
Фамилия. |
|
Сообщения электронной почты
|
result.emails | array of object | |
|
Тип сущности
|
result.emails.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.emails.entityId | string |
Идентификатор сущности. |
|
Адрес электронной почты
|
result.emails.email | string |
Адрес электронной почты. |
|
Проверено
|
result.emails.verified | boolean |
Проверяется ли проверка. |
|
Primary
|
result.emails.primary | boolean |
Указывает, является ли первичный. |
|
Варианты регистра
|
result.emails.caseVariants | string |
Варианты регистра. |
|
URL
|
result.url | string |
URL-адрес. |
|
Телефон
|
result.telephone | string |
Номер телефона. |
|
Версия согласованных условий
|
result.agreedTermsVersion | string |
Версия терминов, защищенная. |
|
Согласилась с последней версией условий
|
result.hasAgreedToLatestTermsVersion | string |
Версия самых поздних терминов aggree. |
|
Отказ в маркетинге
|
result.marketingOptIn | string |
Согласился принять участие в маркетинге. |
|
Домен Badgr
|
result.badgrDomain | string |
Домен Badgr. |
|
Имеет набор паролей
|
result.hasPasswordSet | string |
Если имеется набор паролей. |
|
Recipient
|
result.recipient | string |
Получатель. |
Получение сведений о утверждении backpack
Получение сведений об утверждении в рюкпаке пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
Results
|
result | array of object |
Массив результатов. |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
В ожидании
|
result.pending | string |
Ожидаемый. |
Получение утверждений
Получите список утверждений для одного издателя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
|
Recipient
|
recipient | string |
Идентификатор получателя для фильтрации по |
|
|
Number
|
num | string |
Запрос разбиения результатов на страницы |
|
|
Срок действия включения
|
include_expired | boolean |
Включение утверждений с истекшим сроком действия |
|
|
Включение отозвано
|
include_revoked | boolean |
Включение отозванных утверждений |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.badgeclassName | string |
Имя объекта BadgeClass. |
Получение утверждений BadgeClass
Получение списка утверждений для одного объекта BadgeClass.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
|
Recipient
|
recipient | string |
Идентификатор получателя для фильтрации по |
|
|
Number
|
num | string |
Запрос разбиения результатов на страницы |
|
|
Срок действия включения
|
include_expired | boolean |
Включение утверждений с истекшим сроком действия |
|
|
Включение отозвано
|
include_revoked | boolean |
Включение отозванных утверждений |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.badgeclassName | string |
Имя объекта BadgeClass. |
Получение утверждений в рюкзаке пользователя
Получите список утверждений в рюкзаке пользователя с проверкой подлинности.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.badgeclassName | string |
Имя объекта BadgeClass. |
Проблема с несколькими индикаторами событий
Выдача нескольких копий одного класса BadgeClass нескольким получателям.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
BadgeClass
|
badgeclass | string |
Определение заработать эмблемы. |
|
|
Идентификатор значка Open BadgeClass
|
badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. . |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Идентичность
|
identity | string |
Удостоверение. |
|
|
Хэшированные
|
hashed | boolean |
Есть ли хэшированные. |
|
|
Тип
|
type | string |
Тип. |
|
|
Удостоверение обычного текста
|
plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
|
Salt
|
salt | string |
Если хэширован, соль. |
|
|
Выдано
|
issuedOn | string |
При выпуске. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
Действительно до
|
expires | string |
Истекает срок действия. |
|
|
Extensions
|
extensions | string |
Расширения. |
|
|
Имя badgeClass
|
badgeclassName | string |
Имя объекта BadgeClass. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
BadgeClass
|
result.badgeclass | string |
Определение заработать эмблемы. |
|
Идентификатор значка Open BadgeClass
|
result.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Идентичность
|
result.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.issuedOn | string |
При выпуске. |
|
Описание
|
result.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.evidence | array of object | |
|
URL
|
result.evidence.url | string |
URL-адрес. |
|
Описание
|
result.evidence.narrative | string |
Повествование о эмблеме, выданной. |
|
Отозван
|
result.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.acceptance | string |
Когда значок был принят. |
|
Действительно до
|
result.expires | string |
По истечении срока действия значка. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.badgeclassName | string |
Имя объекта BadgeClass. |
Создание издателя
Создайте издателя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Создано автором
|
createdBy | string |
Кем создано. |
|
|
Имя
|
name | string |
Имя. |
|
|
Изображение
|
image | string |
Изображение. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты. |
||
|
Description
|
description | string |
Описание. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Тип сущности
|
entityType | string |
Тип сущности. |
|
|
Идентификатор организации
|
entityId | string |
Идентификатор сущности. |
|
|
Профиль пользователя
|
userProfile | string |
Профиль пользователя. |
|
|
User
|
user | string |
Пользователь. |
|
|
Role
|
role | string |
Роль. |
|
|
Extensions
|
extensions | string |
Расширения. |
|
|
Домен Badgr
|
badgrDomain | string |
Домен Badgr. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
Имя
|
result.name | string |
Имя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Адрес электронной почты
|
result.email | string |
Адрес электронной почты. |
|
Description
|
result.description | string |
Описание. |
|
URL
|
result.url | string |
URL-адрес. |
|
Персонал
|
result.staff | array of object | |
|
Тип сущности
|
result.staff.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.staff.entityId | string |
Идентификатор сущности. |
|
Профиль пользователя
|
result.staff.userProfile | string |
Профиль пользователя. |
|
User
|
result.staff.user | string |
Пользователь. |
|
Role
|
result.staff.role | string |
Роль. |
|
Extensions
|
result.extensions | string |
Расширения. |
|
Домен Badgr
|
result.badgrDomain | string |
Домен Badgr. |
Создание коллекции
Создайте новую коллекцию.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип сущности
|
entityType | string |
Тип сущности. |
|
|
Идентификатор организации
|
entityId | string |
Идентификатор сущности. |
|
|
Имя
|
name | string |
Имя. |
|
|
Description
|
description | string |
Описание. |
|
|
Владелец
|
owner | string |
Владелец. |
|
|
URL-адрес общего доступа
|
share_url | string |
URL-адрес общей папки. |
|
|
Общий доступ к хэшу
|
shareHash | string |
Хэш общей папки. |
|
|
Опубликовано
|
published | boolean |
Будет ли опубликовано. |
|
|
BadgeClass
|
badgeclass | string |
Определение заработать эмблемы. |
|
|
Идентификатор значка Open BadgeClass
|
badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Идентичность
|
identity | string |
Удостоверение. |
|
|
Хэшированные
|
hashed | boolean |
Есть ли хэшированные. |
|
|
Тип
|
type | string |
Тип. |
|
|
Удостоверение обычного текста
|
plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
|
Salt
|
salt | string |
Если хэширован, соль. |
|
|
Выдано
|
issuedOn | string |
При выпуске. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Описание
|
narrative | string |
Повествование о эмблеме, выданной. |
|
|
Действительно до
|
expires | string |
По истечении срока действия значка. |
|
|
Extensions
|
extensions | string |
Расширения. |
|
|
Имя badgeClass
|
badgeclassName | string |
Имя объекта BadgeClass. |
|
|
Создано в
|
createdAt | string |
Создано в. |
|
|
Создано автором
|
createdBy | string |
Кем создано. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Имя
|
result.name | string |
Имя. |
|
Description
|
result.description | string |
Описание. |
|
Владелец
|
result.owner | string |
Владелец. |
|
URL-адрес общего доступа
|
result.share_url | string |
URL-адрес общей папки. |
|
Общий доступ к хэшу
|
result.shareHash | string |
Хэш общей папки. |
|
Опубликовано
|
result.published | boolean |
Будет ли опубликовано. |
|
Assertions
|
result.assertions | array of object | |
|
Тип сущности
|
result.assertions.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.assertions.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.assertions.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.assertions.createdAt | string |
При создании. |
|
Создано автором
|
result.assertions.createdBy | string |
Создано. |
|
BadgeClass
|
result.assertions.badgeclass | string |
The BadgeClass. |
|
Идентификатор значка Open BadgeClass
|
result.assertions.badgeclassOpenBadgeId | string |
Идентификатор открытого значка BadgeClass. |
|
Issuer
|
result.assertions.issuer | string |
Издатель. |
|
Идентификатор открытой эмблемы издателя
|
result.assertions.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Изображение
|
result.assertions.image | string |
Изображение. |
|
Идентичность
|
result.assertions.recipient.identity | string |
Удостоверение. |
|
Хэшированные
|
result.assertions.recipient.hashed | boolean |
Есть ли хэшированные. |
|
Тип
|
result.assertions.recipient.type | string |
Тип. |
|
Удостоверение обычного текста
|
result.assertions.recipient.plaintextIdentity | string |
Удостоверение в виде открытого текста. |
|
Salt
|
result.assertions.recipient.salt | string |
Если хэширован, соль. |
|
Выдано
|
result.assertions.issuedOn | string |
При выпуске. |
|
Описание
|
result.assertions.narrative | string |
Повествование о эмблеме, выданной. |
|
Evidence
|
result.assertions.evidence | array of object | |
|
URL
|
result.assertions.evidence.url | string |
URL-адрес. |
|
Описание
|
result.assertions.evidence.narrative | string |
Повествование. |
|
Отозван
|
result.assertions.revoked | boolean |
Отменяется ли он. |
|
Причина отзыва
|
result.assertions.revocationReason | string |
Причина отзыва. |
|
Принятие
|
result.assertions.acceptance | string |
Принятие. |
|
Действительно до
|
result.assertions.expires | string |
Истекает срок действия. |
|
Extensions
|
result.assertions.extensions | string |
Расширения. |
|
Имя badgeClass
|
result.assertions.badgeclassName | string |
Имя объекта BadgeClass. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
Создание объекта BadgeClass
Создайте новый класс BadgeClass.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Number
|
num | integer |
Запрос разбиения результатов на страницы |
|
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. . |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Имя
|
name | string |
Имя. |
|
|
Изображение
|
image | string |
Изображение. |
|
|
Description
|
description | string |
Описание. |
|
|
Тип достижения
|
achievementType | string |
Тип достижения. |
|
|
URL-адрес условия
|
criteriaUrl | string |
URL-адрес критерия. |
|
|
Описание условий
|
criteriaNarrative | string |
Описание критериев. |
|
|
Целевое имя
|
targetName | string |
Имя целевого объекта. |
|
|
Целевой URL-адрес
|
targetUrl | string |
URL-адрес целевого объекта. |
|
|
Описание целевого объекта
|
targetDescription | string |
Описание целевого объекта. |
|
|
Целевая платформа
|
targetFramework | string |
Платформа целевого объекта. |
|
|
Целевой код
|
targetCode | string |
Код целевого объекта. |
|
|
Метки
|
tags | array of string | ||
|
Сумма
|
amount | string |
Сумма. |
|
|
Продолжительность
|
duration | string |
Длительность. |
|
|
Extensions
|
extensions | string |
Расширения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Имя
|
result.name | string |
Имя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Description
|
result.description | string |
Описание. |
|
Тип достижения
|
result.achievementType | string |
Тип достижения. |
|
URL-адрес условия
|
result.criteriaUrl | string |
URL-адрес критерия. |
|
Описание условий
|
result.criteriaNarrative | string |
Описание критериев. |
|
Трассы
|
result.alignments | array of object | |
|
Целевое имя
|
result.alignments.targetName | string |
Имя целевого объекта. |
|
Целевой URL-адрес
|
result.alignments.targetUrl | string |
URL-адрес целевого объекта. |
|
Описание целевого объекта
|
result.alignments.targetDescription | string |
Описание целевого объекта. |
|
Целевая платформа
|
result.alignments.targetFramework | string |
Платформа целевого объекта. |
|
Целевой код
|
result.alignments.targetCode | string |
Код целевого объекта. |
|
Метки
|
result.tags | array of string | |
|
Сумма
|
result.expires.amount | string |
Сумма. |
|
Продолжительность
|
result.expires.duration | string |
Длительность. |
|
Extensions
|
result.extensions | string |
Расширения. |
Создание объекта BadgeClass издателя
Создайте новый класс badgeClass, связанный с издателем. Пользователь, прошедший проверку подлинности, должен иметь состояние владельца, редактора или персонала в издателе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
Issuer
|
issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. . |
|
|
Идентификатор открытой эмблемы издателя
|
issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
|
Имя
|
name | string |
Имя. |
|
|
Изображение
|
image | string |
Изображение. |
|
|
Description
|
description | string |
Описание. |
|
|
Тип достижения
|
achievementType | string |
Тип достижения. |
|
|
URL-адрес условия
|
criteriaUrl | string |
URL-адрес критерия. |
|
|
Описание условий
|
criteriaNarrative | string |
Описание критериев. |
|
|
Целевое имя
|
targetName | string |
Имя целевого объекта. |
|
|
Целевой URL-адрес
|
targetUrl | string |
URL-адрес целевого объекта. |
|
|
Описание целевого объекта
|
targetDescription | string |
Описание целевого объекта. |
|
|
Целевая платформа
|
targetFramework | string |
Платформа целевого объекта. |
|
|
Целевой код
|
targetCode | string |
Код целевого объекта. |
|
|
Метки
|
tags | array of string | ||
|
Сумма
|
amount | string |
Сумма. |
|
|
Продолжительность
|
duration | string |
Длительность. |
|
|
Extensions
|
extensions | string |
Расширения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Идентификатор значка "Открыть"
|
result.openBadgeId | string |
Идентификатор индикатора открытия. |
|
Создано в
|
result.createdAt | string |
При создании. |
|
Создано автором
|
result.createdBy | string |
Кем создано. |
|
Issuer
|
result.issuer | string |
Пользователь или организация, создающий или предлагающий эмблемы и выдает им работников. |
|
Идентификатор открытой эмблемы издателя
|
result.issuerOpenBadgeId | string |
Идентификатор открытого значка издателя. |
|
Имя
|
result.name | string |
Имя. |
|
Изображение
|
result.image | string |
Изображение. |
|
Description
|
result.description | string |
Описание. |
|
Тип достижения
|
result.achievementType | string |
Тип достижения. |
|
URL-адрес условия
|
result.criteriaUrl | string |
URL-адрес критерия. |
|
Описание условий
|
result.criteriaNarrative | string |
Описание критериев. |
|
Трассы
|
result.alignments | array of object | |
|
Целевое имя
|
result.alignments.targetName | string |
Имя целевого объекта. |
|
Целевой URL-адрес
|
result.alignments.targetUrl | string |
URL-адрес целевого объекта. |
|
Описание целевого объекта
|
result.alignments.targetDescription | string |
Описание целевого объекта. |
|
Целевая платформа
|
result.alignments.targetFramework | string |
Платформа целевого объекта. |
|
Целевой код
|
result.alignments.targetCode | string |
Код целевого объекта. |
|
Метки
|
result.tags | array of string | |
|
Сумма
|
result.expires.amount | string |
Сумма. |
|
Продолжительность
|
result.expires.duration | string |
Длительность. |
|
Extensions
|
result.extensions | string |
Расширения. |
Создание учетной записи BadgeUser
Создайте учетную запись и профиль BadgeUser.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор сущности. |
|
Тип сущности
|
entityType | string |
Тип сущности. |
|
|
Идентификатор организации
|
entityId | string |
Идентификатор сущности. |
|
|
Имя (Первое имя)
|
firstName | string |
Первое имя. |
|
|
Фамилия
|
lastName | string |
Фамилия. |
|
|
Тип сущности
|
entityType | string |
Тип сущности. |
|
|
Идентификатор организации
|
entityId | string |
Идентификатор сущности. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты. |
||
|
Проверено
|
verified | boolean |
Проверяется ли проверка. |
|
|
Primary
|
primary | boolean |
Указывает, является ли первичный. |
|
|
Варианты регистра
|
caseVariants | string |
Варианты регистра. |
|
|
URL
|
url | string |
URL-адрес. |
|
|
Телефон
|
telephone | string |
Номер телефона. |
|
|
Версия согласованных условий
|
agreedTermsVersion | string |
Версия согласованных условий. |
|
|
Согласилась с последней версией условий
|
hasAgreedToLatestTermsVersion | string |
Версия последних условий, согласованных. |
|
|
Отказ в маркетинге
|
marketingOptIn | string |
Отказался от маркетинга. |
|
|
Домен Badgr
|
badgrDomain | string |
Домен Badgr. |
|
|
Имеет набор паролей
|
hasPasswordSet | string |
Имеет набор паролей. |
|
|
Recipient
|
recipient | string |
Получатель. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Description
|
status.description | string |
Описание. |
|
Success
|
status.success | boolean |
Является ли успех успешным. |
|
результат
|
result | array of object | |
|
Тип сущности
|
result.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.entityId | string |
Идентификатор сущности. |
|
Имя (Первое имя)
|
result.firstName | string |
Первое имя. |
|
Фамилия
|
result.lastName | string |
Фамилия. |
|
Сообщения электронной почты
|
result.emails | array of object | |
|
Тип сущности
|
result.emails.entityType | string |
Тип сущности. |
|
Идентификатор организации
|
result.emails.entityId | string |
Идентификатор сущности. |
|
Адрес электронной почты
|
result.emails.email | string |
Адрес электронной почты. |
|
Проверено
|
result.emails.verified | boolean |
Проверяется ли проверка. |
|
Primary
|
result.emails.primary | boolean |
Указывает, является ли первичный. |
|
Варианты регистра
|
result.emails.caseVariants | string |
Варианты регистра. |
|
URL
|
result.url | string |
URL-адрес. |
|
Телефон
|
result.telephone | string |
Номер телефона. |
|
Версия согласованных условий
|
result.agreedTermsVersion | string |
Версия терминов, защищенная. |
|
Согласилась с последней версией условий
|
result.hasAgreedToLatestTermsVersion | string |
Версия самых поздних терминов aggree. |
|
Отказ в маркетинге
|
result.marketingOptIn | string |
Согласился принять участие в маркетинге. |
|
Домен Badgr
|
result.badgrDomain | string |
Домен Badgr. |
|
Имеет набор паролей
|
result.hasPasswordSet | string |
Если имеется набор паролей. |
|
Recipient
|
result.recipient | string |
Получатель. |
Удаление издателя
Удаление одного издателя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Удаление коллекции
Удаление коллекции из рюкзака.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Удаление объекта BadgeClass
Удаление объекта BadgeClass. Ограничено владельцами или редакторами (а не сотрудниками) соответствующего издателя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |
Удаление утверждения из рюкзака
Удалите утверждение из рюкзака пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
entity_id | True | string |
Идентификатор объекта |