> ## 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. # Get a lesson plan tree by its ID > Purpose: Get the complete lesson plan tree for a lesson plan. When to use: - When you need to display the full lesson plan to a student - For rendering the personalized learning path What it does: - Returns the lesson plan in a syllabus-like format - Includes only non-skipped items (visible content) - Shows the hierarchical structure with components and resources - Provides all original metadata needed for UI rendering ## OpenAPI ````yaml /openapi/beyond-ai/powerpath-api.yaml get /powerpath/lessonPlans/tree/{lessonPlanId} openapi: 3.1.0 info: title: PowerPath API version: 1.0.0 description: > TimeBack PowerPath 100 API # Authentication All endpoints require authentication using the `Authorization: Bearer ` header. The token can be obtained with: ``` curl -X POST https://prod-beyond-timeback-api-2-idp.auth.us-east-1.amazoncognito.com/oauth2/token \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=client_credentials&client_id=&client_secret=" ``` Use the correct IDP server depending on the environment you're using: IDP Server for this environment: ``` https://prod-beyond-timeback-api-2-idp.auth.us-east-1.amazoncognito.com ``` Reach out to the platform team to get a client/secret pair for your application. # Pagination Our API uses offset pagination for list endpoints. Paginated responses include the following fields: - `offset`: Offset for the next page of results - `limit`: Number of items per page (default: 100, maximum: 3000) **Note:** While the OneRoster specification does not define a maximum limit, this implementation enforces a maximum of 3000 items per page to prevent abuse and ensure optimal performance. Example request: ``` GET /ims/oneroster/rostering/v1p2/users?offset=20&limit=20 ``` All listing endpoints support offset pagination. # Filtering All listing endpoints support filtering using the `filter` query parameter, following 1EdTech's filtering specification. The filter should be a string with the following format: ``` ?filter=[field][operator][value] ``` Example request: ``` GET /ims/oneroster/rostering/v1p2/users?filter=status='active' ``` Example request with multiple filters: ``` GET /ims/oneroster/rostering/v1p2/users?filter=status='active' AND name='John' ``` **Filtering by nested relations is not supported**. # Sorting All listing endpoints support sorting using the `sort` and `orderBy` query parameters, following 1EdTech's sorting specification Example request: ``` GET /ims/oneroster/rostering/v1p2/users?sort=lastName&orderBy=asc ``` # Proprietary Extensions This implementation includes proprietary extensions that extend beyond the official OneRoster 1.2 specification to provide additional functionality. ## Search Parameter In addition to the standard `filter` parameter, this implementation provides a `search` query parameter for simplified free-text searching: ``` GET /ims/oneroster/rostering/v1p2/users?search=john ``` **Purpose**: The `search` parameter enables convenient text-based queries across multiple fields simultaneously, whereas the standard `filter` parameter requires specifying exact field names and operators: ``` # Search parameter - searches across multiple fields automatically GET /ims/oneroster/rostering/v1p2/users?search=john # Equivalent using standard filter parameter GET /ims/oneroster/rostering/v1p2/users?filter=givenName~'john' OR familyName~'john' ``` The `search` parameter performs case-insensitive partial matching across predefined fields for each endpoint, providing a more user-friendly querying experience. ## OneRoster 1.2 Standard Parameters The official OneRoster 1.2 specification defines these standard parameters: - `limit` - pagination limit - `offset` - pagination offset - `sort` - field to sort by - `orderBy` - sort direction (asc/desc) - `filter` - filtering expression - `fields` - field selection ## Affected Endpoints The proprietary `search` parameter is available on the following endpoints: **Rostering API**: - `GET /ims/oneroster/rostering/v1p2/academicSessions/` - `GET /ims/oneroster/rostering/v1p2/classes/` - `GET /ims/oneroster/rostering/v1p2/classes/{classSourcedId}/students` - `GET /ims/oneroster/rostering/v1p2/classes/{classSourcedId}/teachers` - `GET /ims/oneroster/rostering/v1p2/courses/` - `GET /ims/oneroster/rostering/v1p2/courses/{courseSourcedId}/classes` - `GET /ims/oneroster/rostering/v1p2/demographics/` - `GET /ims/oneroster/rostering/v1p2/enrollments/` - `GET /ims/oneroster/rostering/v1p2/schools/{schoolSourcedId}/classes/{classSourcedId}/students` - `GET /ims/oneroster/rostering/v1p2/users/` **Gradebook API**: - `GET /ims/oneroster/gradebook/v1p2/assessmentLineItems/` - `GET /ims/oneroster/gradebook/v1p2/assessmentResults/` - `GET /ims/oneroster/gradebook/v1p2/classes/{classSourcedId}/students/{studentSourcedId}/results` - `GET /ims/oneroster/gradebook/v1p2/results/` **Resources API**: - `GET /ims/oneroster/resources/v1p2/resources/` ## Parameter Usage Guide ### Filter Parameter The standard `filter` parameter provides precise control over queries using these operators: - `=` - Exact match - `!=` - Not equal - `~` - Contains (case-insensitive) - `>`, `>=`, `<`, `<=` - Comparison operators - `@` - In list (comma-separated values) ### Logical Operators Combine multiple conditions in filter expressions: - `AND` - Both conditions must be true - `OR` - Either condition must be true ### Usage Examples ```bash # Simple text search across multiple fields GET /users?search=john # Equivalent precise filtering GET /users?filter=givenName~'john' OR familyName~'john' # Complex filtering with multiple conditions GET /users?filter=status='active' AND givenName~'john' # Advanced filtering with different operators GET /users?filter=dateLastModified>'2023-01-01' AND status='active' ``` ## Search Fields by Endpoint Different endpoints search across these predefined fields: - **Users**: `givenName`, `familyName`, `email` - **Courses**: `title`, `courseCode` - **Classes**: `title` - **Organizations**: `name` ## Interoperability Notes The `search` parameter is a proprietary extension specific to this implementation. Other OneRoster-compliant systems may only support the standard `filter` parameter. When building applications that need to work with multiple OneRoster providers, consider using the standard filtering approach. ## Additional Schema Fields ### AssessmentLineItem Extensions The AssessmentLineItem schema includes two proprietary fields that extend curriculum mapping capabilities: #### Component Field - **Field**: `component` - **Type**: Object reference (`{ sourcedId: string }`) - **Purpose**: Direct association between assessment line items and course components, enabling enhanced curriculum mapping and learning pathway tracking. #### ComponentResource Field - **Field**: `componentResource` - **Type**: Object reference (`{ sourcedId: string }`) - **Purpose**: Direct association between assessment line items and specific learning resources, supporting detailed content-to-assessment relationships and adaptive learning features. **Example Usage**: ```json { "sourcedId": "assessment-123", "title": "Chapter 5 Quiz", "component": { "sourcedId": "component-456" }, "componentResource": { "sourcedId": "resource-789" } } ``` ## Affected Endpoints ### Schema Extensions Availability The proprietary schema fields are available in: **Gradebook API**: - `GET /ims/oneroster/gradebook/v1p2/assessmentLineItems/` - Returns assessmentLineItems with `component` and `componentResource` fields - `GET /ims/oneroster/gradebook/v1p2/assessmentLineItems/{sourcedId}` - Returns individual assessmentLineItem with extended fields - `POST /ims/oneroster/gradebook/v1p2/assessmentLineItems/` - Accepts `component` and `componentResource` in request body - `PUT /ims/oneroster/gradebook/v1p2/assessmentLineItems/{sourcedId}` - Accepts extended fields for updates servers: - url: https://api.alpha-1edtech.ai description: PowerPath API security: - OAuth2: [] tags: - name: Course Mastery - name: Course Sequence description: >- Manage course sequences and query course sequence to get the next stage in the student learning path - name: Lesson Mastery description: >- Track and manage student mastery of lesson objectives, through PowerPath 100 lessons - name: Lesson Plans description: Manage lesson plans and instructional content - name: Placement - name: Test Assignments - name: Test Out description: >- Self-elected test-out endpoints for students to verify mastery and advance to the next grade level paths: /powerpath/lessonPlans/tree/{lessonPlanId}: get: tags: - Lesson Plans summary: Get a lesson plan tree by its ID description: |- Purpose: Get the complete lesson plan tree for a lesson plan. When to use: - When you need to display the full lesson plan to a student - For rendering the personalized learning path What it does: - Returns the lesson plan in a syllabus-like format - Includes only non-skipped items (visible content) - Shows the hierarchical structure with components and resources - Provides all original metadata needed for UI rendering operationId: getLessonPlan parameters: - name: lessonPlanId description: Lesson plan ID in: path required: true schema: type: string responses: '200': description: Lesson plan tree content: application/json: schema: type: object properties: lessonPlan: type: object properties: lessonPlan: type: object properties: course: type: object properties: sourcedId: type: string minLength: 1 status: type: string enum: - active - tobedeleted dateLastModified: type: string format: date-time metadata: type: object additionalProperties: true nullable: true description: Additional metadata for the object title: type: string academicSession: type: - object - 'null' properties: sourcedId: type: string required: - sourcedId schoolYear: type: - object - 'null' properties: href: type: string format: uri sourcedId: type: string type: type: string enum: - academicSession - assessmentLineItem - category - class - course - demographics - enrollment - gradingPeriod - lineItem - org - resource - result - scoreScale - student - teacher - term - user - componentResource - courseComponent required: - href - sourcedId - type courseCode: type: - string - 'null' grades: type: - array - 'null' items: allOf: - $ref: '#/components/schemas/GradeEnum' description: The grades of the course enum: - '-1' - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' subjects: type: - array - 'null' items: allOf: - $ref: '#/components/schemas/SubjectEnum' description: The subjects of the course enum: - Reading - Language - Vocabulary - Social Studies - Writing - Science - FastMath - Math - None - Other subjectCodes: type: - array - 'null' items: type: string org: type: object properties: sourcedId: type: string required: - sourcedId level: type: - string - 'null' gradingScheme: type: - string - 'null' resources: type: - array - 'null' items: type: object properties: href: type: string format: uri sourcedId: type: string type: type: string enum: - academicSession - assessmentLineItem - category - class - course - demographics - enrollment - gradingPeriod - lineItem - org - resource - result - scoreScale - student - teacher - term - user - componentResource - courseComponent required: - href - sourcedId - type primaryApp: type: string description: >- sourcedId of the application that owns this course's content. Persisted to courses.primary_app_sourced_id when it matches an active application (resolved via direct match → alias map → fuzzy match). Falls back to metadata.primaryApp on input for back-compat. Non-string values are ignored, matching pre-fix behaviour where the field was an unknown key. required: - status - title - org description: Represents a course. subComponents: type: array items: $ref: '#/components/schemas/LessonPlanTreeComponent' required: - course - subComponents required: - lessonPlan required: - lessonPlan '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedRequestResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' components: schemas: GradeEnum: type: string enum: - '-1' - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' description: >- Grade levels. -1 is Pre-K, 0 is Kindergarten, 1-12 are grades 1-12, 13 is AP. example: '3' SubjectEnum: type: string enum: - Reading - Language - Vocabulary - Social Studies - Writing - Science - FastMath - Math - None - Other LessonPlanTreeComponent: type: object properties: id: type: string description: The ID of the lesson plan item sourcedId: type: string description: The Sourced ID of the component status: type: string enum: - active - tobedeleted title: type: string sortOrder: type: string unlockDate: type: string metadata: type: object additionalProperties: {} prerequisites: type: array items: type: string prerequisiteCriteria: type: string componentResources: type: array items: type: object properties: tenantId: type: - string - 'null' clientAppId: type: - string - 'null' id: type: string description: The ID of the lesson plan item sortOrder: type: string metadata: type: object additionalProperties: {} courseComponentSourcedId: type: string resource: allOf: - $ref: '#/components/schemas/Resource' properties: metadataDetails: type: object properties: type: type: string required: - type required: - metadataDetails required: - tenantId - clientAppId - id - courseComponentSourcedId - resource subComponents: type: array items: $ref: '#/components/schemas/LessonPlanTreeComponent' required: - id - sourcedId - status - title UnauthorizedRequestResponse: type: object properties: imsx_codeMajor: type: string default: failure description: The major response code example: failure imsx_severity: type: string default: error description: The severity of the response example: error imsx_description: type: string imsx_CodeMinor: type: object properties: imsx_codeMinorField: type: array items: type: object properties: imsx_codeMinorFieldName: type: string default: TargetEndSystem description: The field name for the minor code example: TargetEndSystem imsx_codeMinorFieldValue: type: string default: unauthorisedrequest description: The field value for the minor code example: unauthorisedrequest required: - imsx_codeMinorFieldName - imsx_codeMinorFieldValue required: - imsx_codeMinorField imsx_error_details: type: array items: type: object additionalProperties: type: string required: - imsx_codeMajor - imsx_severity - imsx_description - imsx_CodeMinor ForbiddenResponse: type: object properties: imsx_codeMajor: type: string default: failure description: The major response code example: failure imsx_severity: type: string default: error description: The severity of the response example: error imsx_description: type: string imsx_CodeMinor: type: object properties: imsx_codeMinorField: type: array items: type: object properties: imsx_codeMinorFieldName: type: string default: TargetEndSystem description: The field name for the minor code example: TargetEndSystem imsx_codeMinorFieldValue: type: string default: forbidden description: The field value for the minor code example: forbidden required: - imsx_codeMinorFieldName - imsx_codeMinorFieldValue required: - imsx_codeMinorField imsx_error_details: type: array items: type: object additionalProperties: type: string required: - imsx_codeMajor - imsx_severity - imsx_description - imsx_CodeMinor Resource: type: object properties: sourcedId: type: string status: type: string enum: - active - tobedeleted dateLastModified: type: string format: date-time metadata: type: object additionalProperties: true nullable: true description: Additional metadata for the object title: type: string roles: type: array items: type: string enum: - primary - secondary importance: type: string enum: - primary - secondary vendorResourceId: type: string vendorId: type: - string - 'null' applicationId: type: - string - 'null' required: - sourcedId - status - title - vendorResourceId description: Represents a digital resource of some kind. 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 ````