APIs References

Contribution Guidelines    Edit | Report

Bulk Upload Service APIs

  • Bulk Upload Service APIs The Bulk Upload API resources perform operations related to uploads on the Sunbird Platform. The Bulk Upload API(s) operations include uploads and updations.

Content APIs

  • Content APIs The Content API resources perform operations related to Content on the Sunbird Platform. The operations include the basic CRUD (Create, Read, Update and Delete) operations and other operations such as upload, publish.

Course Batch Management APIs

  • Course Batch Management APIs The Course Batch Management API resources perform operations related to management of batches for courses on the Sunbird Platform. The basic operations include creation, updation, joining, listing.

Data Sync APIs

  • Data Sync APIs The Data synchronization API resources perform operations related to data on the Sunbird Platform. Data synchronization API(s) are responsible for establishing consistency among data from a source to a target data storage and vice versa with continuous harmonization of the data over time.

Metrics APIs

  • Metrics APIs The Metrics API resources analyze sunbird’s overall performance and efficiency.These resources perform operations related to the metrics on the Sunbird Platform. The metrics resource performs various operations related to content consumption, content snapshot aggregation.

Notification APIs

  • Notification APIs The Email API resources provides the notification mechanism for all the users on Sunbird .The Resource notifies users officially about something on Sunbird.

Organization Management APIs

  • Organisation Management APIs The Organisation Management API resources perform operations related to management of Organisation on the Sunbird Platform. The basic operations include creation, updation, joining, approving.

User APIs

  • User APIs The User API resources perform operations related to the Users on the Sunbird Platform. The basic operations include Creation, Updation, Reading & Searching.

Announcement APIs

  • Announcements APIs The Announcements API resources on allow users to communicate with other users and post information about various related topics. Announcements are designed to allows the admins to broadcast information out to a specific user or to an entire group of users.

Framework APIs

  • Framework APIs The Framework API resources is basically a supporting data structure which serves as a template. It can be used in places where the structure remains the same but only the usage changes are per requirement. These resources are used to create, update, search frameworks, channels, catergories, terms.

Audience APIs

  • Audience APIs Audience API resources allow to get a count of users from a particular location.

Badges APIs

  • Badges APIs The Badge API resources are used to provide recognition for skills and achievements that are earned by a user.

D.I.A.L APIs

  • D.I.A.L APIs The D.I.A.L Code (Digital Infrastructure for Augmented Learning) API resources are used for energising the textbooks.D.I.A.L code allows textbook creators to tag various pages and topics in a flexible manner using the DIAL codes (in QR code format) and these codes can be linked with digital content, thus providing easy access for the end users and a seamless physical to digital transition.

Push Notification APIs

  • Push Notification APIs Push notification API Resource is a cross-platform solution for sending push notifications on Android, iOS, and web applications.

Geo Location APIs

  • Geo Location APIs Geo-location resources API classifies the organisations on the basis of their location.

Master Key APIs

  • Master Key APIs The master key resources API provides access to the API and other resources with authentication protection, without authenticating it against our authentication provider.

User Notes APIs

  • User Notes APIs The User Notes API resources enables users to take notes on the Sunbird Platform. The basic operations include Creation, Updation,Reading & deleting.

Object APIs

  • Object APIs The Object API resource is used to store the data into sunbird. - Primarily supports announcements for data storage and other related operation. - Allows you to define your own repository inside sunbird and use the same to perform operations on data. - an object can be used in different contexts, it is depends on how it is implemented

Page APIs

  • Page APIs The Page resources APIs are used to set up the current page, change settings, and configure how things will be displayed to the user.

Edit | Report