Bulk Upload

Upload Users in Bulk

This API is associated with upload users in bulk on the Sunbird Platform.

• The endpoint for Upload Users in Bulk is /user/v1/upload
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.open-sunbird.org/api/user/v1/upload

Header parameters

Body

application/x-www-form-urlencoded

user*string

This is a .csv file.

• Each line of the file is a data record. Each record consists of one or more user fields, separated by commas. Each successfully created user is associated with root org of uploader (org admin).

The CSV file format supported is mentioned below:

• NAME: Name of user(firstName)
• MOBILE PHONE: Phone number. Either phone or email is mandatory.
• EMAIL: Email. Either phone or email is mandatory.
• SCHOOL ID: Organisation ID to which user must be associated(orgId).
• USER_TYPE: Type of user. Supported user types are 'teacher' or 'other'.
• ROLES: List of valid roles for assignment to user on association to an organisation.roles must be in Capital letters
• USER ID: User ID. Required only in case of user update.
• External ID: External ID of user. Either, school ID or external ID is mandatory for user association to organisation.

Response

200400401

OK ! Successful operation."bulk upload user" operation was successfully executed.

Headers

Body

application/json

id*string

ver*string

ts*string

params*Params

responseCode*string

result*UserBulkUploadResult

Request

JavaScriptCurl

const response = await fetch('https://staging.open-sunbird.org/api/user/v1/upload', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "user": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "api.user.upload",
  "ver": "v1",
  "ts": "2020-12-01 16:24:35:250+0000",
  "params": {
    "resmsgid": null,
    "msgid": "bf2d6e695e927a885eaae649c45b84b4",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "processId": 1316323485186457600
  }
}

Check Upload Status

This API is used to check the upload status

• The endpoint for Check Upload Status is /data/v1/upload/status/{processId}
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

GEThttps://staging.open-sunbird.org/api/data/v1/upload/status/{processId}

Path parameters

processId*string

Header parameters

Response

200404

OK ! Successful operation." check upload status" operation was successfully executed

Headers

Body

application/json

id*string

ver*string

ts*string

params*Params

responseCode*string

result*CheckUploadStatusResult

Request

JavaScriptCurl

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/upload/status/{processId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "api.upload.status",
  "ver": "v1",
  "ts": "2020-12-01 17:13:43:230+0000",
  "params": {
    "resmsgid": null,
    "msgid": "ff70ec24aae247f1a2b21fae2c200f6c",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": [
      {
        "failureResult": [],
        "processId": 1316326144873267200,
        "successResult": [
          {
            "code": "APDIST1",
            "parentCode": "APCODE",
            "name": "APDIST1",
            "type": "district",
            "parentId": "6824e3d3-5512-4344-a481-7bac011edaa8",
            "id": "333a45f6-ce34-491c-b63b-2187c2df367a",
            "operation": "create"
          },
          {
            "code": "APDIST2",
            "parentCode": "APCODE",
            "name": "APDIST2",
            "type": "district",
            "parentId": "6824e3d3-5512-4344-a481-7bac011edaa8",
            "id": "97287c81-f439-4f69-85fe-d1cf6fca3003",
            "operation": "create"
          }
        ],
        "message": "Operation is completed.",
        "objectType": "location",
        "status": "COMPLETED"
      }
    ]
  }
}

Upload Location Data in Bulk

This API is used to create a background job for bulk upload of location data into the platform. The upload data is provided in CSV format.

• The endpoint for Upload Location Data in Bulk is /data/v1/bulk/location/upload
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.open-sunbird.org/api/data/v1/bulk/location/upload

Header parameters

Body

application/x-www-form-urlencoded

csvFile*string

CSV file which contains location data in following format:

• code: 'National level code for state'

• name: 'Name of entity e.g a state'

• parentCode: 'code of the parent'

• parentId : 'ID of the parent (In a hierarchy),

  • if there exists a parent node either parentCode and parentID is required (in case of a child node)
  • if it is highest (top) node in the hierarchy,then no parent details are required

type*string

Represents the information about the possible values of location types state, district, block, cluster

Response

200400

OK. Successful operation. The data upload operation is accepted for further processing.

Headers

Body

application/json

id*string

ver*string

ts*string

params*Params

responseCode*string

result*UserBulkUploadResult

Request

JavaScriptCurl

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/bulk/location/upload', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "csvFile": "text",
      "type": "district"
    }),
});
const data = await response.json();

Response

{
  "id": "api.bulk.location.upload",
  "ver": "v1",
  "ts": "2020-12-01 17:13:28:034+0000",
  "params": {
    "resmsgid": null,
    "msgid": "0eef8c3ff45390894ecd98c146248792",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "processId": 1316326144873267200
  }
}

Upload Organisations in Bulk

This API is associated with bulk uploading organisations on the Sunbird Platform.

• The endpoint for Upload Organisations in Bulk is /org/v1/upload
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.open-sunbird.org/api/org/v1/upload

Header parameters

Body

application/x-www-form-urlencoded

org*string

This is a .csv file.

• Each line of the file is a data record. Each record consists of one or more organisation fields, separated by commas. Each successfully created organisation is associated with root org of uploader (org admin).

The CSV file format supported is mentioned below:

• SCHOOL NAME: Organisation name(orgName)
• BLOCK CODE: Location code (locationCode)
• SCHOOL ID: Organisation ID. Required only in case of organisation update(organisationId).
• EXTERNAL ID: External ID of organisation(externalId)
• STATUS: Status. Supported values are 'active' and 'inactive'(status) mandatory param.
• DESCRIPTION: Organisation description(description)

Response

200400

OK ! Successful operation."bulk org upload " operation was successfully executed.

Headers

Body

application/json

id*string

ver*string

ts*string

params*Params

responseCode*string

result*UserBulkUploadResult

Request

JavaScriptCurl

const response = await fetch('https://staging.open-sunbird.org/api/org/v1/upload', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "org": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "api.org.upload",
  "ver": "v1",
  "ts": "2020-12-04 06:51:24:413+0000",
  "params": {
    "resmsgid": null,
    "msgid": "54f533acafefddb758704fb75caad1f9",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "processId": 131650814782423040
  }
}

Sample file

1. Users Bulk Upload -

310B

User.bulk.upload.csv

2. Location Bulk Upload -

311B

location_bulk_upload.csv

3. Organizations Bulk Upload -

205B

org_bulk_upload.csv