Sunbird Lern
AskDot
  • LEARN
    • Overview
    • Functional Capabilities
    • Technical Architecture
      • Technical Architecture Diagram
      • Tech Stack
    • Dependencies
    • Product Roadmap
  • USE
    • Overview
    • Release Notes
      • Release V 8.0.0 (Ongoing)
      • Release V 7.0.0
      • Release V 5.4.0
      • Release V 5.3.0
      • Release V 5.2.0
      • Release V 5.1.0
      • Release V 5.0.1
      • Release V 5.0.0
      • Release V 4.10.0
      • Release V 4.9.0
      • Release V 4.8.0
      • Release V 4.7.0
    • Developer Guide
      • USER & ORG SERVICE
        • Features/Core capabilities
        • Architecture
          • Code Flow
        • Developer Installation
          • System Requirements
          • Tech Stack
          • Installation Guide
          • Keycloak Local setup
          • Additional Installation Dependencies:
          • Source Code
          • Installation Configuration
        • Data Models
          • Cassandra
            • Data Dictionary
              • User
              • Organisation
              • System Settings
              • Role
              • Bulk Upload Process
              • Tenant Preference
              • Cassandra Migration Version
              • User Consent
              • Email Template
              • OTP
              • Page Management (LMS Service)
              • Location
              • User Notes
              • Deprecated
          • Elastic Search
          • Redis
        • APIs
          • User Management
            • User Deletion API
            • Ownership Transfer API
          • Organisation Management
          • Location Management
          • Consent Management
          • OTP Services
          • Tenant Configurations
          • Bulk Upload
          • System Settings
          • API Management Service
          • Data Sync
          • Notification APIs
        • Flink Jobs
          • User Cache Updater
          • User Deletion Cleanup Flink Job
          • Ownership Transfer Flink Job
        • Reports
          • Standard Exhaust
            • State Admin Geo report
            • State Admin Report
          • Other Jobs
            • User Cache Indexer Job
            • Delete Users Assets Report
          • Data Products Developer Installation
            • System Requirements
            • Tech Stack
            • Installation Dependencies
            • Local installation of data-products
            • Server setup Guide
            • Installation Configuration
            • Data-product creation guide
            • Troubleshooting a data-product
        • Logs, Telemetry Events
        • Configuration
          • Functional Configurations
          • System Settings
          • Email Configuration
          • SMS Configuration
          • OTP based SMS Configuration
        • Roles
          • System Roles
          • User Roles
          • RBAC
        • Dependencies
        • Keycloak on Sunbird
        • How to Guide
          • Create Organization
          • Create User
          • Add new user type & location
        • Single Sign-on with Sunbird
        • Caching and Denormalising User Metadata
          • ETLUserCacheUpdaterJob
          • UserCacheUpdaterFlinkJob
        • Unit Tests and Code Coverage
        • FAQs
      • LMS(BATCH) SERVICE
        • Features/Core Capabilities
        • Architecture
          • Code Flow
        • Developer Installation
          • System Requirements
          • Tech Stack
          • Installation Guide
          • Source Code
        • Data Models
          • Cassandra
            • Data Dictionary
          • ElasticSearch
          • Redis
        • APIs
        • Flink Jobs
          • Merge User Courses
          • Relation Cache Updater
          • Activity Aggregate Updater
          • Assessment Aggregator
          • Enrolment Reconciliation
          • Collection Certificate Pre-Processor
          • Collection Certificate Generator
        • Reports
          • On-Demand Exhaust
            • Response Exhaust
            • User Info Exhaust
            • Progress Exhaust
          • Other Jobs
            • Collection Summary Job
            • Course Batch Status Updater Job
            • Cassandra Migrator Job
            • Score Metric Migration Job
            • Assessment Score Correction Job
            • Collection Reconciliation Job
            • Course Enrollment Job
            • Course Consumption Job
        • Logs, Telemetry Events
        • Configuration
          • System Configuration
          • Functional Configuration
        • Dependencies
        • Certificate Registry and Credentialing using Sunbird-RC
          • Configuring PublicKey in Sunbird-RC
          • Server Setup guide for Sunbird-RC
          • API Guide For Sunbird-RC
        • Certificate Flow
          • Certificates Creation and Configuration
        • FAQs
      • GROUPS
        • Features/Core Capabilities
        • Architecture
          • Code Flow
        • Developer Installation
          • System Requirements
          • Tech Stack
          • Installation Guide
          • Source Code
          • Installation Configuration
        • Data Models
          • Cassandra
            • Data Dictionary
          • Redis
        • APIs
          • Create Group
        • Logs, Telemetry Events
          • UI Telemetry Events
          • Service Telemetry Events
        • Configuration
          • Functional Configurations
        • Design References
        • Dependencies
        • Unit Tests and Code Coverage
      • NOTIFICATION SERVICE
        • Features/Core Capabilities
        • Architecture
          • Code Flow
        • Developer Installation
          • System Requirements
          • Tech Stack
          • Installation Guide
          • Source Code
          • Installation Configuration
        • Data Models
          • Data Dictionary
        • APIs
        • Flink Jobs
        • Logs, Telemetry Events
        • Configuration
          • Functional Configurations
        • Dependencies
        • Unit Tests and Code Coverage
      • DISCUSSION FORUM
        • Features/Core capabilities
        • Architecture
          • Code Flow
        • Developer Installation
          • System Requirements
          • Tech Stack
          • Installation Guide
            • Nodebb setup
            • Discussion Middleware Setup
            • Discussion Middleware
            • Discussion forum integration with any application
            • Discussion-UI setup along with demo application.
            • Sunbird-lern portal for DF
          • Source Code
        • APIs
          • Category APIs
          • User APIs
          • Post APIs
          • Topic APIs
          • Forum APIs
        • Context Schema
        • Configurations
          • Nodebb Admin panel settings
          • Discussion MW & Nodebb System Config
        • Telemetry Events
        • Dependencies
      • ML SERVICE
        • DATA PIPELINE (Flink Jobs)
          • Program User Info
            • Component Diagram
            • Data Model
            • Folder Structure
          • Ml User Delete
            • Component Diagram
            • Data Model
            • Folder Structure
        • DATA PRODUCTS
          • Program Exhaust
            • Component Diagram
            • Folder Structure
    • Server Installation
    • Dependency Setup
    • Deprecation
      • Release-5.4.0
    • Jenkins Jobs
    • Release Calendar
    • Learn More
      • Tech References
      • Telemetry Processing
      • Data Dictionary
        • Sample Data
      • Delete User Functionality
      • Asset Ownership Transfer
    • FAQs
  • Engage
    • Discuss
    • Contribute to Sunbird Lern
    • Raise an Issue
    • Contribution Guidelines
Powered by GitBook
On this page
  • User-Org Service:
  • LMS Course-Batch Service:

Was this helpful?

Edit on GitHub
  1. USE
  2. Deprecation

Release-5.4.0

Documentation about list of APIs deprecated or planned for deprecation and their corresponding new/alternative APIs available.

List of APIs planned for deprecation by Oct 2023

User-Org Service:

APIs planned for Deprecation
Alternate API
Remarks

{{host}}/api/user/v1/create, {{host}}/api/user/v2/create, {{host}}/api/user/v3/create (routes: /v1/user/create, /v2/user/create, /v3/user/create)

{{host}}/api/user/v1/sso/create

(route: /v1/ssouser/create)

Decommissioned in release-8.0.0

{{host}}/api/user/v1/managed/create, {{host}}/api/user/v4/create (routes: /v4/user/create, /v1/manageduser/create)

{{host}}/api/user/v2/managed/create (route:/v2/manageduser/create)

Decommissioned in release-8.0.0

{{host}}/api/user/v1/signup (route: /v1/user/signup)

{{host}}/api/user/v2/signup (route: /v2/user/signup)

Decommissioned in release-8.0.0

{{host}}/api/user/v1/update, {{host}}/api/user/v2/update (routes: /v1/user/update, /v2/user/update)

{{host}}/api/user/v3/update (route: /v3/user/update)

Decommissioned in release-8.0.0

{{host}}/api/user/v1/read/{{uid}}, {{host}}/api/user/v2/read/{{uid}}, {{host}}/api/user/v3/read/{{uid}},

{{host}}/api/user/v4/read/{{uid}} (routes: /v1/user/read/:uid, /v2/user/read/:uid, /v3/user/read/:uid, /v4/user/read/:uid)

{{host}}/api/user/v5/read/{{uid}} (route: /v5/user/read/:uid)

Decommissioned in release-8.0.0

{{host}}/api/user/v1/get

(route: /v1/user/get/:idType)

{{host}}/api/user/v2/get

(route: /v2/user/get/:idType)

Decommissioned in release-8.0.0

{{host}}/api/user/v1/exists

(route: /v1/user/exists/:key/:value)

{{host}}/api/user/v2/exists

(route: /v2/user/exists/:key/:value)

Decommissioned in release-8.0.0

{{host}}/api/user/v1/search, {{host}}/api/user/v2/search (routes: /v1/user/search, /v2/user/search)

{{host}}/api/user/v3/search (route: /v3/user/search)

Decommissioned in release-8.0.0

{{host}}/api/user/v1/role/assign

(route: /v1/user/assign/role)

{{host}}/api/user/v2/role/assign

(route: /v2/user/assign/role)

Decommissioned in release-8.0.0

{{host}}/api/user/private/v1/assign/role

(route: /private/user/v1/assign/role)

(route: /private/user/v2/assign/role)

private v2 API is not publicly available for access

{{host}}/api/user/v1/consent/read

(route: /v1/user/consent/read)

{{host}}/api/user/v2/consent/read

(route: /v2/user/consent/read)

Decommissioned in release-8.0.0

{{host}}/api/otp/v1/generate

(route: /v1/otp/generate)

{{host}}/api/otp/v2/generate

(route: /v2/otp/generate)

Decommissioned in release-8.0.0

{{host}}/api/otp/v1/verify

(route: /v1/otp/verify)

{{host}}/api/otp/v2/verify

(route: /v2/otp/verify)

Decommissioned in release-8.0.0

{{host}}/api/user/v1/feed

(route: /v1/user/feed/:userId)

{{host}}/api/notification/v1/feed/read

(route: /v1/notification/feed/read/:userId)

{{host}}/api/user/feed/v1/create

(route: /v1/user/feed/create)

(route: /private/v1/user/feed/create)

{{host}}/api/user/feed/v1/update

(route: /v1/user/feed/upate)

{{host}}/api/notification/v1/feed/update

(route: /v1/notification/feed/update)

{{host}}/api/user/feed/v1/delete

(route: /v1/user/feed/delete)

{{host}}/api/notification/v1/feed/delete

(route: /v1/notification/feed/delete)

{{host}}/api/org/v1/ext/search, {{host}}/api/org/v1/search (route: /v1/org/search)

{{host}}/api/org/v2/search (route: /v2/org/search)

Decommissioned in release-8.0.0

LMS Course-Batch Service:

APIs planned for Deprecation
Alternate API
Remarks

{{host}}/api/data/v1/page/assemble, {{host}}/api/data/v1/page/create, {{host}}/api/data/v1/page/section/create, {{host}}/api/data/v1/page/read, {{host}}/api/data/v1/page/section/list, {{host}}/api/data/v1/page/section/read, {{host}}/api/data/v1/page/update, {{host}}/api/data/v1/page/section/update, {{host}}/api/data/v1/dial/assemble (routes: /v1/page/create, /v1/page/update, /v1/page/read/:pageId, /v1/page/all/settings, /v1/page/assemble, /v1/dial/assemble, /v1/page/section/create, /v1/page/section/update, /v1/page/section/list, /v1/page/section/read/:sectionId)

No alternate APIs available or planned for this set of APIs

{{host}}/api/course/v1/create (route: /v1/course/create)

route: /v1/user/content/state

{{host}}/api/course/v1/content/state/update (route: /v1/content/state/update)

PreviousDeprecationNextJenkins Jobs

Last updated 1 year ago

Was this helpful?

Use from KNOWLG BB. ()

collection create API
https://knowlg.sunbird.org/learn/product-and-developer-guide/content-service-1/content-api