Tenant Configurations

PreviousOTP Services NextBulk Upload

Last updated 2 years ago

Was this helpful?

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.

post

/org/v2/preferences/read

Authorizations

Header parameters

tsstring

Timestamp at which given API request is sent.

X-msgidstring

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

Authorizationstringrequired

To make use of this API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

x-authenticated-user-tokenstringrequired

It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password

x-authenticated-forstring

Managed User token of registered MUA user performing given API request.

Body

requestTenantPreferenceReadRequestObjrequired

Example: {"orgId":"all","key":"selfdeclarations"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/org/v2/preferences/read' \
  --header 'Authorization: text' \
  --header 'x-authenticated-user-token: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"orgId":"all","key":"selfdeclarations"}}'

200

400

401

404

500

{
  "id": "api.org.preferences.read",
  "ver": "v2",
  "ts": "2020-11-25 19:32:15:113+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "cb39f64aeb15c9ac0afdb5d2a8bc634b",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "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.

post

/org/v2/preferences/create

Authorizations

Header parameters

tsstring

Timestamp at which given API request is sent.

X-msgidstring

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

Authorizationstringrequired

To make use of this API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

x-authenticated-user-tokenstringrequired

It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password

x-authenticated-forstring

Managed User token of registered MUA user performing given API request.

Body

requestTenantPreferenceCreateRequestObjrequired

Example: {"orgId":"all","key":"selfdeclarations","data":"Tenant Preference Data"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/org/v2/preferences/create' \
  --header 'Authorization: text' \
  --header 'x-authenticated-user-token: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"orgId":"all","key":"selfdeclarations","data":"Tenant preference data"}}'

200

400

401

404

500

{
  "id": "api.org.preferences.create",
  "ver": "v2",
  "ts": "2020-11-26 17:49:14:722+0000",
  "responseCode": "OK",
  "params": {
    "resmsgid": null,
    "msgid": "cc4678bef11ed973caae3760385a3af0",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "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.

patch

/org/v2/preferences/update

Authorizations

Header parameters

tsstring

Timestamp at which given API request is sent.

X-msgidstring

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

Authorizationstringrequired

To make use of this API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

x-authenticated-user-tokenstringrequired

It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password

x-authenticated-forstring

Managed User token of registered MUA user performing given API request.

Body

requestTenantPreferenceCreateRequestObjrequired

Example: {"orgId":"all","key":"selfdeclarations","data":"Tenant Preference Data"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://staging.sunbirded.org/api/org/v2/preferences/update' \
  --header 'Authorization: text' \
  --header 'x-authenticated-user-token: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"orgId":"all","key":"selfdeclarations","data":"Tenant preference data"}}'

200

400

401

404

500

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