Public
Documentation Settings
dev
Double Column
cURL - cURL
Sunbird Collection Management API(s)
Introduction
collection/v1

Sunbird Collection Management API(s)

The Collection Management API allows you to manage collection over the sunbird platform.Apis perform operations related to all the Collection on the Sunbird Platform.

  • Each of the endpoints serve a different purpose, so which one to use depends on what you want to do

  • The operations include CRUD (Create, Update, Read) operations and other operations such as copy, flag, link Dialcode, etc.

  • The URL for Sunbird Content API(s) is collection/v1

  • TestCases

Contact Support:
Email: info@sunbird.org

collection/v1

flag

POSTCollection Flag

/collection/v1/flag/{{collectionId}}

This API is associated with flag Collection on the Sunbird Platform .

  • /Collection/ endpoint executes the "Flag Collection" request based on parameters provided as metadata in the request body.
  • The endpoint for Update Collection is /collection/v1/flag
  • It points to knowledge-mw-service - /v1/collection/flag
  • {...}refers to a section of review endpoint URL path that needs to be replaced by appropriate Id.
  • It is mandatory to provide values for parameters marked with *.
  • Mandatory fields cannot be null or empty.
AUTHORIZATIONAPI Key
Key

Authorization

Value

<value>

HEADERS
X-Authenticated-User-Token

(Required) The Registered User ID used to execute the API.

X-Channel-id

The unique ID provided to the State to which the user belongs.

Accept

application/json

Bodyraw (json)
json
{
  "request": {
    "flagReasons": [
      "Copyright Violation"
    ],
    "flaggedBy": "API-DOC-Tester",
    "versionKey": "{{collectionVersionKey}}",
    "flags": [
      "kp-flags",
      "newKp-flags"
    ]
  }
}
Example Request
OK
curl
curl --location '/collection/v1/flag/magna' \
--header 'Content-Type: magna' \
--header 'X-Authenticated-User-Token: magna' \
--header 'X-Channel-id: magna' \
--header 'Authorization: magna' \
--data '{
  "request": {
    "flagReasons": [
      "fugiat",
      "labore voluptate eiusmod"
    ],
    "flaggedBy": "labore e",
    "flags": [
      "mollit laborum",
      "p"
    ],
    "versionKey": "Ut nulla officia dolore"
  }
}'
200 OK
Example Response
json
{
  "id": "api.collection.flag",
  "ver": "4.0",
  "ts": "2022-01-06T07:11:52ZZ",
  "params": {
    "resmsgid": "eb628dff-53c6-45f2-9789-0f193988f585",
    "status": "successful"
  },
  "responseCode": "OK",
  "result": {
    "identifier": "do_1134467204859658241168",
    "node_id": "do_1134467204859658241168",
    "versionKey": "1641453112470"
  }
}
Content-Type

application/json

POSTCollection Flag Accept

/collection/v1/flag/accept/{{collectionId}}

This API is associated with Flag Accept Collection on the Sunbird Platform .

  • /Collection/ endpoint executes the "Flag Accept Collection" request based on parameters provided as metadata in the request body.
  • The endpoint for Flag Accept Collection is /collection/v1/flag/accept
  • It points to knowledge-mw-service - /v1/collection/flag/accept
  • {...}refers to a section of review endpoint URL path that needs to be replaced by appropriate Id.
  • It is mandatory to provide values for parameters marked with *.
  • Mandatory fields cannot be null or empty.
AUTHORIZATIONAPI Key
Key

Authorization

Value

<value>

HEADERS
X-Authenticated-User-Token

(Required) The Registered User ID used to execute the API.

X-Channel-id

The unique ID provided to the State to which the user belongs.

Authorization

magna

(Required) All content APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.

Accept

application/json

Bodyraw (json)
json
{
  "request": {
    "versionKey": "{{versionKey}}"
  }
}
Example Request
OK
curl
curl --location '/collection/v1/flag/accept/magna' \
--header 'Content-Type: magna' \
--header 'X-Authenticated-User-Token: magna' \
--header 'X-Channel-id: magna' \
--header 'Authorization: magna' \
--data '{
  "request": {
    "versionKey": "{{versionKey}}"
  }
}'
200 OK
Example Response
json
{
  "id": "api.collection.flag.accept",
  "ver": "4.0",
  "ts": "2022-01-06T07:14:38ZZ",
  "params": {
    "resmsgid": "c7b2c6b0-ace7-4da5-8429-6f9d5f6b6d35",
    "status": "successful"
  },
  "responseCode": "OK",
  "result": {
    "identifier": "do_1134467204859658241168",
    "node_id": "do_1134467204859658241168",
    "versionKey": "1641453278531"
  }
}
Content-Type

application/json

hierarchy