Sign in
latestOpenAPI 3.0.12026-08-1091181421.2 KB

44eb39b4bd65

BadgeClasses

Duplicate a BadgeClass

Create a duplicate of the original BadgeClass with a new name

post/v2/badgeclasses/{idOrEntityId}/duplicate

Path parameters

idOrEntityIdstring required

Request body

newNamestring required

The new name for the duplicate badgeclass

Example request

{
  "newName": "Badgeclass Copy"
}

Response

BadgeClass created

achievementTypestring nullable

The type of achievement

archivalNotestring nullable
archivedboolean nullable
archivedDatestring date-time nullable
createdAtstring date-time nullable

Timestamp when the BadgeClass was created

createdBystring nullable

Entity ID of the user who created this BadgeClass

criteriaNarrativestring nullable

Markdown formatted description of the criteria

criteriaUrlstring uri nullable

External URL that describes in a human-readable format the criteria for the BadgeClass

descriptionstring required

Short description of the badge class

entityIdstring required

Unique identifier for this BadgeClass

entityTypestring required
extensionsobject required
idstring required

Internal ID for this BadgeClass

imagestring required

Image of the badge class. Most commonly an URL.

imageAltTextstring nullable
imagePathstring nullable

Internal image path

issuerstring required

Entity ID of the issuer

issuerOpenBadgeIdstring uri required

OB URL of the issuer

namestring required

Name of the badge class

openBadgeIdstring uri required

URL of the OpenBadge compliant json

originalJsonstring nullable

The original OB JSON if the badge class was exported

sourcestring nullable

The original source of the BadgeClass

sourceUrlstring nullable

The original URL of the BadgeClass if it was imported

tagsstring[] required

List of tags that describe the BadgeClass

Example response

{
  "achievementType": "Course",
  "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "entityId": "iOMWsaF1QbmMCofM54JlUg",
  "entityType": "BadgeClass",
  "expires": {
    "amount": 30
  },
  "id": "68e9d238c5afe622816febb3",
  "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
  "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
  "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
  "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
  "name": "Math Expert",
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
  "originalJson": "{}",
  "preferences": {
    "customPropertyValues": [
      {
        "propertyId": "67b32887e2a7a7d5f7adabf1"
      }
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "includeOnPublicPages": true
  },
  "source": "local",
  "sourceUrl": "https://example.com/badge-classes/1"
}