GET

/courses/{id}

Terug naar Course

Veldspecificaties

19 items
Veld Beschrijving Type Verplicht Beperkingen
request.query.id
id
 Tekenreeks Ja -
response.200
response 200
 Object Nee -
response.200.courseId
courseId

Unique identifier for this Course. This identifier equals the identifier of the corresponding CourseStructure.

 Tekenreeks Ja -
response.200.title
title

Title of the Course, to be presented in the Onderwijsleeromgeving.

 Tekenreeks Ja -
response.200.description
description

Short description of the Course, to be presented in the Onderwijsleeromgeving.

 Tekenreeks Nee -
response.200.lastPublishedVersion
lastPublishedVersion

Last published version of this course. Version number is defined by the supplier. After every modification the version number levels up.

 Tekenreeks Ja -
response.200.studies
studies

The studies and study years that this product is targeted at.

 Lijst[] Ja -
response.200.studies[*]
studies

The studies and study years that this product is targeted at.

 Object Nee -
response.200.subjects
subjects

The subjects that this product is targeted at.

 Lijst[] Ja -
response.200.subjects[*]
subjects

The subjects that this product is targeted at.

 Object Nee -
response.400
response 400

Functional status code and status message.

 Object Nee -
response.400.status
status

See functional status codes within the Documentation.

 Geheel getal Ja -
response.400.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee -
response.401
response 401

Functional status code and status message.

 Object Nee -
response.401.status
status

See functional status codes within the Documentation.

 Geheel getal Ja -
response.401.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee -
response.404
response 404

Functional status code and status message.

 Object Nee -
response.404.status
status

See functional status codes within the Documentation.

 Geheel getal Ja -
response.404.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee -

Verwachte statuscodes

4 items
Code Betekenis Uitkomst
200 OK Succes
400 Bad Request Fout
401 Unauthorized Fout
404 Not Found Fout

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /courses/{id}:
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
    get:
      summary: Get Course by ID
      x-tags:
        - Course
      tags:
        - Leermaterialencatalogus
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Course'
        '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-course
      description: |
        Usually the Course is found via the catalog, each product has a list of Courses that is available for a student/teacher when that product is bought. This call is used to get more information about these Courses. Moreover the call can also be used to see if there are any new versions of this Course published. The response is a Course object with basic information about the Course.
      security:
        - OAuth2:
            - eduv.course