Tenant Configurations

TenantPreferenceRead

This API is used to get data that is saved as tenant preference for an organisation

• The endpoint for Update Consent is /org/v2/preferences/read
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.sunbirded.org/api/org/v2/preferences/read

Header parameters

Body

application/json

request*TenantPreferenceReadRequestObj

Response

200400401404500

Body

application/json

id*string

ver*string

ts*string

params*TenantPreferenceReadSuccessParams

responseCode*string

result*TenantPreferenceReadSuccessResult

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/org/v2/preferences/read', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "orgId": "all",
        "key": "selfdeclarations"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.org.preferences.read",
  "ver": "v2",
  "ts": "2020-11-25 19:32:15:113+0000",
  "params": {
    "resmsgid": null,
    "msgid": "cb39f64aeb15c9ac0afdb5d2a8bc634b",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": {
      "updatedBy": null,
      "data": "Tenant preference data",
      "createdBy": "95e4942d-cbe8-477d-aebd-ad8e6de4bfc8",
      "updatedOn": null,
      "createdOn": 1597330354157,
      "key": "selfdeclarations",
      "orgId": "all"
    }
  }
}

TenantPreferenceCreate

This API is used to save data as per the tenant preference for an organisation

• The endpoint for Update Consent is /org/v2/preferences/create
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.sunbirded.org/api/org/v2/preferences/create

Header parameters

Body

application/json

request*TenantPreferenceCreateRequestObj

Response

200400401404500

Body

application/json

id*string

ver*string

ts*string

params*TenantPreferenceReadSuccessParams

responseCode*string

result*TenantPreferenceCreateSuccessResult

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/org/v2/preferences/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "orgId": "all",
        "key": "selfdeclarations",
        "data": "Tenant preference data"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.org.preferences.create",
  "ver": "v2",
  "ts": "2020-11-26 17:49:14:722+0000",
  "params": {
    "resmsgid": null,
    "msgid": "cc4678bef11ed973caae3760385a3af0",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS",
    "orgId": "all",
    "key": "selfdeclarations"
  }
}

TenantPreferenceUpdate

This API is used to update data as per the tenant preference for an organisation

• The endpoint for Update Consent is /org/v2/preferences/update
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

PATCHhttps://staging.sunbirded.org/api/org/v2/preferences/update

Header parameters

Body

application/json

request*TenantPreferenceCreateRequestObj

Response

200400401404500

Body

application/json

id*string

ver*string

ts*string

params*TenantPreferenceReadSuccessParams

responseCode*string

result*TenantPreferenceUpdateSuccessResult

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/org/v2/preferences/update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "orgId": "all",
        "key": "selfdeclarations",
        "data": "Tenant preference data"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.org.preferences.update",
  "ver": "v2",
  "ts": "2020-11-25 19:33:57:441+0000",
  "params": {
    "resmsgid": null,
    "msgid": "8980371bc3521fe2a154e13e4772e493",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}