Hoe kunnen wij je helpen?
< Alle onderwerpen
Printen

LesLinq API

Vernieuwddecember 11, 2025

De koppelingen met externe systemen, Deepl, Power BI en dergelijke worden gemaakt door het creëren van zogenaamde API’s. Hierin wordt op een eenduidige manier vastgelegd welke informatie op welke manier beschikbaar is voor de gebruiker van de API’s.

Dit artikel bevat gedetailleerde informatie over het gebruik van de LesLinq API. Je leest hier welke request-formaten vereist zijn, welke endpoints beschikbaar zijn en hoe je de integratie met het systeem opzet.

Authenticatie

De LesLinq API werkt met key-based autorisatie. Dit betekent dat elke API-aanroep een geldige API key moet bevatten om toegang te krijgen tot beveiligde resources. Zonder geldige key of bij ontbrekende authenticatie wordt de toegang geweigerd.

API credentials

Geautoriseerde klanten vinden hun API endpoints en tokens op de Settings-pagina in het LesLinq platform.

De lijst met beschikbare endpoints wordt opgehaald via de volgende link: Endpoint/swagger (voorbeeld: https://appapi.leslinq.com/swagger). Gebruik hetzelfde token van de Settings-pagina om de beschikbare endpoints te verkennen.


Autorisatie

API Key (Verplicht)
Alle endpoints onder deze controller vereisen een geldige API Key voor authenticatie. Requests zonder geldige key worden geweigerd.

Header Formaat
De API key moet worden verzonden in de Authorization header volgens het volgende formaat:
Authorization: Bearer xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx

Het prefix Bearer is verplicht
Vervang de placeholder door je daadwerkelijke API key

Waar vind ik mijn API Key?
Geautoriseerde klanten kunnen hun API key bekijken en ophalen via de Settings-pagina van LesLinq.

LesLinq API Endpoints

Participants

1. Alle Participants ophalen

Endpoint
GET /api/Client/Participants/Get

Beschrijving
Haalt de lijst op van alle Participants die gekoppeld zijn aan de geauthenticeerde client.

Response
200 OK
Returns an array of participant objects.

Example:
[
{
“Id”: “EncryptedParticipantId”,
“Name”: “Participant Name”,
“Email”: “participant@example.com”,
…
}
]

400 Bad Request
Geen records gevonden

500 Internal Server Error
Onverwachte serverfout.

2. Participant by ID ophalen

Endpoint
GET /api/Client/Participants/Get/{id}

Beschrijving
Haalt gedetailleerde informatie op van een enkele Participant op basis van het versleutelde ID.

Response
200 OK

{
“Id”: “EncryptedParticipantId”,
“Name”: “Participant Name”,
“Email”: “participant@example.com”,
…
}

404 Not Found
Geen deelnemer komt overeen met het opgegeven ID

500 Internal Server Error
Onverwachte serverfout.

Projects

1. Alle projecten ophalen

Endpoint
GET /api/Client/Projects/Get

Beschrijving
Haalt de lijst op van alle projecten die gekoppeld zijn aan de geauthenticeerde client.

Response
200 OK
Returns an array of project objects.

Example:
[
{
“Id”: “EncryptedProjectId”,
“ProjectName”: “Project Name”,
“Description”: “Project Description”,
…
}
]

400 Bad Request
Geen records gevonden

500 Internal Server Error
Onverwachte serverfout

2. Project ophalen by ID

Endpoint
GET /api/Client/Projects/Get/{id}

Beschrijving
Haalt gedetailleerde informatie op van een enkel project op basis van het versleutelde ID.

Response
200 OK

{
“Id”: “EncryptedProjectId”,
“ProjectName”: “Project Name”,
“Description”: “Project Description”,
…
}

404 Not Found
Returned if no project matches the provided ID.

500 Internal Server Error
Onverwachte serverfout

3. Alle deelnemerspogingen ophalen

Endpoint
GET /api/Client/Projects/Attempts

Beschrijving
Haalt alle deelnemerspogingen op die gekoppeld zijn aan de projecten van de geauthenticeerde client.

Response
200 OK
Returns an array of participant attempt objects.

Example:
[
{
“ProjectId”: “EncryptedProjectId”,
“ProjectName”: “Project Name”,
“ParticipantId”: “EncryptedParticipantId”,
“ParticipantName”: “Participant Name”,
“ShareOrDistributionType”: “Email”,
“ShareOrDistributionName”: “Share or Distribution Name”,
“Status”: “Completed”,
“StartTime”: “2025-12-09T11:00:00Z”,
“Attempt”: 1,
…
}
]

400 Bad Request
Geen records

500 Internal Server Error
Onverwachte serverfout

Tags

1. Alle Tag Types ophalen

Endpoint
GET /api/Client/Tags/Types

Beschrijving
Haalt de lijst op van alle tag types die gekoppeld zijn aan de geauthenticeerde client.

Response
200 OK
Returns an array of tag type objects.

Example:
[
{
“Id”: “EncryptedTagTypeId”,
“Name”: “Tag Type”,
“Status”: “Active”
}
]

400 Bad Request
Geen records

500 Internal Server Error
Onverwachte serverfout

2. Tag Type ophalen by ID

Endpoint
GET /api/Client/Tags/Types/{id}

Beschrijving
Haalt een specifiek tag type op voor de geauthenticeerde client op basis van het versleutelde ID.

Response
200 OK

{
“Id”: “EncryptedTagTypeId”,
“Name”: “Tag Type”,
“Status”: “Active”
}

404 Not Found
Tag type not found.

500 Internal Server Error
Onverwachte serverfout

3. Alle Tags ophalen

Endpoint
GET /api/Client/Tags/Get

Beschrijving
Haalt alle tags op die gekoppeld zijn aan de geauthenticeerde client.

Response
200 OK
[
{
“Id”: “EncryptedTagId”,
“Name”: “Tag Name”,
“TagType”: “EncryptedTagTypeId”,
“Status”: “Active”
}
]

400 Bad Request
Geen records.

500 Internal Server Error
Onverwachte serverfout

4. Tag ophalen by ID

Endpoint
GET /api/Client/Tags/Get/{id}

Beschrijving
Haalt een specifieke tag op basis van het versleutelde ID.

Response
200 OK

{
“Id”: “EncryptedTagId”,
“Name”: “Tag Name”,
“TagType”: “EncryptedTagTypeId”,
“Status”: “Active”
}

404 Not Found
Tag niet gevonden.

500 Internal Server Error
Onverwachte serverfout

5. Alle User Tags ophalen

Endpoint
GET /api/Client/Users/Tags

Beschrijving
Haalt alle tags op die toegewezen zijn aan gebruikers onder de geauthenticeerde client.

Response
200 OK
[
{
“UserId”: “EncryptedUserId”,
“TagId”: “EncryptedTagId”
}
]

400 Bad Request
Geen records.

500 Internal Server Error
Onverwachte serverfout

6. Alle Participant Tags Ophalen

Endpoint
GET /api/Client/Participants/Tags

Beschrijving
Haalt tag-koppelingen op voor alle participants die gekoppeld zijn aan de client.

Response
200 OK

[
{
“ParticipantId”: “EncryptedParticipantId”,
“TagId”: “EncryptedTagId”
}
]

400 Bad Request
Geen records.

500 Internal Server Error
Onverwachte serverfout

7. Alle Project Tags ophalen

Endpoint
GET /api/Client/Projects/Tags

Beschrijving
Haalt alle tag-koppelingen op voor Projects van de client.

Response
200 OK

[
{
“ProjectId”: “EncryptedProjectId”,
“TagId”: “EncryptedTagId”
}
]

400 Bad Request
Geen records.

500 Internal Server Error
Onverwachte serverfout

Users

1. Alle Users ophalen

Endpoint
GET /api/Client/Users/Get

Beschrijving
Haalt de lijst op van alle Users die gekoppeld zijn aan de geauthenticeerde client.

Response
200 OK
Returns an array of user objects.

Example:

[
{
“Id”: “EncryptedUserId”,
“Name”: “John Doe”,
“Email”: “john@example.com”,
…
}
]

400 Bad Request
Geen records.

500 Internal Server Error
Onverwachte serverfout

2. Users ophalen by ID

Endpoint
GET /api/Client/Users/Get/{id}

Beschrijving
Haalt details op van een specifieke User.

Response
200 OK
Returns the matching user object.

{
“Id”: “EncryptedUserId”,
“Name”: “John Doe”,
“Email”: “john@example.com”,
…
}

400 Bad Request
Geen records.

500 Internal Server Error
Onverwachte serverfout

Inhoudsopgave