Sunbird Channel API(s)

The Channel API is an interface that allows users to manage channels. Channels are objects that represent different types of content and resources within a system. The API provides operations such as creating, reading, updating, and deleting channels.
. - The URL for Sunbird channel API(s) is channel/v1 - TestCases

Contact Support:
Email: info@sunbird.org

channel/v1

POSTCreate Channel

/channel/v1/create

This API is used for creating a channel

The endpoint for Create Channel is /channel/v1/create

It points to knowledge-mw-service - /v1/channel/create

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

AUTHORIZATIONAPI Key

Key

Authorization

Value

<value>

HEADERS

Content-Type

application/json

Bodyraw (json)

json

{
  "request": {
    "channel": {
      "name": "Channel Name",
      "code": "channel-id1"
    }
  }
}

Example Request

curl

curl --location '/channel/v1/create' \
--header 'Authorization: <API Key>' \
--header 'Content-Type: Ut enim offici' \
--header 'Authorization: Ut enim offici' \
--data '{
  "request": {
    "channel": {
      "name": "Channel Name",
      "code": "channel-id"
    }
  }
}'

200 OK

Example Response

json

{
  "id": "api.channel.create",
  "ver": "1.0",
  "ts": "2020-12-14T08:27:27.810Z",
  "params": {
    "resmsgid": "3357da20-3de6-11eb-9ff3-67c41480f6aa",
    "msgid": "3353bb70-3de6-11eb-9ff3-67c41480f6aa",
    "status": "successful",
    "err": null,
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "identifier": "channel-id",
    "node_id": "channel-id"
  }
}

Content-Type

application/json

GETGet a Channel

/channel/v1/read/{{channelId}}

This API is associated with fetching a channel by a specific channel ID

The endpoint for Get a Channel is /channel/v1/read/{ID}

It points to knowledge-mw-service - /v1/channel/read/{ID}

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

AUTHORIZATIONAPI Key

Key

Authorization

Value

<value>

HEADERS

application/json

Example Request

curl

curl --location '/channel/v1/read/Ut enim offici' \
--header 'Authorization: <API Key>' \
--header 'Content-Type: Ut enim offici' \
--header 'Authorization: Ut enim offici'

200 OK

Example Response

json

{
  "id": "api.channel.read",
  "ver": "3.0",
  "ts": "2020-12-14T08:33:50ZZ",
  "params": {
    "resmsgid": "02c742d2-57e1-4441-aa31-0ce339c3917b",
    "msgid": null,
    "err": null,
    "status": "successful",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "channel": {
      "identifier": "channel-405",
      "lastStatusChangedOn": "2020-12-14T08:27:49.490+0000",
      "code": "channel-405",
      "consumerId": "7411b6bd-89f3-40ec-98d1-229dc64ce77d",
      "assetAdditionalCategories": [],
      "autoCreateBatch": "Enabled",
      "languageCode": [],
      "suggested_frameworks": [
        {
          "identifier": "NCF",
          "code": "NCF",
          "name": "NCF",
          "objectType": "Framework"
        }
      ],
      "createdOn": "2020-12-14T08:27:49.490+0000",
      "objectType": "Channel",
      "versionKey": "1607934825088",
      "collectionPrimaryCategories": [
        "Content Playlist",
        "Course",
        "Digital Textbook",
        "Explanation Content"
      ],
      "contentPrimaryCategories": [
        "Course Assessment",
        "eTextbook",
        "Explanation Content",
        "Learning Resource",
        "Practice Question Set",
        "Teacher Resource"
      ],
      "name": "Channel without Default License",
      "lastUpdatedOn": "2020-12-14T08:33:45.088+0000",
      "defaultCourseFramework": "TPD",
      "collectionAdditionalCategories": [
        "Textbook",
        "Lesson Plan",
        "TV Lesson"
      ],
      "assetPrimaryCategories": [
        "Asset",
        "CertAsset",
        "Certificate Template"
      ],
      "contentAdditionalCategories": [
        "Classroom Teaching Video",
        "Concept Map",
        "Curiosity Question Set",
        "Experiential Resource",
        "Explanation Video",
        "Focus Spot",
        "Learning Outcome Definition",
        "Lesson Plan",
        "Marking Scheme Rubric",
        "Pedagogy Flow",
        "Previous Board Exam Papers",
        "TV Lesson",
        "Textbook"
      ],
      "status": "Live",
      "defaultFramework": "NCF"
    }
  }
}

Content-Type

application/json