GET

/courses

Get all courses

Terug naar Course

Veldspecificaties

19 items
Veld Beschrijving Type Verplicht Beperkingen
request.query.since
since
 Tekenreeks Nee -
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:
    parameters:
      - schema:
          type: string
          format: date-time
        in: query
        name: since
        required: false
        description: 'Request all Courses modified after the specified timestamp. Format: Conform openapi in ZULU time as specified in RFC 3339, section 5.6'
        example: "2017-07-21T17:32:28Z"
    get:
      summary: Get All Courses
      operationId: get-all-courses
      x-tags:
        - Course
      tags:
        - Leermaterialencatalogus
      description: Get all courses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $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'
      security:
        - OAuth2:
            - eduv.course