Sunbird DIAL API(s)_v1
Number of APIs: 11
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
| Property | Description |
|---|---|
| Identifier | Unique DIAL code generated |
| publisher | Publisher of the DIAL code who is going to print this DIAL code on physical/digital |
| batchCode | The DIAL codes are generated against the batch to identify on what process it was generated |
| status | Status of the DIAL code. ex: Draft, Live |
| generatedOn | Time when the DIAL code is generated in the system |
| publishedOn | Time when the DIAL code status is changed to Live. |
DIAL API tests
https://documenter.getQodex.com/view/4214340/UzBvGNaX
-
Generate DIAL code POST {{host}}/api/dialcode/v1/generate
-
Get DIAL code POST {{host}}/api/dialcode/v1/read
-
Search DIAL code POST {{host}}/api/dialcode/v1/search
-
Publish DIAL code POST {{host}}/api/dialcode/v1/publish/{{new_dialcode}}
-
Create Publisher POST {{host}}/api/dialcode/v1/publisher/create
-
Get Publisher GET {{host}}/api/dialcode/v1/publisher/read/{{publisherId}}
-
Update Publisher PATCH {{host}}/api/dialcode/v1/publisher/update/{{publisherId}}
-
Get Process Status GET {{host}}/api/dialcode/v1/process/status/{{processId}}
-
Update DIAL Code Context PATCH {{host}}/api/dialcode/v2/update/{{new_dialcode}}
-
Get DIAL Code Context GET {{host}}/api/dialcode/v2/read/{{new_dialcode}}