BCdiploma Knowledge BaseBCdiploma Knowledge Base
User guide
Technical guide
API
Terms and Data
  • English
  • Français
User guide
Technical guide
API
Terms and Data
  • English
  • Français
  • API

    • How to use BCdiploma API
    • Automate issuing process
    • Deletions and revocations
    • Update
    • Certificate Template Management
    • Learning Pathway Management
    • Download
    • Data Export
    • Miscellaneous APIs
    • Management of errors

Learning Pathway Management

Create or Update a Learning Pathway

A learning pathway is defined directly within the configuration of a parent certificate template. To create a pathway, add a meta_pathway entry to the parent template's JSON, then update it via a PUT call to the endpoint [API-URL]/issuer/:issuer/template/:template.

Tips

The "key" property defines the join field used to link the certificates that make up the pathway. If omitted, the default value ^Email¤ is applied automatically.

The def property contains the list of child templates included in the pathway, identified by their id:

"meta_pathway": {
  "def": [
    {
      "id": "1x30"
    },
    {
      "id": "1x31"
    },
    {
      "id": "1x3A"
    }
  ]
}

Using Reference Tables to Filter Pathway Templates

It is possible to condition the inclusion of a child template in a pathway based on the value of a given placeholder, provided that placeholder is an entry in a reference table.

For example, if the join is based on the value of the ^formation¤ placeholder, which is an entry in the ref_formation reference table, the syntax becomes:

"meta_pathway": {
  "key": "^Email¤",
  "def": [
    {
      "id": "1x01",
      "formation": [
        "Australian Major Projects Leadership Academy",
        "Creativity and Design Thinking"
      ]
    },
    {
      "id": "1x02",
      "formation": [
        "Development & Marketing",
        "Digital Transformation"
      ]
    },
    {
      "id": "1x03",
      "formation": [
        "Development & Marketing",
        "Creativity and Design Thinking",
        "Catalyzing Digital Transformation"
      ]
    },
    {
      "id": "1x06",
      "formation": [
        "Catalyzing Digital Transformation",
        "Medical Statistics"
      ]
    }
  ]
}

In this example, template 1x01 will only be included in the pathway if the value of the formation placeholder is Australian Major Projects Leadership Academy or Creativity and Design Thinking.

Remove a Template from a Pathway

To remove a child template from a pathway, delete its entry from the def list and update the parent template via a PUT call to the endpoint [API-URL]/issuer/:issuer/template/:template.

Warning

When a template is added to a pathway as a child, the meta_pw_key tag is automatically assigned to it. This tag is not removed if the template is later removed from the pathway, in order to avoid invalidating already-published certificates.

Prev
Certificate Template Management
Next
Download