Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Sunbird DIAL API(s)_v1
Introduction
POST
List DIAL codes
POST
Generate DIAL code
POST
Get DIAL code
POST
Search DIAL code
POST
Publish DIAL code
POST
Create Publisher
GET
Get Publisher
PATCH
Update Publisher
GET
Get Process Status
PATCH
Update DIAL Code Context
GET
Get DIAL Code Context

Sunbird DIAL API(s)_v1

DIAL refers to Digital Infrastructure for Augmented learning. DIAL powers the discovery of digital resources using physical
artefacts like QR codes, can be extended to other physical artefacts.
DIAL code does the loose binding of digital assets with physical
artefacts.

Note: Give the reference link to DIAL API tests here. Before we update this, we have to publish the DIAL API tests documentation.

DIAL code usage workflow

  • Reserve: Reserve the DIAL codes by requesting/blocking specific number.
  • Link: Link the DIAL code to any digital or physical asset.
  • Update: Update the DIAL code with context, publisher etc.
  • Generate: Generate the QR codes for the linked DIAL codes.
  • Scan: Scan the physical/digital QR code to discover the specific assets linked to it.

Schema

PropertyDescription
IdentifierUnique DIAL code generated
publisherPublisher of the DIAL code who is going to print this DIAL code on physical/digital
batchCodeThe DIAL codes are generated against the batch to identify on what process it was generated
statusStatus of the DIAL code.
ex: Draft, Live
generatedOnTime when the DIAL code is generated in the system
publishedOnTime when the DIAL code status is changed to "Live".

DIAL API tests

https://documenter.getpostman.com/view/4214340/UzBvGNaX

Loading