API Doelenverdeler

API-authenticatie

Voeg de volgende header toe aan elke request:

• Header: api-key
• Waarde: Opvragen via het registratieformulier

Endpoints

Hieronder vindt je een overzicht van de beschikbare endpoints:

Leerplannen overzicht

• Methode: GET
• URL: https://classid.io/api/leerplannen/list

Dit endpoint geeft een overzicht van de beschikbare leerplannen.

Doelen per leerplan

• Methode: GET
• URL: https://classid.io/api/leerplannen/{leerplanId}

Dit endpoint geeft een overzicht van de beschikbare doelen voor een specifiek leerplan. Vervang {leerplanId} door het gewenste leerplan-ID.

Doelen per leerplan detail

• Methode: GET
• URL: https://classid.io/api/leerplannen/{leerplanId}/detailed

Dit endpoint geeft een overzicht van de beschikbare doelen voor een specifiek leerplan. Hierbij wordt er meer informatie teruggestuurd dan bij de vorige endpoint. Vervang {leerplanId} door het gewenste leerplan-ID.

Informatie van een doel

• Methode: GET
• URL: https://classid.io/api/leerplannen/doel/{doelId}

Dit endpoint geeft een detail van het opgevraagde doel. Vervang {doelId} door het gewenste leerplandoel-ID.

Pakketten

• Methode: GET
• URL: https://classid.io/api/pakketten/{schoolId}

Dit endpoint geeft een overzicht van alle pakketten die door uw school werden aangemaakt voor het huidig schooljaar. Vervang {schoolId} door uw schoolId. Deze kan u hier terugvinden (admin).

Doelen per pakket

• Methode: GET
• URL: https://classid.io/api/pakketten/doel/{pakketId}

Dit endpoint geeft een overzicht van alle doelen en subdoelen die gekoppeld zijn aan een pakket. Vervang {pakketId} door het gewenste pakket-ID.

Doelen van alle pakketten

• Methode: GET
• URL: https://classid.io/api/pakketten/alle-doel/{schoolId}

Dit endpoint geeft een overzicht geeft alle doelen en subdoelen weer die gekoppeld zijn aan alle pakketten die door uw school werden aangemaakt voor het huidig schooljaar. Vervang {schoolId} door uw schoolId. Deze kan u hier terugvinden (admin).

Gekoppelde vakken van alle pakketten

• Methode: GET
• URL: https://classid.io/api/pakketten/vakken/{schoolId}

Dit endpoint geeft een overzicht geeft alle klassen en vakken weer die gekoppeld zijn aan alle pakketten die door uw school werden aangemaakt voor het huidig schooljaar. Vervang {schoolId} door uw schoolId. Deze kan u hier terugvinden (admin).

Leerplannen/doelen/subdoelen selectie

• Methode: POST
• URL: https://classid.io/api/leerplannen/selection

Dit endpoint geeft een overzicht van de beschikbare leerplannen, doelen en subdoelen op basis van de opgegeven selectie. Voeg een gelijkaardig JSON-object toe aan de request body:

{
    "selection": [
        {
            "leerplanId": "24bb6e77-458d-4cd9-9a6e-0bc245da8b57",
            "goalId": "dec30b62-f40d-46d7-8101-a4b8bc8b6f1c"
        },
        {
            "leerplanId": "03ff2023-cabe-49bb-9f00-076eae6ac607",
            "goalId": "f38d2294-6bf4-4e3e-9350-f309261819cf"
        }
    ]
}

Vervang de voorbeeldwaarden voor leerplanId en goalId met de gewenste waarden.