CS:Metadata Afnemen van Koppelpunt

Een partij kan een aanvraag indienen bij de geaggregeerd endpoint conform het Edu-V Afsprakenstelsel.

Catalogusinformatie opvragen

De Catalogue API Edu-V Harvester verzamelt elk uur alle records van de aangesloten API-endpoints van aanbieders en schrijft ze naar een geaggregeerd endpoint. Alle verzamelde records kunnen op basis van de Catalogue API worden opgehaald.

Koppelpunt Catalogue API endpoints

Versie

Wij hebben de laatste versie van de Catalogue API van Edu-V Afsprakenstelsel geïmplementeerd. Momenteel is dit versie 0.9.2.

Validatie

Er vindt momenteel geen record validatie plaats. De records zijn letterlijk overgenomen zoals ze afkomstig zijn uit de catalogus van de aanbieders. De aanbieder wordt geacht de velden te vullen conform het Edu-V afsprakenstelsel. Er wordt niet gecontroleerd of alle verplichte velden zijn ingevuld. Ook wordt het formaat van de aangeleverde waarden niet gecontroleerd.

Authenticatie

Je kunt de Koppelpunt Catalogue API opvragen zonder authenticatie.

Get All Products

Pagineren

In het Edu-V Afsprakenstelsel kunnen aanbieders paginering toepassen om de prestaties van hun interfaces te verbeteren. OpenAPI 3 specificeert geen standaard manier om paginering te implementeren.

We hebben ervoor gekozen om de methode te hanteren die in versie 0.9.0 van Catalogue API werd beschreven, namelijk de parameters start en limit.

• Met start wordt het eerstvolgende record aangegeven, de nummering begint bij 0
• Met limit wordt het aantal records per pagina aangeduid, zonder deze parameter worden 20 records teruggegeven.
• De maximale limit waarde is 100 records per pagina.
• Zonder de parameters limit en start bevat het antwoord alleen de eerste 20 records.

  /products:
    parameters:
      - schema:
          type: integer
        name: start
        in: query
        description: 'Start point for pagination of results, defaults to 0,'
        examples:
          default:
            value: 0
            summary: The start point for pagination
      - schema:
          type: integer
          maximum: 100
        in: query
        name: limit
        description: 'Limit of number of results returned by page, defaults to 20 with max 100.'
        examples:
          default:
            value: 20
            summary: The default value if none is provided
          max:
            value: 100
            summary: The largest recommended page size

Incrementele harvesting

OpenAPI 3 specificeert geen standaard implementatie voor een "since"-parameter en definieert niet of deze moet worden geïmplementeerd als > (groter dan) of >= (groter dan of gelijk aan).

In de Koppelpunt Catalogue API kun je de since-parameter gebruiken om alle wijzigingen sinds een bepaalde datum op te vragen. Het resultaat bevat alle producten die na die datum zijn toegevoegd of gewijzigd, inclusief die datum.

  /products:
    parameters:
      - schema:
          type: string
          format: date-time
        in: query
        name: since
        required: false
        description: 'Request all products 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 Product by ID

Het is ook mogelijk om individuele records op te vragen via het "Get Product by ID" -verzoek.