Description

Allows a client to fetch all system settings.

Request Endpoint

GET https://<Example api server address>/setting

Parameters

None.

cURL syntax

curl --include \
'https://core.dev.Example.net/api/setting'

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "error": false,
  "message": "Fetching system settings successful",
  "detail": null,
  "data": [
    {
      "id": "18ccdbfe-7c49-467e-86f9-a4e214565eec",
      "param": "bypass.sms.numbers",
      "value": "+919916248135,+919916248136"
    }
  ]
}

Return to top

Description

Updates a particular system setting.

Request Endpoint

PUT https://<Example api server address>/setting/{id}

Parameters

Parameter	Type	Use	Description
id	String	Required	Unique id of the setting.

cURL syntax

curl --include \
     --request PUT \
   --data-binary "{
    \"id\": \"18ccdbfe-7c49-467e-86f9-a4e214565eec\",
    \"param\": \"bypass.sms.numbers\",
    \"value\": \"+919916248135,+919916248136\"
}" \
'https://core.dev.Example.net/api/setting/id'

PUT body attributes (JSON)

Attribute	Type	Use	Description
id	String	Required	Unique id of the setting.
param	String	Optional	The param.
value	String	Optional	The value.

PUT body

Headers: Content-Type: application/json

{
  "id": "18ccdbfe-7c49-467e-86f9-a4e214565eec",
  "param": "bypass.sms.numbers",
  "value": "+919916248135,+919916248136"
}

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "error": false,
  "message": "Updating system settings successful",
  "detail": null,
  "data": {
    "id": "18ccdbfe-7c49-467e-86f9-a4e214565eec",
    "param": "bypass.sms.numbers",
    "value": "+919916248135,+919916248136"
  }
}

Return to top