Skip to main content
POST
/
api
/
test
/
url
curl --request POST \
  --url https://pria.praxislxp.com/api/test/url \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://domain.edu/course/12345"
}
'
{
  "ltiassigned": true,
  "status": "active",
  "name": "Acme University",
  "ainame": "Hugo",
  "picture": "https://storage.example.com/logo.png",
  "publicId": "bc6efd03-9d01-43e7-bd49-c4af1c54ae3a"
}

Body

application/json
​
url
string<uri>

The LTI context URL to be tested. Used to find an institution by matching against registered LTI context IDs.

Example:

"https://domain.edu/7891273"

​
institutionid
string<uuid>

The public ID of the institution to lookup directly. Used as fallback if URL lookup fails.

Example:

"bc6efd03-9d01-43e7-bd49-c4af1c54ae3a"

​
email
string<email>

The email address of the user to check membership status for.

Example:

"[email protected]"

​
userid
string

The LXP user ID to lookup the user by (alternative to email).

Example:

"lxp_12345"

Response

URL test completed successfully

​
ltiassigned
boolean

Indicates if the institution was found via LTI context URL match

Example:

true

​
name
string

Name of the institution

Example:

"Acme University"

​
status
enum<string>

Status of the institution, user, or user-institution membership. Possible values include 'active', 'inactive', 'pending', 'suspended', 'invalid'.

Available options:
active,
inactive,
pending,
suspended,
invalid,
deleted
Example:

"active"

​
ainame
string

AI/Digital Twin name associated with the institution

Example:

"Hugo"

​
picture
string

Picture URL for the institution branding

Example:

"https://storage.example.com/logo.png"

​
publicId
string<uuid>

Public identifier for the institution

Example:

"bc6efd03-9d01-43e7-bd49-c4af1c54ae3a"