System Settings

set

post

Authorizations

httpBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

To make use of any System 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-forstringOptional

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

Body

application/json

Responses

200

Success Response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/data/v1/system/settings/set

HTTPcURLJavaScriptPython

POST /api/data/v1/system/settings/set HTTP/1.1
Host: staging.sunbirded.org
Authorization: text
x-authenticated-user-token: text
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "request": {
    "id": "userTnc",
    "field": "userTnc",
    "value": "{\"latestVersion\":\"3.5.0\"}"
  }
}

{
  "id": "api.system.settings.set",
  "ver": "v1",
  "ts": "2020-12-01 10:47:16:629+0000",
  "params": {
    "resmsgid": null,
    "msgid": "340d4ef3f113f5db5e81859e18663214",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS",
    "id": "userTnc"
  }
}

get

get

Authorizations

httpBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

configNamestringRequired

Field config Name

Example: userTnc

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

To make use of any System 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-tokenstringOptional

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-forstringOptional

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

Responses

200

Success Response

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/data/v1/system/settings/get/{configName}

HTTPcURLJavaScriptPython

GET /api/data/v1/system/settings/get/{configName} HTTP/1.1
Host: staging.sunbirded.org
Authorization: text
Accept: */*

{
  "id": "api.system.settings.get.userTnc",
  "ver": "v1",
  "ts": "2020-12-01 17:46:36:645+0530",
  "params": {
    "resmsgid": null,
    "msgid": "62c78ba7-b0e1-408d-8dfe-7cc3c4e652cc",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": {
      "id": "userTnc",
      "field": "userTnc",
      "value": "{\"latestVersion\":\"3.4.0\"}"
    }
  }
}

list

get

Authorizations

httpBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

To make use of any System 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-tokenstringOptional

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-forstringOptional

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

Responses

200

Success Response

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/data/v1/system/settings/list

HTTPcURLJavaScriptPython

GET /api/data/v1/system/settings/list HTTP/1.1
Host: staging.sunbirded.org
Authorization: text
Accept: */*

{
  "id": "api.system.settings.list",
  "ver": "v1",
  "ts": "2020-12-01 12:21:46:829+0000",
  "params": {
    "resmsgid": null,
    "msgid": "f11acda288889cf47ecdf8812e623387",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": [
      {
        "id": "uniqueField",
        "field": "uniqueField",
        "value": false
      },
      {
        "id": "custodianRootOrgId",
        "field": "custodianRootOrgId",
        "value": 1285019302823526400
      },
      {
        "id": "tncConfigtest",
        "field": "tncConfigtest",
        "value": "test"
      },
      {
        "id": "userTnc",
        "field": "userTnc",
        "value": "{\"latestVersion\":\"3.5.0\"}"
      },
      {
        "id": "test",
        "field": "test",
        "value": "@test"
      },
      {
        "id": "userTnc",
        "field": "userTnc",
        "value": "{\"latestVersion\":\"3.5.0\"}"
      },
      {
        "id": "channelRegStatus",
        "field": "channelRegStatus",
        "value": false
      },
      {
        "id": "phoneUnique",
        "field": "phoneUnique",
        "value": true
      },
      {
        "id": "systemInitialisationStatus",
        "field": "systemInitialisationStatus",
        "value": "CUSTODIAN_ORG_CREATED"
      },
      {
        "id": "courseFrameworkId",
        "field": "courseFrameworkId",
        "value": "tpd"
      },
      {
        "id": "consumptionFaqs",
        "field": "consumptionFaqs",
        "value": "https://dev.sunbirded.org/faq.html"
      },
      {
        "id": "ssoCourseSection",
        "field": "ssoCourseSection",
        "value": 129795520637419520
      },
      {
        "id": "emailUnique",
        "field": "emailUnique",
        "value": true
      },
      {
        "id": "tn",
        "field": "tn",
        "value": "{'helpdeskEmail':'[email protected]','playstoreLink':'play.google.com/appid=123'}"
      },
      {
        "id": "emailUniqueAndPhone",
        "field": "emailUniqueAndPhone",
        "value": true
      }
    ]
  }
}