Retrieve settings for the current institution
curl --request POST \
--url https://pria.praxislxp.com/api/user/settings \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"status": "active",
"key": "variable-2"
}
'import requests
url = "https://pria.praxislxp.com/api/user/settings"
payload = {
"status": "active",
"key": "variable-2"
}
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({status: 'active', key: 'variable-2'})
};
fetch('https://pria.praxislxp.com/api/user/settings', 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/settings",
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([
'status' => 'active',
'key' => 'variable-2'
]),
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/settings"
payload := strings.NewReader("{\n \"status\": \"active\",\n \"key\": \"variable-2\"\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/settings")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"active\",\n \"key\": \"variable-2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/settings")
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 \"status\": \"active\",\n \"key\": \"variable-2\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"_id": "687e6ee393c79717445848de",
"key": "variable-2",
"value": "variable value",
"institution": "6631915765bb0a94cfd6ca99",
"user": "6430d02554cd4e00403e8b05",
"status": "active",
"admin_only": true,
"institution_shared": true,
"editable_others": true,
"created": "2023-11-07T05:31:56Z",
"institution_data": {
"_id": "6631915765bb0a94cfd6ca99",
"name": "scarlet.hugo.praxis-ai.instructure.com",
"ainame": "Scarlet"
},
"user_data": {
"_id": "6430d02554cd4e00403e8b05",
"email": "hugo.lebegue@gmail.com",
"fname": "Hugo",
"lname": "Lebegue"
},
"index": 1
}
]
}{
"success": false,
"message": "Error getting setting <details>"
}{
"success": false,
"message": "Authentication Required"
}{
"success": false,
"message": "This functionality is reserved to instance users"
}Setting
Retrieve settings for the current institution
Fetches settings scoped to the authenticated user’s institution, with institution and user metadata. Results are sorted by key ascending and limited to 100 records. Requires the user to belong to an institution.
POST
/
api
/
user
/
settings
Retrieve settings for the current institution
curl --request POST \
--url https://pria.praxislxp.com/api/user/settings \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"status": "active",
"key": "variable-2"
}
'import requests
url = "https://pria.praxislxp.com/api/user/settings"
payload = {
"status": "active",
"key": "variable-2"
}
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({status: 'active', key: 'variable-2'})
};
fetch('https://pria.praxislxp.com/api/user/settings', 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/settings",
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([
'status' => 'active',
'key' => 'variable-2'
]),
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/settings"
payload := strings.NewReader("{\n \"status\": \"active\",\n \"key\": \"variable-2\"\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/settings")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"active\",\n \"key\": \"variable-2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/settings")
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 \"status\": \"active\",\n \"key\": \"variable-2\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"_id": "687e6ee393c79717445848de",
"key": "variable-2",
"value": "variable value",
"institution": "6631915765bb0a94cfd6ca99",
"user": "6430d02554cd4e00403e8b05",
"status": "active",
"admin_only": true,
"institution_shared": true,
"editable_others": true,
"created": "2023-11-07T05:31:56Z",
"institution_data": {
"_id": "6631915765bb0a94cfd6ca99",
"name": "scarlet.hugo.praxis-ai.instructure.com",
"ainame": "Scarlet"
},
"user_data": {
"_id": "6430d02554cd4e00403e8b05",
"email": "hugo.lebegue@gmail.com",
"fname": "Hugo",
"lname": "Lebegue"
},
"index": 1
}
]
}{
"success": false,
"message": "Error getting setting <details>"
}{
"success": false,
"message": "Authentication Required"
}{
"success": false,
"message": "This functionality is reserved to instance users"
}Authorizations
JWT token passed in x-access-token header
Body
application/json
Was this page helpful?
⌘I