Organisation Management

Create a new Organisation

This API is for creation of a new Organisation on the Sunbird Platform.

• The endpoint for Create a new Organisation is /org/v1/create
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.sunbirded.org/api/org/v1/create

Authorization

bearer

Header parameters

Body

application/json

The body contains metadata about the new Organisation to be created.

requestorgapiOrgReqV1 (object)

Response

200400500

OK. Successful operation. The Organisation Create operation was successfully executed.

Body

application/json

id*string

Represents the ID of the request which was made

ver*string

Represents the version of the API which was used

ets*integer (int64)

Represents the EPOCH (UTC) timestamp in milliseconds since EPOCH

params*object

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/org/v1/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "orgName": "Org Name",
        "channel": "Channel",
        "description": "<p>Description</p>",
        "externalId": "ExtId",
        "email": "[e-mail]",
        "isSSOEnabled": true,
        "organisationType": "school",
        "orgLocation": [
          {
            "id": "9541f516-4c01-4322-aa06-4062687a0ce5",
            "type": "block"
          },
          {
            "id": "6dd69f1c-ba40-4b3b-8981-4fb6813c5e71",
            "type": "district"
          },
          {
            "id": "e9207c22-41cf-4a0d-81fb-1fbe3e34ae24",
            "type": "cluster"
          },
          {
            "id": "ccc7be29-8e40-4d0a-915b-26ec9228ac4a",
            "type": "state"
          }
        ],
        "isTenant": true,
        "__$markdownParsed": true
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.org.create",
  "ver": "v1",
  "params": {
    "resmsgid": null,
    "msgid": "5398bdd7-f80d-4a9e-9c13-90ae3c6bbcb0",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "ts": "2020-11-23 10:03:39:935+0000",
  "result": {
    "organisationId": 131636612466278400,
    "response": "SUCCESS"
  }
}

Read Organisation details

This API is for viewing details of an existing Organisation on the Sunbird Platform.

• The endpoint for Read Organisation details is /org/v1/read
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.sunbirded.org/api/org/v1/read

Authorization

bearer

Header parameters

Body

application/json

The body contains metadata about the Organisation whose details are required to be viewed.

requestorgapiOrgReadReq (object)

Response

200400404500

OK. Successful operation. The requested operation was successfully executed.

Body

application/json

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/org/v1/read', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "organisationId": "0131630445447741440"
      }
    }),
});
const data = await response.json();

Response

{
  "result": {
    "id": "api.org.read",
    "ver": "v1",
    "ts": "2020-11-23 10:03:39:935+0000",
    "params": {
      "resmsgid": null,
      "msgid": "5398bdd7-f80d-4a9e-9c13-90ae3c6bbcb0",
      "err": null,
      "status": "success",
      "errmsg": null
    },
    "responseCode": "OK",
    "result": {
      "dateTime": null,
      "preferredLanguage": null,
      "keys": {},
      "channel\"": "ChannelNew",
      "approvedBy": null,
      "description": "<p>Updated Description</p>",
      "updatedDate": "2020-12-01 10:29:49:496+0000",
      "addressId": "0131630420489011201",
      "provider": "channelnew",
      "orgCode": null,
      "locationId": null,
      "theme": null,
      "id": "0131630445447741440",
      "isApproved": null,
      "communityId": null,
      "slug": "channelnew",
      "email": "[e-mail]",
      "isSSOEnabled": false,
      "identifier": "0131630445447741440",
      "thumbnail": null,
      "updatedBy\"": null,
      "orgName": "Org Name",
      "address": {},
      "externalId": "extid",
      "rootOrgId": "0131630445447741440",
      "imgUrl": null,
      "approvedDate": null,
      "homeUrl": null,
      "isDefault": null,
      "createdDate": "2020-12-01 09:52:46:962+0000",
      "createdBy": null,
      "hashTagId": "0131630445447741440",
      "noOfMembers": null,
      "status": 0,
      "orgLocation": [
        {
          "id": "9541f516-4c01-4322-aa06-4062687a0ce5",
          "type": "block"
        },
        {
          "id": "6dd69f1c-ba40-4b3b-8981-4fb6813c5e71",
          "type": "district"
        },
        {
          "id": "e9207c22-41cf-4a0d-81fb-1fbe3e34ae24",
          "type": "cluster"
        },
        {
          "id": "ccc7be29-8e40-4d0a-915b-26ec9228ac4a",
          "type": "state"
        }
      ],
      "isTenant": true,
      "isSchool": true,
      "organisationType": 2,
      "__$markdownParsed": true
    }
  }
}

Search for an Organisation

This API is for searching for Organisations on the Sunbird Platform.

• The endpoint for Search for an Organisation is /org/v1/search
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.sunbirded.org/api/org/v1/search

Authorization

bearer

Header parameters

Body

application/json

The body contains metadata about filters that can be used in Organisation search.

requestorgapiOrgSearchReq (object)

Response

200400500

OK. Successful operation. The requested operation was successfully executed.

Body

application/json

idstring

verstring

tsstring

responseCodestring

resultorgapiorgapiApiResponse (object)

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/org/v1/search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "filters": {
          "id": "0131630445447741440"
        }
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.org.search",
  "ver": "v1",
  "ts": "2020-11-23 09:16:58:628+0000",
  "params": {
    "resmsgid": null,
    "msgid": "ad7135b8-ef64-44bd-adaa-0b131a657689",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": {
      "count": 1,
      "content": [
        {
          "dateTime": null,
          "preferredLanguage": null,
          "keys": {},
          "channel\"": "ChannelNew",
          "approvedBy": null,
          "description": "<p>Updated Description</p>",
          "updatedDate": "2020-12-01 10:29:49:496+0000",
          "addressId": "0131630420489011201",
          "provider": "channelnew",
          "orgCode": null,
          "locationId": null,
          "theme": null,
          "id": "0131630445447741440",
          "isApproved": null,
          "communityId": null,
          "slug": "channelnew",
          "email": "[e-mail]",
          "isSSOEnabled": false,
          "identifier": "0131630445447741440",
          "thumbnail": null,
          "updatedBy\"": null,
          "orgName": "Org Name",
          "address": {},
          "externalId": "extid",
          "rootOrgId": "0131630445447741440",
          "imgUrl": null,
          "approvedDate": null,
          "homeUrl": null,
          "isDefault": null,
          "createdDate": "2020-12-01 09:52:46:962+0000",
          "createdBy": null,
          "hashTagId": "0131630445447741440",
          "noOfMembers": null,
          "status": 0,
          "orgLocation": [
            {
              "id": "9541f516-4c01-4322-aa06-4062687a0ce5",
              "type": "block"
            },
            {
              "id": "6dd69f1c-ba40-4b3b-8981-4fb6813c5e71",
              "type": "district"
            },
            {
              "id": "e9207c22-41cf-4a0d-81fb-1fbe3e34ae24",
              "type": "cluster"
            },
            {
              "id": "ccc7be29-8e40-4d0a-915b-26ec9228ac4a",
              "type": "state"
            }
          ],
          "organisationType": 2,
          "isSchool": true,
          "isTenant": true,
          "__$markdownParsed": true
        }
      ]
    }
  }
}

Update particulars of an existing Organisation

This API is for updating details of an existing Organisation on the Sunbird Platform.

• The endpoint for Update particulars of an existing Organisation is /org/v1/update
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

PATCHhttps://staging.sunbirded.org/api/org/v1/update

Authorization

bearer

Header parameters

Body

application/json

The body contains metadata about an existing Organisation to be updated.

requestorgapiOrgUpdateReq (object)

Response

200400500

OK. Successful operation. The requested operation was successfully executed.

Body

application/json

id*string

Represents the ID of the request which was made

ver*string

Represents the version of the API which was used

ets*integer (int64)

Represents the EPOCH (UTC) timestamp in milliseconds since EPOCH

params*object

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/org/v1/update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "organisationId": "0131630445447741440,",
        "description": "<p>updated description,</p>",
        "orgName": "Updated Org Name,",
        "orgLocation": [
          {
            "id": "9541f516-4c01-4322-aa06-4062687a0ce5",
            "type": "block"
          },
          {
            "id": "6dd69f1c-ba40-4b3b-8981-4fb6813c5e71",
            "type": "district"
          },
          {
            "id": "e9207c22-41cf-4a0d-81fb-1fbe3e34ae24",
            "type": "cluster"
          },
          {
            "id": "ccc7be29-8e40-4d0a-915b-26ec9228ac4a",
            "type": "state"
          }
        ],
        "__$markdownParsed": true
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.org.status.update",
  "ver": "v1",
  "params": {
    "resmsgid": null,
    "msgid": "5398bdd7-f80d-4a9e-9c13-90ae3c6bbcb0",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "ts": "2020-11-23 10:03:39:935+0000",
  "result": {
    "organisationId": 131636612466278400,
    "response": "SUCCESS"
  }
}

Organisation update status

This API is for updating status of an existing Organisation on the Sunbird Platform.

• The endpoint for Organisation update status is /org/v1/status/update
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

PATCHhttps://staging.sunbirded.org/api/org/v1/status/update

Header parameters

Body

application/json

The body contains metadata about an existing Organisation whose status is required to be updated.

requestorgapiOrgStatusUpdateReq (object)

Response

200400500

OK. Successful operation. The requested operation was successfully executed.

Body

application/json

id*string

Represents the ID of the request which was made

ver*string

Represents the version of the API which was used

ets*integer (int64)

Represents the EPOCH (UTC) timestamp in milliseconds since EPOCH

params*object

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/org/v1/status/update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "filters": {
          "organisationId": "0131630445447741440",
          "status": 0
        }
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.org.status.update",
  "ver": "v1",
  "params": {
    "resmsgid": null,
    "msgid": "5398bdd7-f80d-4a9e-9c13-90ae3c6bbcb0",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "ts": "2020-11-23 10:03:39:935+0000",
  "result": {
    "organisationId": 131636612466278400,
    "response": "SUCCESS"
  }
}

Assign Key to an Organisation

This API is for creation/addition of keys to an Organisation

POSThttps://staging.sunbirded.org/api/org/v1/assign/key

Authorization

bearer

Header parameters

Body

application/json

The body contains metadata about the new keys to be created.

requestorgapiOrgAssignKeyReq (object)

Response

200400500

OK. Successful operation. The Assign key to an Organisation operation was successfully executed.

Body

application/json

id*string

Represents the ID of the request which was made

ver*string

Represents the version of the API which was used

ets*integer (int64)

Represents the EPOCH (UTC) timestamp in milliseconds since EPOCH

params*object

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/org/v1/assign/key', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "id": "0131630445447741440",
        "signKeys": [
          "S1",
          "S2"
        ],
        "encKeys": [
          "E1",
          "E2"
        ]
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.org.assign.key",
  "ver": "v1",
  "params": {
    "resmsgid": null,
    "msgid": "5398bdd7-f80d-4a9e-9c13-90ae3c6bbcb0",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "ts": "2020-11-23 10:03:39:935+0000",
  "result": {
    "response": "SUCCESS"
  }
}