Skip to main content
POST
/
api
/
user
/
institutionCreateJoinId
Create or retrieve institution join code
curl --request POST \
  --url https://pria.praxislxp.com/api/user/institutionCreateJoinId \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "institutionId": "60d5ec49f1b2c72b9c8e4d3a"
}
'
import requests

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

payload = { "institutionId": "60d5ec49f1b2c72b9c8e4d3a" }
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({institutionId: '60d5ec49f1b2c72b9c8e4d3a'})
};

fetch('https://pria.praxislxp.com/api/user/institutionCreateJoinId', 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/institutionCreateJoinId",
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([
'institutionId' => '60d5ec49f1b2c72b9c8e4d3a'
]),
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/institutionCreateJoinId"

payload := strings.NewReader("{\n \"institutionId\": \"60d5ec49f1b2c72b9c8e4d3a\"\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/institutionCreateJoinId")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"institutionId\": \"60d5ec49f1b2c72b9c8e4d3a\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"institutionId\": \"60d5ec49f1b2c72b9c8e4d3a\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "joinId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "message": "Successful joinId"
}
{
"success": false,
"message": "Invalid institution"
}
{
"success": false,
"message": "Authentication Required"
}
{
"success": false,
"message": "Unauthorized for users"
}
{
"success": false,
"message": "Not Found"
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
institutionId
string
required

The institution ObjectId to create/retrieve a join code for

Example:

"60d5ec49f1b2c72b9c8e4d3a"

Response

Join code created or retrieved successfully

success
boolean
Example:

true

data
object
message
string
Example:

"Successful joinId"