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)
{{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)
{{host}}/api/user/v1/signup (route: /v1/user/signup)	{{host}}/api/user/v2/signup (route: /v2/user/signup)
{{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)
{{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)
{{host}}/api/user/v1/get (route: /v1/user/get/:idType)	{{host}}/api/user/v2/get (route: /v2/user/get/:idType)
{{host}}/api/user/v1/exists (route: /v1/user/exists/:key/:value)	{{host}}/api/user/v2/exists (route: /v2/user/exists/:key/:value)
{{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)
{{host}}/api/user/v1/role/assign (route: /v1/user/assign/role)	{{host}}/api/user/v2/role/assign (route: /v2/user/assign/role)
{{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)
{{host}}/api/otp/v1/generate (route: /v1/otp/generate)	{{host}}/api/otp/v2/generate (route: /v2/otp/generate)
{{host}}/api/otp/v1/verify (route: /v1/otp/verify)	{{host}}/api/otp/v2/verify (route: /v2/otp/verify)
{{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)

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)		Use collection create API from KNOWLG BB. (https://knowlg.sunbird.org/learn/product-and-developer-guide/content-service-1/content-api)
route: /v1/user/content/state	{{host}}/api/course/v1/content/state/update (route: /v1/content/state/update)