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:

Error with https://308610995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4ZKyfmmhMWpPkD6iYvKF%2Fuploads%2Fgit-blob-d632fad08af22d741a889f188bac008da84e08ea%2Fcoursebatchmanapi.yaml?alt=media: Failed to parse YAML: Multi-line single-quoted string needs to be sufficiently indented

Error with https://308610995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4ZKyfmmhMWpPkD6iYvKF%2Fuploads%2Fgit-blob-d632fad08af22d741a889f188bac008da84e08ea%2Fcoursebatchmanapi.yaml?alt=media: Failed to parse YAML: Multi-line single-quoted string needs to be sufficiently indented

Error with https://308610995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4ZKyfmmhMWpPkD6iYvKF%2Fuploads%2Fgit-blob-d632fad08af22d741a889f188bac008da84e08ea%2Fcoursebatchmanapi.yaml?alt=media: Failed to parse YAML: Multi-line single-quoted string needs to be sufficiently indented

Error with https://308610995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4ZKyfmmhMWpPkD6iYvKF%2Fuploads%2Fgit-blob-d632fad08af22d741a889f188bac008da84e08ea%2Fcoursebatchmanapi.yaml?alt=media: Failed to parse YAML: Multi-line single-quoted string needs to be sufficiently indented

Course Enrolment APIs are listed below:

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.

POSThttps://staging.open-sunbird.org/api/course/v1/enrol

Authorization

bearer

Header parameters

Body

application/json

request*Request

Response

200400500

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

Body

application/json

id*string

ver*string

ts*string

params*Params4

responseCode*string

result*Result

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/course/v1/enrol', {
    method: 'POST',
    headers: {
      "Authorization": "{{api-key}}",
      "x-authenticated-user-token": "{{authToken}}",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "courseId": "{{course-id}}",
        "batchId": "{{batch-id}}",
        "userId": "{{user-id}}"
      }
    }),
});
const data = await response.json();

Response

200400500

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

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.

POSThttps://staging.open-sunbird.org/api/course/v1/unenrol

Authorization

bearer

Header parameters

Body

application/json

request*Request

Response

200400500

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

Body

application/json

id*string

ver*string

ts*string

params*Params4

responseCode*string

result*Result

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/course/v1/unenrol', {
    method: 'POST',
    headers: {
      "Authorization": "{{api-key}}",
      "x-authenticated-user-token": "{{authToken}}",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "courseId": "{{course-id}}",
        "batchId": "{{batch-id}}",
        "userId": "{{user-id}}"
      }
    }),
});
const data = await response.json();

Response

200400500

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

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.

GEThttps://staging.open-sunbird.org/api/course/v1/user/enrollment/list/{user-id}

Authorization

bearer

Path parameters

user-id*string

Id of user for whom enrolment details we want

Query parameters

Header parameters

Response

200500

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

Body

application/json

id*string

ver*string

ts*string

params*Params4

responseCode*string

result*Result2

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/course/v1/user/enrollment/list/{user-id}', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json",
      "Authorization": "{{api-key}}",
      "x-authenticated-user-token": "{{authToken}}"
    },
});
const data = await response.json();

Response

200500

{
  "id": "api.user.courses.list",
  "ver": "v1",
  "ts": "2020-12-03 06:56:38:376+0000",
  "params": {
    "resmsgid": null,
    "msgid": "83f3347f-0d7a-4369-bde2-daae13aa5938",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "courses": [
      {
        "dateTime": 1594191696100,
        "lastReadContentStatus": 2,
        "enrolledDate": "2020-07-08 07:01:36:100+0000",
        "addedBy": null,
        "contentId": "do_11305961646828748812224",
        "active": true,
        "description": "<p>Enter description for Course</p>",
        "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",
        "content": {
          "ownershipType": [
            "createdBy"
          ],
          "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",
          "organisation": [
            "Sunbird"
          ],
          "language": [
            "English"
          ],
          "mimeType": "application/vnd.ekstep.content-collection",
          "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
            }
          },
          "leafNodes": [
            "do_11305605610466508811"
          ],
          "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",
          "children": [
            "do_11305605610466508811"
          ],
          "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",
          "trackable": {
            "enabled": "Yes",
            "autoBatch": "Yes"
          },
          "identifier": "do_11305961646828748812224",
          "lastUpdatedBy": "8454cb21-3ce9-4e30-85b5-fade097880d8",
          "audience": [
            "Teacher"
          ],
          "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",
          "childNodes": [
            "do_11305961679918694412225",
            "do_11305605610466508811"
          ],
          "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",
          "credentials": {
            "enabled": "Yes"
          },
          "prevStatus": "Processing",
          "description": "<p>Enter description for Course</p>",
          "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}",
          "batches": [
            {
              "createdFor": [
                "ORG_001"
              ],
              "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
            }
          ],
          "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",
          "createdFor": [
            "ORG_001"
          ],
          "lastStatusChangedOn": "2020-07-08T06:58:31.95+00:00",
          "creator": "Mentor First User",
          "IL_SYS_NODE_TYPE": "DATA_NODE",
          "os": [
            "All"
          ],
          "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",
          "dialcodes": [
            "U6K9M6"
          ],
          "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,
          "__$markdownParsed": true
        },
        "contentStatus": {
          "do_11305605610466508811": 2
        },
        "issuedCertificates": [],
        "completionPercentage": 100,
        "courseName": "Test-auto-certificate-8thjuly",
        "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"
          }
        ],
        "completedOn": 1595422613486,
        "leafNodesCount": 1,
        "progress": 1,
        "lastReadContentId": "do_11305605610466508811",
        "courseId": "do_11305961646828748812224",
        "collectionId": "do_11305961646828748812224",
        "status": 2,
        "__$markdownParsed": true
      }
    ]
  }
}

Course Progress APIs are listed below:

Error with https://308610995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4ZKyfmmhMWpPkD6iYvKF%2Fuploads%2Fgit-blob-8e1e781e7f481e6bd37e81f06ca81a40b3643f1f%2Fcourseprogressapi.yaml?alt=media: Failed to parse YAML: Multi-line single-quoted string needs to be sufficiently indented

Error with https://308610995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4ZKyfmmhMWpPkD6iYvKF%2Fuploads%2Fgit-blob-8e1e781e7f481e6bd37e81f06ca81a40b3643f1f%2Fcourseprogressapi.yaml?alt=media: Failed to parse YAML: Multi-line single-quoted string needs to be sufficiently indented

Course Batch Certificates APIs are listed below:

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

PATCHhttps://staging.open-sunbird.org/api/course/batch/cert/v1/template/add

Authorization

beareruserToken

Header parameters

Body

application/json

The body refers to the format of the request. The body contains metadata about the request to add the certificate template.

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

request*AddCourseBatchTemplateRequest

Response

200400401500

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

Body

application/json

coursebatchcertificateapiApiResponsecoursebatchcertificateapiApiResponse (object)

coursebatchcertificateapiSuccessResponsecoursebatchcertificateapiSuccessResponse (object)

Contains the success response

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/course/batch/cert/v1/template/add', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json",
      "x-authenticated-user-token": "text",
      "Authorization": "text"
    },
    body: JSON.stringify({
      "request": {
        "batch": {
          "batchId": "text",
          "courseId": "text",
          "template": {
            "criteria": {},
            "identifier": "text",
            "issuer": {
              "name": "text",
              "url": "text"
            },
            "signatoryList": [
              {
                "name": "text",
                "id": "text",
                "designation": "CEO",
                "image": "text"
              }
            ]
          }
        }
      }
    }),
});
const data = await response.json();

Response

200400401500

{
  "coursebatchcertificateapiApiResponse": {
    "id": "text",
    "ver": "text",
    "ets": 0,
    "params": {
      "msgid": "text",
      "resmsgid": "text",
      "status": "success"
    },
    "responseCode": "text"
  },
  "coursebatchcertificateapiSuccessResponse": {
    "result": {
      "response": "SUCCESS"
    }
  }
}

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

PATCHhttps://staging.open-sunbird.org/api/course/batch/cert/v1/template/remove

Authorization

beareruserToken

Header parameters

Body

application/json

The body refers to the format of the request. The body contains metadata about the request to remove certificate template.

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

request*RemoveCourseBatchTemplateRequest

Response

200400401500

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

Body

application/json

coursebatchcertificateapiApiResponsecoursebatchcertificateapiApiResponse (object)

coursebatchcertificateapiSuccessResponsecoursebatchcertificateapiSuccessResponse (object)

Contains the success response

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/course/batch/cert/v1/template/remove', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json",
      "x-authenticated-user-token": "text",
      "Authorization": "text"
    },
    body: JSON.stringify({
      "request": {
        "batch": {
          "courseId": "courseId",
          "batchId": "batchId",
          "template": {
            "identifier": "template Identifier"
          }
        }
      }
    }),
});
const data = await response.json();

Response

200400401500

{
  "coursebatchcertificateapiApiResponse": {
    "id": "text",
    "ver": "text",
    "ets": 0,
    "params": {
      "msgid": "text",
      "resmsgid": "text",
      "status": "success"
    },
    "responseCode": "text"
  },
  "coursebatchcertificateapiSuccessResponse": {
    "result": {
      "response": "SUCCESS"
    }
  }
}

Group Activity Aggregator

Error with https://308610995-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4ZKyfmmhMWpPkD6iYvKF%2Fuploads%2Fx06ZVcTCQKP5fxJUP9zb%2Fgroupactivityapi.yaml?alt=media&token=2bc183af-38b3-4349-bbca-7478f6852943: Failed to parse YAML: Multi-line single-quoted string needs to be sufficiently indented

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

200: OK

{
  "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

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.

POSThttps://staging.open-sunbird.org/api/data/v1/page/create

Authorization

bearer

Header parameters

Body

application/jsonmultipart/form-dataapplication/x-www-form-urlencoded

The body refers to the format of the request.

• The body contains metadata about the request for creating a page.

id*string

Example: "unique API ID"

ts*string

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

params*object

request*Request

Response

200400500

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

Body

application/json

resultNode Id

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/page/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json",
      "X-msgid": "text",
      "ts": "text",
      "Authorization": "text",
      "x-authenticated-user-token": "text"
    },
    body: JSON.stringify({
      "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
          }
        ]
      }
    }),
});
const data = await response.json();

Response

200400500

{
  "result": {
    "node_id": "text"
  },
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {}
}

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.

PATCHhttps://staging.open-sunbird.org/api/data/v1/page/update

Authorization

bearer

Header parameters

Body

application/jsonmultipart/form-dataapplication/x-www-form-urlencoded

The body refers to the format of the request.

• The body contains metadata about the request for updating page info.

id*string

Example: "unique API ID"

ts*string

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

params*object

request*Request20

Response

200400500

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

Body

application/json

resultNode Id

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/page/update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json",
      "X-msgid": "text",
      "ts": "text",
      "Authorization": "text",
      "x-authenticated-user-token": "text"
    },
    body: JSON.stringify({
      "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
          }
        ]
      }
    }),
});
const data = await response.json();

Response

200400500

{
  "result": {
    "node_id": "text"
  },
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {}
}

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.

GEThttps://staging.open-sunbird.org/api/data/v1/page/read/{pageName}

Authorization

bearer

Path parameters

pageName*string

Please append a valid Section Id to the request URL

Header parameters

Response

200500

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

Body

application/json

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

resultobject

Empty Result

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/page/read/{pageName}', {
    method: 'GET',
    headers: {
      "Content-Type": "text",
      "X-msgid": "text",
      "ts": "text",
      "Authorization": "text",
      "x-authenticated-user-token": "text"
    },
});
const data = await response.json();

Response

200500

{
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {},
  "result": {}
}

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.

POSThttps://staging.open-sunbird.org/api/data/v1/page/section/create

Authorization

bearer

Header parameters

Body

application/json

The body refers to the format of the request.

• The body contains metadata about the request for creating geo location.

id*string

Example: "unique API ID"

ts*string

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

params*object

request*Request5

Response

200400500

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

Body

application/json

resultNode Id

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/page/section/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json",
      "X-msgid": "text",
      "ts": "text",
      "Authorization": "text",
      "x-authenticated-user-token": "text"
    },
    body: JSON.stringify({
      "id": "unique API ID",
      "ts": "2013/10/15 16:16:39",
      "params": {},
      "request": {
        "name": "Recommended TextBook",
        "searchQuery": {
          "request": {
            "query": "",
            "filters": {
              "language": [
                "English"
              ],
              "contentType": [
                "TextBook"
              ]
            },
            "limit": 10,
            "sort_by": {
              "lastUpdatedOn": "desc"
            }
          }
        },
        "sectionDataType": "course",
        "display": {
          "name": {
            "en": "popular story",
            "hi": "????????"
          }
        }
      }
    }),
});
const data = await response.json();

Response

200400500

{
  "result": {
    "node_id": "text"
  },
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {}
}

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.

PATCHhttps://staging.open-sunbird.org/api/data/v1/page/section/update

Authorization

bearer

Header parameters

Body

application/json

The body refers to the format of the request.

• The body contains metadata about the request for creating geo location.

id*string

Example: "unique API ID"

ts*string

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

params*object

request*Request13

Response

200400500

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

Body

application/json

resultNode Id

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/page/section/update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json",
      "X-msgid": "text",
      "ts": "text",
      "Authorization": "text",
      "x-authenticated-user-token": "text"
    },
    body: JSON.stringify({
      "example": {
        "request": {
          "id": 1269259447543398400,
          "name": "Linked Content",
          "searchQuery": {
            "request": {
              "facets": [
                "medium"
              ],
              "filters": {
                "primaryCategory": [
                  "Course"
                ],
                "mimeType": [
                  "application/vnd.ekstep.content-collection"
                ],
                "status": [
                  "Live"
                ],
                "compatibilityLevel": {
                  "max": 4,
                  "min": 1
                }
              },
              "mode": "collection",
              "limit": 10,
              "sort_by": {
                "lastUpdatedOn": "desc"
              }
            }
          },
          "display": {
            "name": null,
            "en": "Linked Content"
          }
        }
      }
    }),
});
const data = await response.json();

Response

200400500

{
  "result": {
    "node_id": "text"
  },
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {}
}

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.

GEThttps://staging.open-sunbird.org/api/data/v1/page/section/read/{SectionId}

Authorization

bearer

Path parameters

SectionId*string

Please append a valid Section Id to the request URL

Header parameters

Response

200500

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

Body

application/json

resultNode Id

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/page/section/read/{SectionId}', {
    method: 'GET',
    headers: {
      "Content-Type": "text",
      "X-msgid": "text",
      "ts": "text",
      "Authorization": "text",
      "x-authenticated-user-token": "text"
    },
});
const data = await response.json();

Response

200500

{
  "result": {
    "node_id": "text"
  },
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {}
}

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.

GEThttps://staging.open-sunbird.org/api/data/v1/page/section/list

Authorization

bearer

Header parameters

Response

200500

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

Body

application/json

resultNode Id

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

Request

JavaScriptCurlPython

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/page/section/list', {
    method: 'GET',
    headers: {
      "Content-Type": "text",
      "X-msgid": "text",
      "ts": "text",
      "Authorization": "text",
      "x-authenticated-user-token": "text"
    },
});
const data = await response.json();

Response

200500

{
  "result": {
    "node_id": "text"
  },
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {}
}

{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.

POSThttp://{{host}}/api/course/v1/jobrequest/submit

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://{{host}}/api/course/v1/jobrequest/submit', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "tag": "do_2137002173427875841205_01370023185341644821",
        "requestedBy": "fca2925f-1eee-4654-9177-fece3fd6afc9",
        "dataset": "response-exhaust",
        "datasetConfig": {
          "batchId": "01370023185341644821"
        },
        "output_format": "csv",
        "encryptionKey": "encryption-keyencryption-keyencryption-keyencryption-keyencryption-key"
      }
    }),
});
const data = await response.json();

{host}/v1/jobrequest/list

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

GEThttp://{{host}}/api/course/v1/jobrequest/list/{tag}

Path parameters

tag*string

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://{{host}}/api/course/v1/jobrequest/list/{tag}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();