System Settings

set

POSThttps://staging.sunbirded.org/api/data/v1/system/settings/set

Header parameters

Body

application/json

request*Request

Response

200400401500

Success Response

Body

application/json

id*string

ver*string

ts*string

params*Params

responseCode*string

result*Result

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/data/v1/system/settings/set', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-authenticated-user-token": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "id": "userTnc",
        "field": "userTnc",
        "value": "{\"latestVersion\":\"3.5.0\"}"
      }
    }),
});
const data = await response.json();

Response

200400401500

{
  "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

GEThttps://staging.sunbirded.org/api/data/v1/system/settings/get/{configName}

Path parameters

configName*string

Field config Name

Example: "userTnc"

Header parameters

Response

200401404500

Success Response

Body

application/json

id*string

ver*string

ts*string

params*Params

responseCode*string

result*Result

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/data/v1/system/settings/get/{configName}', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200401404500

{
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": "text",
  "result": {
    "response": "text",
    "id": "text"
  }
}

list

GEThttps://staging.sunbirded.org/api/data/v1/system/settings/list

Header parameters

Response

200401500

Success Response

Body

application/json

id*string

ver*string

ts*string

params*Params

responseCode*string

result*Results

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/data/v1/system/settings/list', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200401500

{
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": "text",
  "result": {
    "response": [
      {
        "id": "text",
        "field": "text",
        "value": "text"
      }
    ]
  }
}