Ga naar inhoud

API: bestanden

Bestanden in de bestandsopslag toevoegen, bijwerken, opvragen en verwijderen.

De bestandsopslag bevat bestanden die je in cursussen hergebruikt, zoals een SCORM-pakket dat aan meerdere activiteiten is gekoppeld. Met deze endpoints voeg je een bestand toe als base64-inhoud, werk je de inhoud en metadata bij, vraag je alle bijgehouden bestanden op en verwijder je een bestand. Dezelfde handelingen in de interface: Bestanden beheren in de bestandsopslag.

Elk endpoint accepteert zowel GET als POST; de kop toont de methode die de specificatie als eerste noemt. Uploads gaan alleen met POST. Stuur je API-sleutel mee in de header Access-Token. De basis-URL is https://<your-platform>/local/ltisaas/api.php/v1; met v0 en het token dummy krijg je testdata. Foutmeldingen komen terug als JSON met success: false, error en debuginfo. Authenticatie, versies en limieten staan in API-documentatie. De beschrijvingen van endpoints en velden hieronder komen uit de specificatie en zijn Engels.

Gegenereerd uit de LtiSaas API-specificatie 1.0, opgehaald op 2026-10-30 van dev-auto.

EndpointBeschrijving
POST /file/addAdd a new file to the system
POST /file/updateUpdate a file by ID
GET /file/listList all tracked files
POST /file/deleteDelete a file by ID

POST /file/add

Add a new file to the system. Uploads a base64-encoded file and stores metadata in the database.

Request body (application/json).

VeldTypeVerplichtBeschrijving
filenamestringjaVoorbeeld: "report.pdf".
filecontentstringjaVoorbeeld: "base64-encoded-content".
titlestringneeVoorbeeld: "Quarterly Report".
referencestringneeVoorbeeld: "REF-2025".
versionstringneeVoorbeeld: "1.0".

Voorbeeldverzoek

curl -X POST -H "Access-Token: <your token>" -H "Content-Type: application/json" \
  -d '{"filename": "report.pdf", "filecontent": "base64-encoded-content"}' \
  "https://<your-platform>/local/ltisaas/api.php/v1/file/add"

Voorbeeldantwoord (200). File added successfully.

{
  "filesize": 1024,
  "filepath": "/moodledata/repository/api/report.pdf",
  "status": "success",
  "id": 42,
  "filename": "report.pdf"
}

Fouten: de specificatie noemt geen foutantwoorden voor dit endpoint.

POST /file/update

Update a file by ID. Updates the content and metadata of a file.

Request body (application/json).

VeldTypeVerplichtBeschrijving
idintegerjaVoorbeeld: 42.
filenamestringjaVoorbeeld: "report.pdf".
filecontentstringjaVoorbeeld: "base64-encoded-content".
titlestringneeVoorbeeld: "Quarterly Report".
referencestringneeVoorbeeld: "REF-2025".
versionstringneeVoorbeeld: "1.1".

Voorbeeldverzoek

curl -X POST -H "Access-Token: <your token>" -H "Content-Type: application/json" \
  -d '{"id": 42, "filename": "report.pdf", "filecontent": "base64-encoded-content"}' \
  "https://<your-platform>/local/ltisaas/api.php/v1/file/update"

Voorbeeldantwoord (200). File updated successfully.

{
  "filesize": 1024,
  "filepath": "/moodledata/repository/api/report.pdf",
  "status": "success",
  "filename": "report.pdf"
}

Fouten: de specificatie noemt geen foutantwoorden voor dit endpoint.

GET /file/list

List all tracked files. Returns a list of all tracked files in the system.

Parameters

Dit endpoint heeft geen parameters.

Voorbeeldverzoek

curl -H "Access-Token: <your token>" \
  "https://<your-platform>/local/ltisaas/api.php/v1/file/list"

Voorbeeldantwoord (200). List of files.

[
  {
    "id": 1,
    "filename": "demo.pdf",
    "revision": 1,
    "version": "1.0",
    "title": "Quarterly Report",
    "reference": "REF-2025",
    "datecreated": 1700000000,
    "dateupdated": 1700000100
  }
]

Fouten: de specificatie noemt geen foutantwoorden voor dit endpoint.

POST /file/delete

Delete a file by ID. Deletes a file by its database ID and removes the file from disk.

Request body (application/json).

VeldTypeVerplichtBeschrijving
idintegerjaVoorbeeld: 3.

Voorbeeldverzoek

curl -X POST -H "Access-Token: <your token>" -H "Content-Type: application/json" \
  -d '{"id": 3}' \
  "https://<your-platform>/local/ltisaas/api.php/v1/file/delete"

Voorbeeldantwoord (200). Success.

{
  "status": "success"
}

Fouten: de specificatie noemt geen foutantwoorden voor dit endpoint.

Laatst bijgewerkt op