APIs

API Documentation:

Refer to **** the below various API documentation related to all the different APIs that are being consumed with in all the batch jobs.

Course Batch Management APIs are listed below:

Course Enrolment APIs are listed below:

Course Progress APIs are listed below:

Course Batch Certificates APIs are listed below:

Group Activity Aggregator

Collection Summary

Collection Summary(https://staging.open-sunbird.org/report/v1/collection/summary)

POST

This API gives the collection summary, like the total number of enrolments, completion count, count of certificates issued.

Request Body

Name

Type

Description

request*

Object

filters*

Object

Search filters

collectionId*

String

Id of the collection

batchId*

String

Id of the batch

group_by

String Array

"state", "dist"

intervals

String

2019-09-23T00:00:00.000Z/2019-09-24T00:00:00.000Z" StartDate - Batch Start Date and Default EndDate - Current Date

{
  "result": {
    "collectionId": "", // Collection/CourseId
    "name": "", // Collection Name
    "batchId": "", // Batch Identifier
    "enrolmentCount": "",
    "completionCount": "",
    "certificatesIssuedCount": "",
    "summary": {  // Summary by state and district level
      "state": {
        "enrolmentCount": "",
        "completionCount": ""
      },
      "district": {
        "enrolmentCount": "",
        "completionCount": ""
      }
    }
  }
}

Page APIs

PreviousRedis NextFlink Jobs

Last updated 12 months ago

Was this helpful?

{host}/v1/jobrequest/submit

This API will internally call ‘/dataset/v1/request/submit’ API in SB-Obsrv ‘On Demand Data Exhaust API’, to submit the on demand exhaust job request. The job status will be in the submitted state.

This API should encrypt the password using auto generated encryption key and pass it in the exhaust API request if the security level is L2 or L3.
L1 and L4 do not need encryption keys.
Fetch the security level using tenant preference APIs to check this.
Configure the exhaust api base url and endpoints.

post

/api/course/v1/jobrequest/submit

Header parameters

x-authenticated-user-tokenstring

User token

Example: {{auth_token}}

Authorizationstring

API key

Example: {{kong_api_key}}

Content-Typestring

Example: application/json

x-channel-idstring

Organisation id of the requestor

Example: {{organisation_id}}

x-authenticated-useridstring

UserId of the requester - ORG_ADMIN, COURSE_MENTOR

Example: {{requested_user_id}}

Body

object

Example:

{"request":{"tag":"do_2137002173427875841205_01370023185341644821","requestedBy":"fca2925f-1eee-4654-9177-fece3fd6afc9","dataset":"response-exhaust","output_format":"csv","encryptionKey":"encryption-keyencryption-keyencryption-keyencryption-keyencryption-key","datasetConfig":{"batchId":"01370023185341644821"}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{host}}/api/course/v1/jobrequest/submit' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"tag":"do_2137002173427875841205_01370023185341644821","requestedBy":"fca2925f-1eee-4654-9177-fece3fd6afc9","dataset":"response-exhaust","output_format":"csv","encryptionKey":"encryption-keyencryption-keyencryption-keyencryption-keyencryption-key","datasetConfig":{"batchId":"01370023185341644821"}}}'

200

No body

Successful response

This API will internally call ‘/dataset/v1/request/list API in Obsrv ‘On Demand Data Exhaust API’, to list all the requests that are specific to a tag

get

/api/course/v1/jobrequest/list/{tag}

Path parameters

tagstringrequired

Header parameters

x-authenticated-user-tokenstring

User token

Example: {{auth_token}}

Authorizationstring

API Key

Example: {{kong_api_key}}

Content-Typestring

Example: application/json

x-channel-idstring

Organisation id of the requestor

Example: {{organisation_id}}

x-authenticated-useridstring

UserId of the requester - ORG_ADMIN, COURSE_MENTOR

Example: {{requested_user_id}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{host}}/api/course/v1/jobrequest/list/{tag}'

200

No body

Successful response

Add certificate template to a course batch

This API allows you to attach certificate templates.

On request, the _ /template/add_ endpoint attaches a template to the course batch.
All fields marked with an * are mandatory
The mandatory fields cannot be null or empty
Backend route: http://lms-service:9000/v1/course/batch/cert/template/add

patch

/course/batch/cert/v1/template/add

Authorizations

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource.Possible media types can be Application/json

tsstring

The timestamp at which the Add certificate template request was sent.

X-msgidstring

A unique ID that identifies the request, in case the same API is executed multiple times.

x-authenticated-user-tokenstringrequired

The access token of the registered user sending the given API request. This is an alphanumeric string.

Authorizationstringrequired

To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received here.

Body

idstring

Represents an API uniquely

verstring

Represents the version of the API which was used

etsinteger · int64

Represents the EPOCH (UTC) timestamp in milliseconds since EPOCH

paramsobject

requestAddCourseBatchTemplateRequestrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://staging.open-sunbird.org/api/course/batch/cert/v1/template/add' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --header 'x-authenticated-user-token: text' \
  --data '{"params":{},"request":{"batch":{"courseId":"text","batchId":"text","template":{"identifier":"text","signatoryList":[{"name":"text","id":"text","designation":"CEO","image":"text"}],"issuer":{"name":"text","url":"text","publicKey":[7,8]},"criteria":{"enrollment":{"status":"2"}}}}}}'

200

400

401

500

{
  "id": "api.course.batch.cert.template.add",
  "ver": "v1",
  "ts": "2020-12-03 05:15:43:693+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "dcef916a-bbf0-48b6-bb20-2e4b9e90745d",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "response": "SUCCESS"
  }
}

OK ! Operation successful."Add Certificate template" operation was executed successfully.

remove certificate template from course batch

This API is associated with detaching certificate templates.

The _ /template/remove_ endpoint detaches a template from the course batch.
All fields marked with an * are mandatory
Required fields cannot be null or empty
Backend Route: http://lms-service:9000/v1/course/batch/cert/template/remove

patch

/course/batch/cert/v1/template/remove

Authorizations

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource.Possible media types can be Application/json

tsstring

The timestamp at which the remove certificate template request was sent.

X-msgidstring

A unique ID that identifies the request in case the same API is executed multiple times.

x-authenticated-user-tokenstringrequired

The access token of the registered user sending the given API request. This is an alphanumeric string.

Authorizationstringrequired

To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received here.

Body

idstring

Represents an API uniquely

verstring

Represents the version of the API which was used

etsinteger · int64

Represents the EPOCH (UTC) timestamp in milliseconds since EPOCH

paramsobject

requestRemoveCourseBatchTemplateRequestrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://staging.open-sunbird.org/api/course/batch/cert/v1/template/remove' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --header 'x-authenticated-user-token: text' \
  --data '{"request":{"batch":{"courseId":"courseId","batchId":"batchId","template":{"identifier":"template Identifier"}}}}'

200

400

401

500

{
  "id": "api.course.batch.cert.template.remove",
  "ver": "v1",
  "ts": "2020-12-03 05:36:09:531+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "cac9434e-fc66-47dc-b37b-15438b3c68ab",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "response": "SUCCESS"
  }
}

OK ! Operation successful."Remove Certificate template" operation was executed successfully.

Create Page

This API is associated with creating a new page. To create a page first create the page section using section create api.make page name unique.

The endpoint for Create Page is /create
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

post

/data/v1/page/create

Authorizations

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource. Possible media types can be:-

Application/json
Multipart/form-data
Application/x-www-form-urlencoded

X-msgidstringrequired

This Id Uniquely identifies a request if the same API is executed multiple times.

tsstringrequired

Time Stamp at which creating page request was sent.

Authorizationstringrequired

All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.

x-authenticated-user-tokenstringrequired

The token/key used to execute the API

Body

idstringrequired

Example: unique API ID

tsstringrequired

Example: 2013/10/15 16:16:39

requestRequestrequired

Example:

{"name":"Resources","portalMap":[{"id":1228383082462412800,"index":1,"group":1},{"id":1228383384379392000,"index":1,"group":2}],"appMap":[{"id":1228383082462412800,"index":1,"group":1},{"id":1228383384379392000,"index":1,"group":2}]}

paramsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.open-sunbird.org/api/data/v1/page/create' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --header 'X-msgid: text' \
  --header 'ts: text' \
  --header 'x-authenticated-user-token: text' \
  --data '{"id":"api.page.create","ts":"2020/12/11 16:16:39","params":{},"request":{"name":"Resources","organisationId":"id of organisation, if you want to create page for your org only. if not pass then page will be created for all org.","portalMap":[{"id":1228383082462412800,"index":1,"group":1},{"id":1228383384379392000,"index":1,"group":2}],"appMap":[{"id":1228383082462412800,"index":1,"group":1},{"id":1228383384379392000,"index":1,"group":2}]}}'

200

400

500

{
  "id": "api.page.create",
  "ver": "v1",
  "ts": "1606196636922",
  "responseCode": "OK",
  "params": {
    "resmsgid": "null,",
    "msgid": "a4b7041c-2d42-43e8-81d2-d3f3b6fbeccf",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "response": "SUCCESS",
    "pageId": 131699903041208320
  }
}

OK ! Successful operation."create page" operation was successfully executed.

Update Page Information

This API is associated with updating the page information

The endpoint for Update Page Information is /update
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

patch

/data/v1/page/update

Authorizations

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource. Possible media types can be:-

Application/json
Multipart/form-data
Application/x-www-form-urlencoded

X-msgidstringrequired

This Id Uniquely identifies a request if the same API is executed multiple times.

tsstringrequired

Time Stamp at which update page information request was sent.

Authorizationstringrequired

All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.

x-authenticated-user-tokenstringrequired

The token/key used to execute the API

Body

idstringrequired

Example: unique API ID

tsstringrequired

Example: 2013/10/15 16:16:39

requestRequest20required

Example:

{"name":"Resourcessss","id":1228394137835929600,"portalMap":[{"id":1228383082462412800,"index":1,"group":1},{"id":1228383384379392000,"index":1,"group":2}],"appMap":[{"id":1228383082462412800,"index":1,"group":1},{"id":1228383384379392000,"index":1,"group":2}]}

paramsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://staging.open-sunbird.org/api/data/v1/page/update' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --header 'X-msgid: text' \
  --header 'ts: text' \
  --header 'x-authenticated-user-token: text' \
  --data '{"id":"unique API ID","ts":"2013/10/15 16:16:39","params":{},"request":{"name":"Resourcessss","id":1228394137835929600,"portalMap":[{"id":1228383082462412800,"index":1,"group":1},{"id":1228383384379392000,"index":1,"group":2}],"appMap":[{"id":1228383082462412800,"index":1,"group":1},{"id":1228383384379392000,"index":1,"group":2}]}}'

200

400

500

{
  "id": "api.page.update",
  "ver": "v1",
  "ts": "1606196636922",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "34b7041c-2d42-43e8-81d2-d3f3b6fbeccf",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "response": "SUCCESS"
  }
}

OK ! Successful operation."update page information" operation was successfully executed.

Get Specific Page Resources

This API is associated with fetching specific resources.

The endpoint for Get Specific Page Resources is /read/{pageName}
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

get

/data/v1/page/read/{pageName}

Authorizations

Path parameters

pageNamestringrequired

Please append a valid Section Id to the request URL

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource. Possible media types can be:-

Application/json

X-msgidstringrequired

This Id Uniquely identifies a request if the same API is executed multiple times.

tsstringrequired

Time Stamp at which get specific page resources request was sent.

Authorizationstringrequired

All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.

x-authenticated-user-tokenstringrequired

The token/key used to execute the API

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://staging.open-sunbird.org/api/data/v1/page/read/{pageName}' \
  --header 'Authorization: text' \
  --header 'Content-Type: text' \
  --header 'X-msgid: text' \
  --header 'ts: text' \
  --header 'x-authenticated-user-token: text'

200

500

{
  "id": "api.page.read.Course",
  "ver": "v1",
  "ts": "2020-12-14 10:30:12:868+0000",
  "params": {
    "resmsgid": null,
    "msgid": "829f92fa-ef96-4250-a9b2-1a169e8ff59d",
    "err": null,
    "status": "success",
    "errmsg": null,
    "responseCode": "OK"
  },
  "result": {
    "page": {
      "name": "Course",
      "id": 1228382478150860800,
      "portalSections": {
        "display": "{\"name\":{\"en\":\"Latest Courses\"}}",
        "alt": null,
        "description": null,
        "index": 1,
        "sectionDataType": "course",
        "imgUrl": null,
        "searchQuery": "{\"request\":{\"filters\":{\"contentType\":[\"Course\"],\"objectType\":[\"Content\"],\"status\":[\"Live\"]},\"sort_by\":{\"lastPublishedOn\":\"desc\"},\"limit\":10}}",
        "name": "Latest Courses",
        "id": 1228382278062080000,
        "dynamicFilters": null,
        "dataSource": null,
        "status": 1,
        "group": 1
      },
      "appSections": {
        "display": "{\"name\":{\"en\":\"Latest Courses\",\"hi\":\"????????\"}}",
        "alt": null,
        "description": null,
        "index": 1,
        "sectionDataType": "course",
        "imgUrl": null,
        "searchQuery": "{\"request\":{\"filters\":{\"contentType\":[\"Course\"],\"objectType\":[\"Content\"],\"status\":[\"Live\"]},\"sort_by\":{\"lastPublishedOn\":\"desc\"},\"limit\":10}}",
        "name": "Latest Courses",
        "id": 1228382278062080000,
        "dynamicFilters": null,
        "dataSource": null,
        "status": 1,
        "group": 1
      }
    }
  }
}

OK ! Successful operation."get specific page resources" operation was successfully executed.

Create Page Section

This API is associated with creating a new section on a page.

The endpoint for Create Page Section is /section/create
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

post

/data/v1/page/section/create

Authorizations

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource. Possible media types can be:-

Application/json

X-msgidstringrequired

This Id Uniquely identifies a request if the same API is executed multiple times.

tsstringrequired

Time Stamp at which create section request was sent.

Authorizationstringrequired

All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.

x-authenticated-user-tokenstringrequired

The token/key used to execute the API

Body

idstringrequired

Example: unique API ID

tsstringrequired

Example: 2013/10/15 16:16:39

requestRequest5required

Example:

{"name":"Recommended TextBook","sectionDataType":"course","display":{"name":{"en":"popular story","hi":"????????"}},"searchQuery":{"request":{"query":"","limit":10,"sort_by":{"lastUpdatedOn":"desc"},"filters":{"language":["English"],"contentType":["TextBook"]}}}}

paramsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.open-sunbird.org/api/data/v1/page/section/create' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --header 'X-msgid: text' \
  --header 'ts: text' \
  --header 'x-authenticated-user-token: text' \
  --data '{"id":"unique API ID","ts":"2013/10/15 16:16:39","params":{},"request":{"name":"Recommended TextBook","sectionDataType":"course","display":{"name":{"en":"popular story","hi":"????????"}},"searchQuery":{"request":{"query":"","limit":10,"sort_by":{"lastUpdatedOn":"desc"},"filters":{"language":["English"],"contentType":["TextBook"]}}}}}'

200

400

500

{
  "id": "api.page.section.create",
  "ver": "v1",
  "ts": "1606196636922",
  "responseCode": "OK",
  "params": {
    "resmsgid": "null,",
    "msgid": "a4b7041c-2d42-43e8-81d2-d3f3b6fbeccf",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "response": "SUCCESS",
    "pageId": 131735539027230720
  }
}

OK ! Successful operation."create section" operation was successfully executed.

Update Page Section

This API is associated with updating content of a section on a page.

The endpoint for Update Page Section is /section/update
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

patch

/data/v1/page/section/update

Authorizations

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource. Possible media types can be:-

Application/json
Multipart/form-data
Application/x-www-form-urlencoded

X-msgidstringrequired

This Id Uniquely identifies a request if the same API is executed multiple times.

tsstringrequired

Time Stamp at which updating page section request was sent.

Authorizationstringrequired

All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.

x-authenticated-user-tokenstringrequired

The token/key used to execute the API

Body

idstringrequired

Example: unique API ID

tsstringrequired

Example: 2013/10/15 16:16:39

requestRequest13required

Example:

{"id":122662435116892160,"name":"Popular Course","sectionDataType":"course","display":{"name":{"en":"popular Course","hi":"????????"}},"searchQuery":{"request":{"query":"","offset":0,"limit":5,"filters":{"objectType":["Content"],"mimeType":["application/vnd.ekstep.html-archive"],"status":["Draft","Live"]}}}}

paramsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://staging.open-sunbird.org/api/data/v1/page/section/update' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --header 'X-msgid: text' \
  --header 'ts: text' \
  --header 'x-authenticated-user-token: text' \
  --data '{"example":{"request":{"id":1269259447543398400,"name":"Linked Content","display":{"name":null,"en":"Linked Content"},"searchQuery":{"request":{"mode":"collection","limit":10,"facets":["medium"],"sort_by":{"lastUpdatedOn":"desc"},"filters":{"primaryCategory":["Course"],"mimeType":["application/vnd.ekstep.content-collection"],"status":["Live"],"compatibilityLevel":{"max":4,"min":1}}}}}}}'

200

400

500

{
  "id": "api.page.section.update",
  "ver": "v1",
  "ts": "1606196636922",
  "responseCode": "OK",
  "params": {
    "resmsgid": "null,",
    "msgid": "a4b7041c-2d42-43e8-81d2-d3f3b6fbeccf",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "response": "SUCCESS",
    "pageId": 131735539027230720
  }
}

OK ! Successful operation."create section" operation was successfully executed.

Fetch Section Details by Id

This API is associated with fetching specific section details.

The endpoint for Fetch Section Details by Id is /section/read/{sectionId}
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

get

/data/v1/page/section/read/{SectionId}

Authorizations

Path parameters

SectionIdstringrequired

Please append a valid Section Id to the request URL

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource. Possible media types can be:-

Application/json
Multipart/form-data
Application/x-www-form-urlencoded

X-msgidstringrequired

This Id Uniquely identifies a request if the same API is executed multiple times.

tsstringrequired

Time Stamp at which Fetch Section Details request was sent.

Authorizationstringrequired

All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.

x-authenticated-user-tokenstringrequired

The token/key used to execute the API

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://staging.open-sunbird.org/api/data/v1/page/section/read/{SectionId}' \
  --header 'Authorization: text' \
  --header 'Content-Type: text' \
  --header 'X-msgid: text' \
  --header 'ts: text' \
  --header 'x-authenticated-user-token: text'

200

500

{
  "id": "api.page.section.read",
  "ver": "v1",
  "ts": "2020-12-16 08:33:54:060+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "5d809eaf-525b-4f96-b3f1-798636b55ecf",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "section": {
      "updatedBy": null,
      "display": "{\"name\":{\"en\":\"Ongoing Courses\"}}",
      "alt": null,
      "description": null,
      "updatedDate": null,
      "sectionDataType": "coursebatch",
      "imgUrl": null,
      "createdDate": null,
      "createdBy": null,
      "searchQuery": "{\"request\":{\"query\":\"\",\"filters\":{\"status\":\"1\"},\"limit\":10,\"sort_by\":{\"createdDate\":\"desc\"}}}",
      "name": "Ongoing Course",
      "id": 127029938411765760,
      "dynamicFilters": null,
      "dataSource": "batch",
      "status": 1
    }
  }
}

OK ! Successful operation."fetching section details" operation was successfully executed.

Fetch Page Settings

This API is associated with fetching the settings of a page.

The endpoint for Fetch Page Settings is /section/list
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

get

/data/v1/page/section/list

Authorizations

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource. Possible media types can be:-

Application/json
Multipart/form-data
Application/x-www-form-urlencoded

X-msgidstringrequired

This Id Uniquely identifies a request if the same API is executed multiple times.

tsstringrequired

Time Stamp at which fetch settings request was sent.

Authorizationstringrequired

All User APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.

x-authenticated-user-tokenstringrequired

The token/key used to execute the API

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://staging.open-sunbird.org/api/data/v1/page/section/list' \
  --header 'Authorization: text' \
  --header 'Content-Type: text' \
  --header 'X-msgid: text' \
  --header 'ts: text' \
  --header 'x-authenticated-user-token: text'

200

500

{
  "id": "api.page.section.list",
  "ver": "v1",
  "ts": "2020-12-16 08:45:22:994+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "04c00561-c3af-46a9-924d-ab891e1b62a8",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "response": [
      {
        "display": "{\"name\":{\"en\":\"Latest Courses\"}}",
        "alt": null,
        "description": null,
        "sectionDataType": "ContentBrowser",
        "imgUrl": null,
        "searchQuery": "{\"request\":{\"filters\":{\"contentType\":[\"Course\"],\"objectType\":[\"Content\"],\"status\":[\"Live\"]},\"sort_by\":{\"lastPublishedOn\":\"desc\"},\"limit\":10}}",
        "name": "Latest Courses",
        "id": 131191751772733440,
        "dynamicFilters": null,
        "dataSource": null,
        "status": 1
      },
      {
        "display": "{\"name\":{\"en\":\"NCC\"}}",
        "alt": null,
        "description": null,
        "sectionDataType": "Content",
        "imgUrl": null,
        "searchQuery": "{\"request\":{\"filters\":{\"contentType\":[\"Course\"],\"status\":[\"Live\"],\"objectType\":[\"Content\"],\"createdFor\":[\"0129902071599595522\"],\"subject\":[\"NCC\"]},\"sort_by\":{\"lastPublishedOn\":\"desc\"},\"limit\":10}}",
        "name": "NCC",
        "id": 129916933832212480,
        "dynamicFilters": null,
        "dataSource": null,
        "status": 1
      }
    ]
  }
}

OK ! Successful operation."fetch settings" operation was successfully executed.

Course Enrol

The API associated with user enrolment into a courseBatch. The endpoint for Course Enrol is /enrol

The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

post

/course/v1/enrol

Authorizations

Header parameters

Authorizationstringrequired

To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

Example: {{api-key}}

x-authenticated-user-tokenstringrequired

The alphanumeric string for accessing the API

Example: {{authToken}}

Body

requestRequestrequired

Example: {"courseId":"{{course-id}}","batchId":"{{batch-id}}","userId":"{{user-id}}"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.open-sunbird.org/api/course/v1/enrol' \
  --header 'Authorization: {{api-key}}' \
  --header 'x-authenticated-user-token: {{authToken}}' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"courseId":"{{course-id}}","batchId":"{{batch-id}}","userId":"{{user-id}}"}}'

200

400

500

{
  "id": "api.course.enroll",
  "ver": "v1",
  "ts": "2020-12-03 04:24:19:186+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "d8e54177-acb2-4351-8dcc-a7e6fc5c8a2f",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "response": "SUCCESS"
  }
}

SUCCESS. The "Course Enrol Request" operation was successful!

Course Unenrol

The Course Unenrol API is associated with unenrol of a user from a CourseBatch. The endpoint for Course Unenrol is /unenrol

The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

post

/course/v1/unenrol

Authorizations

Header parameters

Authorizationstringrequired

To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

Example: {{api-key}}

x-authenticated-user-tokenstringrequired

The alphanumeric string for accessing the API

Example: {{authToken}}

Body

requestRequestrequired

Example: {"courseId":"{{course-id}}","batchId":"{{batch-id}}","userId":"{{user-id}}"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.open-sunbird.org/api/course/v1/unenrol' \
  --header 'Authorization: {{api-key}}' \
  --header 'x-authenticated-user-token: {{authToken}}' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"courseId":"{{course-id}}","batchId":"{{batch-id}}","userId":"{{user-id}}"}}'

200

400

500

{
  "id": "api.course.unenroll",
  "ver": "v1",
  "ts": "2020-12-03 06:33:38:843+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "728efae3-8352-4886-8cb2-34b7b3fc41cc",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "response": "SUCCESS"
  }
}

SUCCESS. The "Course Unenrol Request" operation was successful!

UserEnrolment List

The UserEnrolmentList api provides the detail of a user's all enrolled CourseBatches The endpoint for UserEnrolment List is /user/enrollment/list/{{user-id}}

The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

get

/course/v1/user/enrollment/list/{user-id}

Authorizations

Path parameters

user-idstringrequired

Id of user for whom enrolment details we want

Query parameters

orgdetailsstring

Org details related with course

Example: orgName,email

licenseDetailsstring

License details related with course

Example: name,description,url

fieldsstring

Different course related details can be passed

Example: contentType,topic,name,channel

batchDetailsstring

Batch details can be passed to filter

Example: name,endDate,startDate,status,enrollmentType,createdBy,certificates

cachestring

The batch data got updated in cache after sometime to get updated details immediately we can pass cache false

Example: cache=false

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource.Possible media types can be:- Application/json

Example: application/json

Authorizationstringrequired

To make use of the API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

Example: {{api-key}}

x-authenticated-user-tokenstringrequired

The alphanumeric string for accessing the API

Example: {{authToken}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://staging.open-sunbird.org/api/course/v1/user/enrollment/list/{user-id}' \
  --header 'Authorization: {{api-key}}' \
  --header 'Content-Type: application/json' \
  --header 'x-authenticated-user-token: {{authToken}}'

200

500

{
  "id": "api.user.courses.list",
  "ver": "v1",
  "ts": "2020-12-03 06:56:38:376+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "83f3347f-0d7a-4369-bde2-daae13aa5938",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "result": {
    "courses": [
      {
        "dateTime": 1594191696100,
        "lastReadContentStatus": 2,
        "enrolledDate": "2020-07-08 07:01:36:100+0000",
        "addedBy": null,
        "contentId": "do_11305961646828748812224",
        "active": true,
        "description": "Enter description for Course",
        "courseLogoUrl": "https://sunbirddev.blob.core.windows.net/sunbird-content-dev/content/do_11305961646828748812224/artifact/06_maths_book_1566813333849_1580197829074.thumb.jpg",
        "batchId": 1305961938705612800,
        "userId": "95e4942d-cbe8-477d-aebd-ad8e6de4bfc8",
        "completionPercentage": 100,
        "courseName": "Test-auto-certificate-8thjuly",
        "completedOn": 1595422613486,
        "leafNodesCount": 1,
        "progress": 1,
        "lastReadContentId": "do_11305605610466508811",
        "courseId": "do_11305961646828748812224",
        "collectionId": "do_11305961646828748812224",
        "status": 2,
        "issuedCertificates": [],
        "contentStatus": {
          "do_11305605610466508811": 2
        },
        "certificates": [
          {
            "id": "fe2aadc6-5065-460a-98ed-4de17bc13f62",
            "lastIssuedOn": "2020-07-22T12:57:44.335+00:00",
            "name": "Course completion certificate prad",
            "token": "A8T4Q7",
            "url": "https://dev.sunbirded.org/certs/ORG_001_01305961938705612812/eedc6a60-cc1a-11ea-bff5-c98df349f522.pdf"
          }
        ],
        "content": {
          "copyright": "Sunbird",
          "channel": "b00bc992ef25f1a9a8d63291e20efc8d",
          "downloadUrl": "https://sunbirddev.blob.core.windows.net/sunbird-content-dev/ecar_files/do_11305961646828748812224/test-auto-certificate-8thjuly_1594191511275_do_11305961646828748812224_1.0_spine.ecar",
          "mimeType": "application/vnd.ekstep.content-collection",
          "c_sunbird_dev_private_batch_count": 0,
          "objectType": "Content",
          "appIcon": "https://sunbirddev.blob.core.windows.net/sunbird-content-dev/content/do_11305961646828748812224/artifact/06_maths_book_1566813333849_1580197829074.thumb.jpg",
          "primaryCategory": "Course",
          "appId": "dev.sunbird.portal",
          "contentEncoding": "gzip",
          "lockKey": "097e65a0-9c65-4198-b65c-269de9ae6072",
          "totalCompressedSize": 499149,
          "mimeTypesCount": "{\"application/vnd.ekstep.content-collection\":1,\"application/vnd.ekstep.ecml-archive\":1}",
          "contentType": "Course",
          "identifier": "do_11305961646828748812224",
          "lastUpdatedBy": "8454cb21-3ce9-4e30-85b5-fade097880d8",
          "visibility": "Default",
          "toc_url": "https://sunbirddev.blob.core.windows.net/sunbird-content-dev/content/do_11305961646828748812224/artifact/do_11305961646828748812224_toc.json",
          "contentTypesCount": "{\"CourseUnit\":1,\"Resource\":1}",
          "consumerId": "6533af82-f38b-429a-bcfb-681ed02a62e3",
          "mediaType": "content",
          "osId": "org.ekstep.quiz.app",
          "graph_id": "domain",
          "nodeType": "DATA_NODE",
          "lastPublishedBy": "Ekstep",
          "version": 2,
          "license": "CC BY 4.0",
          "prevState": "Draft",
          "size": 76289,
          "lastPublishedOn": "2020-07-08T06:58:31.132+00:00",
          "IL_FUNC_OBJECT_TYPE": "Content",
          "name": "Test-auto-certificate-8thjuly",
          "status": "Live",
          "code": "org.sunbird.DuGnxI",
          "prevStatus": "Processing",
          "description": "Enter description for Course",
          "idealScreenSize": "normal",
          "posterImage": "https://sunbirddev.blob.core.windows.net/sunbird-content-dev/content/do_11294498061374259215/artifact/06_maths_book_1566813333849_1580197829074.jpg",
          "createdOn": "2020-07-08T06:57:43.417+00:00",
          "reservedDialcodes": "{\"U6K9M6\":0}",
          "copyrightYear": 2020,
          "contentDisposition": "inline",
          "lastUpdatedOn": "2020-07-08T06:58:30.585+00:00",
          "licenseterms": "By creating and uploading content on DIKSHA, you consent to publishing this content under the Creative Commons Framework, specifically under the CC-BY-SA 4.0 license.",
          "SYS_INTERNAL_LAST_UPDATED_ON": "2020-07-23T12:24:29.5+00:00",
          "dialcodeRequired": "No",
          "lastStatusChangedOn": "2020-07-08T06:58:31.95+00:00",
          "creator": "Mentor First User",
          "IL_SYS_NODE_TYPE": "DATA_NODE",
          "pkgVersion": 1,
          "versionKey": 1594191510585,
          "idealScreenDensity": "hdpi",
          "framework": "TPD",
          "depth": 0,
          "s3Key": "ecar_files/do_11305961646828748812224/test-auto-certificate-8thjuly_1594191511275_do_11305961646828748812224_1.0_spine.ecar",
          "createdBy": "8454cb21-3ce9-4e30-85b5-fade097880d8",
          "compatibilityLevel": 4,
          "leafNodesCount": 1,
          "IL_UNIQUE_ID": "do_11305961646828748812224",
          "resourceType": "Course",
          "node_id": 452442,
          "c_sunbird_dev_open_batch_count": 2,
          "ownershipType": [
            "createdBy"
          ],
          "organisation": [
            "Sunbird"
          ],
          "language": [
            "English"
          ],
          "leafNodes": [
            "do_11305605610466508811"
          ],
          "children": [
            "do_11305605610466508811"
          ],
          "audience": [
            "Teacher"
          ],
          "childNodes": [
            "do_11305961679918694412225",
            "do_11305605610466508811"
          ],
          "createdFor": [
            "ORG_001"
          ],
          "os": [
            "All"
          ],
          "dialcodes": [
            "U6K9M6"
          ],
          "trackable": {
            "enabled": "Yes",
            "autoBatch": "Yes"
          },
          "credentials": {
            "enabled": "Yes"
          },
          "batches": [
            {
              "endDate": null,
              "name": "Test-auto-certificate-8thjuly",
              "batchId": 1305961938705612800,
              "enrollmentType": "open",
              "enrollmentEndDate": null,
              "startDate": "2020-07-08",
              "status": 1,
              "createdFor": [
                "ORG_001"
              ]
            },
            {
              "endDate": null,
              "name": "Test-auto-certificate-8thjuly",
              "batchId": 1306956038530662400,
              "enrollmentType": "open",
              "enrollmentEndDate": null,
              "startDate": "2020-07-22",
              "status": 1,
              "createdFor": [
                "ORG_001"
              ]
            }
          ],
          "variants": {
            "online": {
              "ecarUrl": "https://sunbirddev.blob.core.windows.net/sunbird-content-dev/ecar_files/do_11305961646828748812224/test-auto-certificate-8thjuly_1594191511612_do_11305961646828748812224_1.0_online.ecar",
              "size": 4936
            },
            "spine": {
              "ecarUrl": "https://sunbirddev.blob.core.windows.net/sunbird-content-dev/ecar_files/do_11305961646828748812224/test-auto-certificate-8thjuly_1594191511275_do_11305961646828748812224_1.0_spine.ecar",
              "size": 76289
            }
          }
        }
      }
    ]
  }
}

SUCCESS. The "User Enrolment List" operation was successful!

API Documentation:

Course Batch Management APIs are listed below:

Course Enrolment APIs are listed below:

Course Progress APIs are listed below:

Course Batch Certificates APIs are listed below:

Group Activity Aggregator

Collection Summary

Collection Summary(https://staging.open-sunbird.org/report/v1/collection/summary)

Request Body

Page APIs

API Documentation:

Course Batch Management APIs are listed below:

Course Enrolment APIs are listed below:

Course Progress APIs are listed below:

Course Batch Certificates APIs are listed below:

Group Activity Aggregator

Collection Summary

Collection Summary(https://staging.open-sunbird.org/report/v1/collection/summary)

Request Body

Page APIs

{host}/v1/jobrequest/submit

{host}/v1/jobrequest/list

Add certificate template to a course batch

remove certificate template from course batch

Create Page

Update Page Information

Get Specific Page Resources

Create Page Section

Update Page Section

Fetch Section Details by Id

Fetch Page Settings

Course Enrol

Course Unenrol

UserEnrolment List