Organisation Management

Create a new Organisation

post

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.

Authorizations

Header parameters

tsstringoptional

Timestamp at which given API request is sent.

X-msgidstringoptional

This ID uniquely identifies a request if the same API is executed multiple times.

X-Authenticated-User-Tokenstringrequired

Access token of registered user performing given API request.

Authorizationstringrequired

Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.

Body

all ofoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/org/v1/create' \
  --header 'Authorization: text' \
  --header 'X-Authenticated-User-Token: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "request": {
      "orgName": "Org Name",
      "channel": "Channel",
      "description": "Description",
      "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
    }
  }'

200

400

500

200

{
  "id": "api.org.create",
  "ver": "v1",
  "ets": 1,
  "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"
  }
}

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

Read Organisation details

post

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.

Authorizations

Header parameters

tsstringoptional

Timestamp at which given API request is sent.

X-msgidstringoptional

This ID uniquely identifies a request if the same API is executed multiple times.

Authorizationstringrequired

Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.

Body

all ofoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/org/v1/read' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "request": {
      "organisationId": "0131630445447741440"
    }
  }'

200

400

404

500

200

{
  "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": "Updated Description",
      "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
    }
  }
}

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

Search for an Organisation

post

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.

Authorizations

Header parameters

tsstringoptional

Timestamp at which given API request is sent.

X-msgidstringoptional

This ID uniquely identifies a request if the same API is executed multiple times.

X-Authenticated-User-Tokenstringrequired

Access token of registered user performing given API request.

Authorizationstringrequired

Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.

Body

all ofoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/org/v1/search' \
  --header 'Authorization: text' \
  --header 'X-Authenticated-User-Token: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "request": {
      "filters": {
        "id": "0131630445447741440"
      }
    }
  }'

200

400

500

200

{
  "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": "Updated Description",
          "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
        }
      ]
    }
  }
}

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

Update particulars of an existing Organisation

patch

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.

Authorizations

Header parameters

tsstringoptional

Timestamp at which given API request is sent.

X-msgidstringoptional

This ID uniquely identifies a request if the same API is executed multiple times.

X-Authenticated-User-Tokenstringrequired

Access token of registered user performing given API request.

Authorizationstringrequired

Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.

Body

all ofoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://staging.sunbirded.org/api/org/v1/update' \
  --header 'Authorization: text' \
  --header 'X-Authenticated-User-Token: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "request": {
      "organisationId": "0131630445447741440,",
      "description": "updated description,",
      "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"
        }
      ]
    }
  }'

200

400

500

200

{
  "id": "api.org.status.update",
  "ver": "v1",
  "ets": 1,
  "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"
  }
}

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

Organisation update status

patch

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.

Header parameters

tsstringoptional

Timestamp at which given API request is sent.

X-msgidstringoptional

This ID uniquely identifies a request if the same API is executed multiple times.

X-Authenticated-User-Tokenstringrequired

Access token of registered user performing given API request.

Authorizationstringrequired

Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.

Body

all ofoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://staging.sunbirded.org/api/org/v1/status/update' \
  --header 'X-Authenticated-User-Token: text' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "request": {
      "filters": {
        "organisationId": "0131630445447741440",
        "status": 0
      }
    }
  }'

200

400

500

200

{
  "id": "api.org.status.update",
  "ver": "v1",
  "ets": 1,
  "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"
  }
}

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

Assign Key to an Organisation

post

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

Authorizations

Header parameters

tsstringoptional

Timestamp at which given API request is sent.

X-msgidstringoptional

This ID uniquely identifies a request if the same API is executed multiple times.

X-Authenticated-User-Tokenstringrequired

Access token of registered user performing given API request.

Authorizationstringrequired

Specify authorization key (format: Bearer api-key) received from administrator when performing given API request.

Body

all ofoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/org/v1/assign/key' \
  --header 'Authorization: text' \
  --header 'X-Authenticated-User-Token: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "request": {
      "id": "0131630445447741440",
      "signKeys": [
        "S1",
        "S2"
      ],
      "encKeys": [
        "E1",
        "E2"
      ]
    }
  }'

200

400

500

200

{
  "id": "api.org.assign.key",
  "ver": "v1",
  "ets": 1,
  "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"
  }
}

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