Skip to main content
POST
/
api
/
user
/
setting
Create a new instance variable
curl --request POST \
  --url https://pria.praxislxp.com/api/user/setting \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "key": "variable-4",
  "value": "the value",
  "admin_only": true,
  "editable_others": true,
  "institution_shared": true
}
'
import requests

url = "https://pria.praxislxp.com/api/user/setting"

payload = {
    "key": "variable-4",
    "value": "the value",
    "admin_only": True,
    "editable_others": True,
    "institution_shared": True
}
headers = {
    "x-access-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    key: 'variable-4',
    value: 'the value',
    admin_only: true,
    editable_others: true,
    institution_shared: true
  })
};

fetch('https://pria.praxislxp.com/api/user/setting', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pria.praxislxp.com/api/user/setting",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key' => 'variable-4',
    'value' => 'the value',
    'admin_only' => true,
    'editable_others' => true,
    'institution_shared' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pria.praxislxp.com/api/user/setting"

	payload := strings.NewReader("{\n  \"key\": \"variable-4\",\n  \"value\": \"the value\",\n  \"admin_only\": true,\n  \"editable_others\": true,\n  \"institution_shared\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-access-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/user/setting")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"variable-4\",\n  \"value\": \"the value\",\n  \"admin_only\": true,\n  \"editable_others\": true,\n  \"institution_shared\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://pria.praxislxp.com/api/user/setting")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key\": \"variable-4\",\n  \"value\": \"the value\",\n  \"admin_only\": true,\n  \"editable_others\": true,\n  \"institution_shared\": true\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "_id": "687e71b293c797174458e6f2",
    "key": "variable-4",
    "value": "the value",
    "institution": "6631915765bb0a94cfd6ca99",
    "user": "6430d02554cd4e00403e8b05",
    "status": "active",
    "admin_only": true,
    "institution_shared": true,
    "editable_others": true,
    "created": "2023-11-07T05:31:56Z",
    "__v": 0
  },
  "message": "Setting created!"
}
{
  "success": false,
  "message": "Setting with the same key already exists!"
}
{
  "success": false,
  "message": "Authentication Required"
}
{
  "success": false,
  "message": "This functionality is reserved to instance users"
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
key
string
required

Setting key name (must be unique within the institution)

Example:

"variable-4"

value
string

Setting value (optional)

Example:

"the value"

admin_only
boolean

Whether setting is admin-only

Example:

true

editable_others
boolean

Whether setting can be edited by others

Example:

true

institution_shared
boolean

Whether setting is shared across institution

Example:

true

Response

Setting successfully created

success
boolean
Example:

true

data
object
message
string
Example:

"Setting created!"