共用方式為


Badgr(獨立出版商)

世界各地的組織都使用 Badgr 創建品牌學習生態系統,通過基於技能的數字證書、可堆疊的學習途徑和便攜式學習者記錄來支持他們的社區。

此連接器適用於以下產品和區域:

服務 Class Regions
副駕駛工作室 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
邏輯應用程式 標準 所有 Logic Apps 區域, 但下列區域除外:
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 (DoD)
Power Apps 進階 除下列區域外的所有 Power Apps 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
Power Automate(自動化服務) 進階 除下列區域外的所有 Power Automate 區域
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
連絡人​​
名稱 特洛伊·泰勒
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
連接器中繼資料
Publisher Troy Taylor,日立解決方案
網站 https://badgr.com
隱私策略 https://info.badgr.com/privacy-policy.html
類別 人力資源

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

刪除 BadgeClass

刪除 BadgeClass。 僅限於相應發行人的所有者或編輯者(非員工)。

刪除簽發者

刪除單一簽發者。

刪除集合

從背包中刪除收藏。

取得 AccessToken

取得單一 AccessToken。

取得 BadgeClass 的斷言

取得單一 BadgeClass 的判斷提示清單。

取得 BadgeUser 的個人資料

取得單一 BadgeUser 設定檔。 使用 entityId 'self' 來擷取已驗證使用者的設定檔。

取得使用者的 BadgeClasses

取得已驗證使用者的 BadgeClasses 清單。

取得使用者的存取權杖

取得已驗證使用者的存取權杖清單。

取得判斷提示

取得單一發行者的判斷聲明清單。

取得單一判斷提示

取得斷言

取得徽章類別

取得單一 BadgeClass。

取得發行人

取得單一發行人。

取得發行人

取得已驗證使用者的簽發者清單。

取得發行者的徽章類別

取得單一發行者的 BadgeClasses 清單。 已驗證的使用者必須具有「簽發者」的擁有者、編輯者或員工狀態。

取得背包斷言詳細資訊

取得使用者背包中斷言的詳細資料。

取得集合

取得單一集合。

取得集合

獲取收藏列表。

在使用者的背包中取得判斷提示

取得已驗證使用者背包中的斷言清單。

將斷言上傳到背包

將新的主張上傳到使用者的背包。

將斷言匯入背包

將新的主張匯入使用者的背包。

建立 BadgeClass

建立新的 BadgeClass。

建立 BadgeUser 帳戶

建立 BadgeUser 帳戶和個人資料。

建立發行者

建立新的發行者。

建立發行者的 BadgeClass

建立與簽發者相關聯的新 BadgeClass。 已驗證的使用者必須具有「簽發者」的擁有者、編輯者或員工狀態。

建立集合

建立新集合。

從背包中刪除斷言

從使用者的背包中移除判斷提示。

恢復帳戶

恢復帳戶並設置新密碼。

撤銷 AccessToken

撤銷使用者的 AccessToken。

撤銷判斷提示

撤銷判斷。

撤銷多個判斷提示

撤銷多個收件者的多個宣告。

擷取簽發者權杖

擷取發行者權杖。

更新 Backpack 中的宣告接受

更新使用者背包中主張的接受程度。

更新 BadgeClass

更新現有的 BadgeClass。 先前發出的 BadgeInstances 將不會更新。

更新徽章使用者

更新 BadgeUser 的帳戶。 使用 entityId 'self' 來更新已驗證使用者的設定檔

更新斷言

更新判斷提示。

更新發行人

更新單一發行者。

更新集合

更新背包中的收藏。

發出判斷提示

向收件者發出新的宣告。

發出判斷提示

向單一收件者發出宣告。

發行多個 BadgeClass

將相同 BadgeClass 的多個複本發出給多個收件者。

要求帳戶復援電子郵件

要求使用者的帳戶復原電子郵件。

刪除 BadgeClass

刪除 BadgeClass。 僅限於相應發行人的所有者或編輯者(非員工)。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

刪除簽發者

刪除單一簽發者。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

刪除集合

從背包中刪除收藏。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

取得 AccessToken

取得單一 AccessToken。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result AccessToken

取得 BadgeClass 的斷言

取得單一 BadgeClass 的判斷提示清單。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

Recipient
recipient string

要篩選的收件者識別碼

Number
num string

要求結果分頁

包括已過期
include_expired boolean

包含過期的判斷提示

包括已撤銷
include_revoked boolean

包含撤銷的判斷提示

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.badgeclassName string

BadgeClass 的名稱。

取得 BadgeUser 的個人資料

取得單一 BadgeUser 設定檔。 使用 entityId 'self' 來擷取已驗證使用者的設定檔。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

名字
result.firstName string

第一個名字。

姓氏
result.lastName string

姓氏。

電子郵件
result.emails array of object
實體類型
result.emails.entityType string

實體的類型。

實體 ID
result.emails.entityId string

實體的識別碼。

Email
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

收件者。

取得使用者的 BadgeClasses

取得已驗證使用者的 BadgeClasses 清單。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

名稱
result.name string

名稱。

影像
result.image string

圖像。

Description
result.description string

描述。

成就類型
result.achievementType string

成就的類型。

準則網址
result.criteriaUrl string

準則的 URL 位址。

標準敘述
result.criteriaNarrative string

標準的敘述。

坐標系
result.alignments array of object
目標名稱
result.alignments.targetName string

目標的名稱。

目標網址
result.alignments.targetUrl string

目標的 URL 位址。

目標描述
result.alignments.targetDescription string

目標的描述。

目標 Framework
result.alignments.targetFramework string

目標的框架。

目標代碼
result.alignments.targetCode string

目標的程式碼。

Tags
result.tags array of string
總數
result.expires.amount string

金額。

持續時間
result.expires.duration string

持續時間。

Extensions
result.extensions string

擴展。

取得使用者的存取權杖

取得已驗證使用者的存取權杖清單。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of AccessToken

取得判斷提示

取得單一發行者的判斷聲明清單。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

Recipient
recipient string

要篩選的收件者識別碼

Number
num string

要求結果分頁

包括已過期
include_expired boolean

包含過期的判斷提示

包括已撤銷
include_revoked boolean

包含撤銷的判斷提示

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.badgeclassName string

BadgeClass 的名稱。

取得單一判斷提示

取得斷言

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.badgeclassName string

BadgeClass 的名稱。

取得徽章類別

取得單一 BadgeClass。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

名稱
result.name string

名稱。

影像
result.image string

圖像。

Description
result.description string

描述。

成就類型
result.achievementType string

成就的類型。

準則網址
result.criteriaUrl string

準則的 URL 位址。

標準敘述
result.criteriaNarrative string

標準的敘述。

坐標系
result.alignments array of object
目標名稱
result.alignments.targetName string

目標的名稱。

目標網址
result.alignments.targetUrl string

目標的 URL 位址。

目標描述
result.alignments.targetDescription string

目標的描述。

目標 Framework
result.alignments.targetFramework string

目標的框架。

目標代碼
result.alignments.targetCode string

目標的程式碼。

Tags
result.tags array of string
總數
result.expires.amount string

金額。

持續時間
result.expires.duration string

持續時間。

Extensions
result.extensions string

擴展。

取得發行人

取得單一發行人。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

名稱
result.name string

名稱。

影像
result.image string

圖像。

Email
result.email string

電子郵件地址。

Description
result.description string

描述。

URL
result.url string

URL 位址。

員工
result.staff array of object
實體類型
result.staff.entityType string

實體的類型。

實體 ID
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 的網域。

取得發行人

取得已驗證使用者的簽發者清單。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

名稱
result.name string

名稱。

影像
result.image string

圖像。

Email
result.email string

電子郵件地址。

Description
result.description string

描述。

URL
result.url string

URL 位址。

員工
result.staff array of object
實體類型
result.staff.entityType string

實體的類型。

實體 ID
result.staff.entityId string

實體的識別碼。

實體類型
result.staff.userProfile.entityType string

實體類型。

實體 ID
result.staff.userProfile.entityId string

實體識別碼。

名字
result.staff.userProfile.firstName string

第一個名字。

姓氏
result.staff.userProfile.lastName string

姓氏。

電子郵件
result.staff.userProfile.emails array of object
Email
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 的網域。

取得發行者的徽章類別

取得單一發行者的 BadgeClasses 清單。 已驗證的使用者必須具有「簽發者」的擁有者、編輯者或員工狀態。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

Number
num string

要求結果分頁

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

名稱
result.name string

名稱。

影像
result.image string

圖像。

Description
result.description string

描述。

成就類型
result.achievementType string

成就的類型。

準則網址
result.criteriaUrl string

準則的 URL 位址。

標準敘述
result.criteriaNarrative string

標準的敘述。

坐標系
result.alignments array of object
目標名稱
result.alignments.targetName string

目標的名稱。

目標網址
result.alignments.targetUrl string

目標的 URL 位址。

目標描述
result.alignments.targetDescription string

目標的描述。

目標 Framework
result.alignments.targetFramework string

目標的框架。

目標代碼
result.alignments.targetCode string

目標的程式碼。

Tags
result.tags array of string
總數
result.expires.amount string

金額。

持續時間
result.expires.duration string

持續時間。

Extensions
result.extensions string

擴展。

取得背包斷言詳細資訊

取得使用者背包中斷言的詳細資料。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

承諾
result.acceptance string

當徽章被接受時。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

待定。

取得集合

取得單一集合。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

名稱
result.name string

名稱。

Description
result.description string

描述。

所有者
result.owner string

業主。

分享網址
result.share_url string

共用的 URL 位址。

分享哈希
result.shareHash string

共用的雜湊。

發布
result.published boolean

是否發布。

Assertions
result.assertions array of object
實體類型
result.assertions.entityType string

實體的類型。

實體 ID
result.assertions.entityId string

實體的識別碼。

開啟徽章 ID
result.assertions.openBadgeId string

Open 徽章的識別碼。

創建於
result.assertions.createdAt string

建立時。

作者
result.assertions.createdBy string

創建者。

徽章類別
result.assertions.badgeclass string

徽章類別。

BadgeClass 開啟徽章識別碼
result.assertions.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.assertions.issuer string

發行人。

簽發者開啟徽章ID
result.assertions.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.assertions.badgeclassName string

BadgeClass 的名稱。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

取得集合

獲取收藏列表。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

名稱
result.name string

名稱。

Description
result.description string

描述。

所有者
result.owner string

業主。

分享網址
result.share_url string

共用的 URL 位址。

分享哈希
result.shareHash string

共用的雜湊。

發布
result.published boolean

是否發布。

Assertions
result.assertions array of object
實體類型
result.assertions.entityType string

實體的類型。

實體 ID
result.assertions.entityId string

實體的識別碼。

開啟徽章 ID
result.assertions.openBadgeId string

Open 徽章的識別碼。

創建於
result.assertions.createdAt string

建立時。

作者
result.assertions.createdBy string

創建者。

徽章類別
result.assertions.badgeclass string

徽章類別。

BadgeClass 開啟徽章識別碼
result.assertions.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.assertions.issuer string

發行人。

簽發者開啟徽章ID
result.assertions.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.assertions.badgeclassName string

BadgeClass 的名稱。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

在使用者的背包中取得判斷提示

取得已驗證使用者背包中的斷言清單。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.badgeclassName string

BadgeClass 的名稱。

將斷言上傳到背包

將新的主張上傳到使用者的背包。

參數

名稱 機碼 必要 類型 Description
徽章類別
badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。 .

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

身份
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

擴展。

Badge類別名稱
badgeclassName string

BadgeClass 的名稱。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.badgeclassName string

BadgeClass 的名稱。

將斷言匯入背包

將新的主張匯入使用者的背包。

參數

名稱 機碼 必要 類型 Description
URL
url string

符合 OpenBadge 規範徽章的 URL。

影像
image string

Base64 編碼的烘焙 OpenBadge 映像。

斷言
assertion object

符合 OpenBadge 規範的 JSON。

建立 BadgeClass

建立新的 BadgeClass。

參數

名稱 機碼 必要 類型 Description
Number
num integer

要求結果分頁

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。 .

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

名稱
name string

名稱。

影像
image string

圖像。

Description
description string

描述。

成就類型
achievementType string

成就的類型。

準則網址
criteriaUrl string

條件的 URL。

標準敘述
criteriaNarrative string

標準的敘述。

目標名稱
targetName string

目標的名稱。

目標網址
targetUrl string

目標的 URL。

目標描述
targetDescription string

目標的描述。

目標 Framework
targetFramework string

目標的框架。

目標代碼
targetCode string

目標的程式碼。

Tags
tags array of string
總數
amount string

金額。

持續時間
duration string

持續時間。

Extensions
extensions string

擴展。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

名稱
result.name string

名稱。

影像
result.image string

圖像。

Description
result.description string

描述。

成就類型
result.achievementType string

成就的類型。

準則網址
result.criteriaUrl string

準則的 URL 位址。

標準敘述
result.criteriaNarrative string

標準的敘述。

坐標系
result.alignments array of object
目標名稱
result.alignments.targetName string

目標的名稱。

目標網址
result.alignments.targetUrl string

目標的 URL 位址。

目標描述
result.alignments.targetDescription string

目標的描述。

目標 Framework
result.alignments.targetFramework string

目標的框架。

目標代碼
result.alignments.targetCode string

目標的程式碼。

Tags
result.tags array of string
總數
result.expires.amount string

金額。

持續時間
result.expires.duration string

持續時間。

Extensions
result.extensions string

擴展。

建立 BadgeUser 帳戶

建立 BadgeUser 帳戶和個人資料。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

實體類型
entityType string

實體的類型。

實體 ID
entityId string

實體的識別碼。

名字
firstName string

第一個名字。

姓氏
lastName string

姓氏。

實體類型
entityType string

實體的類型。

實體 ID
entityId string

實體的識別碼。

Email
email 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
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

名字
result.firstName string

第一個名字。

姓氏
result.lastName string

姓氏。

電子郵件
result.emails array of object
實體類型
result.emails.entityType string

實體的類型。

實體 ID
result.emails.entityId string

實體的識別碼。

Email
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

收件者。

建立發行者

建立新的發行者。

參數

名稱 機碼 必要 類型 Description
作者
createdBy string

誰創造的。

名稱
name string

名稱。

影像
image string

圖像。

Email
email string

電子郵件地址。

Description
description string

描述。

URL
url string

URL 位址。

實體類型
entityType string

實體的類型。

實體 ID
entityId string

實體的識別碼。

用戶資料
userProfile string

使用者的設定檔。

User
user string

使用者。

Role
role string

角色。

Extensions
extensions string

擴展。

Badgr 網域
badgrDomain string

Badgr 的網域。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

名稱
result.name string

名稱。

影像
result.image string

圖像。

Email
result.email string

電子郵件地址。

Description
result.description string

描述。

URL
result.url string

URL 位址。

員工
result.staff array of object
實體類型
result.staff.entityType string

實體的類型。

實體 ID
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

建立與簽發者相關聯的新 BadgeClass。 已驗證的使用者必須具有「簽發者」的擁有者、編輯者或員工狀態。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。 .

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

名稱
name string

名稱。

影像
image string

圖像。

Description
description string

描述。

成就類型
achievementType string

成就的類型。

準則網址
criteriaUrl string

條件的 URL。

標準敘述
criteriaNarrative string

標準的敘述。

目標名稱
targetName string

目標的名稱。

目標網址
targetUrl string

目標的 URL。

目標描述
targetDescription string

目標的描述。

目標 Framework
targetFramework string

目標的框架。

目標代碼
targetCode string

目標的程式碼。

Tags
tags array of string
總數
amount string

金額。

持續時間
duration string

持續時間。

Extensions
extensions string

擴展。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

名稱
result.name string

名稱。

影像
result.image string

圖像。

Description
result.description string

描述。

成就類型
result.achievementType string

成就的類型。

準則網址
result.criteriaUrl string

準則的 URL 位址。

標準敘述
result.criteriaNarrative string

標準的敘述。

坐標系
result.alignments array of object
目標名稱
result.alignments.targetName string

目標的名稱。

目標網址
result.alignments.targetUrl string

目標的 URL 位址。

目標描述
result.alignments.targetDescription string

目標的描述。

目標 Framework
result.alignments.targetFramework string

目標的框架。

目標代碼
result.alignments.targetCode string

目標的程式碼。

Tags
result.tags array of string
總數
result.expires.amount string

金額。

持續時間
result.expires.duration string

持續時間。

Extensions
result.extensions string

擴展。

建立集合

建立新集合。

參數

名稱 機碼 必要 類型 Description
實體類型
entityType string

實體的類型。

實體 ID
entityId string

實體的識別碼。

名稱
name string

名稱。

Description
description string

描述。

所有者
owner string

業主。

分享網址
share_url string

共用的 URL 位址。

分享哈希
shareHash string

共用的雜湊。

發布
published boolean

是否發布。

徽章類別
badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

身份
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

擴展。

Badge類別名稱
badgeclassName string

BadgeClass 的名稱。

創建於
createdAt string

創建於。

作者
createdBy string

誰創造的。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

名稱
result.name string

名稱。

Description
result.description string

描述。

所有者
result.owner string

業主。

分享網址
result.share_url string

共用的 URL 位址。

分享哈希
result.shareHash string

共用的雜湊。

發布
result.published boolean

是否發布。

Assertions
result.assertions array of object
實體類型
result.assertions.entityType string

實體的類型。

實體 ID
result.assertions.entityId string

實體的識別碼。

開啟徽章 ID
result.assertions.openBadgeId string

Open 徽章的識別碼。

創建於
result.assertions.createdAt string

建立時。

作者
result.assertions.createdBy string

創建者。

徽章類別
result.assertions.badgeclass string

徽章類別。

BadgeClass 開啟徽章識別碼
result.assertions.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.assertions.issuer string

發行人。

簽發者開啟徽章ID
result.assertions.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.assertions.badgeclassName string

BadgeClass 的名稱。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

從背包中刪除斷言

從使用者的背包中移除判斷提示。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

恢復帳戶

恢復帳戶並設置新密碼。

參數

名稱 機碼 必要 類型 Description
代幣
token string

在復原電子郵件中收到的權杖。

密碼
password string

要使用的新密碼。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result

撤銷 AccessToken

撤銷使用者的 AccessToken。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

撤銷判斷提示

撤銷判斷。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼

撤銷原因
revocation_reason string

撤銷此斷言的原因

撤銷多個判斷提示

撤銷多個收件者的多個宣告。

參數

名稱 機碼 必要 類型 Description
徽章類別
badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。 .

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

身份
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

擴展。

Badge類別名稱
badgeclassName string

BadgeClass 的名稱。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.badgeclassName string

BadgeClass 的名稱。

擷取簽發者權杖

擷取發行者權杖。

參數

名稱 機碼 必要 類型 Description
body
body True

傳回

response
AccessToken

更新 Backpack 中的宣告接受

更新使用者背包中主張的接受程度。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

承諾
acceptance string

接受。

徽章類別
badgeclass string

可賺取徽章的定義。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。 .

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

身份
identity string

身分識別。

類型
type string

型別。

雜湊
hashed boolean

是否經過雜湊處理。

純文字身分識別
plaintextIdentity string

明文中的標識。

發佈日期
issuedOn string

當發布時。

記述
narrative string

頒發徽章的敘述。

URL
url string

URL 位址。

記述
narrative string

頒發徽章的敘述。

過期
expires string

到期時。

等待中
pending string

待定。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

承諾
result.acceptance string

當徽章被接受時。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

待定。

更新 BadgeClass

更新現有的 BadgeClass。 先前發出的 BadgeInstances 將不會更新。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。 .

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

名稱
name string

名稱。

影像
image string

圖像。

Description
description string

描述。

成就類型
achievementType string

成就的類型。

準則網址
criteriaUrl string

條件的 URL。

標準敘述
criteriaNarrative string

標準的敘述。

目標名稱
targetName string

目標的名稱。

目標網址
targetUrl string

目標的 URL。

目標描述
targetDescription string

目標的描述。

目標 Framework
targetFramework string

目標的框架。

目標代碼
targetCode string

目標的程式碼。

Tags
tags array of string
總數
amount string

金額。

持續時間
duration string

持續時間。

Extensions
extensions string

擴展。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

名稱
result.name string

名稱。

影像
result.image string

圖像。

Description
result.description string

描述。

成就類型
result.achievementType string

成就的類型。

準則網址
result.criteriaUrl string

準則的 URL 位址。

標準敘述
result.criteriaNarrative string

標準的敘述。

坐標系
result.alignments array of object
目標名稱
result.alignments.targetName string

目標的名稱。

目標網址
result.alignments.targetUrl string

目標的 URL 位址。

目標描述
result.alignments.targetDescription string

目標的描述。

目標 Framework
result.alignments.targetFramework string

目標的框架。

目標代碼
result.alignments.targetCode string

目標的程式碼。

Tags
result.tags array of string
總數
result.expires.amount string

金額。

持續時間
result.expires.duration string

持續時間。

Extensions
result.extensions string

擴展。

更新徽章使用者

更新 BadgeUser 的帳戶。 使用 entityId 'self' 來更新已驗證使用者的設定檔

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

實體類型
entityType string

實體的類型。

實體 ID
entityId string

實體的識別碼。

名字
firstName string

第一個名字。

姓氏
lastName string

姓氏。

實體類型
entityType string

實體的類型。

實體 ID
entityId string

實體的識別碼。

Email
email 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
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

名字
result.firstName string

第一個名字。

姓氏
result.lastName string

姓氏。

電子郵件
result.emails array of object
實體類型
result.emails.entityType string

實體的類型。

實體 ID
result.emails.entityId string

實體的識別碼。

Email
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

收件者。

更新斷言

更新判斷提示。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

徽章類別
badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。 .

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

身份
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

擴展。

Badge類別名稱
badgeclassName string

BadgeClass 的名稱。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.badgeclassName string

BadgeClass 的名稱。

更新發行人

更新單一發行者。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

作者
createdBy string

誰創造的。

名稱
name string

名稱。

影像
image string

圖像。

Email
email string

電子郵件地址。

Description
description string

描述。

URL
url string

URL 位址。

實體類型
entityType string

實體的類型。

實體 ID
entityId string

實體的識別碼。

用戶資料
userProfile string

使用者的設定檔。

User
user string

使用者。

Role
role string

角色。

Extensions
extensions string

擴展。

Badgr 網域
badgrDomain string

Badgr 的網域。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

名稱
result.name string

名稱。

影像
result.image string

圖像。

Email
result.email string

電子郵件地址。

Description
result.description string

描述。

URL
result.url string

URL 位址。

員工
result.staff array of object
實體類型
result.staff.entityType string

實體的類型。

實體 ID
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 的網域。

更新集合

更新背包中的收藏。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

實體類型
entityType string

實體的類型。

實體 ID
entityId string

實體的識別碼。

名稱
name string

名稱。

Description
description string

描述。

所有者
owner string

業主。

分享網址
share_url string

共用的 URL 位址。

分享哈希
shareHash string

共用的雜湊。

發布
published boolean

是否發布。

徽章類別
badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

身份
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

擴展。

Badge類別名稱
badgeclassName string

BadgeClass 的名稱。

創建於
createdAt string

創建於。

作者
createdBy string

誰創造的。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

Results
result array of object

結果陣列。

實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

名稱
result.name string

名稱。

Description
result.description string

描述。

所有者
result.owner string

業主。

分享網址
result.share_url string

共用的 URL 位址。

分享哈希
result.shareHash string

共用的雜湊。

發布
result.published boolean

是否發布。

Assertions
result.assertions array of object
實體類型
result.assertions.entityType string

實體的類型。

實體 ID
result.assertions.entityId string

實體的識別碼。

開啟徽章 ID
result.assertions.openBadgeId string

Open 徽章的識別碼。

創建於
result.assertions.createdAt string

建立時。

作者
result.assertions.createdBy string

創建者。

徽章類別
result.assertions.badgeclass string

徽章類別。

BadgeClass 開啟徽章識別碼
result.assertions.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.assertions.issuer string

發行人。

簽發者開啟徽章ID
result.assertions.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.assertions.badgeclassName string

BadgeClass 的名稱。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

發出判斷提示

向收件者發出新的宣告。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

徽章類別
badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。 .

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

身份
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

擴展。

Badge類別名稱
badgeclassName string

BadgeClass 的名稱。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.badgeclassName string

BadgeClass 的名稱。

發出判斷提示

向單一收件者發出宣告。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

徽章類別
badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。 .

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

身份
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

擴展。

Badge類別名稱
badgeclassName string

BadgeClass 的名稱。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.badgeclassName string

BadgeClass 的名稱。

發行多個 BadgeClass

將相同 BadgeClass 的多個複本發出給多個收件者。

參數

名稱 機碼 必要 類型 Description
實體 ID
entity_id True string

實體的識別碼。

徽章類別
badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。 .

簽發者開啟徽章ID
issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

身份
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

擴展。

Badge類別名稱
badgeclassName string

BadgeClass 的名稱。

傳回

名稱 路徑 類型 Description
Description
status.description string

描述。

成功
status.success boolean

是否成功。

結果
result array of object
實體類型
result.entityType string

實體的類型。

實體 ID
result.entityId string

實體的識別碼。

開啟徽章 ID
result.openBadgeId string

Open 徽章的識別碼。

創建於
result.createdAt string

建立時。

作者
result.createdBy string

誰創造的。

徽章類別
result.badgeclass string

可賺取徽章的定義。

BadgeClass 開啟徽章識別碼
result.badgeclassOpenBadgeId string

BadgeClass 的 Open Badge 識別碼。

Issuer
result.issuer string

創建/提供徽章並將其頒發給收入者的個人或組織。

簽發者開啟徽章ID
result.issuerOpenBadgeId string

發行者 Open Badge 的識別碼。

影像
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

擴展。

Badge類別名稱
result.badgeclassName string

BadgeClass 的名稱。

要求帳戶復援電子郵件

要求使用者的帳戶復原電子郵件。

參數

名稱 機碼 必要 類型 Description
Email
email string

要傳送備援電子郵件的檔案電子郵件地址。

定義

AccessToken