This demo page simulates functionality that might be available in a client application server.
Jump to: Create user | Join | Login | Remove user | Lesson | Results
To get started, enter the values for your Bracken integration here:
| Property | Value |
|---|---|
| Client ID | |
| Client Secret |
Create usertop
POST /api/membership/create
This form is posted to the compatibility server to create a new user, in the same way that the PublicAPI works.
| Property | Value | Response |
|---|---|---|
| Client ID* | ||
| Client Secret* | ||
| Username* | ||
| First name | ||
| Last name | ||
| Password* | ||
| Multicode | ||
| Parent key | ||
Join by multicodetop
GET /api/membership/join/{username}/to/{multicode}
This joins a user with a multicode that can include both Bracken 1 Zones and Bracken 2 Groups.
| Property | Value | Response |
|---|---|---|
| Client ID* | ||
| Client Secret* | ||
| Username | ||
| Multicode | ||
Logintop
GET /api/membership/login/{username}?response_mode={response_mode}
These links simulate the client app behaviour for logging in a user using the PublicAPI / Compatibility API login token method.
Client App Compatibility Bracken
| | | |
(1)--Link-----> | | |
| (2)--GET /login---. | |
| | |(3) |
| | <--Content*----' | |
| <--Render---(4) | |
| | | |
(5)--Action*----------------------------------> |
| | | |
Login user access opens in new tab.
| Property | Value | Action |
|---|---|---|
| Client ID* | ||
| Client Secret* | ||
| Username* | ||
text/html
|
Self-submitting <form> to Bracken 2 |
|
text/plain
|
URL to Bracken 1 for document.location |
|
302 Found
|
Redirect Location to Bracken 1 |
|
Overrides
The redirect targets can be controlled by optional properties in the domain credentials environment variable.
| Parameter | Applies to | Effect |
|---|---|---|
forceLegacyRedirect |
form_post |
The returned self-submitting <form> logs in to
Bracken 1.
|
forceUpdateRedirect |
passthrough, redirect_uri |
The return URL (as text or redirect location) logs the user in to Bracken 2. |
Remove user from group or zonetop
POST /api/membership/accessrights
This removes a user from a zone or group.
| Property | Value | Response |
|---|---|---|
| Client ID* | ||
| Client Secret* | ||
| Username | ||
| Zone or Group key | ||
| Rights ("R" or "D") | ||
List lesson informationtop
GET /api/content/list/lesson/{lessonkey}
List information about a lesson or module.
| Property | Value | Response |
|---|---|---|
| Client ID* | ||
| Client Secret* | ||
| Lesson ID* | ||
Results Modifiedtop
GET /api/lesson/list/zone/{zonekey}/modified/{date}
Compatibility for retrieving Bracken 1 results (using a specific zone), or backported Bracken 2 results (within a group).
For Bracken 2 Portfolios (i.e., in a Group):
- The Pass value is always 1
- The Score value is 0 or 1 depending on the completed date, which indicates whether a portfolio was achieved.
| Property | Value | Response |
|---|---|---|
| Client ID* | ||
| Client Secret* | ||
| Filter date | ||
| Zone or Group key | ||
The results are also displayed in a tabular view below.
| userkey | username | zonekey | resultkey | lessonkey | status | title | created | modified | achieved | score | pass |
|---|