Overview
Caliper
CASE
CLR
EduBridge
OneRoster
PowerPath
QTI
Timeback Events
Webhooks
curl --request POST \
--url https://api.alpha-1edtech.ai/powerpath/createExternalTestOut \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"courseId": "<string>",
"toolProvider": "edulastic",
"grades": [
"-1"
],
"lessonType": "<string>",
"xp": 123,
"lessonTitle": "<string>",
"launchUrl": "<string>",
"unitTitle": "<string>",
"courseComponentSourcedId": "<string>",
"vendorId": "<string>",
"description": "<string>",
"resourceMetadata": "<unknown>"
}
'{
"lessonType": "powerpath-100",
"lessonId": "<string>",
"courseComponentId": "<string>",
"resourceId": "<string>",
"toolProvider": "<string>",
"launchUrl": "<string>",
"vendorId": "<string>",
"courseIdOnFail": "<string>",
"grades": [
"3"
]
}Create an External TestOut
Creates or updates a ComponentResource to act as a TestOut lesson in a course. This allows integrating with external test-taking platforms (like Edulastic) for content delivery.
The endpoint creates or updates (if they already exist) the following entities:
- A CourseComponent for the course to hold the TestOut lesson
- A Resource with lessonType = “test-out” and the external service details as metadata
- A ComponentResource acting as the TestOut lesson
A test assignment is mandatory in order to obtain access credentials for this test on the external platform, as well as to obtain the IDs necessary for fetching test results later on:
- For test assignments, use the “makeExternalTestAssignment” endpoint.
- For test results retrieval, use the “importExternalTestAssignmentResults” endpoint.
This request fails if:
- The course provided does not exist
- An existing TestOut lesson in the course has a different toolProvider than the one provided (need to perform an update to the Resource first, altering the “toolProvider”, before trying again)
A ‘Lesson’ in this context is a ComponentResource object which has a Resource object with lessonType = “test-out” associated with it.
curl --request POST \
--url https://api.alpha-1edtech.ai/powerpath/createExternalTestOut \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"courseId": "<string>",
"toolProvider": "edulastic",
"grades": [
"-1"
],
"lessonType": "<string>",
"xp": 123,
"lessonTitle": "<string>",
"launchUrl": "<string>",
"unitTitle": "<string>",
"courseComponentSourcedId": "<string>",
"vendorId": "<string>",
"description": "<string>",
"resourceMetadata": "<unknown>"
}
'{
"lessonType": "powerpath-100",
"lessonId": "<string>",
"courseComponentId": "<string>",
"resourceId": "<string>",
"toolProvider": "<string>",
"launchUrl": "<string>",
"vendorId": "<string>",
"courseIdOnFail": "<string>",
"grades": [
"3"
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
- Option 1
- Option 2
Input for creating an external test-out lesson
The sourcedId of the Course to create the external test for
The type of external service (e.g.: 'edulastic')
edulastic, mastery-track The grades for the resource
The grades of the course
-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 "test-out"The XP value for the resource
The title of the external test reference
The URL to the external test system (e.g., Edulastic, QTI, etc.)
The title of the unit containing the external test
The sourcedId of an existing CourseComponent (unit) for the test. If not provided, a new unit will be created.
The ID of the test in the spreadsheet
Description of the external test that will be added to the Resource entity's metadata
Additional metadata for the external test resource
Response
Success
powerpath-100, quiz, test-out, placement, unit-test, alpha-read-article The sourcedId of the created external test reference (ComponentResource)
The sourcedId of the component (unit) containing the test
The sourcedId of the resource representing the external test
The tool provider id
The URL to the external test system
The ID of the test in the spreadsheet
The courseId to enroll the student in if they fail the placement test (optional)
The grades for the resource
The grades of the course
-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13