> ## Documentation Index > Fetch the complete documentation index at: https://docs.timeback.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a custom hole-filling course (async) > Creates a custom hole-filling course for a student with specific lessons you choose. Returns 202 with a `jobId` immediately — the course is created asynchronously. ## How it works 1. Looks up the student by email 2. Creates lesson assignments in the target app 3. Creates a course in OneRoster with the assigned lessons 4. Removes the student from existing same-subject courses (protected courses like Manual XP are kept) — unless `skipUnenroll` is true 5. Enrolls the student in the new course If enrollment fails, any removed courses are automatically restored (unless unenrollment was skipped). Progress and failures are reported via Google Chat notifications. ## Picking lessons For **Bridge apps** (`mobymax`, `lalilo`, `freckle`, `vocabloco`, `anton`, `edia`), use `GET /edubridge/progression/catalog` to browse available lessons, then pass the `lessonId` values into the `lessons` array. For the **native OneRoster apps** (`timeback`, `timeback_learn`, `alphawrite`, `alpha_read`), `/catalog` does not apply and no external assignments are created. For `timeback_learn`, Math `lessonId` values are source course-component sourcedIds, while Science values are resource sourcedIds. For the other native apps, `lessonId` values are existing OneRoster resource sourcedIds (for `alpha_read`, use the article resource sourcedId, e.g. `article_4100001`; requires subject `Reading`). ## Validation rules **Grade:** Accepts `PK`, `PreK`, `Pre-K`, `Pre-Kindergarten`, `K`, `KG`, `Kindergarten`, or `0`–`12`. Canonicalized to a numeric string (PK = `-1`, K = `0`). Values like `3rd` or `banana` are rejected. **`next`:** What happens after the student completes the course. Accepts: - A test type: `end of course`, `test out`, or `placement` (case-insensitive, flexible spacing) - A course UUID from an active course sequence — the student will be enrolled in that course next **`assignmentId`:** Must be a positive integer if provided. Resolved automatically from existing enrollments if omitted. ## OpenAPI ````yaml /openapi/beyond-ai/edubridge-api.yaml post /edubridge/progression/custom-hole-filling-course openapi: 3.1.0 info: title: Edubridge API version: 1.0.0 description: > # EduBridge API Overview The Edubridge API provides simplified interfaces for digital schools to manage their digital courses and student enrollments, abstracting away the complexities of the OneRoster standard while maintaining compatibility. It offers streamlined endpoints to enroll students in courses without the need to understand the underlying academic hierarchy. This API significantly reduces integration complexity for third-party systems by handling the background creation and management of academic sessions (per year), classes (per course), and enrollment relationships, allowing consumers to focus on educational experiences rather than data management. Entities involved in the Edubridge API: - Year academic session (per school) - Term academic session (spans the whole year) - Class (per course + term) - Enrollment (per student per class) ## Auto-managed entities The Edubridge API automatically manages the following entities: - Year academic session - Term academic session (spans the whole year) - Class (per course + term) ## Course-centric enrollment This API offers a course-centric view of enrollments, allowing consumers to focus on what courses the student is enrolled in rather than details about the underlying academic hierarchy. You as an API consumer do not need to understand the underlying academic hierarchy to use this API, if you are only interested in what courses a student is enrolled in. Consumers that need to interact with the underlying academic hierarchy through flows not covered by this API can do so by using the raw OneRoster API. ## Pre-requisites Before you can enroll a user in a course, you need the following entities created: - A school or equivalent organization - A course (linked to the organization via orgSourcedId) - A user (that will be enrolled in the course) ## Analytics API The Edubridge Analytics API provides student activity data and metrics across enrollments. ### Available Endpoints **Weekly Facts** - Get facts for a specific week by student email or ID - Returns: List of individual facts grouped by date **Activity (Date Range)** - Get facts for a custom date range by student email or ID - Returns: Aggregated metrics grouped by date → subject and date → subject → app **Enrollment Facts** - Get facts for a specific enrollment - Returns: Aggregated metrics for all activity within an enrollment - Supports optional date range filtering via `startDate` and `endDate` query parameters - Supports timezone conversion via `timezone` query parameter **Highest Grade Mastered** - Get the highest grade a student has mastered for a subject - Returns: Grade data from multiple sources (Edulastic, placement tests, test-out) **Student Percentiles** - Get the latest MAP percentile snapshots for a student - Returns: Per-subject percentile, RIT score, assessment date, and season - Used by: Goals UI setup and percentile/x-factor previews ### Metrics Included - **Activity Metrics**: Questions answered (total/correct), XP earned, units mastered - **Time Metrics**: Active seconds, inactive seconds, waste seconds - **Grouping**: Subject, application/platform, course, campus, date ### Authorization All analytics endpoints require the `analytics.readOnly` OAuth scope. ## Goals API The Goals API enables students to preview, track, and update learning goals through the Lambda-backed `/goals/*` surface. ### Goal Types | Type | Description | Required Fields | |------|-------------|-----------------| | `minimum` | Daily minimum XP target (ongoing) | `subject`, `targetValue`, `targetMetric` | | `grade_mastery` | Master content up to target grade | `subject`, `targetValue` | | `percentile` | Reach target percentile (RIT subjects only) | `subject`, `targetValue` | | `x_factor` | Grow Nx faster than typical (e.g., 2x growth) | `subject`, `targetValue` | | `course` | Complete a specific course or explicit course set | `subject`, `targetValue`, `targetMetric`, and either `stageId` or `courseIds` | ### Pace Type Milestone goals (`grade_mastery`, `percentile`, `x_factor`, `course`) support two pacing approaches: | paceType | User Sets | System Calculates | |----------|-----------|-------------------| | `target_date` | End date | Daily XP needed | | `daily_time` | Daily time commitment | Projected completion timeline | Example: "Reach 6th grade Math by May 15" (`target_date`) vs "Work toward 6th grade Math at a steady daily pace" (`daily_time`). ### Available Endpoints **Subject Goals** - `GET /:studentId/subjects` - List subject goal snapshots for a student; bootstrap reads ensure managed minimum goals exist for currently enrolled supported subjects - `POST /:studentId/subjects` - Create the active learner-facing subject goal for a subject - `PATCH /:studentId/subjects/:subject` - Update the active learner-facing subject goal for a subject - `DELETE /:studentId/subjects/:subject` - Delete the active learner-facing subject goal for a subject - `PATCH /:studentId/subjects/:subject/minimum` - Update the managed minimum baseline for a subject - `POST /:studentId/subjects/preview` - Preview a learner-facing subject goal without saving it **Course Goals** - `GET /:studentId/courses` - List course goal snapshots for a student - `POST /:studentId/courses` - Create an atomic course goal - `PATCH /:studentId/courses/:goalId` - Update an atomic course goal - `DELETE /:studentId/courses/:goalId` - Delete an atomic course goal - `POST /:studentId/courses/preview` - Preview an atomic course goal without saving it ### Response Notes - Subject list responses return `{ studentId, subjects: [...] }`. - Subject create/update/minimum-patch responses return `{ subject: ... }`. - Subject preview responses return `{ preview: ... }`. - Course list responses return `{ studentId, courses: [...] }`. - Course create/update responses return `{ course: ... }`. - Course preview responses return `{ preview: ... }`. - `progress.resolution` - Preview responses return `{ preview: { goal: ... } }` using the same inner goal shape as saved goal detail. - Minimum goals are internally managed baseline rows: - auto-created for supported enrolled subjects on the canonical bootstrap goals-list read - readable and patchable - not creatable or deletable by clients - Filtered/history list reads are pure reads and do not run minimum-goal sync. - Standalone pace and NWEA helper endpoints are intentionally not part of the public goals surface. ### Supported Subjects RIT subjects (for percentile and x-factor goals): Math, Reading, Language, Science All subjects: Math, Reading, Language, Vocabulary, Science, Writing, FastMath, Social Studies ### Authorization All goals endpoints require authentication. Endpoints that rely on upstream analytics or sequence resolution also require the same auth context/API Gateway flow used by the Lambda-backed goals service. ## Student Progress API These Lambda-backed endpoints expose non-goal progress projections outside the goals namespace. ### Available Endpoints - `GET /students/:studentId/courses/:courseId/progress` - Get progress for a single course - `GET /students/:studentId/subjects/:subject/grades/:grade/progress` - Get aggregate progress for all courses in a subject-grade band ### Authorization Student progress endpoints require the same authenticated Lambda-backed flow used by the goals service. ## AP Readiness API The AP Readiness API provides a specialized workflow for AP exam preparation. It stores AP readiness goals in `learning_goals` using the `ap_readiness` goal type, but it has its own API surface, scoring pipeline, dashboard, and drill-down views. ### Available Endpoints **Reference Data** - `GET /subjects` - List supported AP exam subjects and title-matching patterns **Dashboard & Drill-down** - `GET /dashboard?subject=...` - Get dashboard rows for all active AP readiness goals in one AP subject - `GET /students/:studentId/drill-down?goalId=...` - Get per-unit drill-down data for one student's AP goal **Goal Management** - `GET /goals?subject=...` - List active AP readiness goals for an AP subject - `POST /goals` - Create an AP readiness goal - `PATCH /goals/:goalId` - Update the tracked courses or exam date for an AP readiness goal **Enrollment Validation** - `GET /enrollment-check?studentId=...&courseIds=id1,id2,...` - Return courses where the student has no active enrollment ### Goal Model - `goalType` is always `ap_readiness` - `targetMetric` is always `percent` - `paceType` is always `target_date` - `targetValue` is currently fixed to the readiness threshold for a predicted AP score of `5` - `courseIds` stores all tracked courses - `metadata.practice_test_course_ids` stores the subset of tracked courses that are practice tests - `curriculumCourseIds` is a derived field returned by the API and equals `courseIds - practice_test_course_ids` ### Dashboard Metrics Each dashboard row includes: - `readiness.componentA` - curriculum course progress percentage from XP - `readiness.componentB` - weighted practice-test accuracy percentage - `readiness.componentC` - final readiness percentage - `readiness.predictedScore` - predicted AP score from `1-5` - `coverage` - how many curriculum units have assessed activity - `topFocusAreas` - weakest unit names - `timeRemainingPct` - percent of time remaining until the exam date ### Response Notes - Create and update responses return `{ goal: ... }` - List responses return `{ goals: [...], totalCount }` - Dashboard responses return `{ rows: [...] }` - Drill-down responses return `{ units: [...] }` - Enrollment-check responses return `{ missingEnrollments: [...] }` ### Authorization AP Readiness endpoints require authentication and the same API Gateway auth context used by the Lambda-backed service. servers: - url: https://api.alpha-1edtech.ai description: Edubridge API security: - OAuth2: [] tags: - name: Analytics description: >- Analytics endpoints for retrieving and aggregating student activity data, including weekly facts and activity reports across date ranges. - name: AP Readiness description: >- AP exam readiness endpoints for creating AP readiness goals, viewing dashboard metrics, drilling into weak units, and checking enrollment gaps for AP preparation courses. - name: Application Metrics description: Track and manage application metrics for monitoring and analytics purposes - name: Applications description: >- Manage and retrieve applications available in the system. Applications represent different learning platforms or educational software that can be integrated. - name: Calendar Days description: >- Calendar day management for tracking instructional days, holidays, breaks, and other non-instructional days. Enables accurate school day counting for attendance, progress tracking, and compliance reporting. - name: Enrollments description: >- Simplified, course-centric enrollment management that abstracts away the complex OneRoster academic hierarchy - name: Goals description: >- Learning goal management endpoints for setting, tracking, and projecting learning goals including daily minimums, grade mastery targets, percentile targets, and course completion goals. - name: Learning Reports description: >- Learning reports endpoints for retrieving and aggregating student activity data, including weekly facts and activity reports. - name: Progression description: >- Proxy endpoints for the student progression pipeline. These routes forward requests to Lambda-backed API Gateway endpoints that handle Caliper event ingestion, progression enqueuing, and hole-filling course creation. - name: Reports description: >- Report PDF endpoints for storing generated reports and retrieving short-lived signed URLs for browser viewing. - name: Subject Track description: >- Subject tracks determine the target course for each subject and grade level. For example, for subject 'Math' grade level '9', the target course can be 'Math Academy 9th Grade' (this is the course that students will be enrolled in when they get placed to Math Grade 9). There can be only one target course per subject and grade level. - name: Users description: >- User management endpoints that provide simplified access to user data with enhanced filtering and querying capabilities beyond the standard OneRoster API. paths: /edubridge/progression/custom-hole-filling-course: post: tags: - Progression summary: Create a custom hole-filling course (async) description: >- Creates a custom hole-filling course for a student with specific lessons you choose. Returns 202 with a `jobId` immediately — the course is created asynchronously. ## How it works 1. Looks up the student by email 2. Creates lesson assignments in the target app 3. Creates a course in OneRoster with the assigned lessons 4. Removes the student from existing same-subject courses (protected courses like Manual XP are kept) — unless `skipUnenroll` is true 5. Enrolls the student in the new course If enrollment fails, any removed courses are automatically restored (unless unenrollment was skipped). Progress and failures are reported via Google Chat notifications. ## Picking lessons For **Bridge apps** (`mobymax`, `lalilo`, `freckle`, `vocabloco`, `anton`, `edia`), use `GET /edubridge/progression/catalog` to browse available lessons, then pass the `lessonId` values into the `lessons` array. For the **native OneRoster apps** (`timeback`, `timeback_learn`, `alphawrite`, `alpha_read`), `/catalog` does not apply and no external assignments are created. For `timeback_learn`, Math `lessonId` values are source course-component sourcedIds, while Science values are resource sourcedIds. For the other native apps, `lessonId` values are existing OneRoster resource sourcedIds (for `alpha_read`, use the article resource sourcedId, e.g. `article_4100001`; requires subject `Reading`). ## Validation rules **Grade:** Accepts `PK`, `PreK`, `Pre-K`, `Pre-Kindergarten`, `K`, `KG`, `Kindergarten`, or `0`–`12`. Canonicalized to a numeric string (PK = `-1`, K = `0`). Values like `3rd` or `banana` are rejected. **`next`:** What happens after the student completes the course. Accepts: - A test type: `end of course`, `test out`, or `placement` (case-insensitive, flexible spacing) - A course UUID from an active course sequence — the student will be enrolled in that course next **`assignmentId`:** Must be a positive integer if provided. Resolved automatically from existing enrollments if omitted. operationId: createCustomHoleFillingCourse requestBody: content: application/json: schema: type: object properties: studentEmail: type: string format: email description: The student's email address. example: alice@alpha.school subject: type: string enum: - Math - Language - Reading - Writing - Vocabulary - Science description: >- Academic subject. Supported values: `Math`, `Language`, `Reading`, `Writing`, `Vocabulary`, `Science`. example: Reading grade: type: string minLength: 1 description: >- Grade level. Accepted values: - Canonical: `-1` (Pre-K), `0` (K), `1` through `12` - Aliases (case-insensitive): `PK`, `PreK`, `Pre-K`, `Pre-Kindergarten`, `K`, `KG`, `Kindergarten` AP (grade 13), partial numerics (e.g. `3rd`), and unrecognized strings are rejected with 400. example: '3' app: type: string enum: - mobymax - lalilo - freckle - vocabloco - anton - edia - timeback - timeback_learn - alphawrite - alpha_read description: >- Learning app that owns the lessons. When `app` is `timeback`, `timeback_learn`, `alphawrite`, or `alpha_read`, the flow links existing OneRoster resources directly — no Bridge call is made. For `timeback_learn`, Math `lessonId` values must be source course-component sourcedIds while Science values must be resource sourcedIds. For `alphawrite` and `alpha_read`, `lessonId` values must be existing OneRoster resource sourcedIds (for `alpha_read`, the article resource sourcedId, e.g. `article_4100001`). `alpha_read` requires subject `Reading`. example: mobymax lessons: type: array items: type: object properties: lessonId: type: string minLength: 1 description: >- Lesson identifier from the app. For Timeback Learn Math use a source course-component sourcedId; for Timeback Learn Science use a resource sourcedId. example: mm-reading-phonics-01 lessonName: type: string minLength: 1 description: Human-readable lesson title. example: 'Phonics: Short Vowels' order: type: integer minimum: 1 description: >- Display order (1-based). Lessons are sorted by this field server-side before processing. example: 1 xp: type: integer exclusiveMinimum: 0 description: >- XP value for this lesson (positive integer). If omitted, the app's default is used. For apps that expand one lesson into multiple resources (e.g. VocabLoco), the XP is distributed across generated resources with a minimum of 1 XP each. If the value is lower than the number of generated resources, each resource gets 1 XP. Ignored for Timeback, Timeback Learn, AlphaWrite, and Alpha Read (they link existing resources with their own XP). example: 10 required: - lessonId - lessonName - order minItems: 1 description: >- Lessons to include in the custom hole-filling course. At least 1 required. For large sets (>100), lessons are batched automatically across multiple Bridge calls. next: type: string minLength: 1 description: >- Post-completion action. Accepts: - **Test-type strings** (case-insensitive, whitespace/hyphens/underscores ignored): `end of course`, `test out`, `placement`. Also accepts variant spellings like `End Of Course`, `EndOfCourse`, `end-of-course`, `end_of_course`, `TEST OUT`, `Test-Out`, etc. Normalized to `assessment` + the canonical test type. - **Course UUID** — a lowercase UUID referencing a course in an active course sequence for the given subject. Validated server-side: the course must exist, appear in an active sequence, and be the most recent `courseReference` on its stage (historical/swapped-out courses are rejected). Any other value is rejected with 400. example: end of course assignmentId: type: integer exclusiveMinimum: 0 description: >- AlphaTest assignment ID. If omitted, the server attempts to resolve it by scanning the student's existing same-subject enrollments for course metadata containing `assignmentId`. Must be a positive integer. baseCourseSourcedId: type: string description: >- Base course sourced ID for hole-filling lineage tracking. If omitted, the server attempts to resolve it from the student's existing same-subject enrollments. gapAnalysisId: type: string description: Gap analysis record ID for metadata tracking. missedQuestions: type: array items: type: string description: List of missed question IDs for metadata tracking. skipUnenroll: type: boolean description: >- When true, skip unenrolling the student from other active courses of the same subject. By default (false/omitted), the student is unenrolled from all same-subject courses before enrolling in the new HF course. example: false origin: type: string description: >- Origin identifier for the assignment that triggered this custom HF. Propagated to course metadata and used when assigning the follow-up test, so AlphaTest's analysis rules resolve the correct origin. Defaults to 'progression' if omitted. example: timeback_ui required: - studentEmail - subject - grade - app - lessons - next examples: mobymax: summary: MobyMax Reading G3 (end of course) value: studentEmail: student@alpha.school subject: Reading grade: '3' app: mobymax lessons: - lessonId: mobymax_reading_1654_g3 lessonName: Identify and explain personification order: 1 - lessonId: mobymax_informational_text_1321_g3 lessonName: Distinguish fact from opinion order: 2 next: end of course edia: summary: Edia Math G6 (test out) value: studentEmail: student@alpha.school subject: Math grade: '6' app: edia lessons: - lessonId: middle_school.factors and multiples.factor_expressions lessonName: Factor expressions order: 1 - lessonId: >- middle_school.perimeter_area_and_volume.equations_area_of_parallelogram lessonName: >- Write and solve equations involving area of a parallelogram order: 2 next: test out gapAnalysisId: ga-abc-123 alphawrite: summary: AlphaWrite Writing G7 (placement) value: studentEmail: student@alpha.school subject: Writing grade: '7' app: alphawrite lessons: - lessonId: >- alphawrite-paragraphs-g7-identify-topic-sentence-resource lessonName: Identify Topic Sentences order: 1 - lessonId: alphawrite-paragraphs-g7-elaborate-paragraphs-resource lessonName: Elaborate on Paragraphs order: 2 next: placement responses: '202': description: Job accepted — course creation started content: application/json: schema: type: object properties: jobId: type: string format: uuid description: >- Unique job identifier for tracking. The course is created asynchronously. example: 8cf5f85e-3efc-425a-af0b-a2be695ee4bd message: type: string const: Custom HF course creation started description: Confirmation message required: - jobId - message '400': description: >- Validation error: invalid email, unsupported app, non-canonical grade (e.g. `3rd`, `banana`), invalid `next` value, or UUID not found in an active course sequence. content: application/json: schema: type: object properties: error: type: string description: Error message details: description: Additional error details required: - error '500': description: Unexpected server error. content: application/json: schema: type: object properties: error: type: string description: Error message details: description: Additional error details required: - error '502': description: Upstream service error. content: application/json: schema: type: object properties: error: type: string description: Error message details: description: Additional error details required: - error components: securitySchemes: OAuth2: type: oauth2 flows: clientCredentials: scopes: https://purl.imsglobal.org/spec/or/v1p1/scope/admin: Admin access to the API https://purl.imsglobal.org/spec/or/v1p2/scope/admin.own: Admin access restricted to own resources https://purl.imsglobal.org/spec/or/v1p1/scope/roster-core.readonly: Read access to roster core https://purl.imsglobal.org/spec/or/v1p1/scope/roster.readonly: Read access to roster https://purl.imsglobal.org/spec/or/v1p1/scope/roster.createput: Create and update access to roster https://purl.imsglobal.org/spec/or/v1p1/scope/roster.delete: Delete access to roster https://purl.imsglobal.org/spec/or/v1p1/scope/roster-demographics.readonly: Read access to roster demographics https://purl.imsglobal.org/spec/or/v1p1/scope/roster-demographics.createput: Create and update access to roster demographics https://purl.imsglobal.org/spec/or/v1p1/scope/roster-demographics.delete: Delete access to roster demographics https://purl.imsglobal.org/spec/or/v1p1/scope/resource.readonly: Read access to resource https://purl.imsglobal.org/spec/or/v1p1/scope/resource.createput: Create and update access to resource https://purl.imsglobal.org/spec/or/v1p1/scope/resource.delete: Delete access to resource https://purl.imsglobal.org/spec/or/v1p1/scope/gradebook.readonly: Read access to gradebook https://purl.imsglobal.org/spec/or/v1p1/scope/gradebook.createput: Create and update access to gradebook https://purl.imsglobal.org/spec/or/v1p1/scope/gradebook.delete: Delete access to gradebook https://purl.imsglobal.org/spec/powerpath/v1p1/scope/powerpath.readonly: Read access to powerpath https://purl.imsglobal.org/spec/powerpath/v1p1/scope/powerpath.createput: Create and update access to powerpath https://purl.imsglobal.org/spec/powerpath/v1p1/scope/powerpath.delete: Delete access to powerpath https://purl.imsglobal.org/spec/powerpath/v1p1/scope/powerpath.admin: Admin access to powerpath https://purl.imsglobal.org/spec/ob/v3p0/scope/credential.readonly: Read your issued badges https://purl.imsglobal.org/spec/ob/v3p0/scope/credential.upsert: Store new badges in your account https://purl.imsglobal.org/spec/ob/v3p0/scope/credential.delete: Delete access to open badges https://purl.imsglobal.org/spec/ob/v3p0/scope/credential.admin: Administrative access to open badges https://purl.imsglobal.org/spec/clr/v2p0/scope/credential.readonly: Read access to CLR https://purl.imsglobal.org/spec/clr/v2p0/scope/credential.upsert: Create and update access to CLR https://purl.imsglobal.org/spec/clr/v2p0/scope/credential.admin: Administrative access to CLR https://api.alpha-1edtech.ai/edubridge/progression.readonly: Browse lesson catalog via progression proxy https://api.alpha-1edtech.ai/edubridge/progression.createput: Create hole-filling courses via progression proxy tokenUrl: >- https://prod-beyond-timeback-api-2-idp.auth.us-east-1.amazoncognito.com/oauth2/token ````