/courses/{id}/cmi5e

  /courses/{id}/cmi5e:
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
    get:
      summary: Get CourseStructure by ID in CMI5e Format
      x-tags:
        - CourseStructure
      tags:
        - Leermaterialencatalogus
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/CMI5.CourseStructure'
              examples:
                example-1:
                  value:
                    course:
                      title:
                        - lang: string
                          langstring: string
                      description:
                        - lang: string
                          langstring: string
                      image: string
                      publicationdate: string
                      publisher: string
                      streamcode: string
                      version: string
                      streams:
                        - id: string
                          description: string
                    objectives:
                      - id: string
                        title: string
                        description: string
                    aus:
                      - id: string
                        activityType: string
                        moveOn: string
                        launchMethod: string
                        title:
                          - lang: string
                            langstring: string
                        objectives:
                          - string
                        url: string
                        launchParameters: string
                        image: string
                        streamref: string
                    blocks:
                      - id: string
                        title:
                          - lang: string
                            langstring: string
                        description:
                          - lang: string
                            langstring: string
                        blocks:
                          - {}
                        aus:
                          - id: string
                            activityType: string
                            moveOn: string
                            launchMethod: string
                            title:
                              - lang: string
                                langstring: string
                            objectives:
                              - string
                            url: string
                            launchParameters: string
                            image: string
                            streamref: string
                        instructions:
                          - lang: string
                            langstring: string
                        image: string
                        studyloadindicator: 0
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
      operationId: get-coursestructure-by-id
      security:
        - OAuth2:
            - eduv.course
      description: |
        The CourseStructure contains information about the course, including which chapters, paragraphs and assignable units are available, including deeplinks to the publishers playing environment so the student start that unit.
        
        The format of the response is based on the international [xAPI CMI5 CourseDefinition standard](https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/v1/CourseStructure.xsd) and the [Sanoma extension](http://www.sanoma.com/cmi5/ExtendedCourseStructureExtension.xsd). This format is XML based. The response is a full CMI5 Extended Course XML (CMI5e).

        If we decide to make a JSON version then this definition would do fine, as it contains the same fields/information. This cannot be fully defined in openAPI/JSON in the same format as the xml version, but this is a close mapping for reference. See remarks at the CMI5.CourseStructure schema.

        The CMI5 standard also provides a protocol to launch assignable units in a browser and get progress on these assignable units. This is not part of the specification. The format is used to exchange meta information, not to enforce runtime. For the moment it is expected that the url's in the content work without a need to setup sessions etc. Each publisher is responsible for creating url's in such a way that single sign-on is enforced. See Documentation for guidelines for formatting of deeplinks.