...
Sunbird generates a number of datasets for reporting purposes. Some of these are downloaded by users via the UI (the Course progress exhaust, for example), whereas others are used by the Sunbird portal to generate reports and charts, which can then be viewed by users. The portal also allows for download of the underlying data files that are used for chart creation via the UI.
There is a need stated for making all such datasets that are generated by SB to be made accessible via APIs. This will permit for these datasets to be used as per different requirements of pulled via APIs by the adopters, for usage in whatever additional manner they see fit - and enable them to create custom reports/ visualisations of their own.
As part of access to the datasets, the adopter should also be able to mark a dataset as Public or Private - determining whether a dataset can be accessed publicly using the API without any additional authorisation, or whether it needs additional approval from admins for access.
Dataset generation currently happens for:
...
Dataset generation within SB currently happens for:
Custom reports such as the course progress exhaust or the user PII data - these are generated by data products that run on a daily/ on-demand basis
Portal based reports and charts - these are datasets generated from Druid, and power the charts shown on the ‘admin dashboard’ of the portal. These are generated based on the frequency of the reports as configured.
Other custom data files such as Consent files and master data files (geo data, for example)
Sunbird needs to make all these datasets accessible via API, with different levels of access permissions, based on the sensitivity of the data that resides within the dataset. Some may be publicly accessible (having only anonymous data), some may require consent based access (say, files that have PII), and others may be restricted for access only to certain roles (say administrators only)
Sunbird should enable access based on configurations that can enable thisDataset download considerations:
Sunbird should enable an adopter to provision for data security - and allow access to datasets based on the nature of the data they contain. Consequently, a dataset that is not considered sensitive may be made available for public access, whereas sensitive data may require to be protected.
In order to enable different types of access, SB will support configurations that can make the datasets ‘PUBLIC’ or ‘PRIVATE’ - as the adopter may choose - this will determine whether a dataset can be accessed publicly using the API without any additional authorisation, or whether it needs additional approval from admins for access.
...
Problem Statement
As part of opening of DIKSHA Infrastructure to wider ecosystem, there is a need to provide access to open anonymized data to third party ecosystem players to develop custom solutions on top of DIKSHA.
...