API - Participants
Récupération de la liste des participants
Renvoie la liste de tous les utilisateurs inscrits dans la session avec leurs statistiques.
URL: https://my.vtsperform.com/api/client/enrolment/{sessionId}/all
Permission requise: ENROLMENT_READ
Méthode: GET
Réponses:
Code | Exemple |
200 (OK) |
[ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
Récupération des détails d'un participant
Renvoie les détails d'un participant avec ses statistiques.
URL: https://my.vtsperform.com/api/client/enrolment/{sessionId}/{enrolmentId}
Permission requise: ENROLMENT_READ
Méthode: GET
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
Inscription d'un participant
Ajoute un utilisateur à une session.
URL: https://my.vtsperform.com/api/client/enrolment/{sessionId}
Permission requise: ENROLMENT_EDIT
Méthode: POST
Paramètres:
Paramètre | Type | Description |
user_id* | integer | Identifiant de l'utilisateur à ajouter dans la session |
end_date | datetime | (optionnel) Date limite d'accès pour ce participant. Ce champ est ignoré si la session n'est pas configurée avec une durée de disponibilité (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-31 23:59) |
send_notification | boolean | Envoi immédiatement le mail d'invitation défini dans les paramètres de la session. |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
Modification d'un participant
Permet de modifier la date limite d'accès du participant ou d'envoyer le mail d'invitation.
URL: https://my.vtsperform.com/api/client/enrolment/{session_id}/{enrolmentId}
Permission requise: ENROLMENT_EDIT
Méthode: PATCH
Paramètres:
Paramètre | Type | Description |
end_date | datetime | (optionnel) Date limite d'accès pour ce participant. Ce champ est ignoré si la session n'est pas configurée avec une durée de disponibilité (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-31 23:59) |
send_notification | boolean | Envoi immédiatement le mail d'invitation défini dans les paramètres de la session. |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
Suppression d'un participant
Supprime un participant de la session et supprime toutes les statistiques liées.
URL: https://my.vtsperform.com/api/client/enrolment/{session_id}/{enrolmentId}
Permission requise: ENROLMENT_DELETE
Méthode: DELETE
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
- ${ child.title }